CI / Build and test (push) Successful in 11m36s
CI / Windows tests and installer (push) Skipped
CI / YAML check (push) Successful in 12s
Release / Build, test and publish (push) Successful in 14m56s
CI / PostgreSQL 16 integration (push) Successful in 10m11s
CI / PostgreSQL 17 integration (push) Successful in 10m15s
CI / Docker image (push) Successful in 45s
Release / Server image (push) Successful in 4m55s
Co-authored-by: Alberto Balbo <alberto.balbo.96@gmail.com>
116 lines
7.7 KiB
Markdown
116 lines
7.7 KiB
Markdown
# Chronos on Windows
|
||
|
||
Chronos Desktop and Chronos Uploader, and sharing a library from Chronos Desktop. 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. Chronos Server itself runs only in Docker ([docker.md](docker.md), [unraid.md](unraid.md)); on Windows, Chronos
|
||
Desktop serves its own library instead (below).
|
||
|
||
## Downloads
|
||
|
||
Each release on Gitea carries:
|
||
|
||
| File | What it is |
|
||
|---|---|
|
||
| `Chronos-Setup-<version>.exe` | The one setup: Chronos Desktop, Chronos Uploader or both |
|
||
| `Chronos-win-x64-portable-<version>.zip` | Chronos Desktop without installing (portable mode) |
|
||
| `SHA256SUMS` | The SHA-256 of every file |
|
||
|
||
Since 1.1 there is no separate Uploader setup and no Chronos Server for Windows. If you installed Chronos Uploader 1.0
|
||
on its own, run `Chronos-Setup-<version>.exe` once: it replaces the separate Uploader, keeping its sign-in entry, its
|
||
shortcut and its data.
|
||
|
||
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).
|
||
- Options: components (Chronos Desktop, preselected, and Chronos Uploader), folder, desktop and Start menu shortcuts,
|
||
the `.chronos` file type.
|
||
- **Silent** (IT deployment): `Chronos-Setup-<version>.exe /S [/DIR="D:\Apps\Chronos"] [/ALLUSERS]
|
||
[/COMPONENTS=Desktop,Uploader] [/NODESKTOP] [/NOSTARTMENU] [/LANG=it]`. `Desktop` and `Chronos` name the same
|
||
component. An explicit `/COMPONENTS` list is exact: an installed component it leaves out is removed.
|
||
- **Upgrade, add or remove**: run the newer setup over the installed version; it upgrades in place and keeps archive,
|
||
settings and index. Tick or untick a program to add or remove it; the *Changes* row lists what will happen before
|
||
anything runs. A file you changed since the setup installed it is never deleted ("N changed files kept"). With every
|
||
program unticked the button becomes *Uninstall*.
|
||
- **Chronos Server 1.0 for Windows**: a setup that finds it shows "Chronos Server 1.0.0 · No longer offered" and leaves
|
||
it, and its Windows service, untouched. Untick it (or leave it out of `/COMPONENTS`) to remove it with its service; its
|
||
data in `%ProgramData%\Chronos Server` is kept. To keep serving that library, share it from Chronos Desktop (below) or
|
||
move to [Docker](docker.md).
|
||
- **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 1.0 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).
|
||
|
||
Since 1.1 the workspace and the cache keep a separate home for this PC (`local\`) and for each server
|
||
(`servers\<id>\`); the first start of 1.1 sorts a 1.0 workspace and cache into them by renaming folders (a toast says
|
||
*Folders sorted*). Chronos 1.0 cannot open a sorted workspace: downgrading is not supported. Originals downloaded from a
|
||
server go to that server's own archive beside this PC's (for example `D:\ChronosArchive - Studio NAS`); Settings ›
|
||
Workspace › Home folders and Settings › Server › Known servers show every folder with *Open*.
|
||
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.
|
||
- Chronos Uploader checks the same way (its Settings › Updates: *Check on start*, *Check now*, *Download*, *Show setup*),
|
||
except at start when Chronos Desktop is installed in the same folder, whose notice covers the same setup.
|
||
- 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).
|
||
|
||
## Share a library from Chronos Desktop
|
||
|
||
On Windows a library is served by Chronos Desktop itself: Settings › Server › *Share this library*. While Chronos runs
|
||
it serves this PC's current archive to other PCs, Chronos Uploader and render nodes with the same engine as the Docker
|
||
image (API, admin panel, accounts, TLS, LAN announcement, uploads, sync, render nodes), over the desktop's own index:
|
||
there is no second copy of the data.
|
||
|
||
- Ports: HTTPS 8443 and HTTP 8080 by default (Settings › Server › Sharing, with the public ports and the LAN
|
||
announcement). Windows may ask once to let Chronos through the firewall on private networks: allow it, or clients
|
||
cannot connect.
|
||
- Server › This library shows the addresses (with *Copy*), the ports, the certificate fingerprint (with *Copy*), the
|
||
first admin's temporary password while it has not been changed (*Show*, *Copy*), the clients of the last 5 minutes and
|
||
the render nodes online, and *Admin panel*. Clients connect exactly as to a Docker server ("studio-pc" alone works).
|
||
- Sharing stops when Chronos closes. A port in use leaves sharing *Not started*, naming the port.
|
||
- The server's own data (certificate, `server.json`, uploads) lives in `<data folder>\server`; accounts live in the
|
||
index, so its backups cover them.
|
||
- The settings Chronos Desktop owns read "Set in Chronos Desktop" in the admin panel.
|
||
|
||
Moving from Chronos Server 1.0 for Windows: share the same archive folder from Chronos Desktop (Settings › Archive, then
|
||
*Share this library*), or run the Docker image with that archive and a PostgreSQL database; then untick Chronos Server in
|
||
the setup. The 1.0 server's accounts and history stay in its own database in `%ProgramData%\Chronos Server`.
|