Co-authored-by: Alberto Balbo <alberto.balbo.96@gmail.com>
3.5 KiB
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 | Chronos Server in Docker with Compose: image tags, volumes, every CHRONOS_* variable, ports, TLS, PostgreSQL, upgrades, backup and restore, troubleshooting |
| 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 | Chronos Desktop and Chronos Uploader on Windows: the one setup, portable mode, updates, uninstall; sharing a library from Chronos Desktop |
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; can share its own library on the LAN (Settings › Server › Share this library) |
| Chronos Uploader | Windows 10 21H2+ / 11, x64 | A Chronos Server, or a library Chronos Desktop shares, over HTTPS |
| Chronos Server | Docker (linux/amd64), Unraid 6.12+ |
PostgreSQL 16 or 17; its archive folder |
On Windows there is no separate server program: Chronos Desktop › Settings › Server › Share this library serves the PC's library with the same engine (desktop.md).
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).
Where to get them
| What | Where |
|---|---|
The setup (Chronos-Setup-<version>.exe), the portable 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).