12 Commits
Author SHA1 Message Date
MrAlders0n 90de9d5cb0 Document My Atlas 2026-10-12 13:18:26 -04:00
MrAlders0n 8336bf3163 docs(meshmapper): document API key setup (#14) 2026-10-06 17:30:26 -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 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
MrAlders0n b02d20465a fix: github workflow, post images publically 2026-06-20 13:18:46 -04:00
MrAlders0n 2beae4af3a Inital Docs Updated 2026-06-09 16:37:06 -04:00
n30nex 5667c64253 Add Clanker thoughts section to README
Signed-off-by: n30nex <blushellneon@outlook.com>
2026-05-22 23:12:13 -04:00
Chris b7d2924f48 Refactor documentation: separate API contract into its own file and update references 2026-05-21 13:13:33 -04:00
Chris f5da62d6a0 Updated docs 2026-05-21 09:12:41 -04:00
MrAlders0n d8b29b5bfc Initial commit 2026-05-20 19:04:05 -04:00