From 81a2971246816ea97dd453dcf9e1247b016edbeb Mon Sep 17 00:00:00 2001 From: Michael Mayer Date: Sat, 29 Apr 2023 11:58:14 +0200 Subject: [PATCH] Setup: Add config example for PhotoPrism Plus Signed-off-by: Michael Mayer --- setup/docker/arm64/docker-compose.yml | 2 +- setup/docker/armv7/docker-compose.yml | 2 +- setup/docker/docker-compose.yml | 2 +- setup/docker/macos/docker-compose.yml | 2 +- setup/docker/nvidia/docker-compose.yml | 2 +- setup/docker/plus/docker-compose.yml | 140 ++++++++++++++++++++++ setup/docker/scheduler/docker-compose.yml | 2 +- setup/docker/sqlite/docker-compose.yml | 2 +- setup/docker/windows/docker-compose.yml | 2 +- setup/podman/docker-compose.yml | 2 +- 10 files changed, 149 insertions(+), 9 deletions(-) create mode 100644 setup/docker/plus/docker-compose.yml diff --git a/setup/docker/arm64/docker-compose.yml b/setup/docker/arm64/docker-compose.yml index 2367a586b..d05d8623e 100644 --- a/setup/docker/arm64/docker-compose.yml +++ b/setup/docker/arm64/docker-compose.yml @@ -9,7 +9,7 @@ version: '3.5' # the "no matching manifest" error on Raspberry Pi OS (Raspbian). See documentation for details. # - Use https://dl.photoprism.app/docker/armv7/docker-compose.yml to run PhotoPrism and MariaDB on ARMv7-based devices # as well as Raspberry Pi OS (Raspbian) installations without 64-bit support. -# - Hardware transcoding is only available for sponsors due to the high maintenance and support effort. +# - Hardware transcoding is only available to members due to the high maintenance and support effort. # - Running PhotoPrism on a server with less than 4 GB of swap space or setting a memory/swap limit can cause unexpected # restarts ("crashes"), for example, when the indexer temporarily needs more memory to process large files. # - In case you see Docker errors related to "cgroups", try adding the following parameters to /boot/firmware/cmdline.txt diff --git a/setup/docker/armv7/docker-compose.yml b/setup/docker/armv7/docker-compose.yml index 390c1a81d..e0b360caf 100644 --- a/setup/docker/armv7/docker-compose.yml +++ b/setup/docker/armv7/docker-compose.yml @@ -4,7 +4,7 @@ version: '3.5' # # Note: # - Use https://dl.photoprism.app/docker/arm64/docker-compose.yml for running PhotoPrism on ARM64-based (64-bit) devices. -# - Hardware transcoding is only available for sponsors due to the high maintenance and support effort. +# - Hardware transcoding is only available to members due to the high maintenance and support effort. # - Running PhotoPrism on a server with less than 4 GB of swap space or setting a memory/swap limit can cause unexpected # restarts ("crashes"), for example, when the indexer temporarily needs more memory to process large files. # - In case you see Docker errors related to "cgroups", try adding the following parameters to /boot/firmware/cmdline.txt diff --git a/setup/docker/docker-compose.yml b/setup/docker/docker-compose.yml index 9c1836112..b8723c62c 100644 --- a/setup/docker/docker-compose.yml +++ b/setup/docker/docker-compose.yml @@ -3,7 +3,7 @@ version: '3.5' # Example Docker Compose config file for PhotoPrism (Linux / AMD64) # # Note: -# - Hardware transcoding is only available for sponsors due to the high maintenance and support effort. +# - Hardware transcoding is only available to members due to the high maintenance and support effort. # - Running PhotoPrism on a server with less than 4 GB of swap space or setting a memory/swap limit can cause unexpected # restarts ("crashes"), for example, when the indexer temporarily needs more memory to process large files. # - If you install PhotoPrism on a public server outside your home network, please always run it behind a secure diff --git a/setup/docker/macos/docker-compose.yml b/setup/docker/macos/docker-compose.yml index 97033dd15..c1328a7a0 100644 --- a/setup/docker/macos/docker-compose.yml +++ b/setup/docker/macos/docker-compose.yml @@ -3,7 +3,7 @@ version: '3.5' # Example Docker Compose config file for PhotoPrism (Apple macOS) # # Note: -# - Hardware transcoding is only available for sponsors due to the high maintenance and support effort. +# - Hardware transcoding is only available to members due to the high maintenance and support effort. # - Running PhotoPrism on a server with less than 4 GB of swap space or setting a memory/swap limit can cause unexpected # restarts ("crashes"), for example, when the indexer temporarily needs more memory to process large files. # - If you install PhotoPrism on a public server outside your home network, please always run it behind a secure diff --git a/setup/docker/nvidia/docker-compose.yml b/setup/docker/nvidia/docker-compose.yml index d612b6416..1ebaab38e 100644 --- a/setup/docker/nvidia/docker-compose.yml +++ b/setup/docker/nvidia/docker-compose.yml @@ -7,7 +7,7 @@ version: '3.5' # - https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/install-guide.html # # Note: -# - Hardware transcoding is only available for sponsors due to the high maintenance and support effort. +# - Hardware transcoding is only available to members due to the high maintenance and support effort. # - Running PhotoPrism on a server with less than 4 GB of swap space or setting a memory/swap limit can cause unexpected # restarts ("crashes"), for example, when the indexer temporarily needs more memory to process large files. # - If you install PhotoPrism on a public server outside your home network, please always run it behind a secure diff --git a/setup/docker/plus/docker-compose.yml b/setup/docker/plus/docker-compose.yml new file mode 100644 index 000000000..a8c526776 --- /dev/null +++ b/setup/docker/plus/docker-compose.yml @@ -0,0 +1,140 @@ +version: '3.5' + +# Example Docker Compose config file for PhotoPrism® Plus (Linux / AMD64) +# +# Note: +# - Hardware transcoding is only available to members due to the high maintenance and support effort. +# - Running PhotoPrism on a server with less than 4 GB of swap space or setting a memory/swap limit can cause unexpected +# restarts ("crashes"), for example, when the indexer temporarily needs more memory to process large files. +# - If you install PhotoPrism on a public server outside your home network, please always run it behind a secure +# HTTPS reverse proxy such as Traefik or Caddy. Your files and passwords will otherwise be transmitted +# in clear text and can be intercepted by anyone, including your provider, hackers, and governments: +# https://docs.photoprism.app/getting-started/proxies/traefik/ +# +# Setup Guides: +# - https://www.photoprism.app/plus/kb/quickstart +# +# Troubleshooting Checklists: +# - https://docs.photoprism.app/getting-started/troubleshooting/ +# - https://docs.photoprism.app/getting-started/troubleshooting/docker/ +# - https://docs.photoprism.app/getting-started/troubleshooting/mariadb/ +# +# CLI Commands: +# - https://docs.photoprism.app/getting-started/docker-compose/#command-line-interface +# +# All commands may have to be prefixed with "sudo" when not running as root. +# This will point the home directory shortcut ~ to /root in volume mounts. + +services: + photoprism: + ## Use photoprism/photoprism-plus:preview for testing preview builds: + image: photoprism/photoprism-plus:latest + ## Don't enable automatic restarts until PhotoPrism has been properly configured and tested! + ## If the service gets stuck in a restart loop, this points to a memory, filesystem, network, or database issue: + ## https://docs.photoprism.app/getting-started/troubleshooting/#fatal-server-errors + # restart: unless-stopped + stop_grace_period: 10s + depends_on: + - mariadb + security_opt: + - seccomp:unconfined + - apparmor:unconfined + ports: + - "2342:2342" # HTTP port (host:container) + environment: + PHOTOPRISM_ADMIN_USER: "admin" # superadmin username + PHOTOPRISM_ADMIN_PASSWORD: "insecure" # initial superadmin password (8-72 characters) + PHOTOPRISM_AUTH_MODE: "password" # authentication mode (public, password) + PHOTOPRISM_SITE_URL: "http://photoprism.me:2342/" # server URL in the format "http(s)://domain.name(:port)/(path)" + PHOTOPRISM_ORIGINALS_LIMIT: 5000 # file size limit for originals in MB (increase for high-res video) + PHOTOPRISM_HTTP_COMPRESSION: "gzip" # improves transfer speed and bandwidth utilization (none or gzip) + PHOTOPRISM_LOG_LEVEL: "info" # log level: trace, debug, info, warning, error, fatal, or panic + PHOTOPRISM_READONLY: "false" # do not modify originals directory (reduced functionality) + PHOTOPRISM_EXPERIMENTAL: "false" # enables experimental features + PHOTOPRISM_DISABLE_CHOWN: "false" # disables updating storage permissions via chmod and chown on startup + PHOTOPRISM_DISABLE_WEBDAV: "false" # disables built-in WebDAV server + PHOTOPRISM_DISABLE_SETTINGS: "false" # disables settings UI and API + PHOTOPRISM_DISABLE_TENSORFLOW: "false" # disables all features depending on TensorFlow + PHOTOPRISM_DISABLE_FACES: "false" # disables face detection and recognition (requires TensorFlow) + PHOTOPRISM_DISABLE_CLASSIFICATION: "false" # disables image classification (requires TensorFlow) + PHOTOPRISM_DISABLE_VECTORS: "false" # disables vector graphics support + PHOTOPRISM_DISABLE_RAW: "false" # disables indexing and conversion of RAW images + PHOTOPRISM_RAW_PRESETS: "false" # enables applying user presets when converting RAW images (reduces performance) + PHOTOPRISM_JPEG_QUALITY: 85 # a higher value increases the quality and file size of JPEG images and thumbnails (25-100) + PHOTOPRISM_DETECT_NSFW: "false" # automatically flags photos as private that MAY be offensive (requires TensorFlow) + PHOTOPRISM_UPLOAD_NSFW: "true" # allows uploads that MAY be offensive (no effect without TensorFlow) + # PHOTOPRISM_DATABASE_DRIVER: "sqlite" # SQLite is an embedded database that doesn't require a server + PHOTOPRISM_DATABASE_DRIVER: "mysql" # use MariaDB 10.5+ or MySQL 8+ instead of SQLite for improved performance + PHOTOPRISM_DATABASE_SERVER: "mariadb:3306" # MariaDB or MySQL database server (hostname:port) + PHOTOPRISM_DATABASE_NAME: "photoprism" # MariaDB or MySQL database schema name + PHOTOPRISM_DATABASE_USER: "photoprism" # MariaDB or MySQL database user name + PHOTOPRISM_DATABASE_PASSWORD: "insecure" # MariaDB or MySQL database user password + PHOTOPRISM_SITE_CAPTION: "AI-Powered Photos App" + PHOTOPRISM_SITE_DESCRIPTION: "" # meta site description + PHOTOPRISM_SITE_AUTHOR: "" # meta site author + ## Run/install on first startup (options: update https gpu tensorflow davfs clitools clean): + # PHOTOPRISM_INIT: "https gpu tensorflow" + ## Hardware Video Transcoding: + # PHOTOPRISM_FFMPEG_ENCODER: "software" # FFmpeg encoder ("software", "intel", "nvidia", "apple", "raspberry") + # PHOTOPRISM_FFMPEG_BITRATE: "32" # FFmpeg encoding bitrate limit in Mbit/s (default: 50) + ## Run as a non-root user after initialization (supported: 0, 33, 50-99, 500-600, and 900-1200): + # PHOTOPRISM_UID: 1000 + # PHOTOPRISM_GID: 1000 + # PHOTOPRISM_UMASK: 0000 + ## Start as non-root user before initialization (supported: 0, 33, 50-99, 500-600, and 900-1200): + # user: "1000:1000" + ## Share hardware devices with FFmpeg and TensorFlow (optional): + # devices: + # - "/dev/dri:/dev/dri" # Intel QSV + # - "/dev/nvidia0:/dev/nvidia0" # Nvidia CUDA + # - "/dev/nvidiactl:/dev/nvidiactl" + # - "/dev/nvidia-modeset:/dev/nvidia-modeset" + # - "/dev/nvidia-nvswitchctl:/dev/nvidia-nvswitchctl" + # - "/dev/nvidia-uvm:/dev/nvidia-uvm" + # - "/dev/nvidia-uvm-tools:/dev/nvidia-uvm-tools" + # - "/dev/video11:/dev/video11" # Video4Linux Video Encode Device (h264_v4l2m2m) + working_dir: "/photoprism" # do not change or remove + ## Storage Folders: "~" is a shortcut for your home directory, "." for the current directory + volumes: + # "/host/folder:/photoprism/folder" # Example + - "~/Pictures:/photoprism/originals" # Original media files (DO NOT REMOVE) + # - "/example/family:/photoprism/originals/family" # *Additional* media folders can be mounted like this + # - "~/Import:/photoprism/import" # *Optional* base folder from which files can be imported to originals + - "./storage:/photoprism/storage" # *Writable* storage folder for cache, database, and sidecar files (DO NOT REMOVE) + + ## Database Server (recommended) + ## see https://docs.photoprism.app/getting-started/faq/#should-i-use-sqlite-mariadb-or-mysql + mariadb: + image: mariadb:10.11 + ## If MariaDB gets stuck in a restart loop, this points to a memory or filesystem issue: + ## https://docs.photoprism.app/getting-started/troubleshooting/#fatal-server-errors + restart: unless-stopped + stop_grace_period: 5s + security_opt: # see https://github.com/MariaDB/mariadb-docker/issues/434#issuecomment-1136151239 + - seccomp:unconfined + - apparmor:unconfined + command: mysqld --innodb-buffer-pool-size=512M --transaction-isolation=READ-COMMITTED --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci --max-connections=512 --innodb-rollback-on-timeout=OFF --innodb-lock-wait-timeout=120 + ## Never store database files on an unreliable device such as a USB flash drive, an SD card, or a shared network folder: + volumes: + - "./database:/var/lib/mysql" # DO NOT REMOVE + environment: + MARIADB_AUTO_UPGRADE: "1" + MARIADB_INITDB_SKIP_TZINFO: "1" + MARIADB_DATABASE: "photoprism" + MARIADB_USER: "photoprism" + MARIADB_PASSWORD: "insecure" + MARIADB_ROOT_PASSWORD: "insecure" + + ## Watchtower upgrades services automatically (optional) + ## see https://docs.photoprism.app/getting-started/updates/#watchtower + ## activate via "COMPOSE_PROFILES=update docker compose up -d" + watchtower: + restart: unless-stopped + image: containrrr/watchtower + profiles: ["update"] + environment: + WATCHTOWER_CLEANUP: "true" + WATCHTOWER_POLL_INTERVAL: 7200 # checks for updates every two hours + volumes: + - "/var/run/docker.sock:/var/run/docker.sock" + - "~/.docker/config.json:/config.json" # optional, for authentication if you have a Docker Hub account diff --git a/setup/docker/scheduler/docker-compose.yml b/setup/docker/scheduler/docker-compose.yml index c1fa9894e..2da45ac01 100644 --- a/setup/docker/scheduler/docker-compose.yml +++ b/setup/docker/scheduler/docker-compose.yml @@ -4,7 +4,7 @@ version: '3.5' # Includes Ophelia, a docker job scheduler: https://github.com/mcuadros/ofelia # # Note: -# - Hardware transcoding is only available for sponsors due to the high maintenance and support effort. +# - Hardware transcoding is only available to members due to the high maintenance and support effort. # - Running PhotoPrism on a server with less than 4 GB of swap space or setting a memory/swap limit can cause unexpected # restarts ("crashes"), for example, when the indexer temporarily needs more memory to process large files. # - If you install PhotoPrism on a public server outside your home network, please always run it behind a secure diff --git a/setup/docker/sqlite/docker-compose.yml b/setup/docker/sqlite/docker-compose.yml index 0032e06db..36af2c7bd 100644 --- a/setup/docker/sqlite/docker-compose.yml +++ b/setup/docker/sqlite/docker-compose.yml @@ -3,7 +3,7 @@ version: '3.5' # Example Docker Compose config file for PhotoPrism (Linux / AMD64) # # Note: -# - Hardware transcoding is only available for sponsors due to the high maintenance and support effort. +# - Hardware transcoding is only available to members due to the high maintenance and support effort. # - Use SQLite only for small libraries and testing. SQLite locks the index on updates, so other operations have to # wait. In the worst case, this can lead to timeout errors. MariaDB is optimized for high concurrency. # - Running PhotoPrism on a server with less than 4 GB of swap space or setting a memory/swap limit can cause unexpected diff --git a/setup/docker/windows/docker-compose.yml b/setup/docker/windows/docker-compose.yml index 4b2d0b2ac..f3a505c34 100644 --- a/setup/docker/windows/docker-compose.yml +++ b/setup/docker/windows/docker-compose.yml @@ -3,7 +3,7 @@ version: '3.5' # Example Docker Compose config file for PhotoPrism (Windows / AMD64) # # Note: -# - Hardware transcoding is only available for sponsors due to the high maintenance and support effort. +# - Hardware transcoding is only available to members due to the high maintenance and support effort. # - Running PhotoPrism on a server with less than 4 GB of swap space or setting a memory/swap limit can cause unexpected # restarts ("crashes"), for example, when the indexer temporarily needs more memory to process large files. # - Windows Pro users should disable the WSL 2 based engine in Docker Settings > General so that diff --git a/setup/podman/docker-compose.yml b/setup/podman/docker-compose.yml index a16d2715c..48591cc1b 100644 --- a/setup/podman/docker-compose.yml +++ b/setup/podman/docker-compose.yml @@ -3,7 +3,7 @@ version: '3.5' # Example Podman Compose config file for PhotoPrism (RedHat, CentOS, Fedora, and AlmaLinux) # # Note: -# - Hardware transcoding is only available for sponsors due to the high maintenance and support effort. +# - Hardware transcoding is only available to members due to the high maintenance and support effort. # - Running PhotoPrism on a server with less than 4 GB of swap space or setting a memory/swap limit can cause unexpected # restarts ("crashes"), for example, when the indexer temporarily needs more memory to process large files. # - If you install PhotoPrism on a public server outside your home network, please always run it behind a secure