Skip to content

Configuration

Axium is configured entirely through environment variables. The images carry no configuration files and no .env; what you pass to the container is the whole configuration.

  • Environment variables

    Every variable the core reads, with defaults, validation rules and what happens when a value is missing or invalid.

    Reference

  • Database

    Connection string, supported versions, schemas, pool sizes and the automatic schema installation and migration.

    Database

  • License

    How the license is loaded, validated and renewed.

    License

  • Reverse proxy & TLS

    TRUST_PROXY, PUBLIC_BASE_URL and example configurations for nginx, Caddy and Traefik.

    Reverse proxy

  • Web console (ui)

    The one variable the ui needs and the mistakes everyone makes with it.

    Ui

  • Security

    Encryption at rest, credentials, sessions, API keys, CORS and what to lock down at the ingress.

    Security

DATABASE_URL=postgresql://axium:secret@db:5432/axium-api
MASTER_ENCRYPTION_KEY=<64 hex>

DATABASE_URL=postgresql://axium:secret@db:5432/axium-api
MASTER_ENCRYPTION_KEY=<64 hex>
AXIUM_LICENSE=<40 hex>

# Behind a TLS-terminating proxy or load balancer
TRUST_PROXY=true
PUBLIC_BASE_URL=https://axium-api.your-domain.com

# Record every request
OBSERVABILITY_TYPE=postgres
OBSERVABILITY_DB_POSTGRESQL=postgresql://axium:secret@db:5432/axium-api

# Optional
LOG_REQUESTS=true
MAX_UPLOAD_SIZE=50mb