List of Environment Variables
Deployment Configuration via Environment Variables
The values of the following variables are stored in a single GitLab environment variable of type file.
Settings in web reflectivity can be set using the following environment variables.
NOTE: entries deemed as secrets are in bold.
APP
VAR |
SERVICE |
DESCRIPTION |
---|---|---|
DJANGO_SETTINGS_MODULE |
web |
Controls which settings environment to use (prod, envtest, unittest) |
DJANGO_SUPERUSER_USERNAME |
web |
|
DJANGO_SUPERUSER_PASSWORD |
web |
|
DJANGO_SUPERUSER_EMAIL |
web |
|
APP_SECRET |
web |
|
WEBREF_IP_ADDRESS |
web |
IP address of service web as seen from worker JOB_HANDLING_HOST |
DATABASE
VAR |
SERVICE |
DESCRIPTION |
---|---|---|
DATABASE_NAME |
db, web |
Name of the Postgres database |
DATABASE_USER |
db, web |
Owner of the database |
DATABASE_PASS |
db, web |
|
DATABASE_HOST |
db, web |
|
DATABASE_PORT |
db, web |
LIVE DATA SERVER
VAR |
SERVICE |
DESCRIPTION |
---|---|---|
LIVE_DATA_SERVER |
web |
URL template for retrieving data from remote server |
LIVE_DATA_SERVER_DOMAIN |
web |
|
LIVE_DATA_SERVER_PORT |
web |
|
LIVE_PLOT_SECRET_KEY |
web |
|
LIVE_DATA_API_USER |
web |
|
LIVE_DATA_API_PWD |
web |
|
LIVE_DATA_USER_UPLOAD_URL |
web |
URL template for uploading plots to remote data server |
LIVE_DATA_USER_FILES_URL |
web |
URL template for retrieving list of user files |
CELERY
VAR |
SERVICE |
DESCRIPTION |
---|---|---|
C_FORCE_ROOT |
web |
When true Celery workers will run as root |
CELERY_LOG_LEVEL |
web |
More details about the Celery configuration and how it is started can be found here.
REMOTE WORKER
VAR |
SERVICE |
DESCRIPTION |
---|---|---|
REFL1D_JOB_DIR |
web |
Absolute path for job output. |
JOB_HANDLING_HOST |
web |
Hostname used for launching remote jobs. Can be localhost for local environments. |
JOB_HANDLING_PORT |
web |
Port to connect on remote host. |
JOB_HANDLING_INTERPRETER |
web |
Python interpreter to use for jobs submitted to JOB_HANDLING_HOST (e.g. python3) |
LDAP
VAR |
SERVICE |
DESCRIPTION |
---|---|---|
LDAP_SERVER_URI |
web |
|
LDAP_DOMAIN_COMPONENT |
web |
|
LDAP_CERT_FILE |
web |
Path to CA certificate file |
ICAT
VAR |
SERVICE |
DESCRIPTION |
---|---|---|
ICAT_DOMAIN |
web |
|
ICAT_PORT |
web |
|
CATALOG_URL |
web |
ONCat URL |
CATALOG_ID |
web |
|
CATALOG_SECRET |
web |
(This page was reprocuded from https://code.ornl.gov/sns-hfir-scse/deployments/web-reflectivity-deploy/-/blob/main/docs/env.md)