platform/env.example at main · TrigpointingUK/platform · 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
# Database Configuration (PostgreSQL)
DATABASE_URL=postgresql+psycopg2://username:password@localhost:5432/database_name

# Application Configuration
API_V1_STR=/api/v1
PROJECT_NAME=TrigpointingUK API
DEBUG=false
ENVIRONMENT=development
FASTAPI_URL=http://localhost:8000
# Profiling Configuration (development and staging only)
PROFILING_ENABLED=false
PROFILING_DEFAULT_FORMAT=html

# OpenTelemetry Configuration (for distributed tracing and metrics)
OTEL_ENABLED=false
OTEL_METRICS_ENABLED=false
OTEL_EXPORTER_OTLP_ENDPOINT=https://otlp-gateway-prod.grafana.net/otlp
OTEL_EXPORTER_OTLP_HEADERS=Authorization=Basic <base64-encoded-token>

# Pyroscope Configuration (for continuous profiling)
PYROSCOPE_ENABLED=false
PYROSCOPE_SERVER_ADDRESS=https://profiles-prod.grafana.net
PYROSCOPE_AUTH_TOKEN=<pyroscope-token>
# AWS X-Ray
XRAY_ENABLED=false
XRAY_SERVICE_NAME=trigpointing-api-staging
# If running with the X-Ray daemon sidecar on ECS/Fargate, leave default
# Otherwise set host:port such as 127.0.0.1:2000
XRAY_DAEMON_ADDRESS=127.0.0.1:2000
# Sampling rate is controlled by rules, but enabling sampling here toggles it on/off
# Keep existing numeric variable for backwards compat if present; code uses boolean
XRAY_SAMPLING_RATE=0.1

# CORS Configuration
BACKEND_CORS_ORIGINS=["http://localhost:3000", "http://localhost:8080"]

# Auth0 Configuration
# CUSTOM_DOMAIN: User-facing branded domain (e.g., auth.trigpointing.me)
# TENANT_DOMAIN: Auth0 tenant domain for Management API (e.g., your-tenant.eu.auth0.com)
AUTH0_CUSTOM_DOMAIN=auth.your-domain.com
AUTH0_TENANT_DOMAIN=your-tenant.eu.auth0.com
AUTH0_SECRET_NAME=your-auth0-secret-name
AUTH0_CONNECTION=Username-Password-Authentication

# Auth0 Client IDs and Secrets
# SPA_CLIENT_ID: For Swagger OAuth2 (PKCE flow)
# M2M_CLIENT_ID: For Management API and webhook validation
AUTH0_SPA_CLIENT_ID=your-spa-client-id
AUTH0_M2M_CLIENT_ID=your-m2m-client-id
AUTH0_M2M_CLIENT_SECRET=your-m2m-client-secret

# Auth0 API Audience
# This is your API identifier - used for both:
# - Validating tokens from your API clients (users)
# - Validating M2M tokens from Auth0 Actions (webhooks)
AUTH0_API_AUDIENCE=https://your-api-domain.com/

# Redis/ElastiCache Configuration
# Optional: Redis for Auth0 Management API token caching and API response caching
# Leave empty to use in-memory cache only (for local development)
# In production/staging, this is automatically set via Terraform
# REDIS_URL=redis://localhost:6379
# CACHE_ENABLED=true  # Set to false to disable all caching globally