Gateway Configuration

Environment file

Docker Compose loads ./.env from the same directory as the Compose file (for this repo, typically docker/.env).

The package/env_setup.sh script can create or update .env and is intended to run on the host before starting containers. It:

Sets HOST_IP to the host’s primary IP (used by scripts and Django for gateway proxy binding).
Generates DJANGO_SECRET_KEY and mirrors it to SECRET_KEY if missing (Django reads SECRET_KEY from the environment in server/app/settings.py).
Sets default superuser-related keys if absent: DJANGO_SUPERUSER_USERNAME (default admin), DJANGO_SUPERUSER_EMAIL, DJANGO_SUPERUSER_PASSWORD (random if not set).

Important variables

Variable	Purpose
`SECRET_KEY`	Django secret key; required by the application.
`HOST_IP`	Host IP used when starting the main gateway `vxg-proxy-client` and referenced in restart/health paths.
`DJANGO_SUPERUSER_USERNAME`	Admin username for the Django superuser (often `admin`).
`DJANGO_SUPERUSER_PASSWORD`	Password for that superuser (used for web login and API token requests).

Security: Restrict permissions on .env (for example chmod 600). Do not commit real secrets.

Default credentials

Documentation and legacy behavior often refer to username admin and password admin. Your actual password may be auto-generated by env_setup.sh if DJANGO_SUPERUSER_PASSWORD was not set explicitly — check docker/.env on the deployed host.

Use the auth token endpoint with the configured username and password to obtain an API token.

Django settings (reference)

DEBUG: False in server/app/settings.py.
ALLOWED_HOSTS: ['*'] — tighten for production if you use a known hostname.
Database: SQLite at server/db.sqlite3 inside the app container (/code/server/db.sqlite3).
Static files: STATIC_ROOT=/vol/static (shared with nginx).

Nginx

The nginx container uses default.conf.tpl processed with envsubst. Defaults: APP_HOST=app, APP_PORT=8000, LISTEN_PORT=80. Override via container environment if you customize the stack.