mirror of
https://github.com/Studio-Saelix/sencho.git
synced 2026-07-26 11:49:16 +00:00
Anso
b5d3f497cb
* feat(host-console): gate Host Console behind Admiral tier Move the Host Console from the Community (free) tier to Admiral, enforcing the gate at every layer: UI nav visibility, AdmiralGate wrapper, POST /api/system/console-token endpoint, and the WebSocket upgrade handler for /api/system/host-console. * test(auth): mock Admiral license for console-token test The console-token endpoint now requires Admiral tier. Mock LicenseService in the test to return pro/team so the happy-path test passes in CI where no license is activated.
72 lines
3.6 KiB
Plaintext
72 lines
3.6 KiB
Plaintext
---
|
|
title: Host Console
|
|
description: An interactive terminal on your host OS, directly in the browser - no SSH required.
|
|
---
|
|
|
|
The **Console** tab opens a full interactive terminal session on the machine running Sencho. It behaves exactly like an SSH session, but without needing an SSH server, client, or key management.
|
|
|
|
<Note>
|
|
The Host Console requires a **Sencho Admiral** license. Community and Skipper users see an upgrade prompt instead. [Learn more about licensing](/features/licensing).
|
|
</Note>
|
|
|
|
<Frame>
|
|
<img src="/images/host-console/host-console-overview.png" alt="Host Console showing a PowerShell prompt inside the Sencho container working directory" />
|
|
</Frame>
|
|
|
|
## What it is
|
|
|
|
The host console spawns a real PTY (pseudo-terminal) process on the Sencho host using `node-pty`. Your keystrokes are sent over a WebSocket and the terminal output is streamed back in real-time. The terminal emulator is [xterm.js](https://xtermjs.org/), the same engine used by VS Code's built-in terminal.
|
|
|
|
Features:
|
|
- Full colour and cursor support
|
|
- Tab completion (via the host shell)
|
|
- Scrollback buffer (10,000 lines)
|
|
- Automatic terminal resizing when you resize the browser window
|
|
- Copy and paste
|
|
|
|
## Opening the console
|
|
|
|
Click **Console** in the top navigation bar. The session starts immediately in the stack's working directory if a stack is selected, otherwise in the `COMPOSE_DIR` root.
|
|
|
|
The header shows the connection status (**Connected** in green) and which node the console is attached to.
|
|
|
|
Click **Close Console** to end the session and terminate the shell process on the host.
|
|
|
|
## Shell type
|
|
|
|
The shell depends on the host OS:
|
|
- **Linux/macOS hosts:** `bash` or `sh`
|
|
- **Windows hosts (Docker Desktop):** PowerShell (as shown in the screenshot - the console opens inside the Sencho container's Windows environment)
|
|
|
|
## Availability
|
|
|
|
The Host Console is available to **admin** users on the **Admiral** tier. Access is enforced at every layer:
|
|
|
|
- **UI:** The Console tab only appears in the navigation bar for Admiral-licensed admin users.
|
|
- **API:** The `POST /api/system/console-token` endpoint returns `403 Forbidden` without an Admiral license.
|
|
- **WebSocket:** The `/api/system/host-console` upgrade handler rejects connections without an Admiral license.
|
|
|
|
### What Community and Skipper users see
|
|
|
|
If you are on the Community or Skipper tier, navigating to the Console view shows an upgrade prompt with a link to the [pricing page](https://sencho.io/pricing). The Console tab is hidden from the navigation bar entirely.
|
|
|
|
## Security model
|
|
|
|
The host console has a stricter authentication requirement than other features:
|
|
|
|
- Requires a valid **browser session** (httpOnly cookie). Node-proxy tokens used for multi-node communication are explicitly blocked.
|
|
- Each session is issued a short-lived **console token** (60-second TTL) before the WebSocket is established.
|
|
- Access is restricted to the **Admiral** license tier, ensuring only teams with appropriate licensing can use interactive shell access.
|
|
- Because the console gives full shell access to the host, you should secure your Sencho instance with HTTPS and a strong password if it is exposed to a network.
|
|
|
|
<Warning>
|
|
The host console provides unrestricted shell access to the machine running Sencho. Do not expose Sencho on a public network without HTTPS and strong authentication.
|
|
</Warning>
|
|
|
|
## Common uses
|
|
|
|
- Inspecting files in your `COMPOSE_DIR` without leaving the browser
|
|
- Running `docker compose logs --follow` or `docker ps` directly
|
|
- Editing files with `nano` or `vim` for quick fixes
|
|
- Running maintenance scripts or one-off commands on the host
|