Configuration

Configuring .env file

The .env file contains the description of the EXEC docker environment. Configure all mandatory parameters to describe the environment where EXEC components are planned to be deployed. Bootstrap script converts data from this file into the docker compose yml configuration files.

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	Description
EXEC_DOCKER_REPOSITORY *	Jfrog Artifactory Edge repository for pulling EXEC images.
EXEC_INFRA_DOCKER_REPOSITORY	Docker repo for Redis, grafana, and Prometheus containers, if empty - docker hub will be used.
EXEC_HOST_LOGS_VOLUME_PATH *	Host path which is mounted inside the container to store logs.
EXEC_ORG_ID *	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 *	Unique ID to identify the Engage tenant. DBID of the Tenant configuration object in the Engage Configuration DB can be used.
EXEC_REDIS_HOST *	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 *	Port of Redis server
EXEC_REDIS_SECURE	If the Redis server is password protected via the requirepass option.
EXEC_REDIS_PASSWORD	Do not configure the password in the .env file, provide it as input when you run the bootstrap script
A * indicates mandatory fields.

EXCS Parameters

Parameter Name	Description
EXCS_VM_HOST *	IP Address of VM machine where CS will be deployed
EXCS_PORT *	Config Sync Service port
EXCS_TAG *	Config Sync Service Image Version
EXCS_CONFIG_DB_HOST *	IP Address of Config Database.
EXCS_CONFIG_DB_PORT *	Port Number of Config Database
EXCS_CONFIG_DB_USER *	Config Database Username
EXCS_CONFIG_DB_PASSWORD *	Do not configure the password in the .env file, provide it as input when you run the bootstrap script
EXCS_CONFIG_DB_NAME *	Config Database name
EXCS_CONFIG_DB_TYPE *	Config Database Type
EXCS_SYNC_CUSTOMER_OBJECTS_ONLY	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	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	File system path for logs. If not provided, logs will be directed to stdout
EXCS_LOG_FILENAME *	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	Defines the EXCS log level. Values: trace, debug, info, warn, error, fatal
A * indicates mandatory fields.

EXAS Parameters

Parameter Name	Description
EXAS_HOST *	IP Address of VM machine where AS will be deployed
EXAS_PORT *	Agent Sync Service port
EXAS_TAG *	Agent Sync Service Image Version.
EXAS_STAT_SERVER_PRIMARY_HOST *	Primary Stat Server's host IP/FQDN
EXAS_STAT_SERVER_PRIMARY_PORT *	Primary Stat Server's port number.
EXAS_STAT_SERVER_BACKUP_HOST *	Backup Stat Server's host IP/FQDN
EXAS_STAT_SERVER_BACKUP_PORT *	Backup Stat Server's port number.
EXAS_LOG_PATH	File system path for logs. If not provided, logs will be directed to stdout
EXAS_LOG_FILENAME *	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	Defines the EXAS log level. Values: trace, debug, info, warn, error, fatal
A * indicates mandatory fields.

EXCP Parameters

Parameter Name	Description
EXCP_1_VM_HOST_PAIR *	VM Host IPAddress list where Conversation Provider service will be running
EXCP_1_PORT *	Conversation Provider Service port
EXCP_1_TAG *	Conversation Provider Container version
EXCP_1_VOICE_SERVER_VQ *	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 *	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 *	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	File system path for logs. If not provided, logs will be directed to stdout
EXCP_1_LOG_FILE_NAME *	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	Defines the EXCP log level. Values: trace, debug, info, warn, error, fatal
A * indicates mandatory fields.