Configuration

Configuring .env file

You can specify parameters for the deployment by overriding the default values in the .env file. See the Parameters table for a full list of overridable values.

Common Parameters

Parameter Name	Parameter Value	Mandatory/Optional	Description
EXEC_DOCKER_REPOSITORY	pureengageuse1-docker-multicloud.jfrog.io/cce	M	Jfrog Artifactory Edge repository for pulling EXEC images
EXEC_INFRA_DOCKER_REPOSITORY		O	Docker repo for Redis, grafana, and Prometheus containers, if empty - docker hub will be used.
EXEC_HOST_LOGS_VOLUME_PATH	/var/exec/logs	M	Host path which is mounted inside the container to store logs
EXEC_ORG_ID		M	EX Org ID is taken from the following path in the GC UI Admin view: Organization Settings / Organization Details / Advanced / Organization ID
EXEC_TENANT_ID		M	Unique ID to identify the Engage tenant. DBID of the Tenant configuration object in the Engage Configuration DB can be used.
EXEC_REDIS_HOST		M	IP Address of the Redis proxy in case of enterprise Redis and IP Address of Redis server in case of Lab environment
EXEC_REDIS_PORT	6379	M	Port of Redis server
EXEC_REDIS_SECURE	false	O	If the Redis server is password protected via the requirepass option.
EXEC_REDIS_PASSWORD		O	Do not configure the password in the .env file, provide it as input when you run the bootstrap script

EXCS Parameters

Parameter Name	Parameter Value	Mandatory/Optional	Description
EXCS_VM_HOST		M	IP Address of VM machine where CS will be deployed
EXCS_PORT	3640	M	Config Sync Service port
EXCS_TAG	100.0.100.00	M	Config Sync Service Image Version
EXCS_CONFIG_DB_HOST		M	IP Address of Config Database.
EXCS_CONFIG_DB_PORT	8888	M	Port Number of Config Database
EXCS_CONFIG_DB_USER	default	M	Config Database Username
EXCS_CONFIG_DB_PASSWORD		M	Do not configure the password in the .env file, provide it as input when you run the bootstrap script
EXCS_CONFIG_DB_NAME		M	Config Database name
EXCS_CONFIG_DB_TYPE	postgresql	M	Config Database Type
EXCS_SYNC_CUSTOMER_OBJECTS_ONLY	false	O	When set to "true", EXCS only synchronizes objects under customer folder hierarchy to Genesys Cloud. Unless SYNC_CUSTOMER_FOLDER_NAME is specified, treat TENANT_NAME as the top-level customer folder. See Folder Filtering section for more information. Default is "false", i.e. all objects of the supported types are synchronized. Values: true/false (default)
EXCS_SYNC_CUSTOMER_FOLDER_NAME		O	When SYNC_CUSTOMER_OBJECTS_ONLY is set to "true", use the folder name configured here instead of the value of TENANT_NAME.
EXCS_LOG_PATH		O	File system path for logs. If not provided, logs will be directed to stdout
EXCS_LOG_FILENAME	excs-<TENANT_ID>.%Y%m%d_%H%M%S_%L.log	M	File name for logs. If LOG_FILENAME is specified, this environment variable further describes the file name. Example: 'excs-<TENANT_ID>.%Y%m%d_%H%M%S_%L.log'
EXCS_LOG_LEVEL	debug	O	Defines the EXCS log level. Values: trace, debug, info, warn, error, fatal

EXAS Parameters

Parameter Name	Parameter Value	Mandatory/Optional	Description
EXAS_HOST		M	IP Address of VM machine where AS will be deployed
EXAS_PORT	3630	M	Agent Sync Service port
EXAS_TAG	100.0.100.00	M	Agent Sync Service Image Version.
EXAS_STAT_SERVER_PRIMARY_HOST		M	Primary Stat Server's host IP/FQDN
EXAS_STAT_SERVER_PRIMARY_PORT	2060	M	Primary Stat Server's port number.
EXAS_STAT_SERVER_BACKUP_HOST		M	Backup Stat Server's host IP/FQDN
EXAS_STAT_SERVER_BACKUP_PORT	2060	M	Backup Stat Server's port number.
EXAS_LOG_PATH		O	File system path for logs. If not provided, logs will be directed to stdout
EXAS_LOG_FILENAME	exas-<TENANT_ID>.%Y%m%d_%H%M%S_%L.log	M	File name for logs. If LOG_FILENAME is specified, this environment variable further describes the file name. Example: 'exas-<TENANT_ID>.%Y%m%d_%H%M%S_%L.log'
EXAS_LOG_LEVEL	debug	O	Defines the EXAS log level. Values: trace, debug, info, warn, error, fatal

EXCP Parameters

Parameter Name	Parameter Value	Mandatory/Optional	Description
EXCP_1_VM_HOST_PAIR		M	VM Host IPAddress list where Conversation Provider service will be running
EXCP_1_PORT	3650	M	Conversation Provider Service port
EXCP_1_TAG	100.0.100.00	M	Conversation Provider Container version
EXCP_1_VOICE_SERVER_VQ		M	A list of SIP Server host:port for receiving Virtual Queue Events. EXCP should connect to the default port. Format: primary1:port/backup1:port
EXCP_1_VOICE_SERVER_AGENT		M	A list of SIP Server host:port for receiving Extension DN Events . EXCP should connect to the default port. Format: primary1:port/backup1:port
EXCP_1_VOICE_SERVER_CALL		M	A list of SIP Server host:port for receiving Call Monitoring Events. EXCP should connect to the default port. Format: primary1:port/backup1:port
EXCP_1_LOG_PATH		O	File system path for logs. If not provided, logs will be directed to stdout
EXCP_1_LOG_FILE_NAME	excp11-.%Y%m%d_%H%M%S_%L_${TENANT_ID}_${HOSTNAME}.log, excp12-.%Y%m%d_%H%M%S_%L_${TENANT_ID}_${HOSTNAME}.log	M	File name for logs. If EXCP_1_LOG_FILE_NAME is specified, this environment variable further describes the file name. Example: 'excp-.%Y%m%d_%H%M%S_%L_${TENANT_ID}_${HOSTNAME}.log'
EXCP_1_LOG_LEVEL	debug,debug	O	Defines the EXCP log level. Values: trace, debug, info, warn, error, fatal