# MeshCore Hub - Environment Configuration # Copy this file to .env and customize values # # Configuration is grouped by service. Most deployments only need: # - Common Settings (always required) # - MQTT Settings (always required) # - Packet Capture Settings (for observer nodes) # # The Collector, API, and Web services typically run as a combined "core" # profile and share the same data directory. # # ----------------------------------------------------------------------------- # QUICK START: Observer Node # ----------------------------------------------------------------------------- # For an observer node capturing mesh traffic, you need: # # MQTT_HOST=your-mqtt-broker.example.com # MQTT_PORT=1883 # MQTT_USERNAME=your_username # MQTT_PASSWORD=your_password # MQTT_TLS=false # SERIAL_PORT=/dev/ttyUSB0 # # Serial ports are typically /dev/ttyUSB[0-9] or /dev/ttyACM[0-9] on Linux. # ----------------------------------------------------------------------------- # ============================================================================= # COMMON SETTINGS # ============================================================================= # These settings apply to all services # Docker Compose project name # Used as a prefix for container names (e.g., hub-api) and volume names # (e.g., hub_data). Change per instance when running multiple deployments # on the same Docker host (e.g., hub-prod, hub-beta, hub-stg). # For multi-instance setups, see the "Multi-Instance Deployment" section in README.md. COMPOSE_PROJECT_NAME=hub # Domain name for this instance (only needed for Traefik deployments) # Used by docker-compose.traefik.yml to configure routing rules # TRAEFIK_DOMAIN=meshcore.example.com # Docker image version tag to use # Options: latest, main, v1.0.0, etc. IMAGE_VERSION=latest # Logging level (DEBUG, INFO, WARNING, ERROR, CRITICAL) LOG_LEVEL=INFO # Base directory for runtime data (database, etc.) # Default: ./data (relative to docker-compose.yml location) # Inside containers this is mapped to /data # # Structure: # ${DATA_HOME}/ # └── collector/ # └── meshcore.db # SQLite database DATA_HOME=./data # Directory containing seed data files for import # Default: ./seed (relative to docker-compose.yml location) # Inside containers this is mapped to /seed # # Structure: # ${SEED_HOME}/ # ├── node_tags.yaml # Node tags for import # └── members.yaml # Network members for import SEED_HOME=./seed # ============================================================================= # MQTT SETTINGS # ============================================================================= # MQTT broker connection settings for collector and API services # Uses the MeshCore MQTT broker (WebSocket transport with subscriber auth) # See: https://github.com/michaelhart/meshcore-mqtt-broker # MQTT Broker host # When using the local MQTT broker (--profile mqtt), use "mqtt" # When using an external broker, set the hostname/IP # For native (non-Docker) installs, use "localhost" (the Python default) MQTT_HOST=mqtt # MQTT Broker port # Default: 1883 (local, plain WebSocket) # Production behind reverse proxy: 8883 (TLS) MQTT_PORT=1883 # MQTT subscriber authentication # The broker uses subscriber accounts with roles: # Role 1 (admin): full access including /internal topics # Role 2 (full_access): all public topics, no filtering # Role 3 (limited): filtered data (SNR, RSSI, etc. removed) MQTT_USERNAME= MQTT_PASSWORD= # MQTT topic prefix for all MeshCore messages MQTT_PREFIX=meshcore # Enable TLS/SSL for MQTT connection # Set to true when connecting via wss:// (e.g., behind a reverse proxy) MQTT_TLS=false # MQTT transport protocol # The MeshCore MQTT broker uses WebSockets exclusively MQTT_TRANSPORT=websockets # MQTT WebSocket path (used when MQTT_TRANSPORT=websockets) # Default: / (broker accepts any path) # Production: can be set to /mqtt if reverse proxy rewrites paths MQTT_WS_PATH=/ # JWT audience claim for packet capture authentication tokens # Must match AUTH_EXPECTED_AUDIENCE on the broker # Local default: mqtt.localhost # Production: set to your broker's domain (e.g., mqtt.example.com) MQTT_TOKEN_AUDIENCE=mqtt.localhost # ============================================================================= # PACKET CAPTURE SETTINGS # ============================================================================= # External packet capture service (ghcr.io/agessaman/meshcore-packet-capture) # See https://github.com/agessaman/meshcore-packet-capture for documentation. # Uses the "observer" compose profile. # Publishes captured packets to MQTT in LetsMesh upload format, ingested by # the collector. # Serial port for the packet capture device SERIAL_PORT=/dev/ttyUSB0 # Docker image version tag for the packet capture image PACKETCAPTURE_IMAGE_VERSION=latest # Connection timeout and retry settings PACKETCAPTURE_TIMEOUT=30 PACKETCAPTURE_MAX_CONNECTION_RETRIES=5 PACKETCAPTURE_CONNECTION_RETRY_DELAY=5 PACKETCAPTURE_HEALTH_CHECK_INTERVAL=30 # IATA airport code identifier (used in Let's Mesh topic templates) PACKETCAPTURE_IATA=LOC # Device display name (optional, defaults to device name from meshcore connection) # PACKETCAPTURE_ORIGIN= # Send flood adverts at this interval in hours (0 = disabled) PACKETCAPTURE_ADVERT_INTERVAL_HOURS=11 # RF data cache timeout in seconds PACKETCAPTURE_RF_DATA_TIMEOUT=15.0 # ------------------- # Let's Mesh MQTT Brokers (opt-in) # ------------------- # Enable to publish captured packets to the Let's Mesh cloud map # Broker 1 - Let's Mesh US PACKETCAPTURE_MQTT1_ENABLED=false PACKETCAPTURE_MQTT1_SERVER=mqtt-us-v1.letsmesh.net PACKETCAPTURE_MQTT1_PORT=443 PACKETCAPTURE_MQTT1_USE_TLS=true PACKETCAPTURE_MQTT1_USE_AUTH_TOKEN=true PACKETCAPTURE_MQTT1_TOKEN_AUDIENCE=mqtt-us-v1.letsmesh.net PACKETCAPTURE_MQTT1_KEEPALIVE=120 # Broker 2 - Let's Mesh EU PACKETCAPTURE_MQTT2_ENABLED=false PACKETCAPTURE_MQTT2_SERVER=mqtt-eu-v1.letsmesh.net PACKETCAPTURE_MQTT2_PORT=443 PACKETCAPTURE_MQTT2_USE_TLS=true PACKETCAPTURE_MQTT2_USE_AUTH_TOKEN=true PACKETCAPTURE_MQTT2_TOKEN_AUDIENCE=mqtt-eu-v1.letsmesh.net PACKETCAPTURE_MQTT2_KEEPALIVE=120 # Broker 3 - Local MQTT (enabled by default, wired to hub's MQTT_* settings) # Uses websockets and auth tokens by default (set in docker-compose.yml) PACKETCAPTURE_MQTT3_ENABLED=true PACKETCAPTURE_MQTT3_KEEPALIVE=60 # MQTT reconnection settings PACKETCAPTURE_MAX_MQTT_RETRIES=5 PACKETCAPTURE_MQTT_RETRY_DELAY=5 PACKETCAPTURE_EXIT_ON_RECONNECT_FAIL=true # ============================================================================= # COLLECTOR SETTINGS # ============================================================================= # The collector subscribes to MQTT events and stores them in the database # LetsMesh decoder support # The native Python decoder is always enabled. # Optional: channel secret keys (comma or space separated) used to decrypt GroupText # packets. This supports unlimited keys. # Note: Public + #test keys are built into the collector code by default. # To show friendly channel names in the web feed, use label=hex (example: bot=ABCDEF...). # Without keys, encrypted packets cannot be shown as plaintext. # COLLECTOR_CHANNEL_KEYS= # Include built-in 'test' channel messages (channel_idx 217) # Default: false (test channel messages are discarded) # COLLECTOR_INCLUDE_TEST_CHANNEL=false # ------------------- # Webhook Settings # ------------------- # Webhooks forward mesh events to external HTTP endpoints as POST requests # Webhook for advertisement events (node discovery) WEBHOOK_ADVERTISEMENT_URL= WEBHOOK_ADVERTISEMENT_SECRET= # Webhook for all message events (channel and direct messages) WEBHOOK_MESSAGE_URL= WEBHOOK_MESSAGE_SECRET= # Optional: Separate URLs for channel vs direct messages # These override WEBHOOK_MESSAGE_URL if set # WEBHOOK_CHANNEL_MESSAGE_URL= # WEBHOOK_CHANNEL_MESSAGE_SECRET= # WEBHOOK_DIRECT_MESSAGE_URL= # WEBHOOK_DIRECT_MESSAGE_SECRET= # Webhook behavior settings WEBHOOK_TIMEOUT=10.0 WEBHOOK_MAX_RETRIES=3 WEBHOOK_RETRY_BACKOFF=2.0 # ------------------- # Data Retention Settings # ------------------- # Automatic cleanup of old event data (advertisements, messages, telemetry, etc.) # Enable automatic cleanup of old event data DATA_RETENTION_ENABLED=true # Number of days to retain event data # Events older than this are deleted during cleanup DATA_RETENTION_DAYS=30 # Hours between automatic cleanup runs # Applies to both event data and node cleanup DATA_RETENTION_INTERVAL_HOURS=24 # ------------------- # Node Cleanup Settings # ------------------- # Automatic removal of inactive nodes # Enable automatic cleanup of inactive nodes # Nodes with last_seen=NULL (never seen on network) are NOT removed NODE_CLEANUP_ENABLED=true # Remove nodes not seen for this many days (based on last_seen field) NODE_CLEANUP_DAYS=7 # ============================================================================= # API SETTINGS # ============================================================================= # REST API for querying data # External API port API_PORT=8000 # API Keys for authentication # Generate secure keys for production: openssl rand -hex 32 # Leave empty to disable authentication (not recommended for production) API_READ_KEY= API_ADMIN_KEY= # ------------------- # Prometheus Metrics # ------------------- # Prometheus metrics endpoint exposed at /metrics on the API service # Enable Prometheus metrics endpoint # Default: true METRICS_ENABLED=true # Seconds to cache metrics output (reduces database load) # Default: 60 METRICS_CACHE_TTL=60 # CORS origins for the API server (comma-separated) # Only needed when running the web dashboard on a different origin than the API # Example: http://localhost:8080,http://localhost:3000 # CORS_ORIGINS= # External Prometheus port (when using --profile metrics) PROMETHEUS_PORT=9090 # External Alertmanager port (when using --profile metrics) ALERTMANAGER_PORT=9093 # ============================================================================= # WEB DASHBOARD SETTINGS # ============================================================================= # Web interface for visualizing network status # External web port WEB_PORT=8080 # API endpoint URL for the web dashboard # Default: http://localhost:8000 # API_BASE_URL=http://localhost:8000 # API key for web dashboard queries (optional) # If API_READ_KEY is set on the API, provide it here # API_KEY= # Default theme for the web dashboard (dark or light) # Users can override via the theme toggle; their preference is saved in localStorage # Default: dark # WEB_THEME=dark # Locale/language for the web dashboard # Default: en # Supported: en, nl (see src/meshcore_hub/web/static/locales/ for available translations) # WEB_LOCALE=en # Locale used for date/time formatting in the web dashboard # Controls date ordering only; 24-hour clock is still used by default # Examples: en-US (MM/DD/YYYY), en-GB (DD/MM/YYYY) # Default: en-US # WEB_DATETIME_LOCALE=en-US # Auto-refresh interval in seconds for list pages (nodes, advertisements, messages) # Set to 0 to disable auto-refresh # Default: 30 # WEB_AUTO_REFRESH_SECONDS=30 # Enable admin interface at /a/ (requires auth proxy in front) # Default: false # WEB_ADMIN_ENABLED=false # Comma-separated list of trusted proxy hosts for admin authentication headers # Default: * (trust all hosts) # Recommended: set to your reverse proxy IP in production # A startup warning is emitted when using the default * with admin enabled # WEB_TRUSTED_PROXY_HOSTS=* # Timezone for displaying dates/times on the web dashboard # Uses standard IANA timezone names (e.g., America/New_York, Europe/London) # Default: UTC TZ=UTC # Directory containing custom content (pages/, media/) # Default: ./content # CONTENT_HOME=./content # ------------------- # Network Information # ------------------- # Displayed on the web dashboard homepage # Network domain name (optional) # NETWORK_DOMAIN= # Network display name NETWORK_NAME=MeshCore Network # Network location NETWORK_CITY= NETWORK_COUNTRY= # Radio configuration (comma-delimited) # Format: ,,,,, # Example: EU/UK Narrow,869.618MHz,62.5kHz,SF8,CR8,22dBm NETWORK_RADIO_CONFIG= # Welcome text displayed on the homepage (optional, plain text) # If not set, a default welcome message is shown NETWORK_WELCOME_TEXT= # ------------------- # Feature Flags # ------------------- # Control which pages are visible in the web dashboard # Set to false to completely hide a page (nav, routes, sitemap, robots.txt) # FEATURE_DASHBOARD=true # FEATURE_NODES=true # FEATURE_ADVERTISEMENTS=true # FEATURE_MESSAGES=true # FEATURE_MAP=true # FEATURE_MEMBERS=true # FEATURE_PAGES=true # ------------------- # Contact Information # ------------------- # Contact links displayed in the footer NETWORK_CONTACT_EMAIL= NETWORK_CONTACT_DISCORD= NETWORK_CONTACT_GITHUB= NETWORK_CONTACT_YOUTUBE=