Files
Chronos/docs/deploy/desktop.md
T
Alby96andClaude Opus 5.5 0075065884
CI / Build and test (push) Successful in 10m37s
CI / Windows tests and installer (push) Skipped
CI / YAML check (push) Successful in 9s
Release / Build, test and publish (push) Successful in 16m19s
CI / PostgreSQL 16 integration (push) Successful in 10m19s
CI / PostgreSQL 17 integration (push) Successful in 11m27s
CI / Docker image (push) Successful in 57s
Release / Server image (push) Successful in 1m34s
feat: work board, no usage data, archive folder tree, deploy guide (owner review 4 + owner review 1 phase 6) (#62)
Owner review 4 and owner review 1 phase 6.

- Work board in Videos (desktop and admin panel): Published and Workspace lanes (#29).
- Anonymous usage counts removed: Chronos sends nothing about its use (#30).
- The archive's whole folder tree is created inside any archive root, on the server and the desktop (#31).
- Video cards start with the preset; sizes keep number and unit together (#28).
- Deploy guide docs/deploy (Docker, Unraid, desktop), BRIEF §24, original documentation in docs/reference/original (#22).

Closes #22 #28 #29 #30 #31

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-authored-by: Alberto Balbo <alberto.balbo.96@gmail.com>
2026-11-06 18:46:22 +01:00

94 lines
5.6 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.
# Chronos on Windows
Chronos (the desktop program), Chronos Uploader and Chronos Server for Windows. Requirements: Windows 10 21H2 or later,
or Windows 11, x64; 8 GB of memory or more for 4K renders. The programs are self-contained: no .NET runtime to install.
## Downloads
Each release on Gitea carries:
| File | What it is |
|---|---|
| `Chronos-Setup-<version>.exe` | Setup with the components Chronos, Uploader and, optionally, Server |
| `Chronos-Uploader-Setup-<version>.exe` | Setup of the Uploader alone |
| `Chronos-win-x64-portable-<version>.zip` | Chronos without installing (portable mode) |
| `Chronos-Server-win-x64-<version>.zip` | Chronos Server for Windows without the setup |
| `SHA256SUMS` | The SHA-256 of every file |
Check a download before running it: `Get-FileHash .\Chronos-Setup-<version>.exe -Algorithm SHA256` in PowerShell, then
compare with its line in `SHA256SUMS`. Signed builds carry an Authenticode signature; unsigned ones may show a
SmartScreen prompt.
## Setup
- **Per user** (default, no administrator rights): `%LOCALAPPDATA%\Programs\Chronos`.
- **All users**: `Program Files` (Windows asks for permission). Choosing the *Server* component installs for all users,
since it runs as a Windows service.
- Options: components, folder, desktop and Start menu shortcuts, the `.chronos` file type.
- **Silent** (IT deployment): `Chronos-Setup-<version>.exe /S [/DIR="D:\Apps\Chronos"] [/ALLUSERS]
[/COMPONENTS=Chronos,Uploader,Server] [/NODESKTOP] [/NOSTARTMENU] [/LANG=it]`.
- **Upgrade**: run the newer setup over the installed version; it upgrades in place and keeps archive, settings and
index.
- **Uninstall**: Windows Settings › Apps › Installed apps › Chronos › Uninstall, or silently
`"%LOCALAPPDATA%\Programs\Chronos\Uninstall Chronos.exe" /uninstall /S`. Photos and archives are never touched. The
program data in `%LOCALAPPDATA%\Chronos` goes only when you tick that option, and only the part no other installed
Chronos program still uses; a Chronos Server service of that folder is stopped and removed.
## Data folders
| Install | Settings, index (`chronos.db`), logs, caches |
|---|---|
| Setup | `%LOCALAPPDATA%\Chronos` |
| Portable | `data\` next to `Chronos.exe` |
Keep neither inside a OneDrive or Dropbox folder: a SQLite index in a synced folder gets corrupted. The archive and
the workspace are folders you choose in Settings › Archive and Settings › Workspace (the workspace best on a fast local
disk).
Backups of the index go to `backups\` next to it every day (Settings › Advanced › *Back up now* for one more copy;
restore there too).
## Portable mode
Unpack `Chronos-win-x64-portable-<version>.zip` into a folder you can write. The `portable.txt` file next to
`Chronos.exe` keeps everything under `data\` in that folder, so the whole folder can move to another PC or a USB drive.
To upgrade, unpack the newer zip over it (or let *Download* fetch it, below); `data\` stays.
## Updates
- At start (Settings › Updates › *Check on start*, on by default) Chronos reads the **stable** releases of the releases
repository and shows a one-line notice when a newer version exists. *Check for updates* asks at any time.
- *Download* fetches the setup (or, in portable mode, the portable zip), checks it against `SHA256SUMS` and shows it in
Explorer: run it to upgrade.
- There is one channel: stable releases. Pre-releases (`-rc.N`) are never offered; install them by hand from the
Releases page. A pre-release build is offered every newer stable release, and the final release of its own version
once it is out (a `1.1.0-rc.1` build is offered `1.1.0`).
- While the Gitea organisation is private, the check fails for anyone who cannot see the repository (*Check failed*);
it never claims *Up to date* then.
## Connecting to a server
In Chronos (Server) and in the Uploader type the **Client address** the admin panel shows (Settings › Network and TLS),
for example `https://nas.local:8444`. An address without scheme or port means port 8443. The first connection shows the
certificate fingerprint: compare it with the admin panel's and accept it once; a later change asks again. An address
that answers as another service is reported as *not a Chronos server*. Server setup and ports: [docker.md](docker.md),
[unraid.md](unraid.md).
## Chronos Server on Windows
Choose the *Server* component in the setup, or unpack `Chronos-Server-win-x64-<version>.zip` into a folder under
`Program Files`.
- Database: SQLite in `C:\ProgramData\Chronos Server` by default, or PostgreSQL with `CHRONOS_DB=postgres` and the
`CHRONOS_DB_*` variables ([docker.md](docker.md#environment-variables)); archive `C:\ChronosArchive` unless
`CHRONOS_ARCHIVE_PATH` says otherwise. The listening ports are 8080 and 8443 and can be changed in the admin panel.
- Run `Chronos.Server.exe` in a console, or as a service from an administrator prompt: `Chronos.Server.exe
--install-service` (remove with `--uninstall-service`). The service runs as LocalSystem and registers only from a copy
that only administrators can change.
- Without `CHRONOS_ADMIN_PASSWORD` the first start writes a temporary password to `initial-admin-password.txt` in the
data folder (open it from an administrator prompt).
- The data folder is readable only by the server's account, SYSTEM and Administrators. A console run that was not
elevated creates it as your account, and the service then refuses it and names that account: the user guide
(`deploy/releases-repo/README.md` › Chronos Server on Windows) gives the `takeown` and `icacls` commands that fix it.
- Index backups: the `index-backup` schedule copies the SQLite index daily at 03:00 (three copies kept). With
PostgreSQL use `pg_dump`.