mirror of
https://github.com/ipnet-mesh/meshcore-hub.git
synced 2026-07-06 18:01:17 +02:00
Louis King
75 lines
2.8 KiB
Bash
75 lines
2.8 KiB
Bash
# ==========================================================================
|
|
# MeshCore Packet Capture - Observer Configuration
|
|
# ==========================================================================
|
|
# Copy this file to .env and update the values below.
|
|
#
|
|
# This observer captures MeshCore mesh traffic from a serial device and
|
|
# forwards decoded packets to one or more MQTT brokers.
|
|
# By default it sends to IPNet's MeshCore Hub MQTT broker.
|
|
# Optionally, it can send to MeshRank.net
|
|
#
|
|
# Prerequisites:
|
|
# - A MeshCore companion device connected via USB (or modify CONNECTION_TYPE for network)
|
|
#
|
|
# Quick start:
|
|
# cp .env.example .env # then edit .env
|
|
# docker compose up -d
|
|
# ==========================================================================
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# Serial / Device
|
|
# ---------------------------------------------------------------------------
|
|
# Path to your Meshtastic device. Use /dev/serial/by-id/... for a stable path
|
|
# that survives reboots (avoids /dev/ttyUSB0 reordering).
|
|
# Find your device: ls /dev/serial/by-id/
|
|
SERIAL_PORT=/dev/ttyUSB0
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# Identity
|
|
# ---------------------------------------------------------------------------
|
|
# 3-letter IATA airport code for your area (e.g. STN, SEA, LAX, AMS).
|
|
# Used as a location tag in MQTT topic paths.
|
|
IATA=STN
|
|
|
|
# Observer name/identifier. Appears in packet metadata.
|
|
ORIGIN=observer
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# Schedule
|
|
# ---------------------------------------------------------------------------
|
|
# Hours between self-advertisement broadcasts (default: 11).
|
|
ADVERT_INTERVAL_HOURS=11
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# IPNet (required)
|
|
# ---------------------------------------------------------------------------
|
|
# Contribute packets to IPNet MeshCore Hub's MQTT broker.
|
|
# See: https://ipnt.uk/pages/join
|
|
# Enable IPNet MQTT endpoint
|
|
IPNET_ENABLE=true
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# MeshRank (optional)
|
|
# ---------------------------------------------------------------------------
|
|
# Contribute captured packets to the MeshRank.
|
|
# See: https://meshrank.net/become-an-observer
|
|
|
|
MESHRANK_ENABLE=false
|
|
MESHRANK_UPLINK_KEY=
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# Custom MQTT Endpoint (optional)
|
|
# ---------------------------------------------------------------------------
|
|
# Contribute captured packets to a custom MQTT broker.
|
|
|
|
# CUSTOM_ENABLE=false
|
|
# CUSTOM_MQTT_SERVER=
|
|
# CUSTOM_MQTT_PORT=
|
|
# CUSTOM_MQTT_USE_TLS=
|
|
# CUSTOM_MQTT_TLS_VERIFY=
|
|
# CUSTOM_MQTT_USERNAME=
|
|
# CUSTOM_MQTT_PASSWORD=
|
|
# CUSTOM_MQTT_KEEPALIVE=
|
|
# CUSTOM_MQTT_TOPIC_PACKETS=
|
|
# CUSTOM_MQTT_TOPIC_STATUS=
|