Environment Variables for Docker

Environment Variable	Default Values	Description
APPLICATION_NAME	n/a	This environment variable is used to provide custom application name to fetch application properties from config management.
APP_CONFIG_PROFILE	n/a	Name of the application profile that is to be used from a configuration management system such as ZUUL or Spring Cloud Config.
AWS_ACCESS_KEY	n/a	It is the access key used to acess the AWS account from where the parameters are required to be fetched. Note: Note: This must be set, if you want to use AWS systems manager parameter store or AWS secret manager for application configuration and secrets management.
AWS_EXTERNAL_ID	n/a	Optional. A unique identifier that is required when you assume a role in another account. It is used to address the confused deputy problem.
AWS_EXPIRATION_DURATION (ms)	n/a	Optional. Parameter to specify the duration in minutes for which the temporary security credentials remain valid using AssumeRole.
AWS_PARAMETER_STORE	true	This environment variable is optional while running applications on TIBCO Business Studio for BusinessWorks or Docker platforms and it is mandatory while deploying applications on ECS services.
AWS_REGION	n/a	It is the region of your AWS account. Note: Note: This must be set, if you want to use AWS systems manager parameter store or AWS secret manager for application configuration and secrets management.
AWS_ROLE_ARN	n/a	This is required to use assumeRole for authentication. The Amazon Resource Name (ARN) of the role to assume.
AWS_ROLE_SESSION_NAME	n/a	This environment variable is required to use assumeRole for authentication. An identifier for the assumed role session is used to uniquely identify a session when the same role is assumed by different principals or for different reasons. Please refer to AWS documentation for further details on RoleSessionName.
AWS_SECRET_KEY	n/a	It is the secret key used to acess the AWS account from where the parameters are required to be fetched. Note: This must be set, if you want to use AWS systems manager parameter store or AWS secret manager for application configuration and secrets management.
AWS_SECRET_MANAGER	true	Set to use AWS Secret Manager as the credential management system.
AZURE_CLIENT_ID	n/a	It is the Client ID of the service principle.
AZURE_CLIENT_SECRET	n/a	It is the Secret of the service principle.
AZURE_TENANT_ID	n/a	It is the Tenant ID of the Azure account.
AZURE_VAULT	true	This environment variable is set to true to enable Credential Management using Azure Vault.
BW_LOG_FORMAT	n/a	Use value as JSON to change logging format of BWCE to JSON format. Use value as 'Logstash JSON' to change logging format of BWCE to Logstash JSON format.
BW_LOGLEVEL	ERROR	Used to set a log level for the TIBCO BusinessWorks Container Edition application. The default value is ERROR. Supported values are: INFO DEBUG WARN ERROR
BW_ENGINE_THREADCOUNT	8	Used to set engine thread count for the TIBCO BusinessWorks Container Edition application.
BW_ENGINE_STEPCOUNT	-1	Used to set engine step count for the TIBCO BusinessWorks Container Edition application.
BW_APPLICATION_JOB_FLOWLIMIT	n/a	Used to set flow limit for TIBCO BusinessWorks Container Edition application.
BW_PROFILE	n/a	Used to set the name of the BusinessWorks profile from the application.
BW_JAVA_OPTS	n/a	Used to set Java properties that are used at run time. The properties are specified using name-value pairs and are separated by spaces. For example, `BW_JAVA_OPTS="-Dname=value -Dname=value"` Note: Note: BW_JAVA_OPTS environment variable can also be used to hardcore the heap parameters.
BW_JMX_CONFIG	n/a	Used to set JMX configuration (RMI host and JMX port) for monitoring TIBCO BusinessWorks Container Edition application. The value should be provided in RMI_HOST:JMX_PORT format. For example, `BW_JMX_CONFIG=192.168.99.100:8050`
BW_JAVA_GC_OPTS	-XX:+UseG1GC	Used to set JAVA GC configuration. The value should be one of the standard Java GC VM Options. For example: `BW_JAVA_GC_OPTS=-XX:+UseParallelGC`
BREAK_CIRCUIT_ON_404_ERROR	True	Used to change the behavior of the Circuit Breaker functionality. By default, circuit breaks for 404 (Not Found) error code. It does not break the circuit for 404 error code on specifying the value of the variable as `false`.
BW_COMPONENT_JOB_FLOWLIMIT	n/a	Used to set flow limit at component level for TIBCO BusinessWorks Container Edition application. For example, `BW_COMPONENT_JOB_FLOWLIMIT=<applicationn version>.componentName`
CYBERARK	true	Set to use Cyberark as the credential management system.
CONJUR_ACCOUNT	n/a	The account specified during setting up Conjur.
CONJUR_APPLIANCE_URL	n/a	It is the Conjur HTTPS enpoint (OSS/DAP).
CONJUR_AUTHN_LOGIN	n/a	It is the user or host identity.
CONJUR_AUTHN_API_KEY	n/a	It is the user or host API Key.
CUSTOM_LOG_BACK	False	Used for customizing logs.
CYBERARK_KEYSTORE_PATH	n/a	The location of the JKS file.
CYBERARK_KEYSTORE_PASSWORD	n/a	The password of the JKS file.
CONSUL_SERVER_URL	n/a	Used to set Consul server configuration. For example, `CONSUL_SERVER_URL=http://127.0.0.1:8085` This must be set if you intend to use Consul for application configuration or for service registration and discovery.
CONSUL_CUSTOM_FOLDER	n/a	This must be set if you only intend to use properties from Consul Server stored in custom folders. If properties are stored or exported to <CONSUL_SERVER_URL>/ui/dc1/kv/FOLDER1/FOLDER2 location then the value for CONSUL_CUSTOM_FOLDER = FOLDER1/FOLDER2
DISABLE_BWCE_EAR_VALIDATION	False	Used to deploy the ActiveMatrix BusinessWorks 6.x application EAR file on TIBCO BusinessWorks Container Edition without converting project to Container Edition and rebuilding EAR file from TIBCO Business Studio for BusinessWorks. Note: Note: Ensure that the ActiveMatrix BusinessWorks 6.x EAR file is exported. ActiveMatrix BusinessWorks 6.x EAR file should only have TIBCO BusinessWorks Container Edition supported activities and features.
EUREKA_SERVER_URL		Used to set Eureka server configuration. For example, `EUREKA_SERVER_URL=http://127.1.0.1:8080/eureka` This must be set if you intend to use Eureka for service registration and discovery.
HASHICORP_VAULT_ADDR	n/a	URL of the vault server
HASHICORP_VAULT_AUTH	n/a	Provide the authentication value as token or userpass or approle depending on the authentication method used.
HASHICORP_VAULT_NAMESPACE	n/a	Name of the namespace to be used in the application to retrieve secrets from the vault. Optional. This environment variable should be used only if namespaces is used.
HASHICORP_AUTH_PATH	Default path for userpass is userpass/ Default path for approle is approle/	Optional. Path where the authentication option is enabled in the vault.
HASHICORP_VAULT_KV_VERSION	2	Version of the key value engine to be used . The default value is 2 if this environment variable is not used. The only other valid value for this field is 1.
HASHICORP_VAULT_TOKEN	n/a	Provide the token value when authentication method is token.
HASHICORP_VAULT_ROLE_ID	n/a	Provide the role-id if authentication method is approle.
HASHICORP_VAULT_SECRET_ID	n/a	Provide the secret-id if authentication method is approle.
HASHICORP_VAULT_USERNAME	n/a	Provide the username if authentication method is userpass.
HASHICORP_VAULT_PASSWORD	n/a	Provide the password if authentication method is userpass.
HASHICORP_CACERT	n/a	Provide the path of CA certificate used
MASHERY_SERVICE_CONFIG	n/a	Applications can pass TIBCO Mashery configuration information using the `MASHERY_SERVICE_CONFIG` environment variable. The value of the environment variable is a JSON string with the required TIBCO Mashery configuration. For more information, see Integrating with TIBCO Mashery.
SPRING_CLOUD_CONFIG_SERVER_URL	n/a	Used to set URL for Spring Cloud Config Server. For example: `SPRING_CLOUD_CONFIG_SERVER_URL =http://127.1.0.1:8888/` Note: Note: This must be set, if you want to use Spring Cloud Config Server for application configuration management.
SPRING_CLOUD_CONFIG_ACCESS_TOKEN_URI	n/a	Used to set OAuth access token URL for Spring Cloud Config Server, if OAuth is enabled.
SPRING_CLOUD_CONFIG_CLIENT_ID	n/a	Used to set OAuth client ID for Spring Cloud Config Server, if OAuth is enabled.
SPRING_CLOUD_CONFIG_CLIENT_SECRET	n/a	Used to set OAuth client secret for Spring Cloud Config Server, if OAuth is enabled.
X_CONSUL_TOKEN	n/a	Used to authenticate the request made to the Consul server. This environment variable should be used when the consul server is enabled for authentication. Note: Note: This should be set if authentication is enabled on the consul server and you want to authenticate the requests made to the consul server.
VAULT_AUTH_PATH	n/a	Path of the Authentication mounted

