mirror of
https://github.com/Studio-Saelix/sencho.git
synced 2026-07-26 11:49:16 +00:00
Anso
7d9dcc77d4
- Fix Cyrillic character in quickstart image ref and correct registry to Docker Hub (saelix/sencho) - Correct backup guide WAL references (Sencho uses SQLite default journal mode) - Add SSL/TLS reverse proxy examples for Nginx, Traefik, and new Caddy configuration - Add missing env vars (PORT, DATA_DIR, NODE_ENV, FRONTEND_URL, SSO_LDAP_DISPLAY_NAME) to .env.example - Add upgrade & migration guide documenting automatic schema migrations - Add self-hosting best practices (1:1 path rule, Docker socket security, resource recs) - Add architecture overview (system design, request flow, database schema, multi-node model) - Add development & contributor guide (setup, tests, code style, PR workflow) - Update OpenAPI spec from v0.23.0 to v0.25.3 with Registries and Image Updates endpoints - Update docs.json navigation with all new pages and API groups
39 lines
1.4 KiB
Plaintext
39 lines
1.4 KiB
Plaintext
---
|
|
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 \
|
|
saelix/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
|