Changing Host Names
Changing host names associated to AM involves the following high-level steps:
Adding the new host name to the Realm/DNS Aliases list.
Exporting, editing, then importing the configuration.
This step relies on the ssoadm command, which you install separately from AM as described in Setting Up Administration Tools.
Stopping AM and editing configuration files.
Removing the old host name from the Realm/DNS Aliases list.
Before you start, make sure you have a current backup of your current installation. See Backing Up Configurations for instructions.
In the AM console, go to Realms > Realm Name. Then click Properties, add the new host name to the Realm/DNS Aliases list, and then save your work.
Export the service configuration:
ssoadm \ export-svc-cfg \ --adminid uid=amAdmin,ou=People,dc=openam,dc=forgerock,dc=org \ --encryptsecret myEncryptSecretString1234 \ --password-file /tmp/pwd.txt \ --outfile config.xml
Service Configuration was exported.
AM uses the value entered in
--encryptsecretto encrypt passwords stored in the backup file. It can be any value, and is required when restoring a configuration.
Edit the service configuration file:
Change the fully qualified domain name, such as
openam.example.com, throughout the file.
If you are changing the context path, such as
/openam, then make the following changes:
Change the value of
Change contextPath in the value of the
Change contextPath in the value of
Change the context path in a <Value> element that is a child of an <AttributeValuePair> element.
Change the context path where it occurs throughout the file in the full URL to AM, such as
If you are changing the port number, then change the value of
Also change the port number in
host:portcombinations throughout the file.
If you are changing the domain name, then change the cookie domain, such as
<Value>.example.com</Value>throughout the file.
Import the updated service configuration:
ssoadm \ import-svc-cfg \ --adminid uid=amAdmin,ou=People,dc=openam,dc=forgerock,dc=org \ --encryptsecret myEncryptSecretString1234 \ --password-file /tmp/pwd.txt \ --xmlfile config.xml
Directory Service contains existing data. Do you want to delete it? [y|N]
Please wait while we import the service configuration... Service Configuration was imported.
Stop AM or the web container where it runs.
Edit the boot properties file, such as
/home/user/openam/boot.json, changing the fully qualified domain name (FQDN), port, and context path for AM as necessary.
If you are changing the context path, then move the folder containing AM configuration, such as
/home/user/openam/, to match the new context path, such as
If you are changing the location or context path, change the name of the file in the
/home/user/.openamcfgfolder, such as
AMConfig_path_to_tomcat_webapps_openam_, to match the new location and context path.
Also edit the path name in the file to match the change you made when moving the folder.
Restart AM or the web container where it runs.
In the AM console, go to realms > Realm Name, and click Properties.
Remove the old host name from the Realm/DNS Aliases list, and then save your work.