config.toml.sample

# MeshInfo Configuration
# Copy this file to config.toml and edit it for your deployment.
# Full documentation: https://github.com/MeshAddicts/meshinfo

# Enable verbose debug logging (set to true to troubleshoot)
debug = false

# ─────────────────────────────────────────────────────────────────────────────
# Storage — Required
# PostgreSQL is the only supported storage backend.
# ─────────────────────────────────────────────────────────────────────────────

[storage]
# Uplink dedup (#526): store one canonical mqtt_messages row per mesh packet;
# every per-gateway uplink copy is kept losslessly in packet_receptions (id-less
# repeats from the same gateway inside content_dedup_window_seconds are not
# re-recorded). Disable to restore the legacy one-row-per-copy firehose (~10x
# the disk) — that also turns off content dedup and the flood guard below.
dedup_uplinks = true
dedup_window_seconds = 900            # copies of one packet merge within this window
content_dedup_window_seconds = 120    # packets without a packet id (MapReport) merge
                                      # by content within this shorter window
# Per-node flood guard: caps on NEW archive rows per originating node — copies
# dedup folds into packet_receptions don't count, so dense meshes are unaffected
# (measured legit peaks: 28/min, 119/hour). Overflow is dropped before the
# database with a throttled WARNING naming the node. 0 disables a tier; the
# guard needs dedup_uplinks.
max_packets_per_node_per_minute = 60
max_packets_per_node_per_hour = 600
# Blunt escape hatch: node ids whose packets — as origin or uplinking gateway —
# are dropped at the decoder (nothing archived, no node/position/telemetry
# updates). Hex ids.
ingest_denylist = []                  # e.g. ["eba3d8e8"]

# Database snapshot backups. The app schedules these itself — the schedule is
# applied automatically on (re)start, no host cron needed. The raw archive is
# keep-forever, so backups are the only other copy of history.
[backups]
schedule = "daily"                    # off | daily | weekly | monthly
keep_days = 4                         # prune local dumps older than this
dir = "backups"                       # relative to the repo root, or absolute
remote_target = ""                    # optional rsync destination for off-box copies
                                      # (e.g. "user@host:/backups/meshinfo"); pushed by
                                      # scripts/backup_db.sh on the host, where SSH keys live

[storage.postgres]
enabled = true
host = "postgres"                     # use "localhost" if not using Docker
port = 5432
database = "meshinfo"
username = "postgres"
password = "password"
min_pool_size = 1                     # minimum database connection pool size
max_pool_size = 5                     # maximum database connection pool size

# ─────────────────────────────────────────────────────────────────────────────
# Server — Required
# Core runtime identity and behavior.
# ─────────────────────────────────────────────────────────────────────────────

[server]
node_id = "c7181daf"                  # your central mesh node's hex ID
base_url = "REPLACE_WITH_THE_URL_OF_THIS_SERVER_WITHOUT_TRAILING_SLASH"
node_activity_prune_threshold = 259200  # seconds (default: 3 days)
timezone = "America/Los_Angeles"      # IANA timezone (e.g. "UTC", "Europe/London")

# How often the neighbor graph is rebuilt
[server.intervals]
data_save = 300                       # seconds between graph rebuilds

# Node enrichment: ask other MeshInfo / Meshview deployments for the names of
# nodes we have positions/telemetry for but no local NODEINFO.
#
# Provider entry forms:
#   { kind = "meshview", url = "...", name = "...", days_active = 7 }   # Meshview bulk
#   "https://other.meshinfo.example/api/v1/nodes?ids={ids}"             # MeshInfo URL template
[server.enrich]
enabled = true
interval = 900                        # seconds between enrichment runs (±10% jitter applied)
providers = [
    { kind = "meshview", url = "https://meshview.bayme.sh/api/nodes", name = "baymesh", days_active = 7 },
]

# Network graph generation
[server.graph]
enabled = true
max_depth = 10                        # maximum hop depth for neighbor graph

# ─────────────────────────────────────────────────────────────────────────────
# MQTT Broker — Required
# Connects to an MQTT broker to receive Meshtastic mesh traffic.
# ─────────────────────────────────────────────────────────────────────────────

[broker]
enabled = true
host = "mqtt.meshtastic.org"
port = 1883
username = "meshdev"
password = "large4cats"
client_id_prefix = "meshinfo-dev"     # a random UUID is appended at startup

# MQTT topic subscriptions (wildcards supported)
topics = [
  "msh/US/CA/SacValley/#",
  "msh/US/CA/sacvalley/#",
  "msh/US/CA/centralvalley/#",
  "msh/US/CA/sandiegocounty/#",
  "msh/US/CA/socalmesh/#",
]

