diff --git a/docs/getting-started/quickstart.mdx b/docs/getting-started/quickstart.mdx index 74b34b1f..9189ce78 100644 --- a/docs/getting-started/quickstart.mdx +++ b/docs/getting-started/quickstart.mdx @@ -3,16 +3,46 @@ title: Quickstart description: Get Sencho running in under five minutes. --- +This walks you from a clean Docker host to a working Sencho cockpit. Five minutes if your Compose directory is already in the right place, ten if you need to lay it out first. + ## Prerequisites -- Docker and Docker Compose installed on the host -- A directory where your Compose projects live (e.g. `/opt/compose`) +- Docker and Docker Compose installed on the host. +- A directory where your Compose projects live (for example `/opt/compose`). Each subdirectory inside becomes one stack in Sencho. -## Run with Docker +## Run with Docker Compose + +Drop this into a `docker-compose.yml` next to your Compose tree (or anywhere convenient) and bring it up: + +```yaml +services: + sencho: + image: saelix/sencho:latest + container_name: sencho + restart: unless-stopped + ports: + - "1852:1852" + volumes: + - /var/run/docker.sock:/var/run/docker.sock + - /opt/compose:/opt/compose # 1:1 path rule, see below + - sencho_data:/app/data + environment: + - COMPOSE_DIR=/opt/compose + +volumes: + sencho_data: +``` + +```bash +docker compose up -d +``` + + ```bash docker run -d \ --name sencho \ + --restart unless-stopped \ -p 1852:1852 \ -v /var/run/docker.sock:/var/run/docker.sock \ -v /opt/compose:/opt/compose \ @@ -21,24 +51,63 @@ docker run -d \ saelix/sencho:latest ``` -Open `http://localhost:1852` in your browser. On first boot you'll be prompted to create an admin account. - - - 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. - + - Sencho is also published on GitHub Container Registry at `ghcr.io/studio-saelix/sencho:latest` with the same tags and content as Docker Hub. Pull from whichever registry your environment prefers. + Sencho is mirrored on GitHub Container Registry at `ghcr.io/studio-saelix/sencho:latest` with the same tags and digests as Docker Hub. Pull from whichever registry your environment prefers. -## Important: the 1:1 path rule + + `JWT_SECRET` is generated on first boot and persisted to the database. You do not need to provide one. + -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. +## The 1:1 path rule -## Next steps +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 somewhere else, adjust both sides of the mount to match. -- [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 + + This is the most common source of deployment problems. If the host and container paths differ, every relative volume in your Compose files will resolve to the wrong location once Sencho asks Docker to bring a stack up. See the [Configuration guide](/getting-started/configuration#compose-directory-the-11-path-rule) for the full explanation. + + +## First boot + +Open `http://localhost:1852` in a browser. On a fresh install you land on the **Cold start** card, where Sencho asks you to create the first admin account. + + + Sencho first-boot Cold start card with Username, Password, and Confirm password fields, and an Initialize console button + + +Pick a username (the placeholder shows `admin`), choose a password, confirm it, and click **Initialize console**. The strength indicator under the password field expects at least eight characters. + + + The Cold start card only appears the first time you open Sencho. Once the admin account exists, every subsequent visit goes to the regular sign-in screen. + + +## After signing in + +You land on the dashboard. A status bar across the top tells you whether the fleet is healthy, the gauge strip below it shows CPU, memory, disk, and network at a glance, and the **Stack health** table sorts your stacks by load. + + + Sencho dashboard with status bar across the top, CPU/MEMORY/DISK/NETWORK gauges, and a Stack health table sorted by load + + +The top nav (HOME, FLEET, RESOURCES, APP STORE, LOGS, AUTO-UPDATE, CONSOLE, AUDIT, SCHEDULES) is your map of the cockpit. The sidebar on the left lists every stack Sencho discovered under `COMPOSE_DIR`; on a fresh install it is empty until you create one. + +Click **Create Stack** in the sidebar to deploy your first stack, or open **App Store** in the top nav for a one-click template. + +## Where to next + + + + Environment variables, volume mounts, reverse proxy, and the 1:1 path rule in detail. + + + Deploy, edit, restart, update, and roll back stacks from the cockpit. + + + Add a remote Sencho instance and manage it from the same console. + + + Browse 190+ pre-configured templates and deploy in one click. + + diff --git a/docs/images/quickstart/dashboard.png b/docs/images/quickstart/dashboard.png new file mode 100644 index 00000000..7cd03ba1 Binary files /dev/null and b/docs/images/quickstart/dashboard.png differ diff --git a/docs/images/quickstart/setup-cold-start.png b/docs/images/quickstart/setup-cold-start.png new file mode 100644 index 00000000..d5ff49f9 Binary files /dev/null and b/docs/images/quickstart/setup-cold-start.png differ