mirror of
https://github.com/Studio-Saelix/sencho.git
synced 2026-07-26 11:49:16 +00:00
Anso
bb35c1bc92
* feat: add sidebar update indicator toggle and Stack Health badge - Add image_update_sidebar_indicators setting (default off, node-scoped) - Gate the Updates filter chip and sidebar status indicators on the setting - Add "Update available" badge to Stack Health table (always visible) - Extend ImageUpdateStatus with sidebarIndicators boolean - Poll /api/image-updates/status alongside /detail in useImageUpdates - React to SENCHO_SETTINGS_CHANGED for instant toggle propagation - Reset sidebar state on node switch; generation-guard stale responses - Disable toggle when status is null (loading) or field is absent (old node) - Wire stackUpdates through ViewRouter → HomeDashboard → StackHealthTable - Update settings registry, operator docs, and sidebar/dashboard docs * fix: guard against stale node renders, memo drift, and cross-node error toasts - Track owning node ID in useImageUpdates state so React never renders node B with node A's data before the passive effect resets (P2) - Replace incorrect stackUpdates dependency with sidebarStackUpdates in chipFilteredFiles useMemo (P3) - Guard the error toast in handleSidebarIndicatorsChange so a stale PATCH failure from node A does not surface while viewing node B (P3) * fix: default sidebar update indicators to on (opt-out) The sidebar indicators are a safe convenience that most users want. Switching the default from off to on matches the opt-out convention used by prune_on_update, reclaim_hero, and health_gate_enabled.
182 lines
14 KiB
Plaintext
182 lines
14 KiB
Plaintext
---
|
||
title: Stack Sidebar
|
||
description: Manage, group, pin, and bulk-act on your stacks from the primary sidebar.
|
||
---
|
||
|
||
The stack sidebar is your command center for every stack on the active node. Stacks are grouped by label, frequently used stacks can be pinned to the top, search fans out across all connected remote nodes, bulk mode lets you act on several stacks at once, and an activity ticker at the bottom surfaces ongoing operations and recent events.
|
||
|
||
<Frame>
|
||
<img src="/images/sidebar/sidebar-overview.png" alt="Stack sidebar showing the Sencho logo with version tag, the NODE LOCAL node switcher, Create Stack button plus bulk mode and scan-folder icons, the Search stacks input, ALL/UP/DOWN/UPDATES filter chips, a starred PINNED group at top, label groups MEDIA and UTILITIES with stack rows each showing a status pill and label dots, and the activity ticker at the bottom reading LIVE VIEW STACK" />
|
||
</Frame>
|
||
|
||
## Layout
|
||
|
||
From top to bottom:
|
||
|
||
1. **Branding header** shows the Sencho logo and your build version. Hidden on mobile, where the status masthead carries the node context instead.
|
||
2. **Node switcher** selects which Sencho instance you are managing.
|
||
3. **Action row** holds **Create Stack**, the **Bulk mode** toggle (stacked-rows icon), and **Scan stacks folder** (folder-search icon). Only shown when you have permission to create stacks.
|
||
4. **Search** filters the stack list in real time. Typing into **Search stacks...** also fans out to connected remote nodes (see [Cross-node search](#cross-node-search)).
|
||
5. **Filter chips** narrow the list by status (described below).
|
||
6. **Stack list** shows your stacks organized into groups.
|
||
7. **Activity ticker** shows the highest-priority operation or event signal at any moment.
|
||
|
||
## Filter chips
|
||
|
||
Four chips sit below the search box. Each shows a live count to the right of its label, and counts above 99 render as **99+** to keep the row from overflowing.
|
||
|
||
- **All**: every stack on the node.
|
||
- **Up**: stacks that are running with nothing crashed. A stack whose only stopped container finished cleanly (an init job that exited without error) still counts as up.
|
||
- **Down**: stacks that need attention, whether fully stopped or running with at least one crashed container (the `PT` state described below).
|
||
- **Updates**: stacks with at least one image update available. The chip renders in orange when the count is non-zero so you can spot pending updates at a glance. The Updates chip and the trailing update indicators on stack rows are controlled by the Image Update Checks [sidebar setting](/reference/settings#image-update-checks---sidebar). When the setting is off, the chip and indicators are hidden.
|
||
|
||
<Frame>
|
||
<img src="/images/sidebar/sidebar-filter-chips.png" alt="Filter chip row showing ALL (15), Up (15), Down (0), and Updates (1) with the Updates chip highlighted in orange and a collapse toggle icon on the right" />
|
||
</Frame>
|
||
|
||
Click the **−** icon on the right to collapse the chip row when you need more vertical room; it becomes a **+** icon you click to bring the chips back. The collapsed state is remembered in your browser.
|
||
|
||
## Groups
|
||
|
||
Stacks are grouped by label. Groups are sorted by size (most populated first), then alphabetically. Stacks with multiple labels appear in every matching group so you always see the full fleet membership per label. Stacks without labels appear in an **Unlabeled** group at the bottom. Click a group header to collapse or expand it; the collapsed state is remembered per node.
|
||
|
||
## Cross-node search
|
||
|
||
When you type anything into **Search stacks...**, Sencho fans the query out to every connected remote node at the same time. Results from other nodes appear below the local list under an **Other nodes** section, separated by a dividing line.
|
||
|
||
<Frame>
|
||
<img src="/images/sidebar/sidebar-cross-node-search.png" alt="Sidebar with a search query showing local results in label groups, then a dividing line and an OTHER NODES section listing stacks from three remote nodes with their status pills and external-link arrows" />
|
||
</Frame>
|
||
|
||
Each reachable node shows its matching stacks with a status pill and an external-link arrow. Clicking a remote result switches the active node to that instance and opens the stack immediately.
|
||
|
||
If one or more nodes did not respond during the search, a collapsible warning row appears showing how many nodes were unreachable. Expand it to see which nodes failed and why.
|
||
|
||
## Pinning
|
||
|
||
Right-click a stack and choose **Pin to top**. Pinned stacks sit in a dedicated **★ PINNED** group at the very top of the list. Up to 10 stacks can be pinned per node; pinning an 11th evicts the oldest. Right-click a pinned stack and choose **Unpin** to remove it.
|
||
|
||
<Frame>
|
||
<img src="/images/sidebar/sidebar-pinned.png" alt="Sidebar with a starred PINNED group at the top containing plex, followed by the MEDIA group and other label groups below" />
|
||
</Frame>
|
||
|
||
## Stack rows
|
||
|
||
Each row gives you everything you need to read the stack at a glance, in a fixed column order:
|
||
|
||
- **Status pill** on the left. Two uppercase letters in mono type, or a spinner while a lifecycle action is in flight. `UP` (green) means the stack is running with nothing crashed. `DN` (red) means the stack is stopped. `PT` (amber) means the stack is partially running: at least one container is up and at least one has crashed (exited with an error, died, or is restart-looping). Hover the `PT` pill to see the running/total container count, such as `3/5 running`. A stack whose only stopped container finished cleanly stays `UP`.
|
||
- **Stack name** in mono type, truncated with an ellipsis when the row gets tight.
|
||
- **Label dots** to the right of the name. Up to three colored dots represent the stack's labels. If a stack carries more than three labels, a **+N** counter appears for the extras.
|
||
- **Trailing indicator** in its own fixed-width slot at the far right of the name area, showing the highest-priority signal present:
|
||
- Pulsing orange dot: an image update is available. Hover for the "Update available" tooltip.
|
||
- Muted circle-alert icon: the last registry check failed (registry unreachable, missing credentials, or rate-limited). Hover to read the failure reason.
|
||
- Git branch icon: a Git source update is pending and no image update is available.
|
||
- **Hover kebab** on the right edge. On desktop, hover the row to reveal a vertical three-dot menu that opens the same actions as right-clicking. On touch viewports the kebab is always visible.
|
||
|
||
<Frame>
|
||
<img src="/images/sidebar/sidebar-row-anatomy.png" alt="Four stack rows in the MEDIA group: bazarr (UP, purple label dot), plex (UP, purple label dot), radarr (UP, one label dot followed by an orange pulsing update indicator), and seerr (UP, purple label dot)" />
|
||
</Frame>
|
||
|
||
## Bulk mode
|
||
|
||
Click the **Bulk mode** icon next to **Create Stack** (or press <kbd>B</kbd>) to enter selection mode. A checkbox appears at the left of every row, and a sticky toolbar slides in just above the stack list:
|
||
|
||
- **Start**, **Stop**, **Restart** apply the action to every selected stack.
|
||
- **Update** pulls the latest images for every selected stack.
|
||
|
||
Click rows to toggle their selection. The toolbar header shows a running count. Click the **×** in the toolbar to clear the selection, and click the icon again (or press <kbd>B</kbd>) to leave bulk mode.
|
||
|
||
<Frame>
|
||
<img src="/images/sidebar/sidebar-bulk-mode.png" alt="Sidebar in bulk mode: the stacked-rows icon in the action row is highlighted in brand color, a sticky toolbar shows 2 selected with a clear X button and Start/Stop/Restart/Update action buttons, and every stack row has a checkbox visible with bazarr and sonarr checked" />
|
||
</Frame>
|
||
|
||
## Context menu
|
||
|
||
Right-click any stack (or open the kebab that appears on hover) for its context menu. Items are grouped by purpose:
|
||
|
||
- **Inspect**: **Alerts**, **Auto-Heal**, **Check updates**, and **Open App** (only appears when the stack is running and exposes a browser-reachable port).
|
||
- **Organize**: **Labels** opens a submenu listing every label on the node with a checkmark next to each one already assigned to this stack. Click any label to toggle it. The submenu also offers **New label** for inline creation (when you have edit permission and the node is under its label limit) and **Manage labels...** to open the full label settings. Below the Labels entry: **Pin to top** or **Unpin**.
|
||
- **Lifecycle**: **Deploy** (when stopped), **Stop**, **Restart**, **Update** (when running), and **Schedule task** (admin only, opens the Schedules view with this stack pre-selected).
|
||
- **Destructive**: **Delete** (only shown when you have permission to delete this stack).
|
||
|
||
<Note>
|
||
Configuring **Auto-Heal** policies (add, toggle, delete) requires an **admin** role. **Schedule task** also requires an **admin** role.
|
||
</Note>
|
||
|
||
<Frame>
|
||
<img src="/images/sidebar/sidebar-context-menu.png" alt="Right-click context menu on a running stack with four labeled sections: INSPECT with Alerts, Auto-Heal, Check updates, and Open App; ORGANIZE with Labels (submenu arrow) and Pin to top; LIFECYCLE with Stop, Restart, Update, and Schedule task; and DESTRUCTIVE with Delete in red" />
|
||
</Frame>
|
||
|
||
## Keyboard shortcuts
|
||
|
||
Shortcuts fire on the currently selected stack. They are blocked while a text input is focused or the global command palette is open.
|
||
|
||
### Lifecycle
|
||
|
||
| Shortcut | Action | Condition |
|
||
|----------|--------|-----------|
|
||
| <kbd>Ctrl</kbd>+<kbd>Enter</kbd> | Deploy | Stack is stopped |
|
||
| <kbd>Ctrl</kbd>+<kbd>.</kbd> | Stop | Stack is running |
|
||
| <kbd>Ctrl</kbd>+<kbd>R</kbd> | Restart | Stack is running |
|
||
| <kbd>Ctrl</kbd>+<kbd>↑</kbd> | Update images | Stack is running |
|
||
| <kbd>Ctrl</kbd>+<kbd>Backspace</kbd> | Delete | Stack exists |
|
||
|
||
On macOS, use <kbd>Cmd</kbd> in place of <kbd>Ctrl</kbd>.
|
||
|
||
### Inspect and organize
|
||
|
||
| Key | Action |
|
||
|-----|--------|
|
||
| <kbd>A</kbd> | Open the alerts sheet |
|
||
| <kbd>H</kbd> | Open the auto-heal sheet |
|
||
| <kbd>U</kbd> | Check for image updates |
|
||
| <kbd>P</kbd> | Pin or unpin the stack |
|
||
| <kbd>B</kbd> | Toggle bulk mode |
|
||
|
||
## Activity ticker
|
||
|
||
The ticker evaluates a priority cascade on each tick and shows the highest-priority signal available:
|
||
|
||
| Priority | Condition | Dot | Kicker |
|
||
|----------|-----------|-----|--------|
|
||
| 1 | A lifecycle operation is in flight | Brand, pulsing | `LIVE · STREAMING` |
|
||
| 2 | An unread stack error occurred in the last 24h | Red | `ALERT · VIEW LOGS →` |
|
||
| 3 | A stack event occurred in the last hour | Brand | `LIVE · VIEW STACK →` |
|
||
| 4 | An auto-update run is scheduled (and no recent event) | Amber | `AUTOMATION · OPEN SCHEDULE →` |
|
||
| 5 | The notification WebSocket is reconnecting | Amber | `LIVE · NOTIFICATIONS PAUSED` |
|
||
| 6 | No recent activity | Green | `LIVE · OPEN ACTIVITY →` |
|
||
|
||
During an active operation (priority 1), the ticker shows the action verb ("Deploying", "Restarting", etc.), the stack name in brand color, and the elapsed time. The dot only pulses during an active operation. The ticker is not clickable while an operation is in progress or while notifications are reconnecting.
|
||
|
||
Click the ticker in any other state to navigate directly to the linked view.
|
||
|
||
<Frame>
|
||
<img src="/images/sidebar/sidebar-activity.png" alt="Activity ticker footer showing a brand-colored dot, a waveform activity icon, a stack name and event description in monospace, and the kicker LIVE VIEW STACK in small uppercase tracking" />
|
||
</Frame>
|
||
|
||
## Troubleshooting
|
||
|
||
<AccordionGroup>
|
||
<Accordion title="I can't see my newly created stack in the sidebar">
|
||
Confirm the active filter chip is **All** so a status filter is not hiding the row. Clear the **Search stacks...** box in case a stale query is filtering the list. Then click the **Scan stacks folder** icon next to **Create Stack** to re-index the compose directory on disk.
|
||
</Accordion>
|
||
<Accordion title="Pinning is not sticking past the 10th stack">
|
||
Each node has a 10-stack pin limit. When you pin an 11th stack, the oldest pin is automatically evicted so the new one fits. Unpin a stack you no longer need before adding another, or accept that the oldest will roll off.
|
||
</Accordion>
|
||
<Accordion title="Keyboard shortcuts are not firing">
|
||
Shortcuts only fire when a stack row is selected in the sidebar (one row is highlighted). They are blocked while a text input is focused or the global command palette (<kbd>Ctrl</kbd>+<kbd>K</kbd>) is open. Click a stack row, then try the shortcut again.
|
||
</Accordion>
|
||
<Accordion title="The filter chips disappeared from the sidebar">
|
||
Click the **+** icon to the right of the search box to bring them back. The chip row collapses to a **−** / **+** toggle, and the state is remembered in your browser, so an earlier collapse persists across reloads until you expand it again.
|
||
</Accordion>
|
||
<Accordion title="Schedule task is missing from the right-click menu">
|
||
Scheduling requires an **admin** role. Ask an admin on this node to schedule the task for you, or sign in with an admin account.
|
||
</Accordion>
|
||
<Accordion title="Auto-Heal panel opens but Add Policy and the toggles are missing">
|
||
Reading existing Auto-Heal policies is open to every operator, so the panel still opens for non-admins. Adding, enabling, disabling, or deleting policies requires the **admin** role. Sign in with an admin account, or ask an admin on this node to make the change.
|
||
</Accordion>
|
||
<Accordion title="Cross-node search shows some nodes as unreachable">
|
||
Sencho tried to reach those nodes during the search but they did not respond. The node may be offline, its connection credentials may have expired, or a network change may have interrupted the link. Open the Fleet view to check each node's status, or go to Settings and test the connection from the Nodes panel.
|
||
</Accordion>
|
||
</AccordionGroup>
|