2GT-RichandClaude Opus 5
98a72e1f7a
Closes #112. Source stays `docs/*.md`, rendered by MkDocs-Material and published to GitHub Pages by Actions. Same repository on purpose: documentation drifts, and co-location is the only thing that reliably prevents it — the pull request that changes behaviour changes the description, and review sees both. A separate repo would double the ceremony and guarantee divergence. The markdown remains readable when browsing the repository, so the site renders those files rather than replacing them. **Versioned from the start**, using mike. Images are published to GHCR and this project ships betas most days, so readers are routinely running something other than the newest build; a single "latest" would confidently describe a release they do not have. Versions follow the product rather than the docs, so the site and the running image carry the same number. **Content came first, and it had to.** The docs were eleven days and sixteen releases stale — SSH keys, bulk commands, the data-cap SMS, poller health and the timezone setting appeared in exactly zero files between them. Publishing that would have given documentation missing five of the most consequential features a polished, authoritative home, and a well-presented wrong answer is worse than an obviously rough one. Four pages now cover them: - cellular.md — signal grading, carrier aggregation, the uplink anchor, observed bands, and the data-cap SMS including why it fires early and how to calibrate the margin - ssh-keys.md — leading with what installing a key costs, because RouterOS disables password SSH for that user and the database becomes load-bearing - commands.md — why waves exist, and why reading output matters when RouterOS reports failure in text rather than an exit code - scaling.md — headroom, why it is insufficient on its own, and every tunable Pull requests build the site with `--strict`, which turns warnings into errors. That is the point of running it there at all, and it earned itself immediately: the first build failed on two links to the project README, which sits outside the docs tree. They are absolute now, so they resolve both in the rendered site and when reading the markdown on GitHub. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
31 lines
1.9 KiB
Markdown
31 lines
1.9 KiB
Markdown
# MikroTik Manager documentation
|
|
|
|
Reference material for people already running the platform. If you are still deciding
|
|
whether to try it, the [project README](https://github.com/2GT-Media-Group-LLC/mikrotik-manager/blob/main/README.md) is the better starting point.
|
|
|
|
| Document | Covers |
|
|
|---|---|
|
|
| [Configuration](configuration.md) | Environment variables, secret management and key rotation |
|
|
| [Change Guard and Config Health](change-guard.md) | How the safety system works, its settings, and what to expect when it fires |
|
|
| [Alerting](alerting.md) | Alert rules, delivery channels, webhooks, scheduled reports, maintenance windows |
|
|
| [Single sign-on (OIDC)](sso-oidc.md) | Identity provider setup, group-to-role mapping, break-glass behaviour |
|
|
| [CAPsMAN](capsman.md) | How centrally provisioned access points are modelled, and current limits |
|
|
| [Cellular (LTE)](cellular.md) | Signal, carriers, tower movement, and the data-cap reset SMS |
|
|
| [SSH keys](ssh-keys.md) | Per-device keypairs, rotation, and what installing one costs |
|
|
| [Bulk commands](commands.md) | Running one command across a fleet, in waves |
|
|
| [Polling and scaling](scaling.md) | Poller health, headroom, tuning, and clearing a backlog |
|
|
| [API and automation](api.md) | Scoped tokens, authentication, and driving the platform from scripts |
|
|
| [Architecture](architecture.md) | How the system is put together, for contributors |
|
|
|
|
## Conventions used here
|
|
|
|
- **Settings in the UI** are stored in the database and apply without a restart.
|
|
- **Environment variables** live in `.env` and require a container restart to change.
|
|
- Anything described as *read-only* makes no writes to your devices.
|
|
|
|
## Which version is this?
|
|
|
|
These pages describe a specific release, shown in the header. The platform ships
|
|
frequently, so if something here does not match what you see, check that the version you
|
|
are running matches the version you are reading.
|