159 lines
8.9 KiB
YAML
159 lines
8.9 KiB
YAML
version: '3.5'
|
|
|
|
# Example Docker Compose config file for PhotoPrism (Raspberry Pi and other ARM-based devices)
|
|
#
|
|
# Documentation : https://docs.photoprism.org/getting-started/raspberry-pi/
|
|
# Docker Hub URL: https://hub.docker.com/r/photoprism/photoprism/
|
|
#
|
|
# ATTENTION: You have to boot your Raspberry Pi 3 / 4 with the parameter "arm_64bit=1"
|
|
# in config.txt to use our ARM64 image.
|
|
#
|
|
# IMPORTANT: When installing PhotoPrism on a public server outside your home network, please
|
|
# always run it behind a secure HTTPS reverse proxy like Traefik, Caddy, or NGINX.
|
|
# Your files and passwords will be transmitted in clear text otherwise.
|
|
#
|
|
# DOCKER COMPOSE COMMAND REFERENCE
|
|
# --------------------------------------------------------------------------
|
|
# 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
|
|
#
|
|
# See https://docs.photoprism.org/getting-started/docker-compose/#command-line-interface for more examples.
|
|
#
|
|
# To search originals for faces without a complete rescan:
|
|
# docker-compose exec photoprism photoprism faces index
|
|
#
|
|
# NOTE: All commands may have to be prefixed with "sudo" when not running as root.
|
|
# This will point the home directory placeholder ~ to /root in volume mounts.
|
|
|
|
services:
|
|
# REQUIRED: PhotoPrism Application Server
|
|
photoprism:
|
|
# NOTE: photoprism/photoprism-arm64 has been replaced by a single multi-arch image for AMD64,
|
|
# ARM64, and ARMv7. Use photoprism/photoprism:preview for testing preview builds or
|
|
# photoprism/photoprism:latest for the stable release.
|
|
image: photoprism/photoprism:latest
|
|
# Owners of ARMv7-based devices may have to explicitly specify the image architecture:
|
|
# platform: "linux/arm"
|
|
depends_on:
|
|
- mariadb
|
|
# Only enable automatic restarts once your installation is properly
|
|
# configured as it otherwise may get stuck in a restart loop:
|
|
# https://docs.photoprism.org/getting-started/faq/#why-is-photoprism-getting-stuck-in-a-restart-loop
|
|
# restart: unless-stopped
|
|
security_opt:
|
|
- seccomp:unconfined
|
|
- apparmor:unconfined
|
|
# Run as a specific, non-root user (see https://docs.docker.com/engine/reference/run/#user):
|
|
# user: "1000:1000"
|
|
ports:
|
|
- "2342:2342" # [server]:[container]
|
|
environment:
|
|
PHOTOPRISM_ADMIN_PASSWORD: "insecure" # PLEASE CHANGE: Your initial admin password (min 4 characters)
|
|
PHOTOPRISM_SITE_URL: "http://localhost:2342/" # Public URL incl http:// or https:// and /path, :port is optional
|
|
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
|
|
PHOTOPRISM_DEBUG: "false" # Run in debug mode (shows additional log messages)
|
|
PHOTOPRISM_PUBLIC: "false" # No authentication required (disables password protection)
|
|
PHOTOPRISM_READONLY: "false" # Don't modify originals directory (reduced functionality)
|
|
PHOTOPRISM_EXPERIMENTAL: "false" # Enables experimental features
|
|
PHOTOPRISM_DISABLE_CHOWN: "false" # Disables storage permission updates on startup
|
|
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
|
|
PHOTOPRISM_DISABLE_FACES: "false" # Disables facial recognition
|
|
PHOTOPRISM_DISABLE_CLASSIFICATION: "false" # Disables image classification
|
|
PHOTOPRISM_DARKTABLE_PRESETS: "true" # Enables Darktable presets and disables concurrent RAW conversion
|
|
# PHOTOPRISM_FFMPEG_ENCODER: "h264_v4l2m2m" # FFmpeg AVC encoder for video transcoding (default: libx264)
|
|
# PHOTOPRISM_FFMPEG_BUFFERS: "64" # FFmpeg capture buffers (default: 32)
|
|
PHOTOPRISM_DETECT_NSFW: "false" # Flag photos as private that MAY be offensive
|
|
PHOTOPRISM_UPLOAD_NSFW: "true" # Allow uploads that MAY be offensive
|
|
# 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_TITLE: "PhotoPrism"
|
|
PHOTOPRISM_SITE_CAPTION: "Browse Your Life"
|
|
PHOTOPRISM_SITE_DESCRIPTION: ""
|
|
PHOTOPRISM_SITE_AUTHOR: ""
|
|
# Set a non-root user, group, or custom umask if your Docker environment doesn't support this natively:
|
|
# PHOTOPRISM_UID: 1000
|
|
# PHOTOPRISM_GID: 1000
|
|
# PHOTOPRISM_UMASK: 0000
|
|
HOME: "/photoprism"
|
|
# Optional hardware devices for video transcoding and machine learning:
|
|
# devices:
|
|
# - "/dev/video11:/dev/video11" # Video4Linux (h264_v4l2m2m)
|
|
working_dir: "/photoprism"
|
|
volumes:
|
|
# The *originals* folder contains your original photo and video files (- "[host folder]:/photoprism/originals"):
|
|
- "~/Pictures:/photoprism/originals"
|
|
# Multiple folders can be made accessible by mounting them as subfolders of /photoprism/originals:
|
|
# - "/mnt/Family:/photoprism/originals/Family" # [folder 1]:/photoprism/originals/[folder 1]
|
|
# - "/mnt/Friends:/photoprism/originals/Friends" # [folder 2]:/photoprism/originals/[folder 2]
|
|
# You may mount an *import* folder from which files can be transferred to *originals* (optional):
|
|
# - "~/Import:/photoprism/import"
|
|
# Cache, session, thumbnail, and sidecar files will be created in the *storage* folder (never remove):
|
|
- "./storage:/photoprism/storage"
|
|
|
|
# RECOMMENDED: MariaDB Server, a MySQL-compatible Database
|
|
# see https://docs.photoprism.org/getting-started/faq/#should-i-use-sqlite-mariadb-or-mysql
|
|
mariadb:
|
|
restart: unless-stopped
|
|
image: arm64v8/mariadb:10.6
|
|
security_opt:
|
|
- seccomp:unconfined
|
|
- apparmor:unconfined
|
|
command: mysqld --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" # Never remove
|
|
environment:
|
|
MYSQL_ROOT_PASSWORD: insecure
|
|
MYSQL_DATABASE: photoprism
|
|
MYSQL_USER: photoprism
|
|
MYSQL_PASSWORD: insecure
|
|
|
|
# OPTIONAL: Owners of ARMv7-based devices have to revert to an alternative image if they want to use MariaDB.
|
|
# The official image is available for AMD64 and ARM64 only. Pay close attention to changed directory
|
|
# and environment variable names.
|
|
#
|
|
# mariadb:
|
|
# restart: unless-stopped
|
|
# image: lscr.io/linuxserver/mariadb:latest
|
|
# security_opt:
|
|
# - seccomp:unconfined
|
|
# - apparmor:unconfined
|
|
# command: mysqld --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:
|
|
# - "./mariadb:/config" # Never remove
|
|
# environment:
|
|
# MYSQL_ROOT_PASSWORD: insecure
|
|
# MYSQL_DATABASE: photoprism
|
|
# MYSQL_USER: photoprism
|
|
# MYSQL_PASSWORD: insecure
|
|
|
|
# OPTIONAL: Uncomment the following lines to upgrade automatically, whenever there is a new Docker image available.
|
|
# see https://docs.photoprism.org/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 |