env.example

# ================================
# REQUIRED ENVIRONMENT VARIABLES
# ================================

# [REQUIRED]: PostgreSQL connection string for the PortalApp database used by the auth server.
#   - Example: "postgresql://username:password@localhost:5432/dbname"
POSTGRES_CONNECTION_STRING=

# [REQUIRED]: GCP project ID for the data warehouse used by the rate limit store.
#   - Example: "your-project-id"
GCP_PROJECT_ID=

# ================================
# OPTIONAL ENVIRONMENT VARIABLES
# ================================

# [OPTIONAL]: Port to run the external auth server on.
#   - Default: 10001 if not set
PORT=10001

# [OPTIONAL]: Port to run the Prometheus metrics server on.
#   - Default: 9090 if not set
METRICS_PORT=9090

# [OPTIONAL]: Port to run the pprof server on.
#   - Default: 6060 if not set
PPROF_PORT=6060

# [OPTIONAL]: Log level for the external auth server.
#   - Default: "info" if not set
#   - Options: "debug", "info", "warn", "error"
LOGGER_LEVEL=info

# [OPTIONAL]: Image tag/version for the application.
#   - Default: "development" if not set
#   - Used in /healthz endpoint response
IMAGE_TAG=development

# [OPTIONAL]: Refresh interval for the portal app store.
#   - Default: 30s if not set
#   - Examples: "30s", "1m", "2m30s"
PORTAL_APP_STORE_REFRESH_INTERVAL=30s

# [OPTIONAL]: Refresh interval for the rate limit store.
#   - Default: 5m if not set
#   - Examples: "30s", "1m", "2m30s"
RATE_LIMIT_STORE_REFRESH_INTERVAL=5m