Skip to content

Environment Variables

Jacob McSwain edited this page Dec 14, 2023 · 1 revision
Name Default Description
HTTP_PORT 3333 The port to run the HTTP API and frontend from. If you're using the Docker container DO NOT change this
CORS_HOSTS http://localhost:$HTTP_PORT,http://127.0.0.1:$HTTP_PORT Set to a comma-separated list of URLs you expect the app to be accessed at, including the protocol and the port if not 80/443. Used for CORS and websocket Origin validation
TRUSTED_PROXIES unset Set to a comma-separated list of proxy IPs that are allowed to proxy traffic to this app
METRICS_PORT unset Set to a port to enable Prometheus metrics to be exposed
OTLP_ENDPOINT unset Set to an OTLP (OpenTracing) endpoint for instrumentation and tracing
DEBUG unset Set to any value to enable verbose logging and debug mode
PID_FILE /var/run/aredn-manager.pid Set to the location of the PID file. If you're using the Docker container DO NOT change this
NO_DAEMON unset Set to any value to prevent the app from daemonizing itself. If you're using the Docker container DO NOT change this
PASSWORD_SALT salt The password salt. It is recommended to generate a 15+ character random password different from the SESSION_SECRET
INIT_ADMIN_USER_PASSWORD randomly generated If set on the first startup, this seeds the database with the password for the initial Admin user
HIBP_API_KEY unset Set to a HIBP API key to keep bad passwords away
SERVER_NAME unset Set to the desired hostname of the node
MASQUERADE unset Set to enable a masquerade rule for tunnels
VTUN_STARTING_ADDRESS 172.31.180.12 The starting address for VTun peers
NODE_IP unset The in-mesh IP the node should assume
SUPERNODE unset Set to any value to run in supernode mode.
SUPERNODE_ZONE unset Set to the local mesh name, currently unused
SESSION_SECRET unset The session encryption secret. Recommended to generate a 15+ character random password different from the PASSWORD_SALT
PG_USER postgres The PostgreSQL user to authenticate as
PG_PASSWORD password The password of the PostgreSQL user
PG_HOST localhost The PostgreSQL server hostname
PG_PORT 5432 The PostgreSQL server port
PG_DATABASE postgres The PostgreSQL database to use
SERVER_LAT unset The latitude of the server
SERVER_LON unset The longitude of the server
SERVER_GRIDSQUARE unset The HAM gridsquare of the server
METRICS_NODE_EXPORTER_HOST node-exporter The host at which the node exporter can be reached. This is for compatibility with upstream AREDN metrics
Clone this wiki locally