Files
Chronos/docs/deploy/README.md
T
Alby96andClaude Opus 5.5 817956e719 fix: wire the owner review 5 parcels together; docs
The six parcels of owner review 5 merged into or5-v1.1 need a few joins
that no single parcel owned:

- The workspace copy and send jobs compare a project's home server
  through WorkspaceJobOptions.SameServer, so a job queued under a
  server's 1.0 address still runs once its home is re-keyed to the
  server id (plan step S3), with a test against a real server.
- The sample data gives its running and paused jobs a progress detail
  (SampleJobDetails), so the captures show the status line.
- The Windows service strings (Server.Service.*) went with the service
  hosting; they are removed line by line from all 38 cultures.
- The VS Code launch and build task start Chronos.Server.Host, now that
  Chronos.Server is a library.

Docs: CHANGELOG [Unreleased], DECISIONS rows, BRIEF amendments and the
section 24 rows for R1-R4, ARCHITECTURE, the deploy guides (Chronos
Server in Docker only; on Windows Chronos Desktop shares its library),
both READMEs and STATUS (owner review 5 in progress for v1.1.0).

Refs #64 #65 #66 #67

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-15 15:24:55 +01:00

50 lines
3.5 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 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](desktop.md#share-a-library-from-chronos-desktop)).
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 |
|---|---|
| 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](docker.md#ports)).