Skip to content

Environment Variables

Ops Atlas is configured through a .env file at the project root. Docker Compose reads these variables and passes them to the backend and frontend containers.

Complete Reference

Database

VariableDefaultDescription
POSTGRES_DBopsdashboardPostgreSQL database name
POSTGRES_USERpostgresPostgreSQL username
POSTGRES_PASSWORDPostgreSQL password
POSTGRES_PORT5432PostgreSQL port

Security

VariableDefaultDescription
JWT_SECRETRequired. Secret key for signing JWT tokens
ENCRYPTION_KEYRequired. Key for encrypting sensitive data at rest

DANGER

Both JWT_SECRET and ENCRYPTION_KEY are required and must be set before starting the application. Generate them with:

bash
openssl rand -base64 32

Never commit these values to version control.

Networking

VariableDefaultDescription
BACKEND_PORT8090Port the backend listens on
FRONTEND_PORT3000Port the frontend listens on
FRONTEND_URLPublic frontend URL (for reverse proxy setups)
BACKEND_URLPublic backend URL (for reverse proxy setups)
CORS_ALLOWED_ORIGINSComma-separated list of allowed CORS origins

TIP

FRONTEND_URL and BACKEND_URL are optional for simple deployments. Set them when running behind a reverse proxy (e.g., Nginx, Traefik) so that internal redirects and CORS resolve correctly.

Java Runtime

VariableDefaultDescription
JAVA_OPTS-Xms256m -Xmx512mJVM options passed to the Spring Boot backend

Docker Registry

VariableDefaultDescription
DOCKER_REGISTRY_URLDocker registry endpoint (e.g., registry.example.com)
DOCKER_REGISTRY_USERNAMERegistry authentication username
DOCKER_REGISTRY_PASSWORDRegistry authentication password

TIP

Registry variables are optional. If not set, registry features will prompt for configuration through the Settings UI.

Licensing

VariableDefaultDescription
LICENSE_EDITIONCOMMUNITYActive edition: COMMUNITY, PRO, or ENTERPRISE
LICENSE_PUBLIC_KEYPublic key for license validation (optional)

Enterprise

VariableDefaultDescription
TRIVY_PATHPath to the Trivy binary for vulnerability scanning
TRIVY_TIMEOUT300Timeout in seconds for Trivy scans
BACKUP_DIRECTORY/app/backupsDirectory where backups are stored

WARNING

Enterprise variables only take effect when running with an Enterprise license. SSO/OIDC configuration is managed through the Settings UI and stored in the database rather than environment variables.

Example .env File

bash
# Database
POSTGRES_DB=opsdashboard
POSTGRES_USER=postgres
POSTGRES_PASSWORD=changeme
POSTGRES_PORT=5432

# Security (generate with: openssl rand -base64 32)
JWT_SECRET=your-jwt-secret-here
ENCRYPTION_KEY=your-encryption-key-here

# Ports
BACKEND_PORT=8090
FRONTEND_PORT=3000

# URLs (set for reverse proxy)
# FRONTEND_URL=https://ops.example.com
# BACKEND_URL=https://api.ops.example.com
# CORS_ALLOWED_ORIGINS=https://ops.example.com

# JVM
JAVA_OPTS=-Xms256m -Xmx512m

# Docker Registry (optional)
# DOCKER_REGISTRY_URL=registry.example.com
# DOCKER_REGISTRY_USERNAME=admin
# DOCKER_REGISTRY_PASSWORD=secret

# License
LICENSE_EDITION=COMMUNITY

Released under the MIT License.