dandri/Beacon-Docs
1
0 Fork 0
mirror of https://github.com/MeshCore-Beacon/beacon-docs.git synced 2026-10-23 16:52:25 +00:00
Code Issues Packages Projects Releases Wiki Activity
56 Commits 4 Branches 0 Tags
4566bdf99e2830659df2cfb730afdc07bb9d9fee
Commit Graph
56 Commits
This Branch
This Branch
All Branches
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 2d4d257bba Document the 1000-value cap on list params (#33) 2026-10-19 19:47:06 -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 096a463fcc Document the small-table upgrade, observers/channels repack and rollback (#29) 2026-10-19 08:30:22 -04:00
MrAlders0n 30ea3d2720 Document database pools, cost guards, metrics and statement statistics (#28) 2026-10-19 07:53:18 -04:00
MrAlders0n 86b5a611b3 Docs for route retention and reconfirm rework (#27) 
* Document route hop index pre-build, route maintenance changes and keyset reindex

* Profiler extra sample fires on route retention
 2026-10-19 05:39:42 -04:00
MrAlders0n 0635bd674e Document Postgres tuning, migration lock waits, 64-bit cursors and the /info directory check (#26) 2026-10-19 04:02:49 -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 9de500cfa5 docs: PRs target dev in every repo, docs included (#24) 2026-10-16 10:34:12 -04:00
MrAlders0n 541bc238a9 My Atlas: document drag reorder and the Heard by flip 2026-10-12 13:50:26 -04:00
MrAlders0n 90de9d5cb0 Document My Atlas 2026-10-12 13:18:26 -04:00
MrAlders0n 7c1dff6fed docs: document MeshMapper repeater import and node detail meshmapper field (#23) 2026-10-11 12:41:09 -04:00
MrAlders0n 27319994ea Merge pull request #21 from MeshCore-Beacon/dev 
docs: sync dev to main (web.min_web_version and batched route search)
 2026-10-09 23:07:54 -04:00
MrAlders0n 80d6ebbd0e docs(mobile): drop the default server from the privacy and support pages (#22) 
BEACON Mobile no longer ships with a built-in server; users add one on
first launch. Describe that, and stop naming a specific server.
 2026-10-09 23:07:36 -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 fd5f4bdae3 Merge main release history into dev 2026-10-09 22:50:13 -04:00
MrAlders0n 9e4298d589 docs: sync dev to main (/info and mobile.min_app_version) (#19) 
* chore: add .github/CODEOWNERS for main branch policy

Signed-off-by: MrAlders0n <MrAlders0n@smal.ca>

* chore: add .github/workflows/main-source-guard.yml for main branch policy

Signed-off-by: MrAlders0n <MrAlders0n@smal.ca>

* docs(meshmapper): document API key setup (#14)

* docs(observers): document directory pagination (#15)

* docs(mobile): add BEACON Mobile privacy policy and support page (#16)

* 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

---------

Signed-off-by: MrAlders0n <MrAlders0n@smal.ca>
 2026-10-06 21:56:54 -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 80a277decb docs(mobile): add BEACON Mobile privacy policy and support page (#16) 2026-10-06 17:30:26 -04:00
MrAlders0n 7ed231e0ec docs(observers): document directory pagination (#15) 2026-10-06 17:30:26 -04:00
MrAlders0n 8336bf3163 docs(meshmapper): document API key setup (#14) 2026-10-06 17:30:26 -04:00
MrAlders0n ee088b5dfa docs(mobile): add BEACON Mobile privacy policy and support page (#16) 2026-10-06 15:19:37 -04:00
MrAlders0n 791417368b docs(observers): document directory pagination (#15) 2026-10-05 06:34:00 -04:00
MrAlders0n ccf67b1eea docs(meshmapper): document API key setup (#14) 2026-10-04 23:22:36 -04:00
MrAlders0n 5a60f1e00b chore: add .github/workflows/main-source-guard.yml for main branch policy 
Signed-off-by: MrAlders0n <MrAlders0n@smal.ca>
 2026-10-03 20:06:12 -04:00
MrAlders0n a17123af9f chore: add .github/CODEOWNERS for main branch policy 
Signed-off-by: MrAlders0n <MrAlders0n@smal.ca>
 2026-10-03 20:06:10 -04:00
MrAlders0n f0d5632ad9 chore: add .github/workflows/main-source-guard.yml for main branch policy 
Signed-off-by: MrAlders0n <MrAlders0n@smal.ca>
 2026-10-03 20:06:09 -04:00
MrAlders0n 006b2a876c chore: add .github/CODEOWNERS for main branch policy 
Signed-off-by: MrAlders0n <MrAlders0n@smal.ca>
 2026-10-03 20:06:07 -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 d325d986b7 docs(api): lookup status codes, route cursorId, activity coverage fields (#10) 2026-10-02 19:03:50 -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 e671ee45e9 docs(ws): document configure flags and includeRepeats (#6) 2026-09-27 20:38:59 -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 21c69267c5 Delete tickets directory 
Signed-off-by: MrAlders0n <55921894+MrAlders0n@users.noreply.github.com>
 2026-09-02 22:44:35 -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
MrAlders0n b02d20465a fix: github workflow, post images publically 2026-06-20 13:18:46 -04:00
Enot (ded) Skelly 0dc4971873 docs: update base config yaml file to match server example 2026-06-09 14:41:01 -07:00
Enot (ded) Skelly bc61e35ea3 docs: add redis config to example 2026-06-09 14:37:38 -07:00
MrAlders0n 2beae4af3a Inital Docs Updated 2026-06-09 16:37:06 -04:00
n30nex 870337e767 document map page architecture (#3) 2026-05-23 13:19:05 -04:00
n30nex 9352cb0f8f add initial server baseline thoughts (#2) 2026-05-22 23:16:59 -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
n30nex 7290f3e7eb add codex thoughts docs (#1) 2026-05-22 23:11:26 -04:00
Chris 133276c579 Enhance API contract documentation: add detailed descriptions and examples for PATH packet structure and decryption process 2026-05-22 09:33:19 -04:00