2020-08-25 14:57:45 +02:00
|
|
|
version: '3.5'
|
2020-01-19 21:30:44 +01:00
|
|
|
|
2021-12-02 16:28:16 +01:00
|
|
|
# Example Docker Compose config file for PhotoPrism (Raspberry Pi 3/4 and other ARM64-based devices)
|
2021-10-19 16:58:05 +02:00
|
|
|
#
|
2021-12-02 10:34:35 +01:00
|
|
|
# Note:
|
2021-12-08 11:01:58 +01:00
|
|
|
# - You have to boot your Raspberry Pi 3/4 with the parameter "arm_64bit=1" in config.txt to use our ARM64 (64-bit) image.
|
2021-12-25 20:40:57 +01:00
|
|
|
# An "exec format" error will occur otherwise.
|
|
|
|
# - Try explicitly pulling the ARM64 version if you've booted your device with the "arm_64bit=1" flag and you see
|
|
|
|
# the "no matching manifest" error on Raspberry Pi OS (Raspbian). See documentation for details.
|
2022-02-13 16:25:59 +01:00
|
|
|
# - 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.
|
2022-11-04 11:31:48 +01:00
|
|
|
# - Hardware transcoding is only available for sponsors due to the high maintenance and support effort.
|
2021-12-02 16:24:52 +01:00
|
|
|
# - Running PhotoPrism on a server with less than 4 GB of swap space or setting a memory/swap limit can cause unexpected
|
2022-01-27 09:48:21 +01:00
|
|
|
# restarts ("crashes"), for example, when the indexer temporarily needs more memory to process large files.
|
2022-03-24 12:21:19 +01:00
|
|
|
# - In case you see Docker errors related to "cgroups", try adding the following parameters to /boot/firmware/cmdline.txt
|
|
|
|
# or /boot/cmdline.txt (file location depends on the OS in use): cgroup_enable=cpuset cgroup_enable=memory cgroup_memory=1
|
2021-12-02 10:34:35 +01:00
|
|
|
# - If you install PhotoPrism on a public server outside your home network, please always run it behind a secure
|
2022-01-11 14:34:30 +01:00
|
|
|
# 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/
|
2021-10-25 17:10:50 +02:00
|
|
|
#
|
2022-11-04 11:31:48 +01:00
|
|
|
# Setup Guides:
|
|
|
|
# - https://docs.photoprism.app/getting-started/docker-compose/
|
|
|
|
# - https://docs.photoprism.app/getting-started/raspberry-pi/
|
2021-10-23 12:34:03 +02:00
|
|
|
#
|
2022-11-04 11:31:48 +01:00
|
|
|
# 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/
|
2021-09-23 17:40:40 +02:00
|
|
|
#
|
2022-11-04 11:31:48 +01:00
|
|
|
# CLI Commands:
|
|
|
|
# - https://docs.photoprism.app/getting-started/docker-compose/#command-line-interface
|
2021-10-23 12:24:32 +02:00
|
|
|
#
|
2021-10-25 17:22:32 +02:00
|
|
|
# All commands may have to be prefixed with "sudo" when not running as root.
|
2022-01-11 14:48:29 +01:00
|
|
|
# This will point the home directory shortcut ~ to /root in volume mounts.
|
2020-01-19 21:30:44 +01:00
|
|
|
|
|
|
|
services:
|
|
|
|
photoprism:
|
2022-03-02 12:21:46 +01:00
|
|
|
## Use photoprism/photoprism:preview-arm64 for testing preview builds:
|
|
|
|
image: photoprism/photoprism:arm64
|
2021-08-31 18:08:37 +02:00
|
|
|
depends_on:
|
|
|
|
- mariadb
|
2021-12-30 15:23:00 +01:00
|
|
|
## 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
|
2020-12-22 00:27:01 +01:00
|
|
|
# restart: unless-stopped
|
2020-01-19 21:30:44 +01:00
|
|
|
security_opt:
|
|
|
|
- seccomp:unconfined
|
2020-08-25 14:57:45 +02:00
|
|
|
- apparmor:unconfined
|
2020-01-19 21:30:44 +01:00
|
|
|
ports:
|
2021-10-25 17:15:55 +02:00
|
|
|
- "2342:2342" # HTTP port (host:container)
|
2020-10-09 15:58:00 +02:00
|
|
|
environment:
|
2022-11-22 22:03:37 +01:00
|
|
|
PHOTOPRISM_ADMIN_USER: "admin" # superadmin username
|
|
|
|
PHOTOPRISM_ADMIN_PASSWORD: "insecure" # initial superadmin password (minimum 8 characters)
|
2022-07-19 17:00:12 +02:00
|
|
|
PHOTOPRISM_AUTH_MODE: "password" # authentication mode (public, password)
|
2022-10-24 12:36:13 +02:00
|
|
|
PHOTOPRISM_SITE_URL: "http://photoprism.me:2342/" # server URL in the format "http(s)://domain.name(:port)/(path)"
|
2022-02-08 12:51:12 +01:00
|
|
|
PHOTOPRISM_ORIGINALS_LIMIT: 5000 # file size limit for originals in MB (increase for high-res video)
|
|
|
|
PHOTOPRISM_HTTP_COMPRESSION: "none" # improves transfer speed and bandwidth utilization (none or gzip)
|
|
|
|
PHOTOPRISM_WORKERS: 2 # limits the number of indexing workers to reduce system load
|
2022-05-17 04:08:46 +02:00
|
|
|
PHOTOPRISM_LOG_LEVEL: "info" # log level: trace, debug, info, warning, error, fatal, or panic
|
2022-03-30 14:29:01 +02:00
|
|
|
PHOTOPRISM_READONLY: "false" # do not modify originals directory (reduced functionality)
|
2022-02-08 12:51:12 +01:00
|
|
|
PHOTOPRISM_EXPERIMENTAL: "false" # enables experimental features
|
2022-07-29 17:36:57 +02:00
|
|
|
PHOTOPRISM_DISABLE_CHOWN: "false" # disables updating storage permissions via chmod and chown on startup
|
2022-02-08 12:51:12 +01:00
|
|
|
PHOTOPRISM_DISABLE_WEBDAV: "false" # disables built-in WebDAV server
|
|
|
|
PHOTOPRISM_DISABLE_SETTINGS: "false" # disables Settings in Web UI
|
|
|
|
PHOTOPRISM_DISABLE_TENSORFLOW: "false" # disables all features depending on TensorFlow
|
2022-07-29 17:36:57 +02:00
|
|
|
PHOTOPRISM_DISABLE_FACES: "false" # disables face detection and recognition (requires TensorFlow)
|
|
|
|
PHOTOPRISM_DISABLE_CLASSIFICATION: "false" # disables image classification (requires TensorFlow)
|
2023-02-11 19:07:27 +01:00
|
|
|
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)
|
2022-07-22 09:59:08 +02:00
|
|
|
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)
|
2022-02-08 12:51:12 +01:00
|
|
|
PHOTOPRISM_UPLOAD_NSFW: "true" # allow uploads that MAY be offensive
|
2020-12-24 14:08:27 +01:00
|
|
|
# PHOTOPRISM_DATABASE_DRIVER: "sqlite" # SQLite is an embedded database that doesn't require a server
|
2022-02-08 12:51:12 +01:00
|
|
|
PHOTOPRISM_DATABASE_DRIVER: "mysql" # use MariaDB 10.5+ or MySQL 8+ instead of SQLite for improved performance
|
2021-10-23 14:04:53 +02:00
|
|
|
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
|
2022-02-23 14:24:50 +01:00
|
|
|
PHOTOPRISM_SITE_CAPTION: "AI-Powered Photos App"
|
2022-05-17 04:08:46 +02:00
|
|
|
PHOTOPRISM_SITE_DESCRIPTION: "" # meta site description
|
|
|
|
PHOTOPRISM_SITE_AUTHOR: "" # meta site author
|
2022-03-01 18:40:04 +01:00
|
|
|
## Run/install on first startup (options: update, gpu, tensorflow, davfs, clean):
|
2022-02-25 16:33:46 +01:00
|
|
|
# PHOTOPRISM_INIT: "update clean"
|
2022-11-04 11:31:48 +01:00
|
|
|
## Hardware Video Transcoding:
|
2022-04-05 16:48:53 +02:00
|
|
|
# PHOTOPRISM_FFMPEG_ENCODER: "raspberry" # FFmpeg encoder ("software", "intel", "nvidia", "apple", "raspberry")
|
|
|
|
# PHOTOPRISM_FFMPEG_BITRATE: "32" # FFmpeg encoding bitrate limit in Mbit/s (default: 50)
|
2022-07-29 17:36:57 +02:00
|
|
|
## Run as a non-root user after initialization (supported: 0, 33, 50-99, 500-600, and 900-1200):
|
2021-09-28 18:51:23 +02:00
|
|
|
# PHOTOPRISM_UID: 1000
|
|
|
|
# PHOTOPRISM_GID: 1000
|
|
|
|
# PHOTOPRISM_UMASK: 0000
|
2022-02-25 16:45:15 +01:00
|
|
|
## Share hardware devices with FFmpeg and TensorFlow (optional):
|
2022-07-22 09:59:08 +02:00
|
|
|
## See: https://www.raspberrypi.com/documentation/accessories/camera.html#driver-differences-when-using-libcamera-or-the-legacy-stack
|
2021-02-16 11:40:40 +01:00
|
|
|
# devices:
|
2022-07-22 09:59:08 +02:00
|
|
|
# - "/dev/video11:/dev/video11" # Video4Linux Video Encode Device (h264_v4l2m2m)
|
2022-04-05 15:13:27 +02:00
|
|
|
working_dir: "/photoprism" # do not change or remove
|
2022-01-11 14:45:31 +01:00
|
|
|
## Storage Folders: "~" is a shortcut for your home directory, "." for the current directory
|
2020-01-19 21:30:44 +01:00
|
|
|
volumes:
|
2022-05-17 04:08:46 +02:00
|
|
|
# "/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)
|
2020-08-13 16:52:25 +02:00
|
|
|
|
2021-10-25 17:10:50 +02:00
|
|
|
## Database Server (recommended)
|
2021-12-12 20:14:07 +01:00
|
|
|
## see https://docs.photoprism.app/getting-started/faq/#should-i-use-sqlite-mariadb-or-mysql
|
2020-12-22 00:27:01 +01:00
|
|
|
mariadb:
|
2021-12-30 14:56:04 +01:00
|
|
|
## 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
|
2021-08-31 18:08:37 +02:00
|
|
|
restart: unless-stopped
|
2022-12-13 07:29:10 +01:00
|
|
|
image: arm64v8/mariadb:10.10 # ARM64 IMAGE ONLY, DOES NOT WORK ON ARMv7, AMD or Intel
|
2020-12-28 11:41:57 +01:00
|
|
|
security_opt:
|
|
|
|
- seccomp:unconfined
|
|
|
|
- apparmor:unconfined
|
2022-06-01 21:44:58 +02:00
|
|
|
command: mysqld --innodb-buffer-pool-size=256M --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
|
2021-12-30 15:23:00 +01:00
|
|
|
## Never store database files on an unreliable device such as a USB flash drive, an SD card, or a shared network folder:
|
2021-10-19 20:45:21 +02:00
|
|
|
volumes:
|
2022-05-17 04:15:37 +02:00
|
|
|
- "./database:/var/lib/mysql" # DO NOT REMOVE
|
2020-12-22 00:27:01 +01:00
|
|
|
environment:
|
2022-03-30 13:47:49 +02:00
|
|
|
MARIADB_AUTO_UPGRADE: "1"
|
|
|
|
MARIADB_INITDB_SKIP_TZINFO: "1"
|
|
|
|
MARIADB_DATABASE: "photoprism"
|
|
|
|
MARIADB_USER: "photoprism"
|
|
|
|
MARIADB_PASSWORD: "insecure"
|
|
|
|
MARIADB_ROOT_PASSWORD: "insecure"
|
2020-08-13 16:52:25 +02:00
|
|
|
|
2021-10-25 17:10:50 +02:00
|
|
|
## Watchtower upgrades services automatically (optional)
|
2021-12-12 20:14:07 +01:00
|
|
|
## see https://docs.photoprism.app/getting-started/updates/#watchtower
|
2021-10-23 12:24:32 +02:00
|
|
|
#
|
|
|
|
# watchtower:
|
|
|
|
# restart: unless-stopped
|
|
|
|
# image: containrrr/watchtower
|
|
|
|
# environment:
|
|
|
|
# WATCHTOWER_CLEANUP: "true"
|
2021-12-02 10:43:36 +01:00
|
|
|
# WATCHTOWER_POLL_INTERVAL: 7200 # checks for updates every two hours
|
2021-10-23 12:24:32 +02:00
|
|
|
# volumes:
|
|
|
|
# - "/var/run/docker.sock:/var/run/docker.sock"
|
2022-02-08 12:51:12 +01:00
|
|
|
# - "~/.docker/config.json:/config.json" # optional, for authentication if you have a Docker Hub account
|