2GT-RichandClaude Opus 5
6c3d2aaa35
Neither area had a page, and both changed materially in v0.24.2/v0.24.3. The firmware page records why the pipeline downloads and verifies before rebooting, and what raising "at once" actually costs: halting becomes less precise, devices reboot together, and the upstream warning is conservative enough that its absence is not proof of safety. The backups page leads with the fact that a backup is /export text rather than a binary blob, since that is what makes preview and diff possible and what limits what a restore can do. It also states plainly that a backup and its Config History snapshot are one artifact, so deleting one removes the other's rollback. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
34 lines
2.2 KiB
Markdown
34 lines
2.2 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 |
|
|
| [Sites](sites.md) | Grouping devices into sites, switching between them, and what each site scopes |
|
|
| [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 |
|
|
| [Firmware rollouts](firmware.md) | Waves, the upgrade pipeline, and what upgrading several at once costs |
|
|
| [Backups](backups.md) | Finding, reading, comparing and deleting configuration backups |
|
|
| [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.
|