mirror of
https://github.com/Studio-Saelix/sencho.git
synced 2026-07-26 11:49:16 +00:00
Anso
ed553f1f19
Updates the backend listen port, Vite dev proxy target, Docker EXPOSE, compose port mapping, .env.example default, GitHub Actions smoke-test default, healthcheck URLs, and every doc/example reference. Test fixtures that include example URLs were updated for consistency, though their assertions are port-agnostic. The rate-limit value of 3000 in middleware/rateLimiters.ts and the 3000 entry in WEB_UI_PORTS (which detects user containers like Grafana) are intentionally untouched.
41 lines
1.6 KiB
Plaintext
41 lines
1.6 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 1852:1852 \
|
|
-v /var/run/docker.sock:/var/run/docker.sock \
|
|
-v /opt/compose:/opt/compose \
|
|
-v sencho_data:/app/data \
|
|
-e COMPOSE_DIR=/opt/compose \
|
|
saelix/sencho:latest
|
|
```
|
|
|
|
Open `http://localhost:1852` 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. A `JWT_SECRET` is generated automatically on first boot; you do not need to provide one.
|
|
</Note>
|
|
|
|
## Important: the 1:1 path rule
|
|
|
|
The compose directory must be mounted at the **same path** inside and outside the container. The example above mounts `/opt/compose` to `/opt/compose`, which is correct. If your stacks live at a different path, adjust both sides of the mount to match. See the [Configuration guide](/getting-started/configuration#compose-directory-the-11-path-rule) for details.
|
|
|
|
## Next steps
|
|
|
|
- [Configuration](/getting-started/configuration) - environment variables, volume mounts, reverse proxy setup
|
|
- [Features Overview](/features/overview) - tour of everything Sencho can do
|
|
- [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
|
|
- [App Store](/features/app-store) - deploy from 190+ pre-configured templates
|