APPLICATION_NAME

n/a

This environment variable is used to provide custom application name to fetch application properties from config management.

APP_CONFIG_PROFILE

n/a

Name of the application profile that is to be used from a configuration management system such as ZUUL or Spring Cloud Config.

AWS_ACCESS_KEY

n/a

It is the access key used to acess the AWS account from where the parameters are required to be fetched.

Note: Note: This must be set, if you want to use AWS systems manager parameter store or AWS secret manager for application configuration and secrets management.

AWS_EXTERNAL_ID

n/a

Optional. A unique identifier that is required when you assume a role in another account. It is used to address the confused deputy problem.

AWS_EXPIRATION_DURATION (ms)

n/a

Optional. Parameter to specify the duration in minutes for which the temporary security credentials remain valid using AssumeRole.

AWS_PARAMETER_STORE

true

This environment variable is optional while running applications on TIBCO Business Studio for BusinessWorks or Docker platforms and it is mandatory while deploying applications on ECS services.

AWS_REGION

n/a

It is the region of your AWS account.

Note: Note: This must be set, if you want to use AWS systems manager parameter store or AWS secret manager for application configuration and secrets management.

AWS_ROLE_ARN

n/a

This is required to use assumeRole for authentication. The Amazon Resource Name (ARN) of the role to assume.

