Previous | Next | Up | Table of Contents

6.2. Optional Items

1. default-package-folder-name
2. product-version
3. compression-level
4. license-file
5. readme-file
6. intro-file
7. intro-file-external
8. configurable-file
9. chmod-package
10. use-server-permissions
11. default-file-mode
12. default-folder-mode
13. disable-permissions-warning
14. disable-local-installs
15. allow-pfn-edit
16. hide-product-info
17. main-page
18. image-side-panel
19. image-motif
20. auto-install-loaders
21. all-encoded-files-binary
22. post-install-php
23. post-install-php-interactive
24. run-post-install
25. stub-version
26. stub-product
27. stub-copyright
28. stub-description
29. stub-comments
30. stub-icon
31. with
32. add-language-pack
33. default-locale
34. commmon-documents
35. localised-documents
36. active-help-url

Usage:default-package-folder-name "WebEdit"
Default name for the top-level package folder after installation. This can be omitted.

Usage:product-version "1.0 RC8"
The product version may be specified with this item. The default value is '1.0'.

Usage:compression-level 7
When using 'gzip' compression to compress a package folder a compression level may be specified from 0 to 9. Level 9 gives the best compression but is slower than level 1. Level 6 is a reasonable value. Level 0 specifies that no compression should be used.

Usage:license-file license.txt
If this item is used the specified file will be displayed during the installation process

Usage:readme-file readme.txt
If this item is used the use will have the option of displaying the readme file at the end of the installation process.

Usage:intro-file intro.html
An introduction can be shown after the license agreement (or start page, if the license in not present). This introduction may contain installation instructions or other information. Either the path of a file can specified, or a URL.

Usage:intro-file-external 1
If this option is set, the intro file will be launched externally using the Windows file association. For example, an html file will be launched in the default web browser. If this option is not set then the intro file will be displayed in the installer itself.

Usage:configurable-file config.txt
After installation of a product it is often necessary to edit text files in order to configure the application. Installers created with the Package Foundry can automate this task by downloading, editing and uploading configuration files. You can specify (possibly multiple) such files using the configurable-file item.

Usage:chmod-package o-w file.php
If a folder is to be used as the package source, and the compression type is set to 'gzip', permissions can be specified for files or subfolders in the package. These permissions override the permissions of the source file or folder and are used when installing the package either locally or via FTP. This is especially useful on Windows as it enables one to create a package with UNIX-style permissions. Permissions can be specified either as a list as in 'g+r, o-w', or in octal as in '660'.

Usage:use-server-permissions 1
If the package is a folder rather than an archive this option specifies that file and folder permissions should not be edited once the item is uploaded to the target FTP server. If this option is set to 0 then permissions will be modified according to the default-file-mode and default-folder-mode options as described below. The default value for this option is 1.

Usage:default-file-mode 606
When compressing a package archive with gzip compression this setting specifies the default permission mode to use for those files not specified with chmod-package. This option only applies to the Windows version of IPF, as on Linux permissions can be easily set for the package folder using the shell. The default value is 644.

Usage:default-folder-mode 755
When compressing a package archive with gzip compression this setting specifies the default permission mode to use for those folders not specified with chmod-package. This option only applies to the Windows version of IPF, as on Linux permissions can be easily set for the package folder using the shell. The default value is 755.

Usage:disable-permissions-warning 0
The setting of permissions will only work if the chmod command is supported on the target FTP server. If disable-permission-warning is not set, then a warning will be displayed if permissions cannot be set. The files and permissions specified with chmod-package will be listed. The warning is only displayed if at least one item is specified with chmod-package.

Usage:disable-local-installs 1
If a product will only be installed to remote servers, and never to an end-user's local machine, then this option can be used to remove the 'Installation Type' wizard step. This option would be useful, for example, if the creator of the package was intending to use the package to install to a handful of their own remote servers. If a product is for general release then usually this option should not be used.

Usage:allow-pfn-edit 0
When this option is set to 1 the end-user will be able to edit the package folder name.

Usage:hide-product-info 1
When this option is set to 1 the product name and version will not be displayed over the side panel image.

Usage:main-page index.php
This item can be set to the main page of the package. The Configuration Tool will then launch this page in the user's default browser when they click Launch.

Usage:image-side-panel my-panel.png
This item enables customisation of the side panel image on the first page and last pages of the package installer. The image must have file extension .png, .jpeg, .jpg, .bmp, or .gif, and be a valid image of the corresponding image format.

Usage:image-motif motif.png
This item enables customizations of the image appearing on the top right of most pages in the package installer wizard. As with the side panel image, this image must be in Portable Network Graphics format.

Usage:auto-install-loaders 1
By default, Loaders will be installed automatically if they are not already installed on the target server. Use this option to control whether to enable the automatic installation of Loaders.

Usage:all-encoded-files-binary 0
Use this option to specify whether all files in the application which are encoded with the ionCube Encoder have been encoded in binary mode.

Usage:post-install-php my-app/readme.php
Set this item to the URL of a page that should be launched in the user's default web browser after installation is complete. The URL is relative to the folder the user uploads the application into.

Usage:post-install-php-interactive 1
This item specifies whether the post-install script requires user-interaction. If so, then the page will be launched in a browser, otherwise it will be executed silently by the Package Installer.

Usage:run-post-install config
Sometimes a post-install script should be run at the end of the installation wizard, and sometimes it should be run after configuration files have been saved to the server. Use the value 'config' to specify that the post-install script should run after configuration, and any other value to specify that it should run after file upload and any Loader installation.

Use this option to customise the version number of the installer executable file.

Usage:stub-product "My Product"
Use this option to customise the product name in the installer executable file's version info resource.

Usage:stub-copyright "Copyright ionCube 2005"
Use this option to customise the copyright message in the installer executable file's version info resource.

Usage:stub-description "IPF installer product"
Use this option to customise the product description in the installer executable file's version info resource.

Usage:stub-comments "Beta build"
Use this option to customise the comments field in the installer executable file's version info resource.

Usage:stub-icon C:\my_icon.ico
Use this option to customise the application icon of the installer executable file's version info resource.

Usage:with SSL
IPF has a modular architecture, and this option can be used to specify which installed plugins to enable. SSL support is currently implemented as a plugin, and is the only plugin available.

Usage:add-language-pack de
Language packs can be included with the installer by using this option. End-users whose system locale to an included locale will see messages displayed in their language. See the 'locale' subfolder of the IPF installation folder for the available language packs.

Usage:default-locale de
If the end-user's current system locale is not available as an included language pack, unlocalised (English) messages will be displayed by the installer. Specify this option to use a different language pack as the default.

Usage:commmon-documents C:\docs
If this option is used then the common documents folder will be searched for unlocalised versions of install files (readme, license etc). Otherwise IPF will search relative to the current .pfs script.

Usage:localised-documents C:\locale
This option sets the root of the localised documents tree. Subfolders are named according to language codes (e.g. en), or language and country codes (e.g. en_GB). Localised versions of install files are then added to the appropriate language subfolder.

This option sets the target URL for the Help button on IPF created installers.