The installation process can be controlled by setting properties on the command line. These are detailed below.
In general, only the "usual" properties are of interest. The advanced properties are listed for completeness and are like to be useful mostly to people writing installation packages (for instance Federation Operators).
The best & definitive documentation for these properties is the code itself.
Where the installation is. In non-initial installs this defaults to a location derived from the the file used to invoked the installer. Equivalent to (and overwriiten by) the -t qualifier
The EntityID being created at install time
The (DNS) host name of the IdP being created. This is used to generate metadata and also in certificate generation
The scope to assert
The size of keys to generate (the default is currently 3072, but may change in future release)
The password to use when the trust PKCS12 keystore (backchannel) file is created.
The password to use when the sealer PKCS12 keystore (cookie encryption) file is created.
The LDAP Password (usually associated with a username in ldap.properties).
UNIX Only Mode to set on credential files after installation (via chmod). The default value is currently 660
UNIX Only The group to set on the contents of the "credentials" directory (via chgrp). If not specified none is set.
The name a property file to "merge" with the shipped ldap.properties file. Values in the merge file override values in the shipped file.
The name of a property file to "merge" with the shipped idp.properties file. Values in the merge file override values in the shipped file.
The sealer alias to use
The keysize for the sealer .
If set to true then an installation will fail rather than prompt for a missing property. Equivalent to (and overwritten by) the --noPrompt command line option
If provided this property file can be used to as the source of all the properties listed on this page. This can save constructing long command lines. Equivalent to (and overwritten by) the --propertyFile command line option Note that the settings overwrite all other settings from the command line
Set to false to turn OFF the setting of modes after an installation or upgrade. Mode setting includes (but may not be limited to)
Setting the 'bin' folder contents to Read+Execute
Setting the 'dist' folder to Read
For debug purposes, setting this to true will stop intermediate files (such as the idp.property.file) from being deleted after the installation
Which modules to enable on initial install.
Where to install from (the distribution)
The name of a directory used to pre-populate the conf file. Files in the conf tree of the distribution will not overwrite these files.
The name of a directory used to populate edit-webapp during first installation. If present the distributed edit-webapp is ignored.
In all the examples below the command line will be
./bin/install.sh --propertyFile <file>
for Unix and
./bin/install.bat --propertyFile <file>
Property file setting generated key size and enabling two additional modules during installation