AWS_ROLE_SESSION_NAME

n/a

This environment variable is required to use assumeRole for authentication. An identifier for the assumed role session is used to uniquely identify a session when the same role is assumed by different principals or for different reasons. Please refer to AWS documentation for further details on RoleSessionName.

AWS_SECRET_KEY

n/a

It is the secret key used to acess the AWS account from where the parameters are required to be fetched.

Note: This must be set, if you want to use AWS systems manager parameter store or AWS secret manager for application configuration and secrets management.

AWS_SECRET_MANAGER

true

Set to use AWS Secret Manager as the credential management system.

AZURE_CLIENT_ID

n/a

It is the Client ID of the service principle.

AZURE_CLIENT_SECRET

n/a

It is the Secret of the service principle.

AZURE_TENANT_ID

n/a

It is the Tenant ID of the Azure account.

AZURE_VAULT

true

This environment variable is set to true to enable Credential Management using Azure Vault.

BW_LOG_FORMAT

n/a

Use value as JSON to change logging format of BWCE to JSON format.
Use value as 'Logstash JSON' to change logging format of BWCE to Logstash JSON format.

BW_LOGLEVEL

ERROR

Used to set a log level for the TIBCO BusinessWorks Container Edition application. The default value is ERROR. Supported values are:

INFO
DEBUG
WARN
ERROR

BW_ENGINE_THREADCOUNT

8

Used to set engine thread count for the TIBCO BusinessWorks Container Edition application.

BW_ENGINE_STEPCOUNT

-1

Used to set engine step count for the TIBCO BusinessWorks Container Edition application.

BW_APPLICATION_JOB_FLOWLIMIT

n/a

Used to set flow limit for TIBCO BusinessWorks Container Edition application.

BW_PROFILE

n/a

Used to set the name of the BusinessWorks profile from the application.

BW_JAVA_OPTS

n/a

Used to set Java properties that are used at run time. The properties are specified using name-value pairs and are separated by spaces.

For example,

 BW_JAVA_OPTS="-Dname=value -Dname=value"

Note: Note: BW_JAVA_OPTS environment variable can also be used to hardcore the heap parameters.

BW_JMX_CONFIG

n/a

Used to set JMX configuration (RMI host and JMX port) for monitoring TIBCO BusinessWorks Container Edition application. The value should be provided in RMI_HOST:JMX_PORT format.

For example,

BW_JMX_CONFIG=192.168.99.100:8050

BW_JAVA_GC_OPTS

-XX:+UseG1GC

Used to set JAVA GC configuration. The value should be one of the standard Java GC VM Options.

For example:

BW_JAVA_GC_OPTS=-XX:+UseParallelGC

BREAK_CIRCUIT_ON_404_ERROR

True

Used to change the behavior of the Circuit Breaker functionality. By default, circuit breaks for 404 (Not Found) error code.

It does not break the circuit for 404 error code on specifying the value of the variable as false.

BW_COMPONENT_JOB_FLOWLIMIT

n/a

Used to set flow limit at component level for TIBCO BusinessWorks Container Edition application.

For example,

BW_COMPONENT_JOB_FLOWLIMIT=<applicationn version>.componentName

CYBERARK

true

Set to use Cyberark as the credential management system.

CONJUR_ACCOUNT

n/a