# Tags applied to messages based on their topic prefix (used for filtering in the UI)
[[broker.topic_tags]]
prefix = "public/msh/"
tag = "public"
label = "Public MQTT"

[[broker.topic_tags]]
prefix = "msh/US/CA/centralvalley/"
tag = "centralvalley"
label = "Central Valley"

[[broker.topic_tags]]
prefix = "msh/US/CA/socalmesh/"
tag = "socalmesh"
label = "SoCalMesh"

[[broker.topic_tags]]
prefix = "msh/US/CA/sandiegocounty/"
tag = "sandiegocounty"
label = "San Diego County"

[[broker.topic_tags]]
prefix = "msh/US/CA/sacvalley/"
tag = "sacvalley"
label = "Sac Valley"

# Message decoders (at least one should be enabled)
[broker.decoders.protobuf]
enabled = true

[broker.decoders.json]
enabled = true

# ─────────────────────────────────────────────────────────────────────────────
# Channel Configuration
# ─────────────────────────────────────────────────────────────────────────────
# A channel id is a hash of the channel name and its PSK, not a slot number.
# Hashes below assume the default PSK (1PG7OiApB1nwvP+rz05pAQ==); a custom PSK or
# renamed channel produces different ones. Decoded uplinks carry a slot index (0-7);
# ingest re-files those by name (older rows: scripts/backfill_channel_buckets.py).
#
# To see which channels are active:
#   SELECT cm.channel_id, cc.name, COUNT(*) AS msgs
#   FROM chat_messages cm LEFT JOIN chat_channels cc ON cc.id = cm.channel_id
#   GROUP BY 1, 2 ORDER BY msgs DESC;
# ─────────────────────────────────────────────────────────────────────────────

[broker.channels]
# Which channels the Chat page shows (display only — ingest stores everything).
#   "presets" (default) — stock modem-preset channels only (LongFast, ...).
#   "all"     — presets plus human-named channels (regional, club, ...).
#   "manual"  — only what `display` and [[broker.channels.views]] list.
# Channels with no traffic in the selected time range drop off the bar.
mode = "presets"

# Only used when mode = "manual": channel hashes to show. These assume the
# default PSK — a custom PSK or renamed channel produces different hashes.
display = ["8", "31", "24", "15", "118", "119", "112", "110", "14"]

# Encryption keys for decoding channel traffic (base64-encoded)
[[broker.channels.encryption]]
key = "1PG7OiApB1nwvP+rz05pAQ=="
key_name = "Default"

# ─────────────────────────────────────────────────────────────────────────────
# Standard Meshtastic Preset Channel Hashes
# Computed from: XOR_bytes(channel_name) ^ XOR_bytes(PSK)
# These values assume the default PSK above. Names match firmware's display
# strings; the old sample spellings "LongModerate" and "VeryLongSlow" are still
# accepted by `preset =` as aliases (-> LongMod, -> LongFast).
# ─────────────────────────────────────────────────────────────────────────────

[broker.channels.meta.8]
label = "LongFast"
short = "LF"
preset = "LongFast"
description = "LongFast modem preset (default PSK hash: 8)"

[broker.channels.meta.31]
label = "MediumFast"
short = "MF"
preset = "MediumFast"
description = "MediumFast modem preset (default PSK hash: 31)"

[broker.channels.meta.24]
label = "MediumSlow"
short = "MS"
preset = "MediumSlow"
description = "MediumSlow modem preset (default PSK hash: 24)"

[broker.channels.meta.15]
label = "LongSlow"
short = "LS"
preset = "LongSlow"
description = "LongSlow modem preset (default PSK hash: 15)"

[broker.channels.meta.118]
label = "LongTurbo"
short = "LT"
preset = "LongTurbo"
description = "LongTurbo modem preset (default PSK hash: 118)"

[broker.channels.meta.119]
label = "ShortSlow"
short = "SS"
preset = "ShortSlow"
description = "ShortSlow modem preset (default PSK hash: 119)"

[broker.channels.meta.112]
label = "ShortFast"
short = "SF"
preset = "ShortFast"
description = "ShortFast modem preset (default PSK hash: 112)"

[broker.channels.meta.110]
label = "LongMod"
short = "LM"
preset = "LongMod"
description = "LongMod modem preset (default PSK hash: 110)"

[broker.channels.meta.14]
label = "ShortTurbo"
short = "ST"
preset = "ShortTurbo"
description = "ShortTurbo modem preset (default PSK hash: 14)"

# ─────────────────────────────────────────────────────────────────────────────
# Custom Channel Hashes
# Add entries here for private or regional channels your network monitors.
# Find the hash by querying your database (see comment at top of this section).
# ─────────────────────────────────────────────────────────────────────────────

