mirror of
https://github.com/Studio-Saelix/sencho.git
synced 2026-08-07 17:34:23 +00:00
Anso
a1804c8fbe
* docs: comprehensive review and refresh of all documentation pages Reviewed every doc page against the current app state after the v0.38 dashboard redesign. Updated content, fixed inaccuracies, and refreshed all screenshots at 1920x1080. Pages updated: - introduction: expanded feature list to 25 items across 6 subsections - quickstart: fixed docker run command (Docker Hub, auto JWT, COMPOSE_DIR) - configuration: replaced personal paths with generic /home/user/docker - sso-quickstart: fixed Settings navigation reference - sso: added SSO_LDAP_DISPLAY_NAME env var - overview: added 8 missing feature sections (labels, API tokens, schedules, etc.) - dashboard: complete rewrite for new health bar, gauges, stack health table - stack-management: updated for UP/DN indicators, rollback button, split actions - editor: rewritten for two-column layout, inline stats, embedded terminal - resources: updated Quick Clean docs, added network topology and inspect - app-store: updated categories, deploy sheet details, permission gate, settings - openapi.yaml: fixed YAML parsing error on line 1831 Screenshots refreshed: 14 images across 6 feature areas. * docs: review and update observability, console, multi-node, and compatibility pages - Global Observability: fix log format fields, add download button docs, split display limits into memory buffer vs rendered rows, correct settings labels - Host Console: remove internal implementation details per security docs policy, add stack directory behavior, expand header bar docs, remove unverified scrollback claim - Multi-Node: add Compose Directory field, document connection test details panel, fix edit/delete node behavior, simplify token security section, remove internal details - Node Compatibility: add missing self-update capability, remove internal endpoint paths and cache TTL, move from Features to Reference group in navigation - Refresh all screenshots for the redesigned UI (7 images) * docs: review and refresh fleet, remote updates, labels, alerts, routing, and webhooks pages - Fleet View: added node updates modal, container detail, version/update/critical badges, Tags filter - Remote Updates: removed internal details, added capability cross-link, fast polling - Stack Labels: three creation methods, two assignment methods, 10 colors, bulk actions screenshot - Alerts & Notifications: fixed metric labels, added notification popover detail, status banner - Notification Routing: HTTPS requirement, rule card layout, channel terminology fix - Webhooks: corrected license tier to Admiral, matched action labels to UI, removed internal security details, added local-only note - Troubleshooting: centralized entries from remote-updates, stack-labels, notification-routing - Refreshed all screenshots at 1920x1080, removed 11 orphaned images * docs: review and refresh RBAC, user management, and atomic deployments pages - RBAC: added missing Auditor role (5th role), updated permission matrix, fixed license tier references, documented username/password validation rules, self-deletion protection - Atomic Deployments: added "Which operations are protected" section covering webhooks/schedules/app store, removed internal backup path, fixed license tier to Skipper/Admiral - Screenshots: cropped to dialog element per updated strategic cropping guideline, removed 2 orphaned images * docs: review and refresh fleet-wide backups and audit log pages Update fleet-backups page to reflect current inline create form, add scheduled snapshots section, document the detail view and restore dialog, expand RBAC table to all five roles. Update audit log page to document expanded row detail fields, pagination, refresh button, and data retention screenshot. Replace all screenshots with fresh captures at 1920x720. * docs: review and refresh API tokens and private registries pages - API Tokens: clarify Full Admin scope, add Managing tokens section with card details, document revocation confirmation dialog, add usage tracking to security model, refresh screenshot - Private Registries: add Managing registries section with card details and action buttons, document edit behavior, fix URL auto-fill description, remove encryption algorithm name per security policy, fix grammar, refresh both screenshots * docs: review and refresh auto-update policies, scheduled operations, and SSO pages - Auto-Update Policies: document all 8 table columns, expand action buttons, add "All Stacks" wildcard option, fix field labels, add CSV export and pagination details, refresh screenshots - Scheduled Operations: fix System Prune target description, add Task List table columns, restructure create dialog fields with action-specific annotations, rewrite execution history with column table, refresh screenshots - SSO: remove encryption algorithm name per security policy, add LDAP and OIDC configuration field tables, document provider card controls (Save, Test Connection, Remove, Active badge), refresh screenshots - Move SSO troubleshooting entries to centralized troubleshooting page * docs: review and refresh licensing & billing page Update upgrade card feature lists to match actual tier gating (Skipper: fleet view, webhooks, labels, atomic deployments, backups, auto-update policies; Admiral: scoped RBAC, SSO, audit log, host console, API tokens, private registries, scheduled operations). Add flex layout to align upgrade card buttons at the bottom. Replace stale screenshot with fresh community and active license captures. Add feature breakdown subsection and profile menu billing shortcut to docs. * docs: review and refresh settings reference and security advisories pages Settings Reference: add 5 missing sections (SSO, API Tokens, Registries, Labels, Routing), expand Users from 2 to 5 roles, fix System Limits and Developer field labels to match UI, restructure Developer into Streaming and Data Retention sub-tables, update App Store and Support sections, refresh overview screenshot. Security Advisories: restructure into versioned sections (v0.25.x hardening and v0.19-v0.24 CVE remediation), expand from 3 bullet points to 10 specific improvements, fix GitHub URL from SaelixCode to AnsoCode, redact internal details per security docs policy. Remove "Sencho Pro" product name from all three pages, replaced with tier names (Community, Skipper, Admiral). * docs: review and refresh troubleshooting page, remove architecture and development guides - Rewrote forgotten password section to remove exposed SQL and table names - Updated all Settings navigation paths to Profile > Settings > X - Fixed network topology from "tab" to "view mode", added Pro license note - Updated Prune Networks to current "Prune Dead Networks" label - Corrected update check cooldown from vague to 2 minutes - Consolidated two network creation error sections into one - Removed hardcoded version reference (v0.34.0) - Replaced em dashes throughout - Deleted architecture.mdx (exposes internal implementation details) - Deleted development.mdx (contributor guide belongs in repo, not public docs) - Removed both pages from docs.json navigation * docs: review and refresh operations pages (backup, upgrade, self-hosting, troubleshooting) Backup & Restore: - Added missing encryption.key to all backup/restore procedures - Added Warning about restoring db without matching encryption key - Added cross-reference to Fleet-Wide Backups for paid tiers - Removed false claim about no built-in backup scheduler - Updated cron example to include encryption key copy Upgrading Sencho: - Removed internal migration details (table names, column specs, encryption algorithm) - Replaced with high-level migration summary per security docs policy - Added encryption.key to pre-upgrade backup command - Updated version pinning example from 0.25.3 to 0.38.0 - Added Remote Updates cross-reference for Skipper/Admiral users Self-Hosting Best Practices: - Removed JWT_SECRET from env var table (auto-generated, not an env var) - Removed PORT from env var table (hardcoded to 3000, not configurable) - Added API_RATE_LIMIT to env var table (actually exists in code) - Fixed listen port description from "configurable" to "fixed" - Updated resource recommendations based on measured footprint audit - Removed su-exec reference (internal implementation detail) - Upgraded data directory Note to Warning with file names Troubleshooting: - Fixed "Pro features" heading to "Paid features" with correct tier names
159 lines
6.8 KiB
Plaintext
159 lines
6.8 KiB
Plaintext
---
|
|
title: Fleet View
|
|
description: Monitor all your nodes from a single dashboard with real-time health metrics, search, filtering, and container drill-down.
|
|
---
|
|
|
|
The **Fleet** tab gives you a bird's-eye view of every node in your Sencho deployment, local and remote, on one screen. It is available to all tiers, with advanced features unlocked by Sencho Pro.
|
|
|
|
<Frame>
|
|
<img src="/images/fleet-view/fleet-overview.png" alt="Fleet Overview showing health summary cards, toolbar, node cards, and tabs" />
|
|
</Frame>
|
|
|
|
## Page layout
|
|
|
|
The Fleet page is divided into two tabs:
|
|
|
|
- **Overview** - the main monitoring view described on this page
|
|
- **Snapshots** - fleet-wide backup snapshots (covered in [Fleet Backups](/features/fleet-backups))
|
|
|
|
The header shows **Fleet Overview** with a subtitle summarising the current state (e.g. "2 of 2 nodes online, 31 containers, 21 stacks"). Two buttons sit in the top-right corner:
|
|
|
|
| Button | What it does |
|
|
|--------|--------------|
|
|
| **Check Updates** | Opens the Node Updates modal to view and apply Sencho version updates across your fleet (Pro) |
|
|
| **Refresh** | Re-fetches data from all nodes. Shows a spinner while loading |
|
|
|
|
## Community features
|
|
|
|
Every Sencho installation gets the full fleet monitoring grid at no cost.
|
|
|
|
### Node grid
|
|
|
|
Each node appears as a card showing:
|
|
|
|
| Data | Description |
|
|
|------|-------------|
|
|
| **Status badge** | Online (green) or Offline (grayed out) |
|
|
| **Type badge** | `local` or `remote` |
|
|
| **Version badge** | The node's Sencho version (e.g. `v0.38.0`). Remote nodes running older versions that cannot report their version show no version badge |
|
|
| **Update available badge** | Orange pill shown when a newer Sencho version is available for this node |
|
|
| **Critical badge** | Red pill shown when CPU or disk usage exceeds 90% |
|
|
| **Running containers** | Count of containers in `running` state |
|
|
| **Stopped containers** | Count of containers in `exited` state |
|
|
| **Stacks** | Total number of Compose stacks on the node |
|
|
| **CPU usage** | Current percentage with colour-coded bar (green to amber to red) |
|
|
| **RAM usage** | Used / total with percentage bar |
|
|
| **Disk usage** | Used / total with percentage bar |
|
|
|
|
Nodes with an available Sencho update also show an **Update to vX.Y.Z** button at the bottom of the card.
|
|
|
|
Offline nodes are visually dimmed and show a "Node unreachable" placeholder instead of stats.
|
|
|
|
### Manual refresh
|
|
|
|
Click the **Refresh** button in the top-right to re-fetch data from all nodes. The button shows a spinner while loading.
|
|
|
|
---
|
|
|
|
## Pro features
|
|
|
|
<Note>
|
|
The features below require a Sencho Pro license. Community users see an upgrade prompt in place of these controls.
|
|
</Note>
|
|
|
|
### Fleet health summary cards
|
|
|
|
Four cards appear above the node grid, aggregating data across all online nodes:
|
|
|
|
| Card | What it shows |
|
|
|------|---------------|
|
|
| **Containers** | Total running containers, with fleet-wide total in subtitle |
|
|
| **Fleet CPU** | Average CPU across all online nodes, plus which node has the highest load |
|
|
| **Fleet Memory** | Total RAM used / total available across the fleet |
|
|
| **Alerts** | Count of nodes with critical resource usage (CPU or disk above 90%). Card turns red when any exist |
|
|
|
|
### Auto-refresh
|
|
|
|
Fleet data automatically refreshes every 30 seconds. A subtle indicator at the bottom of the page confirms this is active. When a node update is in progress, the refresh rate increases to every 5 seconds so you can watch status changes in near real-time.
|
|
|
|
### Search
|
|
|
|
The search bar filters the node grid in real time. It matches against:
|
|
- Node names (e.g. typing `dev` shows only nodes with "dev" in the name)
|
|
- Stack names (e.g. typing `plex` shows only nodes that have a "plex" stack)
|
|
|
|
### Sorting
|
|
|
|
Use the sort dropdown to order nodes by:
|
|
- **Name** (alphabetical)
|
|
- **CPU Usage** (highest first)
|
|
- **Memory Usage** (highest first)
|
|
- **Containers** (most first)
|
|
- **Status** (online first)
|
|
|
|
Click the arrow button next to the dropdown to toggle ascending/descending.
|
|
|
|
Sort preferences are saved to your browser and persist across sessions.
|
|
|
|
### Filtering
|
|
|
|
Filter pills let you narrow the grid:
|
|
|
|
| Filter | Options |
|
|
|--------|---------|
|
|
| **Status** | All, Online, Offline |
|
|
| **Type** | All Types, Local, Remote |
|
|
| **Critical Only** | Show only nodes with CPU or disk above 90% |
|
|
| **Tags** | Filter by stack labels assigned to nodes |
|
|
|
|
A "Clear filters" button appears when filters hide all nodes.
|
|
|
|
### Stack drill-down
|
|
|
|
Click **Stack details** on any online node card to expand the stack list. The button shows the total stack count (e.g. "18 stacks"). Each stack in the list shows a container count badge.
|
|
|
|
Click a stack name to expand it further and see individual containers with:
|
|
- Container name
|
|
- State badge (running, exited, restarting)
|
|
- Image name (e.g. `linuxserver/plex:latest`)
|
|
- Uptime (e.g. "Up 4 days")
|
|
|
|
Hover over any container row to reveal an **Open in editor** button that navigates you directly to that stack's editor on the corresponding node.
|
|
|
|
<Frame>
|
|
<img src="/images/fleet-view/fleet-drill-down.png" alt="Fleet View with Stack details expanded showing the stack list and a container drill-down" />
|
|
</Frame>
|
|
|
|
### Critical node detection
|
|
|
|
Nodes with CPU or disk usage above 90% automatically receive a red **Critical** badge. Combined with the **Critical Only** filter, this lets you quickly triage overloaded servers.
|
|
|
|
### Node Updates
|
|
|
|
Click **Check Updates** in the header to open the Node Updates modal. This lets you manage Sencho version updates across your entire fleet from one place.
|
|
|
|
<Frame>
|
|
<img src="/images/fleet-view/fleet-node-updates.png" alt="Node Updates modal showing update status for all fleet nodes" />
|
|
</Frame>
|
|
|
|
The modal shows:
|
|
|
|
- **Summary cards** at the top: counts of nodes that are Up to date, have updates Available, are currently Updating, or have Failed
|
|
- **Gateway version** label showing your primary instance's version
|
|
- **Filter** search box to find specific nodes
|
|
- **Node table** with columns: Node name, Type, Current version, Latest version, and Status (either an "Up to date" badge or an "Update" button)
|
|
- **Recheck** button to re-scan for available updates
|
|
- **Update All** button to trigger updates on all remote nodes that have a pending update
|
|
|
|
When you click **Update** on a remote node, Sencho sends the update command and the node restarts with the new version. If you update the local node, a reconnection overlay appears while your primary instance restarts.
|
|
|
|
---
|
|
|
|
## How fleet data is fetched
|
|
|
|
Fleet View queries all registered nodes in parallel. Each node responds independently; one slow or offline node does not block the others. Local node data comes from the Docker socket and system stats directly. Remote node data is fetched over the Distributed API proxy using each node's Bearer token.
|
|
|
|
<Note>
|
|
Fleet View always runs on your primary (local) Sencho instance. It is never proxied through a remote node.
|
|
</Note>
|