mirror of
https://github.com/jorijn/meshcore-stats.git
synced 2026-03-28 17:42:55 +01:00
a3de6cce20
Allow deployers to inject custom HTML into the <head> of every page via the CUSTOM_HEAD_HTML config option, useful for analytics scripts (Plausible, Matomo, etc.) without modifying source. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
167 lines
6.1 KiB
Plaintext
167 lines
6.1 KiB
Plaintext
# MeshCore Stats Configuration
|
|
# Copy this file to meshcore.conf and customize for your setup:
|
|
# cp meshcore.conf.example meshcore.conf
|
|
#
|
|
# Format: KEY=value (no 'export' keyword, no spaces around '=')
|
|
# This format is compatible with both Docker env_file and shell 'source' command.
|
|
# Comments start with # and blank lines are ignored.
|
|
|
|
# =============================================================================
|
|
# Timezone (for Docker deployments)
|
|
# =============================================================================
|
|
# Set the timezone for timestamps in charts and reports.
|
|
# Uses IANA timezone names: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
|
|
# TZ=Europe/Amsterdam
|
|
|
|
# =============================================================================
|
|
# Connection Settings
|
|
# =============================================================================
|
|
|
|
MESH_TRANSPORT=serial
|
|
MESH_SERIAL_PORT=/dev/ttyUSB0
|
|
# MESH_SERIAL_BAUD=115200
|
|
# MESH_DEBUG=0
|
|
|
|
# TCP transport (for macOS Docker or remote serial servers)
|
|
# MESH_TRANSPORT=tcp
|
|
# MESH_TCP_HOST=host.docker.internal
|
|
# MESH_TCP_PORT=5000
|
|
|
|
# BLE transport (Bluetooth Low Energy)
|
|
# MESH_TRANSPORT=ble
|
|
# MESH_BLE_ADDR=AA:BB:CC:DD:EE:FF
|
|
# MESH_BLE_PIN=123456
|
|
|
|
# =============================================================================
|
|
# Remote Repeater Identity
|
|
# =============================================================================
|
|
# At least REPEATER_NAME or REPEATER_KEY_PREFIX is required to identify your repeater
|
|
|
|
REPEATER_NAME=Your Repeater Name
|
|
# REPEATER_KEY_PREFIX=a1b2c3
|
|
REPEATER_PASSWORD=your-password
|
|
|
|
# =============================================================================
|
|
# Display Names (shown in UI)
|
|
# =============================================================================
|
|
|
|
REPEATER_DISPLAY_NAME=My Repeater
|
|
COMPANION_DISPLAY_NAME=My Companion
|
|
|
|
# Public key prefixes (shown below node name in sidebar, e.g., "!a1b2c3d4")
|
|
# REPEATER_PUBKEY_PREFIX=!a1b2c3d4
|
|
# COMPANION_PUBKEY_PREFIX=!e5f6g7h8
|
|
|
|
# =============================================================================
|
|
# Display Units (telemetry formatting only)
|
|
# =============================================================================
|
|
# Select telemetry display unit system:
|
|
# metric -> °C, hPa, m
|
|
# imperial -> °F, inHg, ft
|
|
# Default: metric
|
|
# DISPLAY_UNIT_SYSTEM=metric
|
|
|
|
# =============================================================================
|
|
# Location Metadata (for reports and sidebar display)
|
|
# =============================================================================
|
|
|
|
REPORT_LOCATION_NAME=City, Country
|
|
REPORT_LOCATION_SHORT=City, XX
|
|
REPORT_LAT=0.0
|
|
REPORT_LON=0.0
|
|
REPORT_ELEV=0
|
|
REPORT_ELEV_UNIT=m
|
|
|
|
# =============================================================================
|
|
# Hardware Info (shown in sidebar)
|
|
# =============================================================================
|
|
|
|
REPEATER_HARDWARE=Your Repeater Model
|
|
COMPANION_HARDWARE=Your Companion Model
|
|
|
|
# =============================================================================
|
|
# Radio Configuration Presets
|
|
# =============================================================================
|
|
# Uncomment ONE preset below that matches your MeshCore configuration,
|
|
# or set custom values. These are for display purposes only.
|
|
|
|
# MeshCore EU/UK Narrow (default)
|
|
RADIO_FREQUENCY=869.618 MHz
|
|
RADIO_BANDWIDTH=62.5 kHz
|
|
RADIO_SPREAD_FACTOR=SF8
|
|
RADIO_CODING_RATE=CR8
|
|
|
|
# MeshCore EU/UK Wide
|
|
# RADIO_FREQUENCY=869.525 MHz
|
|
# RADIO_BANDWIDTH=250 kHz
|
|
# RADIO_SPREAD_FACTOR=SF10
|
|
# RADIO_CODING_RATE=CR5
|
|
|
|
# MeshCore US Standard
|
|
# RADIO_FREQUENCY=906.875 MHz
|
|
# RADIO_BANDWIDTH=250 kHz
|
|
# RADIO_SPREAD_FACTOR=SF10
|
|
# RADIO_CODING_RATE=CR5
|
|
|
|
# MeshCore US Fast
|
|
# RADIO_FREQUENCY=906.875 MHz
|
|
# RADIO_BANDWIDTH=500 kHz
|
|
# RADIO_SPREAD_FACTOR=SF7
|
|
# RADIO_CODING_RATE=CR5
|
|
|
|
# MeshCore ANZ (Australia/New Zealand)
|
|
# RADIO_FREQUENCY=917.0 MHz
|
|
# RADIO_BANDWIDTH=250 kHz
|
|
# RADIO_SPREAD_FACTOR=SF10
|
|
# RADIO_CODING_RATE=CR5
|
|
|
|
# =============================================================================
|
|
# Intervals and Timeouts
|
|
# =============================================================================
|
|
|
|
# COMPANION_STEP=60
|
|
# REPEATER_STEP=900
|
|
# REMOTE_TIMEOUT_S=10
|
|
# REMOTE_RETRY_ATTEMPTS=2
|
|
# REMOTE_RETRY_BACKOFF_S=4
|
|
|
|
# Circuit breaker settings (prevents spamming LoRa when repeater is unreachable)
|
|
# REMOTE_CB_FAILS=6
|
|
# REMOTE_CB_COOLDOWN_S=3600
|
|
|
|
# =============================================================================
|
|
# Telemetry Collection (Environmental Sensors)
|
|
# =============================================================================
|
|
# Enable telemetry collection from repeater's environmental sensors
|
|
# (temperature, humidity, barometric pressure, etc.)
|
|
# Requires sensor board attached to repeater (e.g., BME280, BME680)
|
|
# Repeater dashboard charts for telemetry are auto-discovered from telemetry.* keys.
|
|
# telemetry.voltage.* and telemetry.gps.* are collected but intentionally not charted.
|
|
# Default: 0 (disabled)
|
|
# TELEMETRY_ENABLED=1
|
|
|
|
# Telemetry-specific timeout and retry settings
|
|
# Defaults match status settings. Separate config allows tuning if telemetry
|
|
# proves problematic (e.g., firmware doesn't support it, sensor board missing).
|
|
# You can reduce these if telemetry collection is causing issues.
|
|
# TELEMETRY_TIMEOUT_S=10
|
|
# TELEMETRY_RETRY_ATTEMPTS=2
|
|
# TELEMETRY_RETRY_BACKOFF_S=4
|
|
|
|
# =============================================================================
|
|
# Custom HTML (Analytics, etc.)
|
|
# =============================================================================
|
|
# Inject custom HTML into the <head> of every page.
|
|
# Useful for analytics scripts (Plausible, Matomo, etc.) without modifying source.
|
|
# Example for Plausible:
|
|
# CUSTOM_HEAD_HTML=<script defer data-domain="stats.example.com" src="https://plausible.io/js/script.js"></script>
|
|
|
|
# =============================================================================
|
|
# Paths (Native installation only)
|
|
# =============================================================================
|
|
# Docker: Leave these commented. The container uses /data/state and /out by default.
|
|
# Native: Uncomment for local cron-based installation:
|
|
# STATE_DIR=./data/state
|
|
# OUT_DIR=./out
|
|
|