StatusDashboard-Backend/.env.example at main · stackmon/StatusDashboard-Backend · 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 for environment variables
SD_DB=postgresql://pg:pass@localhost:5432/status_dashboard
SD_CACHE=internal
SD_LOG_LEVEL=devel
SD_PORT=8000

# OIDC resource server (Zitadel). The issuer must expose
# /.well-known/openid-configuration; ClientID is the audience every accepted
# token must be issued to.
SD_OIDC_ISSUER=https://zitadel.example.com
SD_OIDC_CLIENT_ID=your-zitadel-project-id
# Optional: claim to use as the display user name. Zitadel access tokens do not
# carry preferred_username unless it is added by an action.
# SD_OIDC_USERNAME_CLAIM=preferred_username

# RBAC roles, matched against the role names carried by the roles claim.
# SD_RBAC_ROLES_ADMINS is mandatory.
SD_RBAC_ROLES_CREATORS=sd_creators
SD_RBAC_ROLES_OPERATORS=sd_operators
SD_RBAC_ROLES_ADMINS=sd_admins
# Optional: machine principals that may only create system incidents.
# SD_RBAC_ROLES_REPORTERS=sd_reporters

# Static site proxy. Comma-separated OBS website endpoints that serve the status
# dashboard, primary first, host only: no scheme, no path. Unknown paths are
# proxied to them; leaving the list empty keeps the plain 404 for those paths.
# SD_STATIC_ORIGINS=status-dashboard-test.obs-website.eu-de.otc.t-systems.com
# Lifetime of a cached response that carries no Cache-Control, and the byte
# budget of the whole response cache.
# SD_STATIC_CACHE_TTL=5m
# SD_STATIC_CACHE_MAX_BYTES=67108864

# Maintenance email notifications (see docs/notifications.md). Off by default;
# when enabled, SD_SMTP_HOST/PORT/FROM and at least one review recipient are
# required.
# SD_NOTIFICATIONS_ENABLED=false

# SMTP transport (required when notifications are enabled)
# SD_SMTP_HOST=smtp.otc.example.com
# SD_SMTP_PORT=587
# SD_SMTP_FROM=status-dashboard@otc.example.com
# SD_SMTP_USER=sd-mailer
# SD_SMTP_PASSWORD=changeme
# SD_SMTP_TLS=false
# SD_SMTP_TIMEOUT=30s

# Delivery tuning
# SD_NOTIFICATIONS_LEASE_TIMEOUT=60s
# SD_NOTIFICATIONS_MAX_ATTEMPTS=5
# SD_NOTIFICATIONS_BACKOFF_INTERVAL=5m

# Review audience (at least one required when enabled)
# SD_NOTIFICATIONS_SMOD_EMAIL=smod@otc.example.com
# SD_NOTIFICATIONS_EMAILS_OPERATORS=ops1@otc.example.com,ops2@otc.example.com
# SD_NOTIFICATIONS_EMAILS_ADMINS=admin@otc.example.com

# Optional: restrict creator contact_email to these domains (empty = any domain)
# SD_NOTIFICATIONS_ALLOWED_DOMAINS=otc.example.com
# Optional: addresses that never receive notifications
# SD_NOTIFICATIONS_EXCLUDED_EMAILS=bot@otc.example.com

# Web origin for maintenance deep links in emails
# SD_WEB_URL=https://status.otc.example.com

# Dedicated /metrics port (only started when notifications are enabled)
# SD_METRICS_PORT=9090