.env.example

# Local development configuration. Copy to .env and fill in. The sidecar
# loads it at boot (real environment variables win), and docker compose
# interpolates it into compose.yaml for both containers. Never commit .env.

# --- sidecar ---------------------------------------------------------------
# Host `make run` only; compose.yaml pins /data/sidecar.db for the container.
SIDECAR_DB=./sidecar.db
# Default OneBusAway REST API key (regions without their own key inherit it).
SIDECAR_OBA_API_KEY=
# Pirate Weather key; without it the weather endpoint returns 403.
SIDECAR_PIRATE_WEATHER_KEY=
# Host `make run` talks to the compose-exposed gorush port; compose.yaml
# pins http://gorush:8088 for the containerised sidecar instead. With this
# set but no gorush running, every due alarm logs a failed send each
# scheduler cycle (and is retried) -- leave it empty if you are not working
# on push.
SIDECAR_GORUSH_URL=http://localhost:8088
# Shared secret gorush sends on the feedback webhook. Generate with
# `openssl rand -hex 32`. Must contain no ':' or whitespace -- gorush splits
# header entries on ':'.
SIDECAR_GORUSH_WEBHOOK_SECRET=
# The iOS app's bundle id. APNs requires it under .p8 auth.
SIDECAR_APNS_TOPIC=org.onebusaway.iphone
# Proxy whose client-address header the per-IP throttles trust: off (the
# TCP peer, right for local runs), cloudflare, render, or header:<Name>.
# Set only behind a proxy that overwrites that header on every request, and
# give one of the two proofs below so a direct request cannot forge it.
SIDECAR_TRUSTED_PROXY=
# Value the proxy adds in X-Sidecar-Proxy-Secret (a Cloudflare Transform
# Rule "Modify Request Header" on the proxied route), and/or the CIDRs the
# proxy connects from. render defaults to the private ranges.
SIDECAR_TRUSTED_PROXY_SECRET=
SIDECAR_TRUSTED_PROXY_CIDRS=

# --- gorush / APNs -----------------------------------------------------------
# Defaults to true in compose.yaml; set to false to run without an Apple key.
# With iOS enabled and no key, gorush exits at startup and `make up` fails
# with "dependency failed to start". gorush also refuses to start with both
# platforms disabled -- turn Android on below if you disable iOS.
#GORUSH_IOS_ENABLED=true
# base64 -i AuthKey_XXXXXXXXXX.p8 | tr -d '\n'
GORUSH_IOS_KEY_BASE64=
# The 10-character key id from the Apple developer portal.
GORUSH_IOS_KEY_ID=
# The 10-character team id.
GORUSH_IOS_TEAM_ID=

# --- gorush / FCM (optional) ------------------------------------------------
GORUSH_ANDROID_ENABLED=false
# FCM service-account credential: the raw JSON key file contents (gorush
# passes this straight to fcm.WithCredentialsJSON), not base64-encoded.
GORUSH_ANDROID_CREDENTIAL=
# Log line format: text (default) or json for log aggregators.
SIDECAR_LOG_FORMAT=text
# Sentry DSN; when set, every error-level log line (handler panics, failed
# pushes, loop failures) is also reported there. Leave empty to disable.
SIDECAR_SENTRY_DSN=
SIDECAR_SENTRY_ENVIRONMENT=
# Continuous SQLite backup to an S3-compatible bucket via Litestream (docker
# image only; see README, Backups). Empty disables it.
SIDECAR_BACKUP_BUCKET=
SIDECAR_BACKUP_ENDPOINT=
SIDECAR_BACKUP_ACCESS_KEY_ID=
SIDECAR_BACKUP_SECRET_ACCESS_KEY=
# Stripe keys for in-app donations (README, Donations). Empty disables the
# route; the apps then hide the donations UI.
SIDECAR_STRIPE_SECRET_KEY=
SIDECAR_STRIPE_TEST_SECRET_KEY=
SIDECAR_STRIPE_RECURRING_PRODUCT_ID=
SIDECAR_STRIPE_TEST_RECURRING_PRODUCT_ID=