135 lines
9 KiB
YAML
135 lines
9 KiB
YAML
version: '3.5'
|
|
|
|
# Example Docker Compose config file for PhotoPrism (Windows / AMD64)
|
|
#
|
|
# Note:
|
|
# - 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
|
|
# they can mount drives other than C:. This will enable Hyper-V, which Microsoft doesn't offer
|
|
# to its Windows Home customers. Docker Desktop uses dynamic memory allocation with WSL 2.
|
|
# It's important to explicitly increase the Docker memory limit to 4 GB or more when using Hyper-V.
|
|
# The default of 2 GB may reduce indexing performance and cause unexpected restarts.
|
|
# - 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 Guide:
|
|
# - https://docs.photoprism.app/getting-started/docker-compose/
|
|
# - https://www.photoprism.app/kb/activation
|
|
#
|
|
# 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/
|
|
#
|
|
# CLI Commands:
|
|
# - https://docs.photoprism.app/getting-started/docker-compose/#command-line-interface
|
|
|
|
services:
|
|
photoprism:
|
|
## Use photoprism/photoprism:preview for testing preview builds:
|
|
image: photoprism/photoprism: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:
|
|
## Web server port mapping in the format "Host:Container". To use a different port, change the host port
|
|
## on the left-hand side and keep the container port, e.g. "80:2342" (for HTTP) or "443:2342 (for HTTPS):
|
|
- "2342:2342"
|
|
environment:
|
|
PHOTOPRISM_ADMIN_USER: "admin" # admin login username
|
|
PHOTOPRISM_ADMIN_PASSWORD: "insecure" # initial admin password (8-72 characters)
|
|
PHOTOPRISM_AUTH_MODE: "password" # authentication mode (public, password)
|
|
PHOTOPRISM_SITE_URL: "http://localhost:2342/" # server URL in the format "http(s)://domain.name(:port)/(path)"
|
|
PHOTOPRISM_DISABLE_TLS: "false" # disables HTTPS/TLS even if the site URL starts with https:// and a certificate is available
|
|
PHOTOPRISM_DEFAULT_TLS: "true" # defaults to a self-signed HTTPS/TLS certificate if no other certificate is available
|
|
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_DEBUG: "false" # run in debug mode, shows additional log messages
|
|
PHOTOPRISM_READONLY: "false" # do not modify originals folder; disables import, upload, and delete
|
|
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: "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 is optional)
|
|
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
|
|
## Video Transcoding (https://docs.photoprism.app/getting-started/advanced/transcoding/):
|
|
# PHOTOPRISM_FFMPEG_ENCODER: "software" # H.264/AVC encoder (software, intel, nvidia, apple, raspberry, or vaapi)
|
|
# PHOTOPRISM_FFMPEG_SIZE: "1920" # video size limit in pixels (720-7680) (default: 3840)
|
|
# PHOTOPRISM_FFMPEG_BITRATE: "32" # video bitrate limit in Mbit/s (default: 50)
|
|
working_dir: "/photoprism" # do not change or remove
|
|
## Storage Folders: use "/" not "\" as separator, "~" is a shortcut for C:/user/{username}, "." for the current directory
|
|
volumes:
|
|
# "C:/user/username/folder:/photoprism/folder" # example
|
|
- "~/Pictures:/photoprism/originals" # original media files (photos and videos)
|
|
# - "D:/example/family:/photoprism/originals/family" # *additional* media folders can be mounted like this
|
|
# - "E:/:/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 (never remove)
|
|
|
|
## Database Server (recommended)
|
|
## see https://docs.photoprism.app/getting-started/faq/#should-i-use-sqlite-mariadb-or-mysql
|
|
mariadb:
|
|
image: mariadb: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
|
|
## --lower-case-table-names=1 stores tables in lowercase and compares names in a case-insensitive manner
|
|
## see https://mariadb.com/kb/en/server-system-variables/#lower_case_table_names
|
|
command: --innodb-buffer-pool-size=512M --lower-case-table-names=1 --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
|
|
volumes:
|
|
- "database:/var/lib/mysql" # Named volume "database" is defined at the bottom (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
|
|
|
|
## Create named volumes, advanced users may remove this if they mount a regular host folder
|
|
## for the database or use SQLite instead (never remove otherwise)
|
|
volumes:
|
|
database:
|
|
driver: local
|