dandri/beacon-server
1
0
Fork 0
mirror of https://github.com/MeshCore-Beacon/beacon-server.git synced 2026-08-29 07:08:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update for v1.6.0

Browse Source
This commit is contained in:
Enot (ded) Skelly
2026-07-24 13:40:57 -07:00
parent 201cd9e364
commit 3799242bce
2 changed files with 33 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+24 -4
View File
@@ -103,6 +103,13 @@ deployment `resolvedPath` will show `"confidence": "none"` for all hops and
arrives and populates `node_short_ids`. This is expected behaviour — resolution
improves automatically as the mesh is observed over time.
Similarly, GRP_TXT packets whose channel key isn't yet known at ingest time are
stored as hash-only, undecrypted rows. Adding the channel's key to `config.yaml`
doesn't retroactively decrypt that history immediately — it's picked up
automatically on the next restart, when Beacon scans for undecrypted packets
matching a now-known channel and decrypts them. Watch the startup log for
`backfilled N previously-undecrypted channel message(s)`.
---
## Configuration
@@ -129,11 +136,15 @@ improves automatically as the mesh is observed over time.
```yaml
# Optional IATA overrides — auto-created on first packet arrival,
# only needed if you want to customise display name or coordinates.
# borderFile points to a GeoJSON Feature (Polygon or MultiPolygon) for the
# region border map feature; relative paths resolve against this config
# file's own directory. Validated at boot — invalid geometry fails startup.
iatas:
YVR:
name: Vancouver International
lat: 49.1967
lng: -123.1815
borderFile: borders/yvr.geojson # optional
# Super-regions grouping multiple IATAs.
regions:
@@ -187,6 +198,12 @@ presence:
websocket:
max_connections_per_ip: 5 # default: 5
# Node staleness, deletion, and clock-drift thresholds.
nodes:
stale_threshold: 24h # mark a node "stale" in the API after this long unseen (default: 24h)
delete_after: 720h # delete a node entirely after this long unseen (default: 30 days, same default as packets.retention)
clock_drift_threshold: 5m # |device clock - server clock| above which clockOutOfSync=true for a repeater/room server (default: 5m)
# Redis caching layer (optional).
# Caches read-heavy, slow-changing responses to reduce PostgreSQL load.
# Connection details (address, password, database) are set via environment
@@ -212,8 +229,8 @@ ingest:
```
IATAs are auto-created on first packet arrival. The config file adds display
names and coordinates. Regions and channel keys must be defined here — they are
not auto-created.
names, coordinates, and optional region borders. Regions and channel keys
must be defined here — they are not auto-created.
---
@@ -366,9 +383,10 @@ Not yet implemented — see the Authentication section above.
| `GET` | `/channels/{id}/messages` | List messages for a channel (optional: `?since=<ms>&iata=<code>&limit=50`) |
| `GET` | `/iatas` | List all known IATA codes |
| `GET` | `/iatas/{iata}` | Get a single IATA code |
| `GET` | `/iatas/{iata}/border` | Get an IATA's GeoJSON region border, if configured (204 if not) |
| `GET` | `/messages` | List all messages (optional: `?channelId=<int>&channelHash=<hex>&iata=<code>&since=<ms>&limit=50`) |
| `GET` | `/messages/backfill` | Backfill messages after a given message ID |
| `GET` | `/nodes` | List nodes |
| `GET` | `/nodes` | List nodes (optional: `?pubkeyPrefix=<hex>&neighbors&iatas=<codes>&pubkey=<hex>`) |
| `GET` | `/nodes/{nodeId}` | Get node detail |
| `GET` | `/nodes/{nodeId}/neighbors` | List neighboring nodes observed in the mesh |
| `GET` | `/nodes/{nodeId}/observations` | List observations for a node |
@@ -376,7 +394,7 @@ Not yet implemented — see the Authentication section above.
| `GET` | `/observers/{observerId}` | Get observer detail including broker last-seen timestamps |
| `GET` | `/observers/{observerId}/adverts` | Adverts heard by observer |
| `GET` | `/observers/{observerId}/telemetry` | Observer telemetry history (optional: `?range=24h&interval=1h\|6h\|24h`) |
| `GET` | `/packets` | List packets with filters |
| `GET` | `/packets` | List packets (optional: `?payloadTypes=<csv>&routeTypes=<csv>&scopes=<csv>` accept plural, comma-separated values alongside the singular params) |
| `GET` | `/packets/backfill` | Backfill packets after a given observation ID |
| `GET` | `/packets/{packetHash}` | Get packet with all observations |
| `GET` | `/regions` | List all regions (summary) |
@@ -390,8 +408,10 @@ Not yet implemented — see the Authentication section above.
| `GET` | `/stats/overview` | Network overview stats |
| `GET` | `/stats/payload-breakdown` | Observation counts by payload type (last 24h by default) |
| `GET` | `/stats/scopes` | Configured region scopes and breakdown of packets, nodes, observers |
| `GET` | `/stats/top-advertisers` | Top N nodes by distinct ADVERT packet count (last 24h by default, from materialized view) |
| `GET` | `/stats/top-nodes` | Top N nodes by observation count (from materialized view) |
| `GET` | `/stats/top-observers` | Top N observers by observation count (last 24h by default) |
| `GET` | `/stats/top-talkers` | Top N companion names by decrypted channel message count (last 24h by default, from materialized view) |
| `GET` | `/traces` | List trace tags with filters (optional: ?type=TRACE\|PING) |
| `GET` | `/traces/{tag}` | Get full trace detail with resolved routes |
config.yaml.example
+9
View File
@@ -6,6 +6,9 @@ iatas:
name: Vancouver International
lat: 49.1967
lng: -123.1815
# borderFile: borders/yvr.geojson # optional GeoJSON Feature (Polygon/MultiPolygon)
# # for the region border map; path is relative to
# # this file's directory; validated at boot.
YYJ:
name: Victoria International
lat: 48.6469
@@ -75,6 +78,12 @@ packets:
websocket:
max_connections_per_ip: 5 # default: 5
# Node staleness, deletion, and clock-drift thresholds.
#nodes:
# stale_threshold: 24h # default: 24h
# delete_after: 720h # default: 30 days, same default as packets.retention
# clock_drift_threshold: 5m # default: 5m
# CORS configuration.
# Controls which origins, methods and headers are allowed for cross-origin requests.
# Defaults to allowing all origins with GET/HEAD/OPTIONS if omitted — appropriate