Using the .env configuration file

Summary

The ODE application can be configured using shell environment variables. Users can either set these variables locally or edit them in the .env file located in the root jpo-ode directory.

Utilization

The following table list the environment variables used in Docker files and shell scripts to automate the deployment process and customize it for each deployment environment. Setting these environment variables will allow the deployment to take place without any modification to the default configuration files.

Notes:

• Variables set locally will override any variables set in the file
• The dot prefix on the .env filename will make it appear hidden on Unix operating systems. You can view hidden files using ls -la.
• Privacy note: take care when using source control as these variables contain sensitive information.

Environment Variable	Description
DOCKER_HOST_IP	(Required) The IP address of Docker host machine which can be found by running "ifconfig". Look for "inet addr:" within "eth0" or "en0" for OSX
DOCKER_SHARED_VOLUME	(Required) The full path of a directory on the host machine to be shared with docker containers.
ODE_DDS_CAS_USERNAME	The username for authenticating the USDOT Situation Data Warehouse WebSocket server
ODE_DDS_CAS_PASSWORD	The password for authenticating the USDOT Situation Data Warehouse WebSocket server
ODE_EXTERNAL_IPV4	The advertised IPv4 address of the server running ODE
ODE_EXTERNAL_IPV6	The advertised IPv6 address of the server running ODE
CVPEP_BSM_S3_ACCESS_KEY_ID	CVPEP BSM S3 depositor access key id
CVPEP_BSM_S3_SECRET_ACCESS_KEY	CVPEP BSM S3 depositor secret access key
CVPEP_BSM_S3_BUCKET_NAME	CVPEP BSM S3 depositor bucket name
CVPEP_BSM_S3_DEPOSIT_KEY	CVPEP BSM S3 filepath prefix
CVPEP_BSM_S3_TOPIC	CVPEP BSM S3 kafka subscription topic
RDE_BSM_S3_ACCESS_KEY_ID	RDE BSM S3 depositor access key id
RDE_BSM_S3_SECRET_ACCESS_KEY	RDE BSM S3 depositor secret access key
RDE_BSM_S3_BUCKET_NAME	RDE BSM S3 depositor bucket name
RDE_BSM_S3_DEPOSIT_KEY	RDE BSM S3 filepath prefix
RDE_BSM_S3_TOPIC	RDE BSM S3 kafka subscription topic
CVPEP_TIM_S3_ACCESS_KEY_ID	CVPEP TIM S3 depositor access key id
CVPEP_TIM_S3_SECRET_ACCESS_KEY	CVPEP TIM S3 depositor secret access key
CVPEP_TIM_S3_BUCKET_NAME	CVPEP TIM S3 depositor bucket name
CVPEP_TIM_S3_DEPOSIT_KEY	CVPEP TIM S3 filepath prefix
CVPEP_TIM_S3_TOPIC	CVPEP TIM S3 kafka subscription topic
RDE_TIM_S3_ACCESS_KEY_ID	RDE TIM S3 depositor access key id
RDE_TIM_S3_SECRET_ACCESS_KEY	RDE TIM S3 depositor secret access key
RDE_TIM_S3_BUCKET_NAME	RDE TIM S3 depositor bucket name
RDE_TIM_S3_DEPOSIT_KEY	RDE TIM S3 filepath prefix
RDE_TIM_S3_TOPIC	RDE TIM S3 kafka subscription topic
ODE_OUTPUT_SCHEMA_VERSION	Sets the schemaVersion desired for output messages.
SEC_CRYPTO_SERVICE_BASE_URI	Sets the URI for the crypto service, used by ode-security-svcs. This is the end-point that ode-security-svcs uses to perform cryptographic functions such as signing, signature verification, encrypting and decrypting
ODE_SECURITY_SVCS_SIGNATURE_URI	Sets the URI for ODE signature service. If set to UNSECURED data will not be signed.
ODE_RSU_USERNAME	Sets the default RSU username to be used. See here for more details.
ODE_RSU_PASSWORD	Sets the default RSU password to be used. See here for more details.