# Example:
# [broker.channels.meta.42]
# label = "My Region"
# short = "MR"
# description = "Private channel for My Region mesh network"

# ─────────────────────────────────────────────────────────────────────────────
# Channel Views — tabs shown in the Chat UI
# Only single-channel views are supported. Views with no data are hidden.
# Chat uses these only when mode = "manual"; Nodes and Log always read them.
# ─────────────────────────────────────────────────────────────────────────────

[[broker.channels.views]]
id = "lf"
label = "LongFast"
short = "LF"
channels = ["8"]
default = true                        # shown by default in the UI

[[broker.channels.views]]
id = "mf"
label = "MediumFast"
short = "MF"
channels = ["31"]

# ─────────────────────────────────────────────────────────────────────────────
# Mesh Network Metadata — Required
# Describes your mesh network; shown in the web UI and announcements.
# ─────────────────────────────────────────────────────────────────────────────

[mesh]
name = "Central Valley Mesh"
shortname = "CVM"
description = "Serving Meshtastic to the California Central Valley and surrounding areas."
# Optional logo shown in the collapsed (slim) nav rail. Path or URL; falls back
# to the mesh name's first letter when empty. Drop a file in public/images and
# point here, e.g. "/images/logo.svg", or use a full https:// URL.
icon = ""
url = "https://CVME.sh"
contact = "https://CVME.sh"
country = "US"
region = "California"
metro = "Fresno, Modesto, Bakersfield"
latitude = 36.72
longitude = -119.78
altitude = 0                          # meters above sea level
timezone = "America/Los_Angeles"      # IANA timezone (e.g. "UTC", "Europe/London")

# Announce this MeshInfo instance to the mesh network discovery service
[mesh.announce]
enabled = true
interval = 60                         # minutes

# ─────────────────────────────────────────────────────────────────────────────
# Integrations — Optional
# ─────────────────────────────────────────────────────────────────────────────

# Reverse geocoding
[integrations.geocoding]
enabled = false
provider = "geocode.maps.co"

[integrations.geocoding."geocode.maps.co"]
api_key = "REPLACE_WITH_API_KEY"

# Discord bot for mesh notifications and live mesh bridge
[integrations.discord]
enabled = false
token = "REPLACE_WITH_TOKEN"
guild = "REPLACE_WITH_GUILD_ID"

# Live mesh-to-Discord bridge
# Forwards mesh text messages and position updates into Discord channels.
[integrations.discord.bridge]
enabled = false
aggregate_seconds = 5      # seconds to wait for additional gateways before posting
edit_window_seconds = 900  # posted embeds keep absorbing straggler gateway copies
                           # (as edits) this long; shorter windows re-post duplicates
# alert_channel = "1234567890123456789"  # Channel for node online/offline alerts (linked nodes only)

# Map mesh channels to Discord channel IDs for text messages.
# Key = wire channel name (case-sensitive, recommended) or a channel bucket id
# (hash / name-bucket number from /v1/channels). A bucket-id key pins one
# name+PSK domain and wins over a name key; a name key follows the channel
# across re-keys and also matches channels whose hash was never learned.
# Messages on unmapped channels are ignored.
[integrations.discord.bridge.channels]
# "LongFast" = "1234567890123456789"     # -> #longfast
# "MediumFast" = "1234567890123456790"   # -> #mediumfast
# "31" = "1234567890123456790"           # same, pinned to the default-PSK hash

# Same key rules for position updates. Only nodes flagged as "trackers" via
# /addtracker will have positions forwarded.
[integrations.discord.bridge.position_channels]
# "LongFast" = "1234567890123456791"     # positions -> #position-tracking

# Static map thumbnails for position tracking embeds.
# Renders map images server-side by fetching tiles and compositing them locally.
# No external "static map API" — just tile fetching from OSM or Mapbox.
# The clickable link always points to your MeshInfo map page.
# If mapbox is configured with a valid token, it is preferred; otherwise falls back to OSM.
[integrations.discord.bridge.maps]
provider = "none"  # "none", "osm", "mapbox"
                   # none    = no thumbnail, just a clickable link to your map
                   # osm     = OpenStreetMap tiles rendered server-side (no token needed)
                   # mapbox  = Mapbox tiles rendered server-side (requires access token)

# Mapbox configuration (only used when provider = "mapbox")
[integrations.discord.bridge.maps.mapbox]
access_token = ""
style = "mapbox/dark-v11"
# style = "mapbox/streets-v12"
# style = "mapbox/satellite-streets-v12"
# style = "mapbox/outdoors-v12"
# style = "mapbox/light-v11"

