Environment Variables
Overview #
All of the available environment variables are filled with default values, so Demyx can get started right away. If you want to modify any of these, then please run demyx host edit
where it will automatically restart the Demyx container after editing the values.
# DEMYX HOST CONFIG - AUTO GENERATED
# HTTP AUTH
DEMYX_AUTH_USERNAME=<auto generated>
DEMYX_AUTH_PASSWORD=<auto generated>
# BACKUP
DEMYX_BACKUP_ENABLE=true
DEMYX_BACKUP_LIMIT=7
# CODE-SERVER
DEMYX_CODE_DOMAIN=code
DEMYX_CODE_ENABLE=false
DEMYX_CODE_PASSWORD=<auto generated>
DEMYX_CODE_SSL=false
# CONTAINER CPU/MEM
DEMYX_CPU=.50
DEMYX_MEM=256m
# LOGROTATE
DEMYX_LOGROTATE=daily
DEMYX_LOGROTATE_INTERVAL=7
DEMYX_LOGROTATE_SIZE=10M
# HEALTHCHECK
DEMYX_HEALTHCHECK=true
DEMYX_HEALTHCHECK_DISK=/demyx
DEMYX_HEALTHCHECK_DISK_THRESHOLD=80
DEMYX_HEALTHCHECK_LOAD=10
# MATRIX
DEMYX_MATRIX=false
DEMYX_MATRIX_KEY=false
DEMYX_MATRIX_URL=false
# SMTP
DEMYX_SMTP=false
DEMYX_SMTP_HOST=false
DEMYX_SMTP_FROM=false
DEMYX_SMTP_PASSWORD=false
DEMYX_SMTP_USERNAME=false
DEMYX_SMTP_TO=false
# TRAEFIK
DEMYX_TRAEFIK_DASHBOARD=false
DEMYX_TRAEFIK_DASHBOARD_DOMAIN=traefik
DEMYX_TRAEFIK_LOG=INFO
DEMYX_TRAEFIK_SSL=false
# MISC
DEMYX_CF_KEY=false
DEMYX_DOMAIN=localhost
DEMYX_EMAIL=info@localhost
DEMYX_IMAGE_VERSION=latest
DEMYX_IP=false
DEMYX_HOSTNAME=demo
DEMYX_TELEMETRY=true
DEMYX_TZ=America/Los_Angeles
HTTP Auth #
Credentials are used for code-server and Traefik’s dashboard. Requires DEMYX_DOMAIN
.
Environment Variable | Value |
---|---|
DEMYX_AUTH_USERNAME | Auto generated |
DEMYX_AUTH_USERNAME | Auto generated |
Backup #
Environment Variable | Value |
---|---|
DEMYX_BACKUP_ENABLE | true | false |
DEMYX_BACKUP_LIMIT | 7 |
Code-server #
To properly configure code-server, DEMYX_DOMAIN
has to be set. Code-server is accessible only through subdomain; so when DEMYX_DOMAIN
is set, code-server can be accessible with the url http://code.your-domain.tld
.
Environment Variable | Value |
---|---|
DEMYX_CODE_DOMAIN | code |
DEMYX_CODE_ENABLE | true | false |
DEMYX_CODE_PASSWORD | Auto generated |
DEMYX_CODE_SSL | true | false (Requires DEMYX_EMAIL ) |
Logrotate #
Environment Variable | Value |
---|---|
DEMYX_LOGROTATE | daily | weekly | monthly | yearly |
DEMYX_LOGROTATE_INTERVAL | 7 |
DEMYX_LOGROTATE_SIZE | 10M |
Healthcheck #
Requires DEMYX_MATRIX
and/or DEMYX_SMTP
to be configured.
Environment Variable | Value |
---|---|
DEMYX_HEALTHCHECK | true | false |
DEMYX_HEALTHCHECK_DISK | /demyx |
DEMYX_HEALTHCHECK_DISK_THRESHOLD | 80 (Gets the Use% value from df -h ) |
DEMYX_HEALTHCHECK_LOAD | 10 (Compares the 5 minute load average from /proc/loadavg ) |
Matrix #
Third party notification feature using third party image nim65s/matrix-webhook. Requires matrix to be already running.
Environment Variable | Value |
---|---|
DEMYX_MATRIX | true | false |
DEMYX_MATRIX_KEY | false |
DEMYX_MATRIX_URL | false |
SMTP #
Demyx now includes the package ssmtp
to send out simple email notifications. Use any of your favorite third party relays to use this feature. Only port 587 is allowed and do not include port number in DEMYX_SMTP_HOST
.
Environment Variable | Value |
---|---|
DEMYX_SMTP | true | false |
DEMYX_SMTP_HOST | false |
DEMYX_SMTP_FROM | false |
DEMYX_SMTP_PASSWORD | false |
DEMYX_SMTP_USERNAME | false |
DEMYX_SMTP_TO | false |
Traefik #
To properly configure Traefik’s dashboard, DEMYX_DOMAIN
has to be set. Traefik’s dashboard is accessible only through subdomain; so when DEMYX_DOMAIN
is set, it can be accessible with the url http://traefik.your-domain.tld
.
Environment Variable | Value |
---|---|
DEMYX_TRAEFIK_DASHBOARD | true | false |
DEMYX_TRAEFIK_DASHBOARD_DOMAIN | traefik (Do not include the TLD) |
DEMYX_TRAEFIK_LOG | INFO (More info at Traefik) |
DEMYX_TRAEFIK_SSL | true | false (Requires DEMYX_EMAIL ) |
Miscellaneous #
Telemetry only grabs the server IP and the value of DEMYX_VERSION
.
Environment Variable | Value |
---|---|
DEMYX_CF_KEY | false (Requires API Token with proper permission) |
DEMYX_DOMAIN | localhost |
DEMYX_EMAIL | info@localhost |
DEMYX_IMAGE_VERSION | latest |
DEMYX_IP | false (IP whitelisting purposes, CSV is accepted) |
DEMYX_HOSTNAME | Auto generated |
DEMYX_TELEMETRY | true | false |
DEMYX_TZ | America/Los_Angeles |