PingAM 8.0.0

Passive install with the configurator

The configurator, openam-configurator-tool-14.1.3.28.jar, lets you install AM based on settings in a property file.

To use the configurator, the AM server must be deployed and running but not yet configured.

This command-line utility is deprecated and will be removed in a future AM release.

Follow these steps to install AM with the configurator:

Set up the configuration tools

  1. Make sure the JAVA_HOME environment variable is correctly set:

    $ echo $JAVA_HOME
/path/to/jdk

  2. Create a file system directory to unpack the tools:

    $ mkdir -p /path/to/am-tools/config

  3. Unpack the tools from where you unzipped AM:

    $ cd /path/to/am-tools/config
$ unzip ~/Downloads/am/AM-SSOConfiguratorTools-5.1.3.28.zip
Archive:  ~/Downloads/am/AM-SSOConfiguratorTools-5.1.3.28.zip
creating: legal-notices/
inflating: legal-notices/LICENSE.DOM-software.html
inflating: legal-notices/NOTICE.resolver.txt
inflating: legal-notices/LICENSE.DOM-documentation.html
…​ (more output) …​
extracting: lib/xml-apis-2.11.0.jar
extracting: openam-configurator-tool-14.1.3.28.jar
extracting: lib/servlet-api-2.5.jar

Install AM with the configurator

  1. Make sure the JAVA_HOME environment variable is correctly set:

    $ echo $JAVA_HOME
/path/to/jdk

  2. The configurator tool needs a property file to specify the AM configuration. You can find property file options in configurator.jar.

    Copy the sample configuration property file provided with AM, and modify properties as needed:

    $ cd /path/to/am-tools/config
$ cp sampleconfiguration config.properties
$ grep -v "^#" config.properties \| grep -v "^$"
SERVER_URL=https://am.example.com:8443
DEPLOYMENT_URI=/am
BASE_DIR=/home/am/
locale=en_US
PLATFORM_LOCALE=en_US
AM_ENC_KEY=
ADMIN_PWD=password
COOKIE_DOMAIN=example.com
ACCEPT_LICENSES=true
DATA_STORE=dirServer
DIRECTORY_SSL=SSL
DIRECTORY_SERVER=ds.example.com
DIRECTORY_PORT=1636
DIRECTORY_ADMIN_PORT=4444
ROOT_SUFFIX=ou=am-config
DS_DIRMGRDN=uid=am-config,ou=admins,ou=am-config
DS_DIRMGRPASSWD=password

    When setting options in the property file, note the following:

    • If you include the ACCEPT_LICENSES=true property, AM automatically accepts the software license agreement and suppresses the display of the license acceptance page during silent installation.

    • When installing AM to support HTTPS, make sure the SERVER_URL property specifies a URL with HTTPS.

    • You must use an external directory server for the configuration store. If you try to install AM with the DATA_STORE=embedded property, the installation fails with the following exception From AM 8, embedded DS configuration is not supported.

  3. Run the AM configurator tool, openam-configurator-tool-14.1.3.28.jar:

    $ java -jar openam-configurator-tool-14.1.3.28.jar --file config.properties

    You can specify additional runtime options on the command line:

    • With the --acceptLicense option, the installer auto-accepts the software licensing agreement and suppresses the display of the license acceptance page, resulting in the same behavior as setting ACCEPT_LICENSES=true in the configuration property file.

    • The -Djavax.net.ssl.trustStore=PATH_TO_JKS_TRUSTSTORE option is required when installing AM to support HTTPS. Specify the AM web container’s trust store for PATH_TO_JKS_TRUSTSTORE.

    The installer displays output similar to the following:

    $ java -jar openam-configurator-tool-14.1.3.28.jar --file config.properties
Checking license acceptance….License terms accepted.
Checking configuration directory /home/openam…. Success.
Installing OpenAM configuration store…Success RSA/ECB/OAEPWithSHA1AndMGF1…

…​

Configuration complete!