mirror of
https://github.com/Studio-Saelix/sencho.git
synced 2026-08-11 03:06:54 +00:00
docs: audit and refresh documentation with updated screenshots (#197)
Update 11 doc pages with accurate content and capture 14 fresh screenshots. Remove JWT_SECRET from configuration (auto-generated), fix editor container actions, add missing Settings sections, update Features Overview, and add remote alerts documentation.
This commit is contained in:
Anso
@@ -51,7 +51,11 @@ Stack alerts are configured per-stack. Right-click a stack in the sidebar (or cl
|
||||
<img src="/images/stack-management/stack-context-menu.png" alt="Stack context menu showing the Alerts option" />
|
||||
</Frame>
|
||||
|
||||
The alerts sheet shows existing rules for the stack and a form to create new ones.
|
||||
The alerts panel slides open, showing existing rules for the stack and a form to create new ones.
|
||||
|
||||
<Frame>
|
||||
<img src="/images/alerts-notifications/alert-panel.png" alt="Alert panel showing alert rules and creation form" />
|
||||
</Frame>
|
||||
|
||||
### Alert fields
|
||||
|
||||
@@ -93,3 +97,24 @@ All dispatched notifications appear in the **notification bell** (top-right of t
|
||||
<Note>
|
||||
Notifications only reach external agents (Discord, Slack, Webhook) if at least one agent is enabled. Dashboard notifications appear regardless.
|
||||
</Note>
|
||||
|
||||
## Alerts on remote nodes
|
||||
|
||||
Alerts work the same way on remote nodes as they do locally. When you switch to a remote node and right-click a stack, the alerts panel shows and manages rules for that remote instance.
|
||||
|
||||
<Frame>
|
||||
<img src="/images/alerts-notifications/alert-panel-remote.png" alt="Alert panel on a remote node" />
|
||||
</Frame>
|
||||
|
||||
### How it works
|
||||
|
||||
1. **Alert rules are stored on each node independently.** When you create an alert while a remote node is selected, the rule is saved on that remote Sencho instance's database - not your primary instance.
|
||||
2. **Monitoring runs locally on each node.** The remote Sencho instance evaluates its own alert rules against its own container metrics every minute.
|
||||
3. **Notifications are sent by the node that detects the breach.** Make sure notification agents (Discord, Slack, Webhook) are configured on each remote node where you want to receive alerts - notification settings are per-instance.
|
||||
|
||||
### Setup checklist for remote alerts
|
||||
|
||||
1. On the **remote** Sencho instance, go to **Settings → Notifications** and configure at least one agent
|
||||
2. From your **primary** instance, switch to the remote node
|
||||
3. Right-click a stack and select **Alerts** to create rules
|
||||
4. The remote instance handles monitoring and notification delivery independently
|
||||
|
||||
@@ -43,13 +43,17 @@ The left panel lists all containers that belong to the selected stack. Each cont
|
||||
|
||||
### Container actions
|
||||
|
||||
Each container row has three action buttons:
|
||||
Each container row has action buttons that appear on hover:
|
||||
|
||||
| Button | What it does |
|
||||
|--------|--------------|
|
||||
| **Logs** (external link icon) | Opens a live log stream modal for that container |
|
||||
| **Terminal** (terminal icon) | Opens an interactive bash session inside the container |
|
||||
| **Copy ID** | Copies the container ID to the clipboard |
|
||||
| Button | Icon | What it does |
|
||||
|--------|------|--------------|
|
||||
| **Open App** | External link | Opens the container's web UI in a new tab (uses the first mapped port) |
|
||||
| **View Live Logs** | Scroll text | Opens a live log stream modal for that container (available when running) |
|
||||
| **Open Bash Terminal** | Terminal | Opens an interactive bash session inside the container (admin only, available when running) |
|
||||
|
||||
<Frame>
|
||||
<img src="/images/editor/container-actions.png" alt="Container action buttons on a running container" />
|
||||
</Frame>
|
||||
|
||||
### Log viewer
|
||||
|
||||
|
||||
@@ -16,6 +16,10 @@ Create point-in-time snapshots of every `compose.yaml` and `.env` file across yo
|
||||
3. Optionally enter a description (e.g. "Before v2 migration")
|
||||
4. Click **Create** - Sencho captures files from every reachable node
|
||||
|
||||
<Frame>
|
||||
<img src="/images/fleet-backups/create-snapshot.png" alt="Create Snapshot dialog" />
|
||||
</Frame>
|
||||
|
||||
During creation, Sencho connects to each node in parallel:
|
||||
- **Local nodes** - reads files directly from the compose directory
|
||||
- **Remote nodes** - fetches files via the Distributed API proxy using the node's API token
|
||||
@@ -24,6 +28,10 @@ If a remote node is offline or unreachable, it is **skipped gracefully**. The sn
|
||||
|
||||
## Browsing snapshots
|
||||
|
||||
<Frame>
|
||||
<img src="/images/fleet-backups/browse-snapshots.png" alt="Snapshot list showing date, description, scope, and warnings" />
|
||||
</Frame>
|
||||
|
||||
The snapshot list shows:
|
||||
- **Date** - when the snapshot was taken
|
||||
- **Description** - your optional label
|
||||
|
||||
@@ -31,6 +31,10 @@ On the **remote** Sencho instance (the server you want to add), open **Settings
|
||||
|
||||
On your **primary** Sencho instance, open **Settings → Nodes** and click **+ Add Node**. Fill in:
|
||||
|
||||
<Frame>
|
||||
<img src="/images/multi-node/add-node-form.png" alt="Add Node form with Name, Type, API URL, and Token fields" />
|
||||
</Frame>
|
||||
|
||||
| Field | Description |
|
||||
|-------|-------------|
|
||||
| **Name** | A display name (e.g. `prod-server`, `media-box`) |
|
||||
@@ -58,7 +62,7 @@ The Compose directory path matters on remote nodes too. When you register a remo
|
||||
The **node switcher** dropdown in the top-left of the sidebar shows the currently active node. Click it to switch to any registered node. All views - dashboard stats, stack list, editor, resources, logs - immediately reflect the selected node.
|
||||
|
||||
<Frame>
|
||||
<img src="/images/multi-node/node-manager.png" alt="Node switcher dropdown and node list" />
|
||||
<img src="/images/multi-node/node-switcher-dropdown.png" alt="Node switcher dropdown expanded showing available nodes" />
|
||||
</Frame>
|
||||
|
||||
Node status indicators:
|
||||
|
||||
+40
-36
@@ -3,41 +3,17 @@ title: Features Overview
|
||||
description: A high-level tour of everything Sencho can do.
|
||||
---
|
||||
|
||||
## Dashboard
|
||||
|
||||
The Home view shows real-time system stats at a glance - active containers, exited containers, Docker network activity, and host resource usage (CPU, RAM, disk). Historical CPU and RAM charts display trends over the last 24 hours. A Docker Run converter lets you paste any `docker run` command and convert it to a Compose stack. [Learn more →](/features/dashboard)
|
||||
|
||||
## Stack management
|
||||
|
||||
Deploy, start, stop, restart, and remove Docker Compose stacks through a point-and-click interface. Edit `compose.yaml` and `.env` files directly in the built-in Monaco editor with syntax highlighting. [Learn more →](/features/stack-management)
|
||||
Deploy, start, stop, restart, update, and remove Docker Compose stacks through a point-and-click interface. Right-click any stack in the sidebar for a context menu with quick actions including alerts configuration, update checks, and deployment controls. [Learn more →](/features/stack-management)
|
||||
|
||||
## Editor
|
||||
|
||||
Full in-browser code editor for your Compose and environment files. Toggle edit mode, save to disk, or save and deploy in one step. Per-container live stats and an interactive bash exec terminal live alongside the editor. [Learn more →](/features/editor)
|
||||
|
||||
## Multi-node support
|
||||
|
||||
Add remote Sencho instances as nodes. All dashboard operations - stack management, logs, stats - work identically whether you're targeting your local machine or a server on the other side of the world. Uses a transparent HTTP proxy model; no SSH or shared Docker sockets required. [Learn more →](/features/multi-node)
|
||||
|
||||
## Fleet View
|
||||
|
||||
Monitor your entire infrastructure from a single screen. The fleet dashboard shows all nodes with health metrics, container counts, and resource usage. Pro users unlock fleet health summary cards, container drill-down, search, sorting, filtering, and critical node detection. [Learn more →](/features/fleet-view)
|
||||
|
||||
## RBAC & user management
|
||||
|
||||
Create viewer accounts with read-only access to dashboards, logs, and file contents - while keeping deploy and edit permissions locked to admins. Sencho Pro supports two roles: Admin (full access) and Viewer (read-only). [Learn more →](/features/rbac)
|
||||
|
||||
## Atomic deployments
|
||||
|
||||
Pro users get automatic backup and rollback on every deployment. Before applying changes, Sencho snapshots your compose and environment files. If containers crash after deploy, the previous configuration is restored automatically. [Learn more →](/features/atomic-deployments)
|
||||
|
||||
## Fleet-wide backups
|
||||
|
||||
Create point-in-time snapshots of every compose file and environment file across all nodes. Snapshots are stored centrally and can be browsed by node and stack. Restore individual stacks from any snapshot with optional one-click redeploy - even to remote nodes. Offline nodes are gracefully skipped with visible warnings. [Learn more →](/features/fleet-backups)
|
||||
|
||||
## Real-time logs & stats
|
||||
|
||||
Stream container logs and resource metrics (CPU, memory, network I/O) live in the browser via WebSocket and Server-Sent Events connections. The Home dashboard shows historical CPU and RAM charts over the last 24 hours.
|
||||
|
||||
## Global observability
|
||||
|
||||
The **Logs** view aggregates output from all containers across all stacks into a single scrollable stream. Filter by stack, log level (stdout/stderr), or search for keywords. Switch to developer mode for real-time SSE streaming.
|
||||
Full in-browser Monaco editor for your `compose.yaml` and `.env` files with syntax highlighting. Toggle edit mode, save to disk, or save and deploy in one step. The container panel shows per-container live stats (CPU, RAM, network), with buttons to open the app, stream logs, or launch a bash terminal. [Learn more →](/features/editor)
|
||||
|
||||
## Resources hub
|
||||
|
||||
@@ -49,20 +25,48 @@ View and manage all Docker images, volumes, and networks. Resources are classifi
|
||||
| **External** | Part of another Compose project |
|
||||
| **Unused / Reclaimable** | Safe to prune |
|
||||
|
||||
Run scoped prune operations to clean up Sencho-managed resources only, or target all Docker resources when needed.
|
||||
Run scoped prune operations to clean up Sencho-managed resources only, or target all Docker resources when needed. [Learn more →](/features/resources)
|
||||
|
||||
## App Store
|
||||
|
||||
Browse 190+ pre-configured application templates. Filter by category (Media, Automation, Development, etc.), configure environment variables, volumes, and ports, and deploy with a single click.
|
||||
Browse 190+ pre-configured application templates. Filter by category (Media, Automation, Development, etc.), configure environment variables, volumes, and ports, and deploy with a single click. Customize the template source URL to use your own registry. [Learn more →](/features/app-store)
|
||||
|
||||
## Global observability
|
||||
|
||||
The **Logs** view aggregates output from all containers across all stacks into a single scrollable stream. Filter by stack, log level (stdout/stderr), or search for keywords. Switch to developer mode for real-time SSE streaming instead of polling. [Learn more →](/features/global-observability)
|
||||
|
||||
## Host console
|
||||
|
||||
Open an interactive terminal on the host OS directly in the browser - full xterm.js emulation with color support. No SSH client required.
|
||||
Open an interactive terminal on the host OS directly in the browser - full xterm.js emulation with color support. No SSH client required. Admin-only access. [Learn more →](/features/host-console)
|
||||
|
||||
## Webhooks
|
||||
## Multi-node support
|
||||
|
||||
Trigger stack actions from external CI/CD pipelines via HTTP webhooks. Create a webhook targeting a specific stack and action, then call it from GitHub Actions, GitLab CI, or any system that can send an HTTP POST. Requests are authenticated with HMAC-SHA256 signatures - no session cookies required. [Learn more →](/features/webhooks)
|
||||
Add remote Sencho instances as nodes. All dashboard operations - stack management, logs, stats - work identically whether you're targeting your local machine or a server on the other side of the world. Uses a transparent HTTP proxy model; no SSH or shared Docker sockets required. [Learn more →](/features/multi-node)
|
||||
|
||||
## Fleet View
|
||||
|
||||
Monitor your entire infrastructure from a single screen. The fleet dashboard shows all nodes with health metrics, container counts, and resource usage. Pro users unlock fleet health summary cards, container drill-down, search, sorting, filtering, and critical node detection. [Learn more →](/features/fleet-view)
|
||||
|
||||
## Alerts & notifications
|
||||
|
||||
Configure threshold-based alerts (CPU, memory, network, restart count) per stack. Route notifications to Discord, Slack, or any generic webhook endpoint. [Learn more →](/features/alerts-notifications)
|
||||
Configure threshold-based alerts (CPU, memory, network, restart count) per stack. Route notifications to Discord, Slack, or any generic webhook endpoint. Alerts are evaluated every minute with configurable duration and cooldown. [Learn more →](/features/alerts-notifications)
|
||||
|
||||
## Webhooks
|
||||
|
||||
Trigger stack actions from external CI/CD pipelines via HTTP webhooks. Create a webhook targeting a specific stack and action, then call it from GitHub Actions, GitLab CI, or any system that can send an HTTP POST. Requests are authenticated with HMAC-SHA256 signatures. [Learn more →](/features/webhooks)
|
||||
|
||||
## RBAC & user management
|
||||
|
||||
Create viewer accounts with read-only access to dashboards, logs, and file contents - while keeping deploy and edit permissions locked to admins. Sencho Pro supports two roles: Admin (full access) and Viewer (read-only). [Learn more →](/features/rbac)
|
||||
|
||||
## Atomic deployments
|
||||
|
||||
Pro users get automatic backup and rollback on every deployment. Before applying changes, Sencho snapshots your compose and environment files. If containers crash after deploy, the previous configuration is restored automatically. [Learn more →](/features/atomic-deployments)
|
||||
|
||||
## Fleet-wide backups
|
||||
|
||||
Create point-in-time snapshots of every compose file and environment file across all nodes. Snapshots are stored centrally and can be browsed by node and stack. Restore individual stacks from any snapshot with optional one-click redeploy - even to remote nodes. [Learn more →](/features/fleet-backups)
|
||||
|
||||
## Licensing & billing
|
||||
|
||||
Sencho is free for personal use with the Community tier. Pro unlocks RBAC, webhooks, fleet backups, atomic deployments, and advanced fleet features. Manage your license, view subscription details, and access the billing portal from Settings. [Learn more →](/features/licensing)
|
||||
|
||||
@@ -39,6 +39,10 @@ Sencho Pro introduces role-based access control with two distinct roles: **Admin
|
||||
|
||||
## Managing users
|
||||
|
||||
<Frame>
|
||||
<img src="/images/rbac/users-settings.png" alt="Users management panel showing user list with roles" />
|
||||
</Frame>
|
||||
|
||||
Admins can manage accounts in **Settings → Users**. From there you can:
|
||||
|
||||
- **Create** a new user with a username, password, and role (Admin or Viewer)
|
||||
|
||||
@@ -18,6 +18,10 @@ Sencho webhooks let external systems trigger stack actions over HTTP. The typica
|
||||
|
||||
## Creating a webhook
|
||||
|
||||
<Frame>
|
||||
<img src="/images/webhooks/webhooks-settings.png" alt="Webhooks settings panel" />
|
||||
</Frame>
|
||||
|
||||
Open **Settings → Webhooks** and click **Create Webhook**. Fill in:
|
||||
|
||||
| Field | Description |
|
||||
|
||||
Reference in New Issue
Block a user