20 Commits
Author SHA1 Message Date
MrAlders0n 4566bdf99e Document the packet sites read model (#35)
* Document the packet sites read model

* List the region page differences; scope the sweep alerts to the writer
2026-10-20 00:18:37 -04:00
MrAlders0n 738af58ebe Document the channel message read model (#34) 2026-10-19 21:20:27 -04:00
MrAlders0n dc0383e0ca Document the observer adverts index and payload-type backfill (#32) 2026-10-19 19:18:50 -04:00
MrAlders0n b711a44548 Document exact page cursors and the 2.1 packets migrations (#31)
* Document exact page cursors and the 2.1 packets migrations

* Use EXISTS for the packets type check
2026-10-19 16:08:49 -04:00
MrAlders0n ca805e739b Document planguard, read-only mode and the daily plan check (#30) 2026-10-19 13:50:36 -04:00
MrAlders0n 30ea3d2720 Document database pools, cost guards, metrics and statement statistics (#28) 2026-10-19 07:53:18 -04:00
MrAlders0n 457fde14fd Document the 600 a minute API limit (#25)
Templates, contract, configuration, security and design docs now say 600.
Upgrading notes how to raise a pinned 300 and why the fail2ban flood jail
still sits above it.
2026-10-18 23:13:00 -04:00
MrAlders0n 7c1dff6fed docs: document MeshMapper repeater import and node detail meshmapper field (#23) 2026-10-11 12:41:09 -04:00
MrAlders0n 182010dbc6 docs: document web.min_web_version, batched route search and merge-commit releases (#20) 2026-10-09 23:05:49 -04:00
MrAlders0n 9d1dae3bf9 docs: document GET /info and mobile.min_app_version (#18)
* docs: document GET /info and mobile.min_app_version

* docs: match /info serverVersion and admin field to the server
2026-10-06 21:47:26 -04:00
MrAlders0n ccf67b1eea docs(meshmapper): document API key setup (#14) 2026-10-04 23:22:36 -04:00
MrAlders0n f2728b059b docs: reorganise into a deploy and operate front door (#12)
* docs: move design and API contract into docs/

* docs: add releases and versioning page

* docs: add configuration reference for server and web

* docs: add reverse proxy page

* docs: add upgrading page

* docs: add operations page and move backup and profiling docs

* docs: add getting packets in and security pages

* docs: add troubleshooting page

* docs(api): fold admin, activity, route and summary notes into the contract

* docs(deploy): add type 2 split deployment, finish the beacon rename, ignore secrets

* docs: rewrite README as the front door and share the contributor workflow

* docs: remove em dashes from prose and config comments

* docs: apply review fixes to type 2, upgrading, troubleshooting and first-run notes

* docs: fix upgrade order, restore steps, type 2 setup and contract details from review

* docs: keep the gitignore to deployment secrets and runtime state
2026-10-02 21:42:13 -04:00
MrAlders0n b38be34aad docs: web env vars, response shapes and 2.0.0 web review updates (#11) 2026-10-02 19:19:43 -04:00
MrAlders0n b0323b84b3 docs: update for Beacon 2.0.0 (#9)
Upgrade guide (fresh database, config changes that fail startup), nginx and
Caddy reverse proxy examples with X-Real-IP and trusted_proxies, a fixed
compose subnet, and the API contract and design doc brought up to date.
2026-10-02 16:53:36 -04:00
MrAlders0n 24d2e5fa01 docs(config): require scope regions and surface MeshMapper integrations (#8) 2026-09-30 22:12:15 -04:00
MrAlders0n 12997ae5ec docs: observer activity endpoint, airtime field rename, sustained-rate fail2ban jail (#4) 2026-09-10 07:18:33 -04:00
MrAlders0n ee19469633 Edge access logs, IP header hygiene, block lists, fail2ban jails 2026-09-02 22:25:01 -04:00
MrAlders0n 30c101d190 docs: REDIS_ADDR in env template, channel/trace IATA tables
The example .env never set REDIS_ADDR, so stacks built from it ran
with caching silently off. Also document the channels list IATA
filter and the new channel_iatas/trace_iatas tables.
2026-07-23 12:21:21 -04:00
Enot (ded) Skelly 0dc4971873 docs: update base config yaml file to match server example 2026-06-09 14:41:01 -07:00
MrAlders0n 2beae4af3a Inital Docs Updated 2026-06-09 16:37:06 -04:00