The installation process can be controlled by setting properties on the command line. These are detailed below.
The best & definitive documentation for these properties is the code itself.
Usual Properties
Property | Description |
---|
idp.target.dir | 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 |
idp.entityID | The EntityID being created at install time |
idp.host.name | The host name of the IdP being created. This is used to generate metadata and also in certificate generation |
idp.scope | The scope to assert |
idp.keysize | The size of keys to generate (the default is currently 3072, but may change in future release) |
idp.keystore.password | The password to use when the trust PKCS12 keystore (backchannel) file is created. |
idp.sealer.password | The password to use when the sealer PKCS12 keystore (cookie encryption) file is created. |
idp.LDAP.credential | The LDAP Password (usually associated with a username in ldap.properties). |
idp.conf.credentials.filemode | UNIX Only Mode to set on credential files after installation (via chmod). The default value is currently 660 |
idp.conf.credentials.group | UNIX Only The group to set on the contents of the "credentials" directory (via chgrp). If not specified none is set. |
Advanced Properties
Property | Description |
---|
ldap.merge.properties | The name a property file to "merge" with the shipped ldap.properties file. Values in the merge file override values in the shipped file. |
idp.merge.properties | 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. |
idp.sealer.alias | The sealer alias to use |
idp.sealer.keysize
| The keysize for the sealer .
|
idp.noprompt | 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 |
idp.property.file | 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 |
idp.conf.setmode | Set to false to turn OFF the setting of modes after an installation or upgrade. Mode setting includes (but may not be limited to)
|
idp.no.tidy | For debug purposes, setting this to true will stop intermediate files (such as the idp.property.file) from being deleted after the installation |
idp.initial.modules | Which modules to enable on initial install. |
Not available in V5
idp.src.dir
idp.conf.preoverlay
idp.initial.edit-webapp
Property | Used during | Description |
---|
idp.src.dir | Installation | Where to install from (the distribution) |
idp.conf.preoverlay | Installation | 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. |
idp.initial.edit-webapp | Installation | The name of a directory used to populate edit-webapp during first installation. If present the distributed edit-webapp is ignored. |
Examples
Setting generated key size on non-Windows system
./bin/install.sh -Didp.keysize=2048
Setting generated key size on Windows system
.\bin\install.bat -Didp.keysize=2048
Setting installation directory on Windows systems
.\bin\build.bat -Didp.target.dir="C:\Program Files (x86)\Shibboleth\IdP"
Enable two additional modules during installation
install.bat -Didp.initial.modules=+idp.intercept.Impersonate,idp.authn.MFA