mirror of
https://github.com/Studio-Saelix/sencho.git
synced 2026-07-26 11:49:16 +00:00
docs: align README with the open-source Community product (#1626)
* docs: align README and overview docs with current AGPLv3 tier model Community is now described as the complete free product, with a single consolidated Admiral section replacing scattered per-bullet tags that had drifted out of sync with the actual gates (security scanning, private registries, and most of RBAC/audit moved to Community over time). Remove promotion of Sencho Mesh, Fleet Secrets, and Host Console, which are no longer discoverable by default. Align the Fleet Secrets, Host Console, and Sencho Mesh sections in the features overview with the limited-availability framing already used elsewhere on that page. Refresh every README screenshot to the current UI and add new captures for Security, Blueprints, Scheduled Operations, and Compose Doctor. The introductory tier-framing sentence and docs navigation placement for the now-hidden surfaces are intentionally left for a later, dedicated pass once the Admiral positioning work settles. * docs: restructure README around the open-source Community product Drop "What Sencho is not (yet)", fold its known-limitations pointer into the Documentation section. Rewrite Telemetry and data handling to drop the Admiral license-validation detail, since this file is the open-source entry point and Admiral customers work from their own agreements. Move the Admiral section to just before Documentation, community, and license so the README leads with the Community product throughout.
This commit is contained in:
Anso
@@ -41,28 +41,16 @@ It runs as a single container on your hardware and gives you a UI for the work y
|
||||
|
||||
A Sencho instance is autonomous. To manage another machine, you install a second Sencho on it and connect them with a long-lived API token; the primary dashboard then acts as an authenticated HTTP and WebSocket proxy across your fleet. Use TLS, a VPN, or a private network for any untrusted link. Each node still uses its local Docker socket (see Quick start), but Sencho does not require SSH and does not expose a remote Docker socket on the network. For nodes behind NAT or strict firewalls, the Pilot Agent establishes a single outbound WebSocket tunnel to the primary, so the remote host opens no inbound port at all.
|
||||
|
||||
Most capabilities are free in the Community tier. A few advanced governance, security, and fleet-control features ship in the paid Admiral tier; pricing lives at [sencho.io/pricing](https://sencho.io/pricing).
|
||||
|
||||
## What Sencho is not (yet)
|
||||
|
||||
Sencho is a Docker Compose control plane focused on homelab and small-fleet operators. It is intentionally not:
|
||||
|
||||
- A Kubernetes scheduler or replacement.
|
||||
- A reverse proxy. Front Sencho with your existing proxy (Caddy, Traefik, nginx) for TLS and authentication on the public edge.
|
||||
- A monitoring stack. Sencho surfaces container and host metrics in the dashboard but does not replace Prometheus, Grafana, or your existing alerting pipeline.
|
||||
- A CI / CD pipeline. Use webhooks, the API, or Git-sourced stacks to connect Sencho to your build system.
|
||||
|
||||
See [KNOWN_LIMITATIONS.md](KNOWN_LIMITATIONS.md) for the current limitation list.
|
||||
Sencho is free, open-source software under AGPLv3. Everything below is included in the Community tier with unlimited nodes and users.
|
||||
|
||||
---
|
||||
|
||||
**Tier coverage:** All bullets below are available in the free Community tier unless marked `(Admiral)`. Full breakdown at [sencho.io/pricing](https://sencho.io/pricing).
|
||||
|
||||
## Capabilities
|
||||
|
||||
### Stacks
|
||||
- Full Compose lifecycle: create, deploy, restart, stop, pull
|
||||
- Monaco editor with diff preview before save and one-click rollback
|
||||
- Atomic deployments with automatic rollback on failure
|
||||
- Monaco editor with diff preview before save and one-click rollback to any prior deploy
|
||||
- [Health-gated updates](https://docs.sencho.io/features/health-gated-updates) that hold a rollout until health checks pass, with stalled-update detection and in-app recovery
|
||||
- [Git-sourced stacks](https://docs.sencho.io/features/git-sources) pulled and synced from any repository, with ordered multi-file Compose
|
||||
- [File explorer](https://docs.sencho.io/features/stack-file-explorer) for compose, env, and supporting files, with move and rename across directories
|
||||
@@ -74,7 +62,7 @@ See [KNOWN_LIMITATIONS.md](KNOWN_LIMITATIONS.md) for the current limitation list
|
||||
- Aggregated [log search and stream](https://docs.sencho.io/features/global-observability) across every container in the fleet
|
||||
- Live container stats, health checks, and image-update notifications on a configurable cadence, with links from each image to its registry and source
|
||||
- Threshold alerts for CPU, memory, and network
|
||||
- Read-only [audit log](https://docs.sencho.io/features/audit-log) of every action **(Admiral)**
|
||||
- Read-only [audit log](https://docs.sencho.io/features/audit-log) of every action, with a 14-day recent-activity window
|
||||
- [Network topology](https://docs.sencho.io/features/fleet-view) view of containers, networks, and nodes
|
||||
- Documentation-drift flags when a [stack dossier](https://docs.sencho.io/features/stack-dossier) diverges from the running stack
|
||||
|
||||
@@ -82,6 +70,10 @@ See [KNOWN_LIMITATIONS.md](KNOWN_LIMITATIONS.md) for the current limitation list
|
||||
- Multi-node management via authenticated HTTP and WebSocket proxy
|
||||
- [Fleet view](https://docs.sencho.io/features/fleet-view) with grid and topology layouts
|
||||
- [Fleet snapshots](https://docs.sencho.io/features/fleet-backups) of compose and env across the fleet
|
||||
- [Fleet Federation](https://docs.sencho.io/features/fleet-federation): cordon nodes and pin Blueprints to specific hosts
|
||||
- [Fleet Actions](https://docs.sencho.io/features/fleet-actions): bulk label operations, fleet-wide stop-by-label, and fleet-wide prune
|
||||
- [Fleet Dossier](https://docs.sencho.io/features/fleet-dossier): export the whole fleet as a single browsable Markdown archive
|
||||
- Node labels and grouping
|
||||
- [Pilot Agent](https://docs.sencho.io/features/pilot-agent) for nodes behind NAT or strict firewalls
|
||||
- Node compatibility checks before deploying
|
||||
|
||||
@@ -91,22 +83,20 @@ See [KNOWN_LIMITATIONS.md](KNOWN_LIMITATIONS.md) for the current limitation list
|
||||
- [Scheduled operations](https://docs.sencho.io/features/scheduled-operations) on cron
|
||||
- [Webhooks](https://docs.sencho.io/features/webhooks) on stack lifecycle events
|
||||
- [Blueprints](https://docs.sencho.io/features/blueprint-model): declarative fleet templates with drift detection
|
||||
- Encrypted [Fleet Secrets](https://docs.sencho.io/features/fleet-secrets) pushed to labeled nodes **(Admiral)**
|
||||
|
||||
### Security
|
||||
- [SSO](https://docs.sencho.io/features/sso): custom OIDC, presets for Google, GitHub, and Okta, plus LDAP and Active Directory
|
||||
- [SSO](https://docs.sencho.io/features/sso): custom OIDC and presets for Google, GitHub, and Okta
|
||||
- [Two-factor authentication](https://docs.sencho.io/features/two-factor-authentication) with TOTP and backup codes
|
||||
- [RBAC](https://docs.sencho.io/features/rbac) with admin (full control) and viewer (read-only) roles; deployer, node-admin, and auditor roles plus scoped permissions **(Admiral)**
|
||||
- [RBAC](https://docs.sencho.io/features/rbac) with admin (full control) and viewer (read-only) roles
|
||||
- [Security overview](https://docs.sencho.io/features/security) with a chart-led scan summary, sortable images, and searchable scan history
|
||||
- [Vulnerability scanning](https://docs.sencho.io/features/vulnerability-scanning) via Trivy on every tier, with on-demand node-wide scans and VEX-based suppression; SARIF export and SBOM upload **(Admiral)**
|
||||
- [Vulnerability scanning](https://docs.sencho.io/features/vulnerability-scanning) via Trivy, with on-demand node-wide scans, VEX-based suppression, SARIF export, and SBOM upload
|
||||
- [Compose network inspector](https://docs.sencho.io/features/compose-networking) with an exposure-intent guard for unintended published ports
|
||||
- Scan policy packs for reusable security rules **(Admiral)**
|
||||
- [Private registries](https://docs.sencho.io/features/private-registries) and [deploy enforcement](https://docs.sencho.io/features/deploy-enforcement) for non-compliant images **(Admiral)**
|
||||
- Scan policy packs for reusable security rules
|
||||
- [Private registries](https://docs.sencho.io/features/private-registries) for Docker Hub, GHCR, and custom registries, plus [deploy enforcement](https://docs.sencho.io/features/deploy-enforcement) for non-compliant images
|
||||
- [API tokens](https://docs.sencho.io/features/api-tokens) for automation
|
||||
|
||||
### Operations
|
||||
- [Host console](https://docs.sencho.io/features/host-console) in the browser **(Admiral)**
|
||||
- Off-site stack archives via custom S3 (every tier) or [Sencho Cloud Backup](https://docs.sencho.io/operations/backup) **(Admiral)** for managed storage
|
||||
- Off-site stack archives via [custom S3-compatible storage](https://docs.sencho.io/operations/backup)
|
||||
- [Notification routing](https://docs.sencho.io/features/alerts-notifications#notification-routing) to Slack, Discord, email, and webhooks
|
||||
- [Global search](https://docs.sencho.io/features/global-search) across stacks, containers, and services
|
||||
- [Resources view](https://docs.sencho.io/features/resources) for images, volumes, and networks with scoped prune actions
|
||||
@@ -181,18 +171,27 @@ See the [multi-node guide](https://docs.sencho.io/features/multi-node) for the f
|
||||
|---|---|
|
||||
|  |  |
|
||||
|  |  |
|
||||
|  |  |
|
||||
|  |  |
|
||||
|
||||
---
|
||||
|
||||
## Telemetry and data handling
|
||||
|
||||
Sencho does not emit telemetry, analytics, or crash reports. The only outbound traffic is license validation against Lemon Squeezy, and only when a paid license key is activated. Community-tier instances make no outbound calls to Sencho-controlled endpoints. Stack metadata, container inventory, and user activity never leave your instance.
|
||||
Sencho does not emit telemetry, analytics, or crash reports, and makes no outbound calls to Sencho-controlled endpoints. Stack metadata, container inventory, and user activity never leave your instance.
|
||||
|
||||
---
|
||||
|
||||
## Admiral
|
||||
|
||||
**Admiral** is Studio Saelix's paid business assurance plan on top of everything in Community: priority support, managed continuity (Sencho Cloud Backup), governance depth (advanced RBAC roles, LDAP / Active Directory, full audit log export and anomaly detection), and cross-node Fleet Sync policy replication. AWS ECR registry credentials currently require Admiral as well. See [sencho.io/pricing](https://sencho.io/pricing) for current plan details.
|
||||
|
||||
---
|
||||
|
||||
## Documentation, community, and license
|
||||
|
||||
- **Documentation:** [docs.sencho.io](https://docs.sencho.io)
|
||||
- **Known limitations:** [KNOWN_LIMITATIONS.md](KNOWN_LIMITATIONS.md)
|
||||
- **If something breaks:** the [Recovery guide](https://docs.sencho.io/operations/recovery) covers getting back to a working state when Sencho, a deploy, sign-in, Docker, or a node fails.
|
||||
- **Community:** [GitHub Discussions](https://github.com/studio-saelix/sencho/discussions)
|
||||
- **Contributing:** [CONTRIBUTING.md](CONTRIBUTING.md)
|
||||
|
||||
@@ -152,7 +152,7 @@ Track mutating actions across your Sencho instance with a searchable trail: who
|
||||
## Fleet management
|
||||
|
||||
<Frame>
|
||||
<img src="/images/overview/fleet-topology.png" alt="Fleet view in grid layout: the fleet masthead showing aggregate CPU, memory, and container counts across all nodes, the tab strip (Overview, Snapshots, Status, Map, Deployments, Routing, Federation, Actions, Secrets), and the node grid with per-node container counts and CPU, RAM, and disk usage bars." />
|
||||
<img src="/images/overview/fleet-topology.png" alt="Fleet view in grid layout: the fleet masthead showing aggregate CPU, memory, and container counts across all nodes, the tab strip (Overview, Snapshots, Status, Map, Deployments, Federation, Actions), and the node grid with per-node container counts and CPU, RAM, and disk usage bars." />
|
||||
</Frame>
|
||||
|
||||
### Multi-node support
|
||||
@@ -165,7 +165,7 @@ Add remote nodes behind NAT, residential networks, or corporate firewalls withou
|
||||
|
||||
### Sencho Mesh
|
||||
|
||||
Connect containers across nodes by hostname over the Pilot tunnel so a multi-node fleet feels like one machine. Opt a stack into the mesh and its services become reachable from any other meshed stack at a stable hostname. Admiral. [Learn more →](/features/sencho-mesh)
|
||||
Connect containers across nodes by hostname over the Pilot tunnel so a multi-node fleet feels like one machine. Opt a stack into the mesh and its services become reachable from any other meshed stack at a stable hostname. Limited availability; requires Admiral when enabled on an instance. [Learn more →](/features/sencho-mesh)
|
||||
|
||||
### Fleet View
|
||||
|
||||
@@ -189,7 +189,7 @@ When several Sencho instances run as a fleet, the control instance is the source
|
||||
|
||||
### Fleet Secrets
|
||||
|
||||
Centralized, encrypted, versioned env-var bundles you push to labeled nodes' stacks. Every save bumps a version, and every push records a per-node diff in the audit log using overlay merge semantics. Admiral. [Learn more →](/features/fleet-secrets)
|
||||
Centralized, encrypted, versioned env-var bundles you push to labeled nodes' stacks. Every save bumps a version, and every push records a per-node diff in the audit log using overlay merge semantics. Limited availability; requires Admiral and the admin role when enabled on an instance. [Learn more →](/features/fleet-secrets)
|
||||
|
||||
### Fleet-wide backups
|
||||
|
||||
@@ -205,7 +205,7 @@ When you manage nodes running different Sencho versions, the dashboard detects e
|
||||
|
||||
### Host console
|
||||
|
||||
Open an interactive terminal on the host OS directly in the browser with full xterm.js emulation and color support. No SSH client required; admin-only. [Learn more →](/features/host-console)
|
||||
Open an interactive terminal on the host OS directly in the browser with full xterm.js emulation and color support. No SSH client required. Limited availability; requires Admiral and the admin role when enabled on an instance. [Learn more →](/features/host-console)
|
||||
|
||||
## Security and access
|
||||
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 175 KiB After Width: | Height: | Size: 193 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 188 KiB After Width: | Height: | Size: 214 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 259 KiB After Width: | Height: | Size: 305 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 170 KiB After Width: | Height: | Size: 192 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 265 KiB After Width: | Height: | Size: 215 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 201 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 365 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 320 KiB After Width: | Height: | Size: 192 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 142 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 304 KiB After Width: | Height: | Size: 239 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 224 KiB After Width: | Height: | Size: 305 KiB |
Reference in New Issue
Block a user