A few of the class/javadoc links in the various configuration topics may not yet be updated after the V5 release. Feel free to file Jira issues if you find specific cases.

PropertyDrivenInstallation

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.

Property

Description

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 (DNS) 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.

Property

Description

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)

  • Setting the 'bin' folder contents to Read+Execute

  • Setting the 'dist' folder to Read

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.

  • idp.src.dir

  • idp.conf.preoverlay

  • idp.initial.edit-webapp

 

Property

Used during

Description

 

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

In all the examples below the command line will be

./bin/install.sh --propertyFile <file>

for Unix and

./bin/install.bat --propertyFile <file>

for Windows

Property file setting generated key size and enabling two additional modules during installation
idp.keysize=2048 idp.initial.modules=+idp.intercept.Impersonate,idp.authn.MFA