superplane/.env.example at main · superplanehq/superplane · 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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
# Local development overrides.
#
# Copy this file to `.env` and uncomment only the values you want to override.
# Docker Compose automatically reads `.env` in the repo root for variable
# interpolation. It is not a generic env_file, so variables only affect the app
# container when docker-compose.dev.yml explicitly references them.

## Public web/API entrypoint
##
## If you change PUBLIC_API_PORT, keep BASE_URL, WEBHOOKS_BASE_URL, and
## ALLOWED_WS_ORIGINS aligned unless you intentionally need different origins.
# PUBLIC_API_PORT=8000
# BASE_URL=http://localhost:8000
# WEBHOOKS_BASE_URL=http://localhost:8000
# ALLOWED_WS_ORIGINS=http://localhost:8000

## App-facing ports
##
## PORT and API_PORT default to PUBLIC_API_PORT. Only set them directly when
## the app server and Vite proxy need to diverge from PUBLIC_API_PORT.
# PORT=8000
# API_PORT=8000
# VITE_DEV_PORT=5173
# VITE_PREVIEW_PORT=4173
# STORYBOOK_PORT=6006

## Supporting service host ports
# PGWEB_PORT=8081
# RABBITMQ_PORT=5672
# RABBITMQ_MANAGEMENT_PORT=15672
# OTEL_GRPC_PORT=4317
# OTEL_HTTP_PORT=4318

## Performance profiling (Go pprof)
##
## When PPROF_ENABLED=yes the dev server exposes net/http/pprof endpoints at
## http://localhost:${PPROF_PORT}/debug/pprof/ for CPU, heap, goroutine, block,
## and mutex profiles. Defaults to on in the dev compose file; set to anything
## other than "yes" to disable. The endpoint is unauthenticated, so keep it off
## outside local development. See docs/contributing/profiling.md.
# PPROF_ENABLED=yes
# PPROF_PORT=6060

## Database timeout overrides
##
## Values can be Go durations such as 60s/2m or integer milliseconds.
# DB_STATEMENT_TIMEOUT=60s
# DB_IDLE_IN_TRANSACTION_SESSION_TIMEOUT=30s

## Telemetry and frontend feature flags
# SENTRY_ENVIRONMENT=development
# POSTHOG_KEY=
# DASH0_WEB_OTLP_ENDPOINT=
# DASH0_WEB_AUTH_TOKEN=
# DASH0_WEB_SERVICE_NAME=superplane-web
# DASH0_WEB_ENVIRONMENT=
# VITE_FORCE_USAGE_PAGE=true

## Email and signup
##
## Email consumers are skipped unless RESEND_API_KEY and sender values are set.
# RESEND_API_KEY=
# EMAIL_FROM_NAME=SuperPlane
# EMAIL_FROM_ADDRESS=noreply@notifications.superplane.com
# BLOCK_SIGNUP=yes
# SIGNUP_WAITLIST_MAILERLITE_ACCOUNT_ID=
# SIGNUP_WAITLIST_MAILERLITE_FORM_ID=

## Anthropic managed agents
##
## All three values are required for the agent provider to be enabled.
## The agent UI is gated by the claude_managed_agents experimental feature.
# ANTHROPIC_API_KEY=
# ANTHROPIC_AGENT_ID=
# ANTHROPIC_ENVIRONMENT_ID=

## Runner task broker
##
## Required together when Runner components should use an external broker.
# TASK_BROKER_BASE_URL=
# TASK_BROKER_FLEET_ID=
# TASK_BROKER_AUTH_TOKEN=

## Usage service
# USAGE_GRPC_URL=

## scripts/wait-for-app
##
## make dev.server sources `.env` through scripts/wait-for-app after starting
## the dev server, so these helper values can live here too.
# WAIT_FOR_APP_HOST=localhost
# WAIT_FOR_APP_TIMEOUT_SECONDS=60
# WAIT_FOR_APP_INTERVAL_SECONDS=2