Starting the Approval Server Docker container with default configurations

Learn how to start the Approval Server Docker container.

To start the container with default configurations to view files inside the container, use:

docker run -it -e LICENSE=accept approval-app

When you start by using the default configurations, the Approval server Docker image name is approval-app.

Default host name

When you start by using the default configurations, the Approval Server Docker container  host name is approval.

Mandatory environment variables

These are the mandatory environment variables that you must specify to configure the Approval Server Docker container.


Environment variable name	Description
SPIUSER_PWD	The encrypted password for the spiuser. For more information, see Setting the spiuser password in your Docker images.
AUTH_TOOLING_HOST	The Auth environment Tooling web hostname.
LIVE_TOOLING_HOST	The Live environment Tooling web hostname.
SESSION_KEY_ENCRYPT	The encrypted session key. Note: This parameter was optional in all releases prior to HCL Commerce 9.1.12.0.
JWKS	The JSON Web Key Set (JWKS) containing the JSON Web Key (JWK) used to validate the JSON Web Token (JWT) that is issued by the Transaction server. TheApproval server only requires the public key related information from the JWT. In the event that the private key information is also included in the JWKS, the Approval server will remove the private key information and only configure the public key for use with the application.

app-secure.properties

A boot configuration file, app-secure.properties, is also required to be passed in via the persistent volume. This file contains:

Required database configurations in order to connect to PostgreSQL. The contents of this configuration file depend on whether or not you want to enable secure SSL connectivity to the database.

For an SSL enabled database:

spring.datasource.url=jdbc:postgresql://postgresql:5432/comdb?ssl=true&sslfactory=org.postgresql.ssl.DefaultJavaSSLFactory spring.datasource.username=hclcom  
                                    spring.datasource.password=user-password 
                                    spring.datasource.hikari.schema=hclcom spring.flyway.url=jdbc:postgresql://postgresql:5432/comdb?ssl=true&sslfactory=org.postgresql.ssl.DefaultJavaSSLFactory  
                                    spring.flyway.user=hclcom  
                                    spring.flyway.password=user-password 
                                    spring.flyway.default-schema=hclcom

For a non-SSL enabled database:

spring.datasource.url=jdbc:postgresql://postgresql:5432/comdb spring.datasource.username=hclcom
                                    spring.datasource.password=user-password
                                    spring.datasource.hikari.schema=hclcom spring.flyway.url=jdbc:postgresql://postgresql:5432/comdb
                                    spring.flyway.user=hclcom
                                    spring.flyway.password=user-password
                                    spring.flyway.default-schema=hclcom

Log level for the Feign API client. This configuration is for the consumption of API logging information for troubleshooting purposes. By default, this is set to BASIC, which logs the request method, URL, the response status code, and the execution time. For more information, see Configuring logging for the Approval server.

Optional environment variables

These are the optional environment variables that you can specify to configure the Approval Server Docker container container.


Environment variable name	Description
SPIUSER_NAME	The SPIUSER name. If it is not specified, then the default value `spiuser` is assumed.
AUTH_TOOLING_PORT	The Authoring environment tooling web port. If it is not specified, then the default value `8000` is assumed.
LIVE_TOOLING_PORT	The Live environment tooling web port. If it is not specified, then the default value `8000` is assumed.

Code example

For example, to start with mandatory parameters, run the following command.

docker run -it -e LICENSE=accept \  
                    -e SPIUSER_PWD=<SPI user password> \ 
                    -e AUTH_TOOLING_HOST=<Auth tooling host> \ 
                    -e LIVE_TOOLING_HOST=<Live tooling host> \ 
                    -e SESSION_KEY_ENCRYPT=<Session key> \ 
                    -v app-secure.properties:/SETUP/boot-config/app-secure.properties \ 
                    <Approval docker image>