The account specified during setting up Conjur.

CONJUR_APPLIANCE_URL

n/a

It is the Conjur HTTPS enpoint (OSS/DAP).

CONJUR_AUTHN_LOGIN

n/a

It is the user or host identity.

CONJUR_AUTHN_API_KEY

n/a

It is the user or host API Key.

CUSTOM_LOG_BACK

False

Used for customizing logs.

CYBERARK_KEYSTORE_PATH

n/a

The location of the JKS file.

CYBERARK_KEYSTORE_PASSWORD

n/a

The password of the JKS file.

CONSUL_SERVER_URL

n/a

Used to set Consul server configuration.

For example,

CONSUL_SERVER_URL=http://127.0.0.1:8085

This must be set if you intend to use Consul for application configuration or for service registration and discovery.

CONSUL_CUSTOM_FOLDER

n/a

This must be set if you only intend to use properties from Consul Server stored in custom folders.

If properties are stored or exported to <CONSUL_SERVER_URL>/ui/dc1/kv/FOLDER1/FOLDER2 location then the value for CONSUL_CUSTOM_FOLDER = FOLDER1/FOLDER2

DISABLE_BWCE_EAR_VALIDATION

False

Used to deploy the ActiveMatrix BusinessWorks 6.x application EAR file on TIBCO BusinessWorks Container Edition without converting project to Container Edition and rebuilding EAR file from TIBCO Business Studio for BusinessWorks.

Note: Note: Ensure that the ActiveMatrix BusinessWorks 6.x EAR file is exported. ActiveMatrix BusinessWorks 6.x EAR file should only have TIBCO BusinessWorks Container Edition supported activities and features.

EUREKA_SERVER_URL

Used to set Eureka server configuration.

For example,

EUREKA_SERVER_URL=http://127.1.0.1:8080/eureka

This must be set if you intend to use Eureka for service registration and discovery.

HASHICORP_VAULT_ADDR

n/a

URL of the vault server

HASHICORP_VAULT_AUTH

n/a

Provide the authentication value as token or userpass or approle depending on the authentication method used.

HASHICORP_VAULT_NAMESPACE

n/a

Name of the namespace to be used in the application to retrieve secrets from the vault.

Optional. This environment variable should be used only if namespaces is used.

HASHICORP_AUTH_PATH

Default path for userpass is userpass/

Default path for approle is approle/

Optional. Path where the authentication option is enabled in the vault.

HASHICORP_VAULT_KV_VERSION

2

Version of the key value engine to be used . The default value is 2 if this environment variable is not used. The only other valid value for this field is 1.

HASHICORP_VAULT_TOKEN

n/a

Provide the token value when authentication method is token.

HASHICORP_VAULT_ROLE_ID

n/a

Provide the role-id if authentication method is approle.

HASHICORP_VAULT_SECRET_ID

n/a

Provide the secret-id if authentication method is approle.

HASHICORP_VAULT_USERNAME

n/a

Provide the username if authentication method is userpass.

HASHICORP_VAULT_PASSWORD

n/a

Provide the password if authentication method is userpass.

HASHICORP_CACERT

n/a

Provide the path of CA certificate used

MASHERY_SERVICE_CONFIG

n/a

Applications can pass TIBCO Mashery configuration information using the MASHERY_SERVICE_CONFIG environment variable.

The value of the environment variable is a JSON string with the required TIBCO Mashery configuration.

For more information, see Integrating with TIBCO Mashery.

SPRING_CLOUD_CONFIG_SERVER_URL

n/a

Used to set URL for Spring Cloud Config Server.

For example:

SPRING_CLOUD_CONFIG_SERVER_URL =http://127.1.0.1:8888/

Note: Note: This must be set, if you want to use Spring Cloud Config Server for application configuration management.

SPRING_CLOUD_CONFIG_ACCESS_TOKEN_URI

n/a

Used to set OAuth access token URL for Spring Cloud Config Server, if OAuth is enabled.

SPRING_CLOUD_CONFIG_CLIENT_ID

n/a

Used to set OAuth client ID for Spring Cloud Config Server, if OAuth is enabled.

SPRING_CLOUD_CONFIG_CLIENT_SECRET

n/a

Used to set OAuth client secret for Spring Cloud Config Server, if OAuth is enabled.

X_CONSUL_TOKEN

n/a

Used to authenticate the request made to the Consul server.

This environment variable should be used when the consul server is enabled for authentication.

Note: Note: This should be set if authentication is enabled on the consul server and you want to authenticate the requests made to the consul server.

VAULT_AUTH_PATH

n/a

Path of the Authentication mounted