From 251a69b001ca7b6c86270f7bb2e221acb70fcde8 Mon Sep 17 00:00:00 2001 From: Michael Mayer Date: Fri, 4 Nov 2022 11:31:48 +0100 Subject: [PATCH] NVIDIA: Add docker-compose.yml example #2613 Signed-off-by: Michael Mayer --- docker/examples/arm64/docker-compose.yml | 32 ++--- docker/examples/armv7/docker-compose.yml | 30 ++-- docker/examples/docker-compose.yml | 32 ++--- docker/examples/macos/docker-compose.yml | 31 ++--- docker/examples/nvidia/docker-compose.yml | 137 +++++++++++++++++++ docker/examples/scheduler/docker-compose.yml | 28 +--- docker/examples/sqlite/docker-compose.yml | 28 +--- docker/examples/windows/docker-compose.yml | 30 ++-- 8 files changed, 203 insertions(+), 145 deletions(-) create mode 100644 docker/examples/nvidia/docker-compose.yml diff --git a/docker/examples/arm64/docker-compose.yml b/docker/examples/arm64/docker-compose.yml index 65b3e0533..4fa0284a8 100644 --- a/docker/examples/arm64/docker-compose.yml +++ b/docker/examples/arm64/docker-compose.yml @@ -9,6 +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. # - 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 @@ -18,28 +19,17 @@ version: '3.5' # in clear text and can be intercepted by anyone, including your provider, hackers, and governments: # https://docs.photoprism.app/getting-started/proxies/traefik/ # -# Documentation : https://docs.photoprism.app/getting-started/raspberry-pi/ -# Docker Hub URL: https://hub.docker.com/r/photoprism/photoprism/ +# Setup Guides: +# - https://docs.photoprism.app/getting-started/docker-compose/ +# - https://docs.photoprism.app/getting-started/raspberry-pi/ # -# DOCKER COMPOSE COMMAND REFERENCE -# see https://docs.photoprism.app/getting-started/docker-compose/#command-line-interface -# -------------------------------------------------------------------------- -# Start | docker-compose up -d -# Stop | docker-compose stop -# Update | docker-compose pull -# Logs | docker-compose logs --tail=25 -f -# Terminal | docker-compose exec photoprism bash -# Help | docker-compose exec photoprism photoprism help -# Config | docker-compose exec photoprism photoprism config -# Reset | docker-compose exec photoprism photoprism reset -# Backup | docker-compose exec photoprism photoprism backup -a -i -# Restore | docker-compose exec photoprism photoprism restore -a -i -# Index | docker-compose exec photoprism photoprism index -# Reindex | docker-compose exec photoprism photoprism index -f -# Import | docker-compose exec photoprism photoprism import +# 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/ # -# To search originals for faces without a complete rescan: -# docker-compose exec photoprism photoprism faces index +# 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. @@ -92,7 +82,7 @@ services: PHOTOPRISM_SITE_AUTHOR: "" # meta site author ## Run/install on first startup (options: update, gpu, tensorflow, davfs, clean): # PHOTOPRISM_INIT: "update clean" - ## Hardware Video Transcoding (for sponsors only due to high maintenance and support costs): + ## Hardware Video Transcoding: # PHOTOPRISM_FFMPEG_ENCODER: "raspberry" # 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): diff --git a/docker/examples/armv7/docker-compose.yml b/docker/examples/armv7/docker-compose.yml index e61c30ab4..a7d550419 100644 --- a/docker/examples/armv7/docker-compose.yml +++ b/docker/examples/armv7/docker-compose.yml @@ -4,6 +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. # - 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 @@ -13,28 +14,17 @@ version: '3.5' # in clear text and can be intercepted by anyone, including your provider, hackers, and governments: # https://docs.photoprism.app/getting-started/proxies/traefik/ # -# Documentation : https://docs.photoprism.app/getting-started/raspberry-pi/ -# Docker Hub URL: https://hub.docker.com/r/photoprism/photoprism/ +# Setup Guides: +# - https://docs.photoprism.app/getting-started/docker-compose/ +# - https://docs.photoprism.app/getting-started/raspberry-pi/ # -# DOCKER COMPOSE COMMAND REFERENCE -# see https://docs.photoprism.app/getting-started/docker-compose/#command-line-interface -# -------------------------------------------------------------------------- -# Start | docker-compose up -d -# Stop | docker-compose stop -# Update | docker-compose pull -# Logs | docker-compose logs --tail=25 -f -# Terminal | docker-compose exec photoprism bash -# Help | docker-compose exec photoprism photoprism help -# Config | docker-compose exec photoprism photoprism config -# Reset | docker-compose exec photoprism photoprism reset -# Backup | docker-compose exec photoprism photoprism backup -a -i -# Restore | docker-compose exec photoprism photoprism restore -a -i -# Index | docker-compose exec photoprism photoprism index -# Reindex | docker-compose exec photoprism photoprism index -f -# Import | docker-compose exec photoprism photoprism import +# 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/ # -# To search originals for faces without a complete rescan: -# docker-compose exec photoprism photoprism faces index +# 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. diff --git a/docker/examples/docker-compose.yml b/docker/examples/docker-compose.yml index 8f837617e..a51352eb0 100644 --- a/docker/examples/docker-compose.yml +++ b/docker/examples/docker-compose.yml @@ -3,6 +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. # - 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 @@ -10,28 +11,17 @@ version: '3.5' # in clear text and can be intercepted by anyone, including your provider, hackers, and governments: # https://docs.photoprism.app/getting-started/proxies/traefik/ # -# Documentation : https://docs.photoprism.app/getting-started/docker-compose/ -# Docker Hub URL: https://hub.docker.com/r/photoprism/photoprism/ +# Setup Guides: +# - https://docs.photoprism.app/getting-started/docker-compose/ +# - https://docs.photoprism.app/getting-started/raspberry-pi/ # -# DOCKER COMPOSE COMMAND REFERENCE -# see https://docs.photoprism.app/getting-started/docker-compose/#command-line-interface -# -------------------------------------------------------------------------- -# Start | docker-compose up -d -# Stop | docker-compose stop -# Update | docker-compose pull -# Logs | docker-compose logs --tail=25 -f -# Terminal | docker-compose exec photoprism bash -# Help | docker-compose exec photoprism photoprism help -# Config | docker-compose exec photoprism photoprism config -# Reset | docker-compose exec photoprism photoprism reset -# Backup | docker-compose exec photoprism photoprism backup -a -i -# Restore | docker-compose exec photoprism photoprism restore -a -i -# Index | docker-compose exec photoprism photoprism index -# Reindex | docker-compose exec photoprism photoprism index -f -# Import | docker-compose exec photoprism photoprism import +# 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/ # -# To search originals for faces without a complete rescan: -# docker-compose exec photoprism photoprism faces index +# 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. @@ -83,7 +73,7 @@ services: 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 (for sponsors only due to high maintenance and support costs): + ## 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): diff --git a/docker/examples/macos/docker-compose.yml b/docker/examples/macos/docker-compose.yml index d6de7ff60..a73e3e8bf 100644 --- a/docker/examples/macos/docker-compose.yml +++ b/docker/examples/macos/docker-compose.yml @@ -1,8 +1,9 @@ version: '3.5' -# Example Docker Compose config file for PhotoPrism (macOS) +# 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. # - 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 @@ -10,28 +11,16 @@ version: '3.5' # in clear text and can be intercepted by anyone, including your provider, hackers, and governments: # https://docs.photoprism.app/getting-started/proxies/traefik/ # -# Documentation : https://docs.photoprism.app/getting-started/docker-compose/ -# Docker Hub URL: https://hub.docker.com/r/photoprism/photoprism/ +# Setup Guide: +# - https://docs.photoprism.app/getting-started/docker-compose/ # -# DOCKER COMPOSE COMMAND REFERENCE -# see https://docs.photoprism.app/getting-started/docker-compose/#command-line-interface -# -------------------------------------------------------------------------- -# Start | docker-compose up -d -# Stop | docker-compose stop -# Update | docker-compose pull -# Logs | docker-compose logs --tail=25 -f -# Terminal | docker-compose exec photoprism bash -# Help | docker-compose exec photoprism photoprism help -# Config | docker-compose exec photoprism photoprism config -# Reset | docker-compose exec photoprism photoprism reset -# Backup | docker-compose exec photoprism photoprism backup -a -i -# Restore | docker-compose exec photoprism photoprism restore -a -i -# Index | docker-compose exec photoprism photoprism index -# Reindex | docker-compose exec photoprism photoprism index -f -# Import | docker-compose exec photoprism photoprism import +# 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/ # -# To search originals for faces without a complete rescan: -# docker-compose exec photoprism photoprism faces index +# CLI Commands: +# - https://docs.photoprism.app/getting-started/docker-compose/#command-line-interface services: photoprism: diff --git a/docker/examples/nvidia/docker-compose.yml b/docker/examples/nvidia/docker-compose.yml new file mode 100644 index 000000000..a6b03608b --- /dev/null +++ b/docker/examples/nvidia/docker-compose.yml @@ -0,0 +1,137 @@ +version: '3.5' + +# Example Docker Compose config file for PhotoPrism (NVIDIA Container Toolkit / AMD64) +# +# For hardware transcoding with an NVIDIA graphics card, the NVIDIA Container Toolkit must be installed on +# the host computer first. Instructions can be found in their installation guide: +# - 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. +# - 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://docs.photoprism.app/getting-started/docker-compose/ +# - https://docs.photoprism.app/getting-started/troubleshooting/docker/ +# - https://docs.photoprism.app/getting-started/advanced/transcoding/#nvidia-container-toolkit +# +# 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:preview for testing preview builds: + image: photoprism/photoprism:latest + depends_on: + - mariadb + ## 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 + security_opt: + - seccomp:unconfined + - apparmor:unconfined + ports: + - "2342:2342" # HTTP port (host:container) + environment: + PHOTOPRISM_ADMIN_USER: "admin" # admin username + PHOTOPRISM_ADMIN_PASSWORD: "insecure" # initial admin password (minimum 8 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_RAW: "false" # disables indexing and conversion of RAW files + PHOTOPRISM_RAW_PRESETS: "false" # enables applying user presets when converting RAW files (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_DESCRIPTION: "" # meta site description + PHOTOPRISM_SITE_AUTHOR: "" # meta site author + PHOTOPRISM_SITE_CAPTION: "AI-Powered Photos App" + ## Run/install on first startup: + PHOTOPRISM_INIT: "tensorflow" + ## Hardware Video Transcoding: + ## see https://docs.photoprism.app/getting-started/advanced/transcoding/#nvidia-container-toolkit + PHOTOPRISM_FFMPEG_ENCODER: "nvidia" + PHOTOPRISM_FFMPEG_BITRATE: "50" + NVIDIA_VISIBLE_DEVICES: "all" + NVIDIA_DRIVER_CAPABILITIES: "compute,video,utility" + ## 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" + 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) + deploy: + resources: + reservations: + devices: + - driver: "nvidia" + count: 1 + capabilities: [gpu] + + ## Database Server (recommended) + ## see https://docs.photoprism.app/getting-started/faq/#should-i-use-sqlite-mariadb-or-mysql + mariadb: + ## 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 + image: mariadb:10.9 + 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 + # + # watchtower: + # restart: unless-stopped + # image: containrrr/watchtower + # 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/docker/examples/scheduler/docker-compose.yml b/docker/examples/scheduler/docker-compose.yml index 7b95d8016..ddcdad367 100644 --- a/docker/examples/scheduler/docker-compose.yml +++ b/docker/examples/scheduler/docker-compose.yml @@ -4,6 +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. # - 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 @@ -11,28 +12,13 @@ version: '3.5' # in clear text and can be intercepted by anyone, including your provider, hackers, and governments: # https://docs.photoprism.app/getting-started/proxies/traefik/ # -# Documentation : https://docs.photoprism.app/getting-started/docker-compose/ -# Docker Hub URL: https://hub.docker.com/r/photoprism/photoprism/ +# Setup Guides: +# - https://docs.photoprism.app/getting-started/docker-compose/ +# - https://docs.photoprism.app/getting-started/raspberry-pi/ +# - https://docs.photoprism.app/getting-started/troubleshooting/docker/ # -# DOCKER COMPOSE COMMAND REFERENCE -# see https://docs.photoprism.app/getting-started/docker-compose/#command-line-interface -# -------------------------------------------------------------------------- -# Start | docker-compose up -d -# Stop | docker-compose stop -# Update | docker-compose pull -# Logs | docker-compose logs --tail=25 -f -# Terminal | docker-compose exec photoprism bash -# Help | docker-compose exec photoprism photoprism help -# Config | docker-compose exec photoprism photoprism config -# Reset | docker-compose exec photoprism photoprism reset -# Backup | docker-compose exec photoprism photoprism backup -a -i -# Restore | docker-compose exec photoprism photoprism restore -a -i -# Index | docker-compose exec photoprism photoprism index -# Reindex | docker-compose exec photoprism photoprism index -f -# Import | docker-compose exec photoprism photoprism import -# -# To search originals for faces without a complete rescan: -# docker-compose exec photoprism photoprism faces index +# 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. diff --git a/docker/examples/sqlite/docker-compose.yml b/docker/examples/sqlite/docker-compose.yml index 736a93c45..ea24c4dbe 100644 --- a/docker/examples/sqlite/docker-compose.yml +++ b/docker/examples/sqlite/docker-compose.yml @@ -3,6 +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. # - 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 @@ -12,28 +13,13 @@ version: '3.5' # in clear text and can be intercepted by anyone, including your provider, hackers, and governments: # https://docs.photoprism.app/getting-started/proxies/traefik/ # -# Documentation : https://docs.photoprism.app/getting-started/docker-compose/ -# Docker Hub URL: https://hub.docker.com/r/photoprism/photoprism/ +# Setup Guides: +# - https://docs.photoprism.app/getting-started/docker-compose/ +# - https://docs.photoprism.app/getting-started/raspberry-pi/ +# - https://docs.photoprism.app/getting-started/troubleshooting/docker/ # -# DOCKER COMPOSE COMMAND REFERENCE -# see https://docs.photoprism.app/getting-started/docker-compose/#command-line-interface -# -------------------------------------------------------------------------- -# Start | docker-compose up -d -# Stop | docker-compose stop -# Update | docker-compose pull -# Logs | docker-compose logs --tail=25 -f -# Terminal | docker-compose exec photoprism bash -# Help | docker-compose exec photoprism photoprism help -# Config | docker-compose exec photoprism photoprism config -# Reset | docker-compose exec photoprism photoprism reset -# Backup | docker-compose exec photoprism photoprism backup -a -i -# Restore | docker-compose exec photoprism photoprism restore -a -i -# Index | docker-compose exec photoprism photoprism index -# Reindex | docker-compose exec photoprism photoprism index -f -# Import | docker-compose exec photoprism photoprism import -# -# To search originals for faces without a complete rescan: -# docker-compose exec photoprism photoprism faces index +# 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. diff --git a/docker/examples/windows/docker-compose.yml b/docker/examples/windows/docker-compose.yml index 184481782..225b81fb2 100644 --- a/docker/examples/windows/docker-compose.yml +++ b/docker/examples/windows/docker-compose.yml @@ -3,6 +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. # - 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 @@ -15,28 +16,17 @@ version: '3.5' # in clear text and can be intercepted by anyone, including your provider, hackers, and governments: # https://docs.photoprism.app/getting-started/proxies/traefik/ # -# Documentation : https://docs.photoprism.app/getting-started/docker-compose/ -# Docker Hub URL: https://hub.docker.com/r/photoprism/photoprism/ +# Setup Guide: +# - https://docs.photoprism.app/getting-started/docker-compose/ # -# DOCKER COMPOSE COMMAND REFERENCE -# see https://docs.photoprism.app/getting-started/docker-compose/#command-line-interface -# -------------------------------------------------------------------------- -# Start | docker-compose up -d -# Stop | docker-compose stop -# Update | docker-compose pull -# Logs | docker-compose logs --tail=25 -f -# Terminal | docker-compose exec photoprism bash -# Help | docker-compose exec photoprism photoprism help -# Config | docker-compose exec photoprism photoprism config -# Reset | docker-compose exec photoprism photoprism reset -# Backup | docker-compose exec photoprism photoprism backup -a -i -# Restore | docker-compose exec photoprism photoprism restore -a -i -# Index | docker-compose exec photoprism photoprism index -# Reindex | docker-compose exec photoprism photoprism index -f -# Import | docker-compose exec photoprism photoprism import +# 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/ +# - https://docs.photoprism.app/getting-started/troubleshooting/windows/ # -# To search originals for faces without a complete rescan: -# docker-compose exec photoprism photoprism faces index +# CLI Commands: +# - https://docs.photoprism.app/getting-started/docker-compose/#command-line-interface services: photoprism: