mirror of
https://github.com/Studio-Saelix/sencho.git
synced 2026-07-26 11:49:16 +00:00
Anso
dd54a2e483
* feat: graduate Host Console to Community admins Make Host Console available to Community and Admiral admins (system:console), add host-console-community for mixed fleets, and keep opaque API tokens off the host shell. * docs: document Host Console deep links Cover root and stack-scoped Console URLs, correct the phone treatment note, and pin parse/build round-trips in senchoRoute tests. * fix: bind Host Console socket to the resolved node Treat unresolved activeNode as loading, target the WebSocket with an explicit nodeId, and wait for stack deep-link hydration so the shell cannot open on the wrong node or compose root. Add regression coverage for node/stack retargeting and fail-closed directory resolution. * fix: harden Host Console node binding, audit acting_as, and console_session tokens Reject unknown or malformed nodeIds before spawning a PTY. Record hub operators in audit_log.acting_as for remote console_session bridges. Path-scope and one-time-consume console_session JWTs so Host Console mints cannot open container exec or be replayed. * test: expect acting_as in audit CSV export header Align the CSV export assertion with the P0-2B acting_as column added to audit log exports.
105 lines
7.3 KiB
Plaintext
105 lines
7.3 KiB
Plaintext
---
|
|
title: Deep links and URLs
|
|
description: Bookmark, share, and refresh Sencho views with real browser URLs that survive Back and Forward.
|
|
---
|
|
|
|
Every major screen in Sencho has a stable address in the browser bar. Refresh the page, paste a link to a teammate, or use Back and Forward without losing your place.
|
|
|
|
## What gets its own URL
|
|
|
|
Sencho encodes the active node, the view you are on, and the deep state that view cares about.
|
|
|
|
| Destination | Example path | What it opens |
|
|
|-------------|--------------|---------------|
|
|
| Home dashboard | `/nodes/local/dashboard` | The home dashboard for the `local` node |
|
|
| Stack list (phone) | `/nodes/local/stacks` | The full-width stack list on a phone |
|
|
| Stack detail | `/nodes/local/stacks/radarr` | Radarr's stack detail (anatomy). Sidebar entry point |
|
|
| Compose editor | `/nodes/local/stacks/radarr/compose` | Radarr's compose.yaml Monaco editor |
|
|
| Env tab + file | `/nodes/local/stacks/radarr/env?env=.env.prod` | Radarr's env tab with a specific env file selected |
|
|
| Files browser | `/nodes/local/stacks/radarr/files` | Radarr's file browser (desktop; opens the compose editor instead on a phone) |
|
|
| Resources | `/nodes/local/resources` | Resources for the active node |
|
|
| Networking | `/nodes/local/networking` | Networking operator page for the active node |
|
|
| Security tab | `/nodes/local/security/images` | Security view on the Images tab |
|
|
| App Store | `/nodes/local/templates` | App Store on the active node |
|
|
| Logs | `/nodes/local/logs` | Cross-fleet log aggregation |
|
|
| Update | `/nodes/local/updates` | Fleet-wide update check |
|
|
| Console | `/nodes/local/host-console` | Host Console (admin role) |
|
|
| Console in a stack | `/nodes/local/host-console/radarr` | Host Console rooted in the Radarr stack directory |
|
|
| Audit | `/nodes/local/audit` | Audit history |
|
|
| Settings section | `/nodes/local/settings/nodes` | Settings on the Nodes section |
|
|
| Fleet tab | `/nodes/local/fleet/snapshots` | Fleet on the Snapshots tab (desktop) |
|
|
| Schedules filter | `/nodes/local/schedules?node=3` | Scheduled operations filtered to node `3` |
|
|
|
|
Fleet, Logs, Update, Schedules, and Audit are gated by role or license tier and are hub-only: their URLs redirect to the dashboard while a remote node is active. Console is also gated, but is reachable against any node, remote included. See [Multi-Node Fleet](/features/multi-node#what-top-level-views-show-when-a-remote-node-is-active) for the hub-only list and [RBAC & User Management](/features/rbac) for the full permission matrix.
|
|
|
|
Fleet tab URLs are stable slugs that do not always match the tab's on-screen label. For example the **Status** tab uses the `configuration` segment and the **Map** tab uses the `dependencies` segment.
|
|
|
|
Remote nodes use a slug derived from the node name and id (for example `/nodes/nas-box-42/dashboard`). The default local node keeps the short `local` slug.
|
|
|
|
## Stack detail vs compose editor
|
|
|
|
Clicking a stack in the sidebar opens **stack detail** at `/nodes/<node>/stacks/<stack>` (anatomy on the right). Opening the compose, env, or files editor appends that tab to the path:
|
|
|
|
- `/stacks/radarr`: detail
|
|
- `/stacks/radarr/compose`: compose.yaml editor
|
|
- `/stacks/radarr/env`: env editor
|
|
- `/stacks/radarr/files`: file browser (desktop)
|
|
|
|
Closing the Monaco editor returns you to the detail URL for that stack.
|
|
|
|
## Env tab URLs
|
|
|
|
Sencho encodes env file selection in the `?env=` query on the Env tab only:
|
|
|
|
- **Default file omitted:** when the stack's first env file is selected (usually `.env`), the URL is `/env` with no query parameter.
|
|
- **Non-default files use basenames only:** `?env=.env.prod`, never a server filesystem path.
|
|
- **Legacy bookmarks:** older links that used an absolute path in `?env=` still open the matching file by basename. Sencho normalizes the URL to basename form when the address bar updates.
|
|
- **Unknown basenames:** if `?env=` does not match any file on the stack, Sencho opens the default env file.
|
|
- **No env files:** a stack with no env file at all has no Env tab. Opening `/env` on it stays on the compose editor instead.
|
|
|
|
Compose and Files routes never carry `?env=`.
|
|
|
|
## Node slugs
|
|
|
|
- The primary local node is always `/nodes/local/...`.
|
|
- Every other node uses `/nodes/<name-slug>-<id>/...`, which stays stable when you rename the node (the id suffix is what Sencho resolves).
|
|
|
|
## Bookmarks and sharing
|
|
|
|
Copy the address bar after you land on a screen. Anyone with access to that Sencho instance and the right role can open the same view from the link. Sencho waits for permissions and license metadata to finish loading before it redirects a link you are allowed to see, so a valid paid or admin-only URL is not rewritten while metadata is still in flight.
|
|
|
|
If a link points at a stack that cannot be loaded (for example the node is offline), Sencho keeps the URL and shows a retryable error in the sidebar or on the phone stack detail screen instead of silently sending you home.
|
|
|
|
## Back, Forward, and refresh
|
|
|
|
- **Back / Forward** walk through the views you opened in order, including stack editor tabs where applicable.
|
|
- **Refresh** reloads the current URL and restores the same node, view, stack, and surface (detail vs compose/env/files editor) when the underlying data is available.
|
|
- **Unsaved edits** still block navigation. Sencho prompts before you leave a dirty compose or env buffer via Back, a sidebar link, or another stack.
|
|
|
|
## Phone layout
|
|
|
|
On a phone, Home and the stack list are distinct URLs even though both relate to stacks on desktop:
|
|
|
|
- `/nodes/local/dashboard` opens the home dashboard.
|
|
- `/nodes/local/stacks` opens the stack list.
|
|
|
|
On desktop, opening the stack list at `/nodes/local/stacks` canonicalizes to `/nodes/local/dashboard` because the sidebar stack list is part of the home layout on a wide screen.
|
|
|
|
Settings follows a similar split, but only on a phone: `/nodes/local/settings` opens the section list, and `/nodes/local/settings/<section>` opens a section directly. On desktop, `/nodes/local/settings` always normalizes straight to `/nodes/local/settings/appearance`; there is no bare section-list state to land on.
|
|
|
|
Fleet, Resources, Security, App Store, Logs, Update, Audit, and Schedules keep the exact same URL between desktop and phone, each rendering a phone-optimized screen at that path. Console also keeps the same URL on a phone (`/nodes/<node>/host-console`), but Host Console is a desktop-oriented terminal: open it on a wider screen for a full interactive session.
|
|
|
|
On a phone, `/nodes/local/stacks/<stack>/files` opens the compose editor instead. Sencho does not expose a separate file-browser URL on a phone.
|
|
|
|
## What is not in the URL
|
|
|
|
Some in-app state is intentionally not encoded:
|
|
|
|
- **Stack Anatomy sub-tabs** (Anatomy, Activity, Dossier, Drift, Environment, and the rest) stay in memory only. Refresh returns you to the default Anatomy tab for that stack. A [Networking](/features/networking) finding's action can open a stack directly on its Doctor, Dossier, or Drift tab; this is in-app navigation, not a separate URL, so the same refresh behavior applies.
|
|
|
|
## Tips
|
|
|
|
- Use the global search palette (<kbd>Ctrl</kbd>+<kbd>K</kbd>) to jump anywhere; navigation still updates the URL when you pick a page, node, or stack.
|
|
- Deep links use stack directory names (the name you see in the sidebar), not internal compose filenames.
|
|
- Opening Sencho at `/` sends you to the active node's dashboard once you are signed in.
|