Files
nostermd-relay/.env.example
Robert Goodall 8e9235a820
ci / build (pull_request) Successful in 23s
ci / image (pull_request) Skipped
seed default channel(s) on boot
fresh relay seeds configured open channels (RELAY_DEFAULT_CHANNELS,
default general) so a client always has a room. relay-signed 9007
through the normal pipeline; idempotent; never reopens a closed group.

also adds mission/roadmap and separation rationale to the readme.
2026-07-25 08:11:39 -04:00

41 lines
1.5 KiB
Bash

# Nosterm relay deployment configuration.
# Copy to `.env` and adjust.
# Stable 64-char hex identity that signs group metadata/rosters.
# REQUIRED when RELAY_ENV=production (the relay refuses to start without it).
# In dev it is auto-generated and persisted to the data volume.
# Generate one with: openssl rand -hex 32
RELAY_SECRET_KEY=
# Set to "production" to require a stable RELAY_SECRET_KEY (fail-fast if unset).
# Leave empty for development (auto-generates + persists a key).
RELAY_ENV=
# NIP-11 relay metadata.
RELAY_NAME=Nosterm Home Relay
RELAY_DESCRIPTION=
RELAY_CONTACT=relay@nosterm.com
# Optional message-of-the-day: shown in the client's relay "server window" on
# connect (IRC-style MOTD). Multi-line supported with \n. Empty = falls back to
# the built-in "nerdworks.io" ascii banner.
RELAY_MOTD=
# Channels seeded as open groups on boot so a fresh relay is never empty.
# Comma-separated group ids (leading '#' tolerated). Unset = "general".
RELAY_DEFAULT_CHANNELS=general
# Retention (chat messages only; membership/metadata are never pruned).
# 0 = unlimited.
RELAY_RETENTION_DAYS=0
RELAY_RETENTION_MAX_MESSAGES=0
RELAY_RETENTION_INTERVAL_MINUTES=60
# Optional federation with peer relays. Empty = disabled.
# Format: "<wss-url>[|<mode>:<channels>]" entries separated by ';'.
# mode = mirror (bidirectional) | ingest (read-only). Default mirror.
# channels = comma list of group ids, or '*' for all. Default '*'.
# Example:
# wss://a.example|mirror:general,dev;wss://b.example|ingest:*
RELAY_FEDERATION_PEERS=