Skip to content

Configuration ​

All settings go in .env next to docker-compose.yml. After a change, run docker compose up -d to apply it.

Site name, contact link, colour, logo, favicon, timezone and data retention can also be changed in the panel under Settings; the panel value wins.

Install ​

VariableDefault
AEROSTAT_VERSIONlatestImage tag to run
AEROSTAT_BIND0.0.0.0Address the status page listens on. 127.0.0.1 behind a reverse proxy
AEROSTAT_PORT3000Port the status page listens on
NEXT_SERVER_ACTIONS_ENCRYPTION_KEYRequired. openssl rand -base64 32
TRUSTED_PROXY_HOPS1Only for proxies that add to X-Forwarded-For, see TRUSTED_PROXY_HOPS
RUST_LOGinfoBackend log level

Database ​

VariableDefault
DATABASE_URLRequired. Postgres connection string
DB_USER, DB_PASSWORD, DB_NAMEaerostat, change_me, aerostatThe Postgres that comes with AeroStat only
METRICS_RETENTION_DAYS60Days of check results to keep

Site defaults ​

VariableDefault
SITE_NAMEAeroStatDefault site name
CONTACT_URLDefault contact link
PRIMARY_COLOR#1678c2Default accent colour
UPDATE_CHECKtrueShow people who can view System when a newer release is out

Sign-in ​

VariableDefault
SECRET_KEYEncrypts authenticator app secrets. openssl rand -hex 32. Without it only email codes work
SESSION_DAYS30How long a panel sign-in lasts (max 365)
LOGIN_MAX_FAILURES_PER_IP10Failed sign-ins from one IP before a block. IPv6 addresses count per /64 block, since one connection gets a whole block
LOGIN_MAX_FAILURES_PER_ACCOUNT30Failed sign-ins on one account before new IPs are blocked; IPs that signed in to it in the last 90 days still get in
LOGIN_LOCKOUT_MINUTES15How long a block lasts

Email ​

See email notifications.

VariableDefault
SMTP_HOSTMail server. Empty turns email off
SMTP_PORT465 or 587Mail server port, follows SMTP_ENCRYPTION
SMTP_ENCRYPTIONstarttls, or tls on port 465tls, starttls or none
SMTP_USERNAMEMail server login
SMTP_PASSWORDMail server password. Never shown in the panel
SMTP_FROM_ADDRESSSMTP_USERNAMEAddress emails are sent from
SMTP_FROM_NAMESite nameName emails are sent from

Backups ​

VariableDefault
BACKUP_DIR/data/backupsWhere backups are stored
PG_DUMP_PATH, PG_RESTORE_PATH, PSQL_PATHpg_dump, pg_restore, psqlThe PostgreSQL tools, only needed outside Docker

Released under the MIT License.