Documentation

Documentation

Eleven guides (numbered 01–11 in the repo). Start with Installation and User guide, then use the sections below as you need them.

How to use this documentation

New users: Installation → User guide. That covers getting the app running, the setup wizard, layout, and daily use.

Customising: Configuration (config file reference) and Modules (what each module does). Docker only if you deploy with containers.

Problems or privacy: Debugging (logs, APRS issues), Telemetry (what is sent, opt-out), Third-party (optional network services).

Developers: Architecture and Creating a module. Feature requests for ideas and bugs.

All guides

Getting started

01 — Installation — Core installers, GitHub + installer, manual install, service mode; Docker points to 05.
02 — User guide — Run at logon, setup wizard, menu, layout, modules, telemetry pointer, APRS overview.

Reference & deployment

03 — Configuration — glancerf_config.json keys and environment variables.
04 — Modules — Built-in modules, structure, map overlays, API routes.
05 — Docker — Hub image, run options, volumes, maintainer publishing.

Troubleshooting & transparency

06 — Debugging — Log levels, log files, APRS debug, cache and WebSocket notes.
07 — Telemetry — Anonymous data, opt-out in Setup.
08 — Third-party and services — CDNs, map tiles, APIs, optional network use.

Developers & community

09 — Architecture — Repo layout, servers, routes, WebSocket.
10 — Creating a module — Custom modules under _custom/.
11 — Feature requests — Requested features and how to suggest more.