docs: update documentation for v9.7.2 — setup CLI, navigation, UI scale
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
Jason Staack
@@ -1,6 +1,6 @@
|
||||
# TOD - The Other Dude: User Guide
|
||||
|
||||
Managed Service Provider (MSP) fleet management platform for MikroTik RouterOS devices.
|
||||
Fleet management platform for MikroTik RouterOS devices.
|
||||
|
||||
---
|
||||
|
||||
@@ -28,51 +28,43 @@ You can always add more organizations and devices later from the sidebar.
|
||||
|
||||
## Navigation
|
||||
|
||||
TOD uses a collapsible sidebar with four sections. Press `[` to toggle the sidebar between expanded (240px) and collapsed (48px) views. On mobile, the sidebar opens as an overlay.
|
||||
TOD uses a collapsible sidebar organized into task-based sections. Press `[` to toggle the sidebar between expanded (240px) and collapsed (48px) views. On mobile, the sidebar opens as an overlay.
|
||||
|
||||
### Fleet
|
||||
The sidebar footer contains the theme toggle (dark/light), connection status indicator, logout button, and UI scale selector. For super_admin users, the tenant selector is in the sidebar header.
|
||||
|
||||
### Operate
|
||||
|
||||
| Item | Description |
|
||||
|------|-------------|
|
||||
| **Dashboard** | Overview of your fleet with device status cards, active alerts, metrics sparklines, and "APs Needing Attention" wireless health card. The landing page after login. |
|
||||
| **Overview** | Overview of your fleet with device status cards, active alerts, metrics sparklines, and "APs Needing Attention" wireless health card. The landing page after login. |
|
||||
| **Devices** | Fleet table with search, sort, and filter. Click any device row to open its detail page. |
|
||||
| **Sites** | Tower and site management -- organize devices by physical location with sectors, health monitoring, wireless links, and site-scoped alerts. |
|
||||
| **Wireless Links** | Fleet-wide view of all discovered AP-to-CPE wireless connections with signal, CCQ, TX/RX rates, and link state. |
|
||||
| **Alerts** | Live alert feed with filtering by severity (info, warning, critical) and acknowledgment actions. |
|
||||
| **Wireless** | Fleet-wide view of all discovered AP-to-CPE wireless connections with signal, CCQ, TX/RX rates, and link state. |
|
||||
| **Map** | Geographic fleet map with status-colored markers and automatic clustering. Devices with coordinates appear on the map; clusters reflect aggregate health (green = all online, red = all offline, amber = mixed). |
|
||||
|
||||
### Manage
|
||||
### Act
|
||||
|
||||
| Item | Description |
|
||||
|------|-------------|
|
||||
| **Config Editor** | Browse and edit RouterOS configuration paths in real-time. Select a device from the header dropdown. |
|
||||
| **Batch Config** | Apply configuration changes across multiple devices simultaneously using templates. |
|
||||
| **Bulk Commands** | Execute RouterOS CLI commands across selected devices in bulk. |
|
||||
| **Config** | Browse and edit RouterOS configuration paths in real-time. Select a device from the header dropdown. |
|
||||
| **Templates** | Create and manage reusable configuration templates. |
|
||||
| **Firmware** | Check for RouterOS updates and schedule firmware upgrades across your fleet. |
|
||||
| **Maintenance** | Schedule maintenance windows to suppress alerts during planned work. |
|
||||
| **VPN** | WireGuard VPN tunnel management -- create, deploy, and monitor tunnels between devices. |
|
||||
| **Commands** | Execute RouterOS CLI commands across selected devices in bulk. |
|
||||
|
||||
### Low-Frequency (bottom of sidebar)
|
||||
|
||||
| Item | Description |
|
||||
|------|-------------|
|
||||
| **Organizations** | Create and manage tenants for multi-tenant operation. Each tenant's data is fully isolated -- users in one organization cannot see another's devices or data. |
|
||||
| **Certificates** | Internal Certificate Authority management -- generate, deploy, and rotate TLS certificates for your devices. |
|
||||
### Monitor
|
||||
|
||||
| Item | Description |
|
||||
|------|-------------|
|
||||
| **Topology** | Interactive network map showing device connections and shared subnets, with automatic layout for readability. |
|
||||
| **Alerts** | Live alert feed with filtering by severity (info, warning, critical) and acknowledgment actions. |
|
||||
| **VPN** | WireGuard VPN tunnel management -- create, deploy, and monitor tunnels between devices. |
|
||||
| **Alert Rules** | Define threshold-based alert rules on device metrics with configurable severity and notification channels. |
|
||||
| **Audit Trail** | Immutable, append-only log of all operations -- configuration changes, logins, user management, and admin actions. |
|
||||
| **Transparency** | KMS access event dashboard showing encryption key usage across your organization (admin only). |
|
||||
| **Maintenance** | Schedule maintenance windows to suppress alerts during planned work. |
|
||||
| **Settings** | System configuration and profile settings. |
|
||||
| **Audit Log** | Immutable, append-only log of all operations -- configuration changes, logins, user management, and admin actions. |
|
||||
| **Reports** | Generate and export PDF reports: fleet summary, device health, compliance, and SLA. |
|
||||
|
||||
### Admin
|
||||
|
||||
| Item | Description |
|
||||
|------|-------------|
|
||||
| **Users** | User management with role-based access control (RBAC). Assign roles: super_admin, admin, operator, viewer. |
|
||||
| **Organizations** | Create and manage tenants for multi-tenant MSP operation. Each tenant's data is fully isolated — users in one organization cannot see another's devices or data. |
|
||||
| **API Keys** | Generate and manage programmatic access tokens (prefixed `mktp_`) with operator-level permissions. |
|
||||
| **Settings** | System configuration, theme toggle (dark/light), and profile settings. |
|
||||
| **About** | Platform version, feature summary, and project information. |
|
||||
|
||||
---
|
||||
|
||||
## Keyboard Shortcuts
|
||||
@@ -227,15 +219,17 @@ Device credentials (RouterOS username/password) are encrypted at rest and only d
|
||||
|
||||
---
|
||||
|
||||
## Theme
|
||||
## Theme & UI Scale
|
||||
|
||||
TOD supports dark and light modes:
|
||||
|
||||
- **Dark mode** (default) uses the Midnight Slate palette.
|
||||
- **Light mode** provides a clean, high-contrast alternative.
|
||||
- Toggle in **Settings** or let the portal follow your system preference.
|
||||
- Toggle using the theme button in the **sidebar footer**, or let the portal follow your system preference.
|
||||
- The command palette and all UI components adapt to the active theme.
|
||||
|
||||
A **UI scale selector** is available in the sidebar footer with three options: 100%, 110%, and 125%. This adjusts the base font size and layout density across the entire interface. Your preference is saved per browser.
|
||||
|
||||
---
|
||||
|
||||
## Tower & Site Management
|
||||
@@ -244,7 +238,7 @@ Sites represent physical locations in your network -- towers, rooftops, equipmen
|
||||
|
||||
### Creating a Site
|
||||
|
||||
1. Navigate to **Fleet > Sites** in the sidebar.
|
||||
1. Navigate to **Sites** in the sidebar.
|
||||
2. Click **New Site**.
|
||||
3. Fill in the site details:
|
||||
- **Name** (required) -- a descriptive label for the location (e.g., "North Ridge Tower").
|
||||
@@ -315,7 +309,7 @@ Link states transition automatically based on poll results and missed-poll count
|
||||
|
||||
There are two ways to view wireless links:
|
||||
|
||||
- **Fleet-wide**: Navigate to **Fleet > Wireless Links** in the sidebar. This shows all discovered links across your organization, filterable by state (active, degraded, down, stale).
|
||||
- **Fleet-wide**: Navigate to **Wireless** in the sidebar. This shows all discovered links across your organization, filterable by state (active, degraded, down, stale).
|
||||
- **Per-site**: Open a site detail page and switch to the **Links** tab. This shows only the links associated with devices assigned to that site.
|
||||
|
||||
Both views group links by AP device. Each CPE row shows signal strength (dBm), CCQ percentage, TX/RX data rates, link state, and time since last seen.
|
||||
@@ -361,7 +355,7 @@ Alert events appear in the site's Alerts tab with timestamps, severity, the trig
|
||||
|
||||
The fleet map provides a geographic view of all devices that have coordinates assigned (either directly on the device or inherited from their site).
|
||||
|
||||
- Navigate to **Fleet > Map** in the sidebar.
|
||||
- Navigate to **Map** in the sidebar.
|
||||
- Devices appear as color-coded markers: **green** for online, **red** for offline.
|
||||
- When devices are geographically close, they automatically cluster into numbered circles. Cluster color reflects aggregate health: green if all devices in the cluster are online, red if all are offline, and amber if mixed.
|
||||
- Click a cluster to zoom in and see individual markers. Click a device marker to see its status summary and link to its detail page.
|
||||
|
||||
Reference in New Issue
Block a user