# ─────────────────────────────────────────────────────────────────────────────
# Land cover — Optional
# Per-pixel ITU-R clutter loss for the map's coverage and scan tools, sampled
# from pre-baked NLCD tiles. When tile_dir exists and enabled = true, the API
# mounts it at /tiles/landcover. Without a bake, the frontend falls back to a
# default class everywhere — coverage still works, just less accurate.
#
# To populate tiles, run the one-time bake (idempotent, safe to re-run):
#   docker compose --profile bake run --rm landcover-bake
# See scripts/README-landcover.md for sub-region bakes, disk/time estimates,
# and the host-Python alternative. RF model details in RF-MODEL.md.
# ─────────────────────────────────────────────────────────────────────────────

[landcover]
enabled = true
tile_dir = "output/landcover"   # bind-mounted into the meshinfo container
source = "USGS NLCD 2024"       # surfaced in the map UI attribution chip

# ─────────────────────────────────────────────────────────────────────────────
# Canopy heights — Optional
# Per-pixel measured canopy heights for ITU-R P.833-9 path-integrated
# vegetation loss. Replaces class-nominal heights (15-20 m by class) with
# measurements from ETH Global Canopy Height 2020 (Lang et al. 2023, 10 m).
# When tile_dir exists and enabled = true, the API mounts it at /tiles/canopy.
# Without a bake, the frontend falls back to class-nominal heights.
#
# To populate tiles, run the one-time bake (idempotent, safe to re-run):
#   docker compose --profile bake run --rm canopy-bake
# See scripts/README-canopy.md for sub-region bakes, disk/time estimates,
# and the host-Python alternative.
# ─────────────────────────────────────────────────────────────────────────────

[canopy]
enabled = true
tile_dir = "output/canopy"      # bind-mounted into the meshinfo container
source = "ETH Global Canopy Height 2020"

# ─────────────────────────────────────────────────────────────────────────────
# Building heights — Optional
# Per-pixel measured building heights for ITU-R P.452-17 endpoint clutter and
# the ITM DSM along the propagation path. Replaces class-nominal heights
# (4/9/15/25 m for the four NLCD developed-intensity classes) with
# measurements from JRC GHS-BUILT-H ANBH (100 m global, CC-BY-4.0).
# When tile_dir exists and enabled = true, the API mounts it at /tiles/buildings.
# Without a bake, the frontend falls back to class-nominal heights.
#
# To populate tiles, run the one-time bake (idempotent, safe to re-run):
#   docker compose --profile bake run --rm building-bake
# See scripts/README-buildings.md for sub-region bakes, disk/time estimates,
# and the host-Python alternative.
# ─────────────────────────────────────────────────────────────────────────────

[buildings]
enabled = true
tile_dir = "output/buildings"   # bind-mounted into the meshinfo container
source = "JRC GHS-BUILT-H R2023A"

# ─────────────────────────────────────────────────────────────────────────────
# Live network coverage — Optional
# A server-baked raster tile pyramid of predicted RF reach across all positioned
# nodes (the same ITM model as the interactive Coverage tool). Baked by the
# standalone `coverage-worker` container into tile_dir and served at
# /tiles/coverage. Off by default — enable only when running the worker.
# ─────────────────────────────────────────────────────────────────────────────

[coverage]
enabled = false                 # then: docker compose --profile coverage up -d coverage-worker
tile_dir = "output/coverage"    # shared with the coverage-worker container
# Worker endpoint backing the map's hover lookup ("which nodes cover this point").
lookup_url = "http://coverage-worker:9301"
# Full guide (tuning, small hosts, troubleshooting): frontend/coverage-worker/README.md

# ─────────────────────────────────────────────────────────────────────────────
# UI Customization — Optional
# External tools and node detail links shown in the web UI.
# ─────────────────────────────────────────────────────────────────────────────

# External tools shown in the web UI sidebar
[[mesh.tools]]
name = "Liam's Meshtastic Map"
url = "https://meshtastic.liamcottle.net"

[[mesh.tools]]
name = "MeshMap"
url = "https://meshmap.net"

[[mesh.tools]]
name = "Bay Mesh Explorer"
url = "https://meshview.bayme.sh"

[[mesh.tools]]
name = "HWT Path Profiler"
url = "https://heywhatsthat.com/profiler.html"

# "Elsewhere" links shown on node detail pages
# URLs support {node_id_hex} and {node_id_int} placeholders
[[mesh.elsewhere_links]]
name = "Bay Mesh Explorer"
url = "https://meshview.bayme.sh/node/{node_id_int}"

[[mesh.elsewhere_links]]
name = "Liam's Map"
url = "https://meshtastic.liamcottle.net/?node_id={node_id_int}"

[[mesh.elsewhere_links]]
name = "MeshMap"
url = "https://meshmap.net/#{node_id_int}"