feat: add automated docs pipeline and scaffold /docs folder

- Add sync-docs CI job: runs on push to main, copies /docs into sencho-docs repo via DOCS_REPO_TOKEN
- Scaffold /docs with mint.json, getting-started/introduction.mdx, getting-started/quickstart.mdx, features/overview.mdx
- Update CHANGELOG
This commit is contained in:
SaelixCode
2026-03-22 21:08:16 -04:00
parent c36ee93416
commit 9496b14f72
6 changed files with 141 additions and 0 deletions
+16
View File
@@ -0,0 +1,16 @@
---
title: Introduction
description: What Sencho is and why you might want it.
---
Sencho is a self-hosted Docker Compose management dashboard. It gives you a clean web UI to deploy, manage, and monitor your Docker Compose stacks — locally or across multiple remote servers — without touching a terminal.
## Key concepts
- **Stacks** — a Docker Compose project living in your `COMPOSE_DIR`. Sencho treats each subdirectory as a stack.
- **Nodes** — a Sencho instance. Your local machine is always the default node. Add remote nodes by pointing Sencho at another Sencho instance's API URL.
- **Resources** — images, volumes, and networks that belong to your stacks (managed) or exist outside them (external/unused).
<Note>
Sencho never accesses remote servers directly via SSH or Docker TCP. Remote management works by proxying API requests to another running Sencho instance.
</Note>
+33
View File
@@ -0,0 +1,33 @@
---
title: Quickstart
description: Get Sencho running in under five minutes.
---
## Prerequisites
- Docker and Docker Compose installed on the host
- A directory where your Compose projects live (e.g. `/opt/compose`)
## Run with Docker
```bash
docker run -d \
--name sencho \
-p 3000:3000 \
-v /var/run/docker.sock:/var/run/docker.sock \
-v /opt/compose:/app/compose \
-v sencho_data:/app/data \
-e JWT_SECRET=change-me \
ghcr.io/ansоcode/sencho:latest
```
Open `http://localhost:3000` in your browser. On first boot you'll be prompted to create an admin account.
<Note>
Replace `/opt/compose` with the path to your Compose projects directory. Every subdirectory inside it becomes a stack in Sencho.
</Note>
## Next steps
- [Add a remote node](/features/overview) to manage another server from the same dashboard
- Browse your stacks, start/stop services, and tail logs from the dashboard