-
-
Notifications
You must be signed in to change notification settings - Fork 16
Expand file tree
/
Copy pathconfig.toml.sample
More file actions
344 lines (285 loc) · 14.7 KB
/
config.toml.sample
File metadata and controls
344 lines (285 loc) · 14.7 KB
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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
# 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]
read_from = "postgres"
write_to = ["postgres"]
[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 via external data sources
[server.enrich]
enabled = true
interval = 900 # seconds between enrichment runs
provider = "world.meshinfo.network"
# 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
# ─────────────────────────────────────────────────────────────────────────────
# Meshtastic firmware 2.5+ identifies channels by a hash value derived from
# the channel name and PSK — not a slot index (0-7). The hashes below are
# computed for the default PSK (1PG7OiApB1nwvP+rz05pAQ==). If your network
# uses a custom PSK, your channel hashes will differ.
#
# To discover which channel hashes are active on your network, query your DB:
# SELECT channel_id, COUNT(*) as msgs FROM chat_messages
# GROUP BY channel_id ORDER BY msgs DESC;
# ─────────────────────────────────────────────────────────────────────────────
[broker.channels]
# Channel hashes to show in the UI. Channels with no data are hidden
# automatically — it is safe to list all presets here.
display = ["8", "31", "24", "15", "55", "119", "112", "9", "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. Verified against live traffic.
# ─────────────────────────────────────────────────────────────────────────────
[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.55]
label = "VeryLongSlow"
short = "VLS"
preset = "VeryLongSlow"
description = "VeryLongSlow modem preset (default PSK hash: 55)"
[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.9]
label = "LongModerate"
short = "LM"
preset = "LongModerate"
description = "LongModerate modem preset (default PSK hash: 9)"
[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.
# ─────────────────────────────────────────────────────────────────────────────
[[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."
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
# alert_channel = "1234567890123456789" # Channel for node online/offline alerts (linked nodes only)
# Map Meshtastic channel hashes to Discord channel IDs for text messages.
# Key = Meshtastic channel hash (from broker.channels.display), value = Discord channel ID.
# Messages on unmapped channels are ignored.
[integrations.discord.bridge.channels]
# "8" = "1234567890123456789" # LongFast -> #longfast
# "31" = "1234567890123456790" # MediumFast -> #mediumfast
# Map Meshtastic channel hashes to Discord channel IDs for position updates.
# Only nodes flagged as "trackers" via /addtracker will have positions forwarded.
[integrations.discord.bridge.position_channels]
# "8" = "1234567890123456791" # LongFast 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"
# ─────────────────────────────────────────────────────────────────────────────
# 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 = "Armooo's MeshView"
url = "https://meshview.armooo.net"
[[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://app.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 = "Armooo's MeshView"
url = "https://meshview.armooo.net/packet_list/{node_id_int}"
[[mesh.elsewhere_links]]
name = "Bay Mesh Explorer"
url = "https://app.bayme.sh/node/{node_id_hex}"
[[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}"