Overriding the default docker compose properties
For advanced usage, create a copy of the om-compose.properties.sample file, name it as om-compose.properties, uncomment one or more properties and change the default value to override it as required.
The following table describes the om-compose
properties:
Property | Default value | Description |
---|---|---|
DTK_LICENSE |
blank | Set this to accept if you have already read the license and accepted it and
want to run the setup without any prompt. |
AP_WAR_FILES |
smcfs,sbc,sma,isccs,isf |
The list of applications that you want to build. For the default value, the Sterling Application Console, IBM® Sterling Business Center, System Management Administrator, and IBM Sterling Call Center, and Store Engagement 2.0 applications are built one after another. To build the WAR file for the
IBM Sterling Call
Center next-generation
application, add |
STORE_DISABLE_LEGACY_APP |
Y |
|
OM_INSTALL_LOCALIZATION |
false |
Set it to true , if you need to install locales and localization
packages. |
OM_LOCALES |
The supported locales include: zh_CN, zh_TW, fr_FR, ja_JP, pt_BR, ko_KR, ru_RU, tr_TR, it_IT,
es_ES, de_DE, pl_PL Set the property value to only those locales that you want to install. |
|
|
|
Change the value of these properties, if other services are running on the same port. Ideally, you must stop any natively running Db2, WebSphere Application Server, Liberty, or MQ application services before running the setup. In that case, you need not change the values of these properties. |
AP_DEBUG_PORT |
8383 |
By default, you can debug the application server in the compose environment through the
8383 port. If the default port is already in use, or for any other reason, you can
enable debugging through a different port. To enable debugging through a different port, complete
the following steps:
|
HOST_OS |
linux |
Set the property to mac , if you are setting up the developer toolkit on
macOS.Leave the property as the default value of |
HOST_ARCH | amd64 | The architecture platform for images that are used in the DTK. If you are installing the DTK on a machine with arm64-based Apple Silicone chipset such as Apple M1, set the value to arm64. |
JAVA_HOME |
If HOST_OS is set to mac , set JAVA_HOME to the JDK home directory on your
Mac. |
|
ORDERHUB_ENABLE |
Y | Set to N if you do not want to run the orderhub extensions container
that supports Order Hub UI customization. Important: If
you are subscribed to
IBM Sterling Order Management System
Software (On Premises), see Overriding the default Docker Compose properties (On
Premises). Configurations for On Premises include additional properties that you need to
set.
|
ORDERHUB_MODE | oms | Use the default value of oms to enable next-generation Order Hub. Set to omoc to enable the Sterling Order Management System (SaaS) version of Order Hub. If you already ran
om-compose setup/setup-upg
before changing the property to omoc, then update the property and run the
following command.
Important: If
you are subscribed to
IBM Sterling Order Management System
Software (On Premises), see Overriding the default Docker Compose properties (On
Premises). Configurations for On Premises include additional properties that you need to
set.
|
AP_HOST | localhost | This property is applicable when setting up Order Hub from a developer
toolkit. Change the value if your application server is not running on localhost. For example,
Note: If you previously ran
om-compose setup or om-compose setup-upg before setting
AP_HOST, then set the property and run the following
command.
|
OH_EXT_HTTPS_PORT | 8443 | Change the value if other services are running on the same port. |
CC_ENABLE | N | Set the value to Y to create the containers for the Sterling
Call Center next-generation application. |
AP_MASHUP_HOST | localhost | Host name or IP of the om-appserver container where icc is
deployed for the Sterling
Call Center next-generation application. |