.env.example

# PG Atlas Backend — environment variable template.
# Copy this file to .env and fill in values for local development.
# Never commit .env to version control.
#
# All variables are prefixed with PG_ATLAS_.

# ---------------------------------------------------------------------------
# Required
# ---------------------------------------------------------------------------

# Canonical URL of this API instance. Used as the OIDC audience when verifying
# GitHub OIDC tokens submitted by the pg-atlas-sbom-action.
# For local development use http://localhost:8000; for production use the public URL.
PG_ATLAS_API_URL=http://localhost:8000

# ---------------------------------------------------------------------------
# Required for database write path
# ---------------------------------------------------------------------------

# Async SQLAlchemy connection URL (asyncpg driver).
# For docker-compose local dev: change `changeme` to match PG_ATLAS_POSTGRES_PASSWORD.
# Note the local dev superuser is 'atlas' (postgres:18 disallows 'pg_'-prefixed names).
PG_ATLAS_DATABASE_URL=postgresql://atlas:changeme@localhost:5432/pg_atlas

# Filesystem path where raw SBOM bytes are written (local dev / host side).
# The docker-compose api container mounts ./artifact_store to /data/artifacts;
# inside the container set this to /data/artifacts.
PG_ATLAS_ARTIFACT_STORE_PATH=./artifact_store

# ---------------------------------------------------------------------------
# Optional
# ---------------------------------------------------------------------------

# OpenGrants API key for increased rate limits
# PG_ATLAS_OPENGRANTS_KEY=a0929b...8d3775

# Python logging level: DEBUG | INFO | WARNING | ERROR  (default: INFO)
# PG_ATLAS_LOG_LEVEL=INFO

# Seconds to cache GitHub's JWKS response (default: 3600)
# PG_ATLAS_JWKS_CACHE_TTL_SECONDS=3600

# ---------------------------------------------------------------------------
# docker-compose helpers (consumed by docker-compose.yml, not by the app)
# ---------------------------------------------------------------------------

# PostgreSQL password for the atlas user on the local postgres:18 container.
# Must match the password in PG_ATLAS_DATABASE_URL above.
PG_ATLAS_POSTGRES_PASSWORD=changeme