Files
sencho/docs/getting-started/quickstart.mdx
T
SaelixCode 98910c4117 docs: bootstrap user-facing documentation from codebase audit
- Add 5 new Tier 1 doc pages: configuration, stack-management, editor,
  multi-node, and alerts-notifications
- Update introduction, quickstart, and features/overview to reflect
  current feature set and link to new pages
- Restructure mint.json with Getting Started / Features / Reference /
  Operations navigation groups
- Add Playwright-captured screenshots for all major UI screens
2026-03-22 22:39:06 -04:00

39 lines
1.4 KiB
Plaintext
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
---
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>
## Important: the 1:1 path rule
The `-v /opt/compose:/app/compose` mount above uses a simplified path for illustration. In practice, you must mount your compose directory at the **same path** inside and outside the container. See the [Configuration guide](/getting-started/configuration#compose-directory-the-11-path-rule) for details — this is the most common setup mistake.
## Next steps
- [Configuration](/getting-started/configuration) — full environment variable reference, reverse proxy setup
- [Stack Management](/features/stack-management) — create and deploy your first stack
- [Multi-Node](/features/multi-node) — add a remote server to manage from this dashboard