wtclaude
416761f8f7
Additive, v1-only backend contract for the Android app's opt-in push (Part 1 of
M7; docs/android/PLAN.md §11). The app is a pure consumer — this lands the
endpoints, fan-out, and relay it needs.
- Schema: push_devices (per-device endpoint) + notification_subscriptions
(per-user opted-in streams), FK→users ON DELETE CASCADE.
- Stream catalog + event→stream mapping (config/notificationStreams.js): public
streams (news.post, server.status, idoc.warning, champ.start, governor.election)
drawn ONLY from the SSE PUBLIC_KINDS allowlist; personal owner-keyed streams
(vendor.sale, house.idoc, account.login). Full-state upserts (champ/city) fire
only on a real transition via an injectable tracker.
- Fan-out (utils/pushDispatch.js): content-free tickles ({ stream, ref }) POSTed
to each subscribed device; never throws. Two producers — shardIngest.ingest
(beside the SSE broadcast) and the create/publish-post path (news.post).
Personal events resolve to the owner via shardLinks. SSRF guard: endpoints must
be HTTPS, non-private, and on the NTFY_BASE_URL/NTFY_ALLOWED_ORIGINS allow-set —
enforced at registration and every publish.
- Routes under the role-agnostic self surface (never /admin): POST|GET
/auth/me/devices, DELETE /auth/me/devices/:id, GET
/auth/me/notifications/streams, GET|PUT /auth/me/notifications/subscriptions.
Swagger regenerated (4 paths, PushDevice/NotificationStreams/etc. schemas).
- ntfy service in docker-compose.yml: pinned image, declarative ./ntfy/server.yml,
no published host port, anonymous unguessable topics (no accounts) — zero
interactive setup. No publish token required (content-free design); optional
NTFY_PUBLISH_TOKEN honored.
- Tests: pushDispatch (mapping, PUBLIC_KINDS gate, owner-keying, SSRF guard,
content-free payload) + notifications route auth gate. Full suite green (247).
Co-Authored-By: Claude <noreply@anthropic.com>
113 lines
5.5 KiB
Plaintext
113 lines
5.5 KiB
Plaintext
# ─── Runic Gateway server — local dev environment ───
|
|
# Copy to server/.env for running `npm run dev` outside Docker.
|
|
# (In Docker, the root .env / docker-compose provides these instead.)
|
|
|
|
NODE_ENV=development
|
|
PORT=3000
|
|
# Separate, unpublished port for server<->bot internal traffic (the decrypted
|
|
# bot-token route). Must match the port in bot/.env's SITE_INTERNAL_URL and must
|
|
# never be exposed through a public reverse proxy. See issue #33.
|
|
INTERNAL_PORT=3001
|
|
# Logging — written to BOTH the console and a log file (default <server>/logs/app.log).
|
|
LOG_LEVEL=debug # console verbosity: error | warn | info | debug
|
|
FILE_LOG_LEVEL=debug # file verbosity
|
|
LOG_TO_FILE=true # set false for console-only
|
|
# LOG_DIR= # defaults to server/logs
|
|
# LOG_FILE=app.log
|
|
|
|
# Point at a local or Dockerized MariaDB
|
|
DB_HOST=127.0.0.1
|
|
DB_PORT=3306
|
|
DB_NAME=runic_gateway
|
|
DB_USER=runic
|
|
DB_PASSWORD=change-me-db-password
|
|
|
|
JWT_SECRET=dev-only-change-me
|
|
JWT_EXPIRES_IN=1d
|
|
COOKIE_SECURE=auto
|
|
COOKIE_NAME=rg_token
|
|
|
|
# Encryption key for secrets stored at rest (OAuth client secrets in auth_providers).
|
|
# Any string — hashed to a 256-bit AES-GCM key. REQUIRED in production; in dev an
|
|
# insecure key is derived from JWT_SECRET if unset (with a warning).
|
|
SECRET_ENC_KEY=dev-only-change-me-too
|
|
|
|
# Public base URL of this app, used to build the OAuth redirect_uri
|
|
# (${APP_BASE_URL}/api/v1/auth/sso/:provider/callback). Set this in production so
|
|
# the callback URL matches what you register with Google/Discord. If unset, it is
|
|
# derived from the incoming request (fine for local dev).
|
|
APP_BASE_URL=http://localhost:5173
|
|
|
|
# Short-lived mobile access token lifetime + refresh token lifetime (Part 2).
|
|
MOBILE_ACCESS_TTL=15m
|
|
MOBILE_REFRESH_TTL_DAYS=30
|
|
|
|
# Reverse-proxy trust. Request path: client -> Pangolin -> newt agent "ptero"
|
|
# (separate VM) -> this app. ptero is the hop that connects to us, so pin
|
|
# TRUST_PROXY to ptero's LAN IP: Express then honours X-Forwarded-For ONLY on
|
|
# connections from ptero, and req.ip / req.secure reflect the real client (used
|
|
# by rate limiting, backoff, bot-ban, activity log).
|
|
# <ptero LAN IP> -> e.g. 10.0.0.42 (RECOMMENDED in prod; requires a static
|
|
# DHCP reservation for ptero in Omada — a lease change would
|
|
# silently break IP trust)
|
|
# an integer -> that many hops (fallback if you can't pin an IP)
|
|
# false -> no proxy (direct connections)
|
|
# NOTE: a blanket "true" is intentionally rejected (coerced to 1) — it would let
|
|
# clients spoof their IP via a forged X-Forwarded-For and dodge rate limits/bans.
|
|
TRUST_PROXY=1
|
|
|
|
# Set to 1 to log each request's raw peer address + X-Forwarded-For + resolved
|
|
# req.ip, so you can verify/refresh ptero's IP without redeploying. Noisy —
|
|
# leave off in normal operation.
|
|
DEBUG_TRUST_PROXY=0
|
|
|
|
# Optional TOTP two-factor (opt-in per user).
|
|
# TOTP_ISSUER defaults to BRAND_NAME; BRAND_* live in the root .env (see root .env.example)
|
|
TOTP_ISSUER=Runic Gateway
|
|
# How long the "password verified, awaiting code" step stays valid.
|
|
TOTP_CHALLENGE_TTL=5m
|
|
|
|
# Created on first boot if the users table is empty
|
|
ADMIN_USERNAME=admin
|
|
ADMIN_PASSWORD=change-me-admin-password
|
|
|
|
# Email is configured in Admin → Settings → Email (Gmail over OAuth2), not here.
|
|
# It reuses the Google auth provider's OAuth client and stores an encrypted
|
|
# refresh token in the DB. The contact recipient is the `contact_email` site
|
|
# setting; while email is unconfigured the contact form falls back to a mailto: link.
|
|
|
|
CLIENT_ORIGIN=http://localhost:5173
|
|
|
|
# Discord bot — internal API (server <-> bot/). BOT_INTERNAL_KEY MUST be
|
|
# byte-for-byte identical to the same variable in bot/.env.example — it is the
|
|
# only auth on both sides' /internal/* routes, so a mismatch silently breaks
|
|
# every server<->bot call with 401s. It also guards the server's
|
|
# /internal/bot-config route, which returns the DECRYPTED Discord token: with
|
|
# NODE_ENV=production the app REFUSES TO START if this is blank, a documented
|
|
# placeholder, or shorter than 16 chars (a warning only in dev). The Discord bot
|
|
# TOKEN itself is not an env var — it's entered in the admin panel and stored
|
|
# encrypted in the DB (see the bot_config table / SECRET_ENC_KEY above).
|
|
BOT_INTERNAL_URL=http://localhost:4100
|
|
BOT_INTERNAL_KEY=dev-only-change-me-bot-key
|
|
|
|
# News announcement pipeline (published news post -> in-game town crier + Discord
|
|
# #news). The dispatcher is an in-process poller; these tune it. Links in the
|
|
# announcements use APP_BASE_URL (set above), so set that in production too.
|
|
# ANNOUNCE_POLL_MS how often the dispatcher sweeps for due/retry legs
|
|
# TOWNCRIER_DURATION_SEC how long the in-game town-crier message stays up (<= 86400)
|
|
ANNOUNCE_POLL_MS=15000
|
|
TOWNCRIER_DURATION_SEC=3600
|
|
|
|
# Push notifications (M7) — opt-in fan-out to the Android app via a self-hosted
|
|
# ntfy UnifiedPush relay (docs/android/PLAN.md §11). The publisher POSTs
|
|
# content-free tickles to each device's endpoint, so no publish token is required.
|
|
# NTFY_BASE_URL Public relay URL; also the backend's SSRF allow-set — a
|
|
# device may only register an endpoint on this origin.
|
|
# NTFY_ALLOWED_ORIGINS Optional comma-separated extra allowed origins.
|
|
# NTFY_PUBLISH_TOKEN Optional bearer token for backend->ntfy publishes (off by default).
|
|
# Leave NTFY_BASE_URL unset in local dev to allow any public HTTPS endpoint
|
|
# (private/loopback hosts are always rejected).
|
|
# NTFY_BASE_URL=https://ntfy.example.com
|
|
# NTFY_ALLOWED_ORIGINS=
|
|
# NTFY_PUBLISH_TOKEN=
|