docsight/.env.example at main · NonCertus/docsight · 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
# DOCSight - Environment Variables (optional)
# Copy to .env and edit. All values can also be set via the web UI setup wizard.
# Environment variables override config.json values.

# ── Modem ────────────────────────────────────────────────────────────────────
MODEM_TYPE=fritzbox            # fritzbox, tc4400, ultrahub7, vodafone_station, ch7465, cm3500
MODEM_URL=http://192.168.178.1
MODEM_USER=
MODEM_PASSWORD=

# ── General ──────────────────────────────────────────────────────────────────
POLL_INTERVAL=900              # Polling interval in seconds (60-14400)
HISTORY_DAYS=0                 # Snapshot retention in days (0 = unlimited)
# SNAPSHOT_TIME=06:00          # Daily snapshot time (HH:MM) -- UI only, no env var
WEB_PORT=8765
# ADMIN_PASSWORD=              # Web UI password (hashed with scrypt)
# LANGUAGE=en                  # UI language (en, de, fr, es) -- UI only, no env var
# THEME=dark                   # UI theme (dark, light) -- UI only, no env var
# DEMO_MODE=false              # Enable demo mode with synthetic data
LOG_LEVEL=INFO                 # DEBUG, INFO, WARNING, ERROR
# DOCSIGHT_AUDIT_JSON=1        # Emit audit log as structured JSON
DATA_DIR=/data                 # Data directory (rarely needed)

# ── MQTT / Home Assistant ────────────────────────────────────────────────────
# MQTT_HOST=                   # Enables HA integration when set
# MQTT_PORT=1883               # 8883 enables TLS automatically
# MQTT_USER=
# MQTT_PASSWORD=
# MQTT_TLS_INSECURE=false      # Disable TLS cert verification (self-signed certs)
# MQTT_TOPIC_PREFIX=docsight
# MQTT_DISCOVERY_PREFIX=homeassistant
# PUBLIC_URL=                  # Public URL for HA device link

# ── Speedtest Tracker ────────────────────────────────────────────────────────
# SPEEDTEST_TRACKER_URL=       # Your Speedtest Tracker instance URL
# SPEEDTEST_TRACKER_TOKEN=     # API token from Speedtest Tracker settings
# BOOKED_DOWNLOAD=0            # Booked download speed in Mbit/s
# BOOKED_UPLOAD=0              # Booked upload speed in Mbit/s

# ── BQM / Smokeping ─────────────────────────────────────────────────────────
# BQM_URL=                     # ThinkBroadband BQM share URL (.png)
# SMOKEPING_URL=               # Smokeping base URL
# SMOKEPING_TARGETS=           # Comma-separated Smokeping targets

# ── Notifications ────────────────────────────────────────────────────────────
# NOTIFY_WEBHOOK_URL=          # Webhook URL for alerts
# NOTIFY_WEBHOOK_TOKEN=        # Webhook auth token (optional)
# NOTIFY_MIN_SEVERITY=warning  # Minimum severity: info, warning, critical
# NOTIFY_COOLDOWN=3600         # Cooldown between alerts in seconds

# ── BNetzA ───────────────────────────────────────────────────────────────────
# BNETZ_ENABLED=true           # Show BNetzA integration in sidebar
# BNETZ_WATCH_ENABLED=false    # Auto-import measurement files
# BNETZ_WATCH_DIR=/data/bnetz  # Directory to watch for measurement files

# ── UI Toggles ───────────────────────────────────────────────────────────────
# GAMING_QUALITY_ENABLED=true  # Show gaming quality badge on dashboard