diff --git a/deploy/docker/.env.example b/deploy/docker/.env.example index f7e438eb..34666df7 100644 --- a/deploy/docker/.env.example +++ b/deploy/docker/.env.example @@ -1,5 +1,6 @@ TITANO_ADMIN_PASSWORD=change-me-at-first-login TITANO_DB_PASSWORD=choose-a-long-random-password +# Folder of your archive, owned by PUID:PGID (an empty or root-owned folder is given to them at the first start) TITANO_ARCHIVE=/mnt/user/Timelapse TITANO_DATA=./data TITANO_PGDATA=./pgdata diff --git a/deploy/docker/Dockerfile b/deploy/docker/Dockerfile index b55c8971..62efaee5 100644 --- a/deploy/docker/Dockerfile +++ b/deploy/docker/Dockerfile @@ -21,6 +21,8 @@ LABEL org.opencontainers.image.title="Titano Server" \ org.opencontainers.image.description="Time-lapse archive, uploads, jobs and rendering server" \ org.opencontainers.image.version="$TITANO_VERSION" \ org.opencontainers.image.licenses="LicenseRef-Titano-EULA" +# ASPNETCORE_HTTP_PORTS is emptied: the server binds its own ports, and the base image's 8080 only made Kestrel warn +# "Overriding address(es)" at every start. ENV TITANO_ARCHIVE_PATH=/archive \ TITANO_DATA_PATH=/data \ TITANO_HTTP_PORT=8080 \ @@ -28,6 +30,7 @@ ENV TITANO_ARCHIVE_PATH=/archive \ TITANO_DB=postgres \ PUID=1000 \ PGID=1000 \ + ASPNETCORE_HTTP_PORTS= \ DOTNET_gcServer=1 \ DOTNET_GCHeapAffinitizeMask= \ DOTNET_NOLOGO=1 diff --git a/deploy/docker/docker-compose.yml b/deploy/docker/docker-compose.yml index f8f6c3c9..c32c1862 100644 --- a/deploy/docker/docker-compose.yml +++ b/deploy/docker/docker-compose.yml @@ -8,6 +8,9 @@ services: depends_on: postgres: condition: service_healthy + # Publishing a port as another host port ("18443:8443")? Set TITANO_PUBLIC_HTTPS_PORT (and _HTTP_PORT) below to the + # host port. LAN discovery reaches clients only with "network_mode: host" (then drop "ports"); on this bridge + # network clients add the server by its address. ports: - "8080:8080" - "8443:8443" @@ -20,7 +23,10 @@ services: TITANO_DB_NAME: titano TITANO_DB_USER: titano TITANO_DB_PASSWORD: ${TITANO_DB_PASSWORD:?set TITANO_DB_PASSWORD in .env} + # auto (self-signed), pem or proxy; behind a proxy, TITANO_TRUSTED_PROXIES lists its address if it is not on a + # private network TITANO_TLS_MODE: auto + # TITANO_PUBLIC_HTTPS_PORT: "8443" TITANO_SERVER_NAME: Titano Server # Trace, Debug, Information, Warning or Error TITANO_LOG_LEVEL: Information @@ -28,6 +34,8 @@ services: PGID: ${PGID:-1000} TZ: ${TZ:-UTC} volumes: + # The archive folder should belong to PUID:PGID; an empty or root-owned one is given to them at start (the folder + # only, never its contents). - ${TITANO_ARCHIVE:-./archive}:/archive - ${TITANO_DATA:-./data}:/data diff --git a/deploy/docker/entrypoint.sh b/deploy/docker/entrypoint.sh index 9ea31992..8604d26f 100755 --- a/deploy/docker/entrypoint.sh +++ b/deploy/docker/entrypoint.sh @@ -1,17 +1,39 @@ #!/bin/sh -# Runs Titano Server as PUID:PGID (Unraid/NAS convention). /data is owned by that user; /archive is left as -# mounted (it may hold terabytes) and only checked for write access. +# Runs Titano Server as PUID:PGID (Unraid/NAS convention). The data folder is owned by that user. The archive is left +# as mounted (it may hold terabytes) and only checked for write access; only when that user cannot write it and the +# folder is empty or owned by root (Docker creates a missing bind source or a fresh volume that way) is the folder +# itself, never its contents, given to PUID:PGID. set -eu PUID="${PUID:-1000}" PGID="${PGID:-1000}" +DATA="${TITANO_DATA_PATH:-/data}" +ARCHIVE="${TITANO_ARCHIVE_PATH:-/archive}" umask 002 +# Help and the health probe touch neither folder. +case "${1:-}" in + --help | -h | -\? | /\? | --healthcheck) exec dotnet /app/Titano.Server.dll "$@" ;; +esac + +as_user() { + setpriv --reuid="$PUID" --regid="$PGID" --clear-groups -- "$@" +} + if [ "$(id -u)" = "0" ]; then - mkdir -p /data - chown -R "$PUID:$PGID" /data - if ! setpriv --reuid="$PUID" --regid="$PGID" --clear-groups -- test -w "${TITANO_ARCHIVE_PATH:-/archive}"; then - echo "warning: ${TITANO_ARCHIVE_PATH:-/archive} is not writable by $PUID:$PGID" >&2 + mkdir -p "$DATA" "$ARCHIVE" + chown -R "$PUID:$PGID" "$DATA" + if ! as_user test -w "$ARCHIVE"; then + if [ -z "$(ls -A "$ARCHIVE")" ] || [ "$(stat -c %u "$ARCHIVE")" = "0" ]; then + owner="$(stat -c %u:%g "$ARCHIVE")" + if chown "$PUID:$PGID" "$ARCHIVE" 2>/dev/null; then + echo "titano: $ARCHIVE belonged to $owner; it now belongs to $PUID:$PGID (the folder only, not its contents)" + fi + fi + if ! as_user test -w "$ARCHIVE"; then + echo "error: $ARCHIVE is not writable by $PUID:$PGID; give that user write access to the archive folder on the host, or set PUID and PGID to its owner" >&2 + exit 1 + fi fi exec setpriv --reuid="$PUID" --regid="$PGID" --clear-groups -- dotnet /app/Titano.Server.dll "$@" fi diff --git a/deploy/releases-repo/README.md b/deploy/releases-repo/README.md index 19fcefa7..399080cd 100644 --- a/deploy/releases-repo/README.md +++ b/deploy/releases-repo/README.md @@ -64,6 +64,10 @@ curl -L -o .env https://raw.githubusercontent.com/alby96/titano-releases/main/do docker compose up -d ``` +Create the archive folder owned by `PUID:PGID` first (for example `mkdir -p && chown 1000:1000 `). An +empty folder, or one owned by root (as Docker creates a missing one), is given to `PUID:PGID` at start: the folder +itself, never its contents. Any other folder that user cannot write stops the container with a one-line error. + Open `http://:8080/admin`, sign in as `admin` with the password from `.env` and choose a new one. Titano clients connect to `https://:8443`; the first connection shows the server's certificate fingerprint, which the admin panel shows under Settings so you can compare them. @@ -75,6 +79,15 @@ admin panel shows under Settings so you can compare them. - Upgrade: `docker compose pull && docker compose up -d`. Jobs in progress resume from their last checkpoint. - All settings: environment variables `TITANO_*` (see `docker-compose.yml`) or `/data/server.json`. Run `docker run --rm ghcr.io/alby96/titano-server:latest --help` for the list. +- Other host ports: when you publish the container's ports as other host ports (`18443:8443`), set + `TITANO_PUBLIC_HTTPS_PORT` (and `TITANO_PUBLIC_HTTP_PORT`) to the host ports, so the admin panel's redirect to HTTPS + and LAN discovery name the ports clients can reach. +- LAN discovery (`TITANO_DISCOVERY`, on by default) needs host networking (`network_mode: host` in compose, Network + type *Host* on Unraid): on a bridge network its broadcasts never leave the container's network. Without it, add the + server in Titano by its address. +- Behind a reverse proxy (`TITANO_TLS_MODE=proxy`), only the proxies listed in `TITANO_TRUSTED_PROXIES` may set + `X-Forwarded-*` headers (default: loopback and the private networks 10/8, 172.16/12, 192.168/16, fc00::/7). The admin + panel shows *Not via proxy* when a page did not come through a trusted proxy over HTTPS. ## Titano Server on Unraid @@ -82,18 +95,26 @@ admin panel shows under Settings so you can compare them. role `titano` (for example with `docker exec -it postgresql17 psql -U postgres -c "CREATE ROLE titano LOGIN PASSWORD '…'" -c "CREATE DATABASE titano OWNER titano"`). 2. In Docker › *Template repositories* add `https://github.com/alby96/titano-releases` and save. -3. Docker › *Add container* › Template `titano-server`. Set the admin password, the database host (the PostgreSQL - container's name or IP), password and the archive share (default `/mnt/user/Timelapse`). +3. Docker › *Add container* › Template `titano-server`. Set the admin password, the database host, password and the + archive share (default `/mnt/user/Timelapse`). The database host is the Unraid server's IP address (the PostgreSQL + template publishes port 5432): container names resolve only when both containers are on the same custom Docker + network, not on the default *bridge*. If you change the HTTPS port, enter the same port in *Public HTTPS port*. 4. Open the WebUI (`http://[IP]:8080/admin`). The template file is [`unraid/titano.xml`](unraid/titano.xml). ## Titano Server on Windows -Unpack `Titano-Server-win-x64-.zip` (or choose the *Server* component in the setup). It uses SQLite in +Choose the *Server* component in the setup, or unpack `Titano-Server-win-x64-.zip`. It uses SQLite in `C:\ProgramData\Titano Server` by default, or PostgreSQL with `TITANO_DB=postgres` and the `TITANO_DB_*` variables. +The data folder is readable only by the server's account, SYSTEM and Administrators; without `TITANO_ADMIN_PASSWORD` +the first start writes a temporary admin password to `initial-admin-password.txt` there (open it from an +administrator prompt). + Run `Titano.Server.exe` in a console, or install it as a Windows service from an administrator prompt with -`Titano.Server.exe --install-service` (remove it with `--uninstall-service`). +`Titano.Server.exe --install-service` (remove it with `--uninstall-service`). The service runs as LocalSystem, so it +registers only from a copy inside `Program Files` that only administrators can change: install for *All users*, or +unpack the zip into a folder under `Program Files`. ## Translations diff --git a/deploy/unraid/titano.xml b/deploy/unraid/titano.xml index 30fa9b4f..e45ef58f 100644 --- a/deploy/unraid/titano.xml +++ b/deploy/unraid/titano.xml @@ -22,12 +22,13 @@ A PostgreSQL 16 or 17 container (official "postgres" template) with a database and user for Titano. 8080 - 8443 + 8443 + /mnt/user/Timelapse /mnt/user/appdata/titano admin - postgresql17 + 5432 titano titano @@ -38,5 +39,5 @@ Information 99 100 - Europe/Rome + Europe/Rome