maturity-tool/.env.example at main · DPGAlliance/maturity-tool · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
# Example environment configuration (copy to .env and edit as needed)
#
# This repo supports two ways to provide secrets:
# 1) Plain env vars (good for local dev): API_KEY, GITHUB_TOKEN, OPENAI_API_KEY
# 2) Docker secrets files (recommended for servers): *_FILE
#    Docker Compose mounts files from ./secrets/* into /run/secrets/* and the app reads them.
#
# Mapping (Docker Compose):
# - secrets/postgres_password -> DB_PASSWORD_FILE=/run/secrets/postgres_password
# - secrets/api_key           -> API_KEY_FILE=/run/secrets/api_key
# - secrets/github_token      -> GITHUB_TOKEN_FILE=/run/secrets/github_token
# - secrets/openai_api_key    -> OPENAI_API_KEY_FILE=/run/secrets/openai_api_key (only needed for summarize jobs)
#
# See secrets/README.md

# --- Postgres (Docker Compose) ---
POSTGRES_DB=maturity
POSTGRES_USER=maturity
# In Docker Compose, keep the password in secrets/postgres_password instead.
# App containers receive DB_HOST/DB_PORT/DB_NAME/DB_USER/DB_PASSWORD_FILE automatically from docker-compose.yml.
# For non-Docker runs, export DB_HOST, DB_PORT, DB_NAME, DB_USER, and DB_PASSWORD (or DB_PASSWORD_FILE).

# --- API ---
# For local (non-Docker) runs of the API/scripts, you can set API_KEY directly.
# In Docker Compose, prefer secrets/api_key + API_KEY_FILE.
# API_KEY_FILE=/run/secrets/api_key

# --- GitHub ---
# For local (non-Docker) runs of the viewer/scripts, you can set GITHUB_TOKEN directly.
# In Docker Compose, prefer secrets/github_token + GITHUB_TOKEN_FILE.
# GITHUB_TOKEN_FILE=/run/secrets/github_token

# --- Refresh scheduler (optional compose profile) ---
# Recommended for servers: start the scheduler profile so cache and summaries populate. Not using the profile is mostly for debugging.
# Owners/orgs to refresh, comma-separated (owner1, owner2, ...)
# If unset, refresh_scheduler falls back to DISTINGUISHED_OWNERS list.
REFRESH_OWNERS=

# Optional: limit to a single repo name (NOT owner/repo)
# REFRESH_REPO=DIGIT-OSS

# Run interval in days (default is 7 if unset)
REFRESH_INTERVAL_DAYS=7

# Optional seconds override (mainly for testing)
# REFRESH_INTERVAL_SECONDS=60

# Force refresh even if cache is fresh
FORCE_REFRESH=false

# After each refresh cycle, run summaries (requires API_KEY + OPENAI_API_KEY) SHOULD BE TRUE by default.
RUN_SUMMARIES=true

# In Docker Compose, the API is reachable from the scheduler container at http://api:8000
SUMMARY_BASE_URL=http://api:8000

# Optional summary tuning
# SUMMARY_MODEL=gpt-4o-mini
# SUMMARY_HISTORY=5
# SUMMARY_MAX_AGE_DAYS=30
# SUMMARY_FORCE=false
# SUMMARY_NO_STORE=false

# --- Summaries (optional job) ---
# Required if you run scripts/summarize.py (or if RUN_SUMMARIES=true in the refresh scheduler)
# OPENAI_API_KEY_FILE=/run/secrets/openai_api_key