cdnutterandClaude Opus 5.5
f3185ba7bd
Backups are .tar.gz archives of a consistent database snapshot (VACUUM INTO) plus the images folder. They run on a cron schedule, daily at 3:00 by default, and the newest N scheduled ones are kept (7 by default). Manual backups are never pruned. Settings → Backups offers schedule presets or a custom cron expression, retention, "Back up now", and download/delete for each backup. A small built-in parser handles standard 5-field cron syntax with names, ranges, steps and @daily-style shorthands. Backups go to CANON_BACKUP_DIR (default data/backups). Compose mounts a separate canon-backups volume at /backups, overridable with CANON_BACKUP_PATH. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
39 lines
1.5 KiB
Bash
39 lines
1.5 KiB
Bash
# Copy to .env and fill in what you need. Everything here is optional.
|
|
|
|
# Create the owner account on first start. If unset, Canon prints a one-time
|
|
# setup code to the log and you create the account at http://<host>:4242/setup.
|
|
CANON_ADMIN_USERNAME=
|
|
CANON_ADMIN_PASSWORD=
|
|
|
|
# API keys. You can also enter these in Settings → Integrations; values set
|
|
# here take precedence and are locked in the web UI.
|
|
CANON_TMDB_API_KEY=
|
|
CANON_TVDB_API_KEY=
|
|
CANON_TVDB_PIN=
|
|
CANON_IGDB_CLIENT_ID=
|
|
CANON_IGDB_CLIENT_SECRET=
|
|
|
|
# Behind a reverse proxy that terminates HTTPS:
|
|
# CANON_TRUST_PROXY=true # honor X-Forwarded-For / -Proto / -Host
|
|
# CANON_SECURE_COOKIES=true # always mark the session cookie Secure
|
|
|
|
# CANON_HOST=0.0.0.0 # all network interfaces; 127.0.0.1 = this machine only
|
|
# CANON_PORT=4242
|
|
# CANON_LOG_LEVEL=debug
|
|
# CANON_BACKUP_DIR=./data/backups # outside Docker; Compose sets /backups
|
|
|
|
# Time zone for backup schedules (default UTC in Docker).
|
|
# TZ=America/Los_Angeles
|
|
|
|
# ---- Docker Compose only (not read by Canon itself) ----
|
|
# Where the database and images live. Default: the canon_canon-data volume.
|
|
# Use an absolute host path to keep them in a folder (writable by UID 1000).
|
|
# CANON_DATA_PATH=/srv/canon
|
|
# Where backups are written. Default: the canon_canon-backups volume.
|
|
# CANON_BACKUP_PATH=/mnt/nas/canon-backups
|
|
# Host address and port to publish on.
|
|
# CANON_BIND=0.0.0.0
|
|
# CANON_PUBLISH_PORT=4242
|
|
# Version label baked into the image at build time.
|
|
# CANON_VERSION=dev
|