Files
Chronos/docs/deploy/README.md
T
Alby96andClaude Opus 5.5 b4c2f5805b docs: deploy guide, owner review 4 request (phase 6)
Owner review 1 phase 6 asks for Docker, Unraid and deploy documentation. docs/deploy/
now covers the image tags, volumes, every CHRONOS_* variable with its default, ports and
public ports (the owner's host 8087/8444 mapping), TLS modes and the fingerprint,
upgrades and forward-only migrations, backup and restore, PostgreSQL, troubleshooting,
and the desktop Setup, portable mode and update channel.

The owner review 4 request (2026-11-06) is recorded with its interpretation and plan;
BRIEF §14.9 lists CHRONOS_TRUSTED_PROXIES, which the server already read, §19.6 points
to the Unraid guide, and §24 gains the rows of owner review 4 and phase 6. STATUS shows
both in progress for v0.1.0-rc.14, then v1.0.0.

Refs #22

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-06 16:53:01 +01:00

47 lines
3.2 KiB
Markdown
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.
# Deploying Chronos
How to install, configure, upgrade and back up the Chronos programs. Written for the person who runs them; the
specification behind each behaviour is `docs/BRIEF.md` (§14.9 configuration and Docker, §18 installer and updates,
§19.5 images, §19.6 Unraid template).
| Guide | For |
|---|---|
| [docker.md](docker.md) | Chronos Server in Docker with Compose: image tags, volumes, every `CHRONOS_*` variable, ports, TLS, PostgreSQL, upgrades, backup and restore, troubleshooting |
| [unraid.md](unraid.md) | Chronos Server on Unraid with the template `deploy/unraid/chronos.xml` and the official PostgreSQL template, including host ports other than 8080/8443 |
| [desktop.md](desktop.md) | Chronos and Chronos Uploader on Windows: Setup, portable mode, updates, uninstall; Chronos Server on Windows |
The short user guide that ships with every release is `deploy/releases-repo/README.md` (it becomes the README of a
separate releases repository when `RELEASES_REPO` is set). It and these guides say the same things; these go further.
## The pieces
| Program | Runs on | Talks to |
|---|---|---|
| **Chronos** (desktop) | Windows 10 21H2+ / 11, x64 | Its own archive and index on the PC; optionally a Chronos Server over HTTPS |
| **Chronos Uploader** | Windows 10 21H2+ / 11, x64 | A Chronos Server over HTTPS |
| **Chronos Server** | Docker (`linux/amd64`), Unraid 6.12+, Windows 10/11/Server 2019+ x64 | PostgreSQL 16 or 17 (Linux), SQLite or PostgreSQL (Windows); its archive folder |
The archive is the source of truth: photos, sidecars, proxies and renders live in ordinary folders, and the database is
an index that can be rebuilt from them (BRIEF §7). Users, sign-ins, schedules, job history and the audit log live only
in the database, so back up both (see [docker.md › Backup and restore](docker.md#backup-and-restore)).
## Where to get them
| What | Where |
|---|---|
| Windows installers, portable zips, the Windows server zip, `SHA256SUMS` | Releases of `BalboSoft/Chronos` on `https://gitea.encke-hake.ts.net` (or of the releases repository) |
| Server image | `gitea.encke-hake.ts.net/balbosoft/chronos-server` — `:latest`, `:<version>`, `:nightly` |
| Compose file and `.env` example | `https://gitea.encke-hake.ts.net/BalboSoft/Chronos/raw/branch/main/deploy/docker/docker-compose.yml` and `…/deploy/docker/.env.example` |
| Unraid template | `https://gitea.encke-hake.ts.net/BalboSoft/Chronos/raw/branch/main/deploy/unraid/chronos.xml` |
While the `BalboSoft` organisation on Gitea is private, downloads, the update check and image pulls work only for
signed-in accounts: run `docker login gitea.encke-hake.ts.net` before pulling.
## Connecting a client in one paragraph
Open the admin panel (`http://<host>:<HTTP port>/admin`), go to Settings › Network and TLS and copy the **Client
address**. Type it in Chronos (Server) and in the Uploader. The first connection shows the server's certificate
**Fingerprint**; compare it with the one on the same admin page and accept it once. When the container's ports are
published as other host ports, set **Public HTTP port** and **Public HTTPS port** first, so the client address names the
ports clients can reach ([docker.md › Ports](docker.md#ports)).