-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy path.env.example
More file actions
72 lines (63 loc) · 2.93 KB
/
.env.example
File metadata and controls
72 lines (63 loc) · 2.93 KB
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
# Copy to .env (which is gitignored) and populate secrets.
# IMPORTANT: Never commit .env with real values!
# ============================================================================
# STRFRY RELAY CONFIGURATION
# ============================================================================
# StrFry relay private key (hex, 64 chars). Do NOT commit real value.
STRFRY_PRIVATE_KEY=
# ============================================================================
# EVENT FORWARDER NOSTR SECRET KEYS
# ============================================================================
# These are used to sign sync progress events (kind 30078)
# Generate with: openssl rand -hex 32
# Or use existing Nostr keypairs in nsec format or hex
# Secret key for LIVE forwarders (streaming from now onwards)
# All live forwarders share this key for sync progress tracking
NOSTR_SYNC_SECKEY_LIVE=
# Secret key for HISTORICAL forwarders (syncing from 2020-01-01)
# All history forwarders share this key for sync progress tracking
NOSTR_SYNC_SECKEY_HISTORY=
# ============================================================================
# MACHINE-SPECIFIC PATHS (Optional)
# ============================================================================
# Override where on-disk databases live. Leave unset to use ./data/... under
# the repo. Paths can be absolute (recommended for large DBs on a separate
# drive) or relative to the project directory.
#
# STRFRY_DB_PATH=/mnt/ssd/strfry-db
# STRFRY_QUARANTINE_DB_PATH=/mnt/ssd/strfry-quarantine-db
# DGRAPH_DATA_PATH=/mnt/ssd/dgraph
# ============================================================================
# BUILD CONFIGURATION (Optional)
# ============================================================================
# Version information for Docker builds
# These will be embedded in the container image labels
FWD_VERSION=dev
FWD_GIT_COMMIT=unknown
FWD_BUILD_TIME=unknown
# NOTE: The whitelist server derives its commit and build time automatically
# from the .git directory at build time (Go's -buildvcs=auto). No env vars
# required. `docker compose -f docker-compose.dgraph.yml up -d --build
# whitelist-server` Just Works.
# ============================================================================
# NOTES
# ============================================================================
#
# Why separate keys for live vs history?
# - Each forwarder instance needs a unique sync progress identifier
# - The identifier is based on: source relay URL + d tag (derived from seckey)
# - Live and history forwarders for the same relay need different keys
# to maintain separate sync progress states
#
# Example key generation:
# openssl rand -hex 32
# Output: a1b2c3d4e5f6789012345678901234567890123456789012345678901234
#
# Or use Nostr nsec format:
# nsec1abc123...
#
# Security:
# - Never commit .env to git
# - Rotate keys if compromised
# - Each deployment environment should have unique keys
# - Store securely (vault, secrets manager, etc.)