HashScope/env.example at main · 256foundation/HashScope · 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
# HashScope Configuration
# Copy this file to .env and configure for your setup

# ==============================================================================
# POOL CONFIGURATION
# ==============================================================================
# Pool to connect to (both MITM and agents will use this)
POOL_HOST=stratum+tcp://your-pool.example.com
POOL_PORT=3333

# ==============================================================================
# ITERATION 2: NOSTR CONFIGURATION
# ==============================================================================
# Unique run ID - use the same RUN_ID for MITM and all agents to enable communication
# IMPORTANT: .env files don't execute shell commands, so use one of these approaches:
#   1. Set a static value: RUN_ID=my-test-run-123
#   2. Generate once: RUN_ID=test-run-1736283820
#   3. Pass as env var: RUN_ID="test-run-$(date +%s)" docker compose up
# Leave empty to auto-generate (but won't match between restarts)
RUN_ID=

# Enable Nostr functionality (set to true to enable Iteration 2 features)
NOSTR_ENABLED=false

# Nostr relay URL (required if NOSTR_ENABLED=true)
# Popular public relays:
#   - wss://relay.damus.io
#   - wss://relay.nostr.band
#   - wss://nos.lol
# For production, consider self-hosting
NOSTR_RELAY_URL=

# Nostr private key for MITM (hex-encoded)
# Auto-generated if not provided - check logs for the generated key
# Save the generated key here to persist across restarts
NOSTR_SK=

# ==============================================================================
# AGENT CONFIGURATION
# ==============================================================================
# Worker name for pool authentication
# Note: Agents automatically append .hashscope_agent{random5digits} to create
# unique worker names (e.g., myworker.hashscope_agent12345)
WORKER_NAME=hashscope_agent

# Worker password (if required by pool)
WORKER_PASSWORD=x

# Telemetry publishing interval in seconds
TELEMETRY_INTERVAL_SEC=5

# ==============================================================================
# ADVANCED SETTINGS
# ==============================================================================
# Capture limits
CAPTURE_MAX_MESSAGES=50000
CAPTURE_MAX_PER_SESSION=10000

# API and proxy ports (usually don't need to change these)
LISTEN_HOST=0.0.0.0
LISTEN_PORT=3333
API_HOST=0.0.0.0
API_PORT=8000

# Nostr event kinds (custom kinds for HashScope)
NOSTR_KIND_SHARE=30080
NOSTR_KIND_TELEMETRY=30079