mirror of
https://github.com/photoprism/photoprism.git
synced 2026-07-24 02:29:10 +00:00
c2baf2ae5a
Creates accounts to run PhotoPrism under a custom user ID. Also adds them to the video and render groups, which might help to access hardware transcoding devices.
107 lines
No EOL
6.7 KiB
YAML
107 lines
No EOL
6.7 KiB
YAML
version: '3.5'
|
|
|
|
# Example Docker Compose config file for PhotoPrism (Linux / AMD64)
|
|
#
|
|
# Note:
|
|
# - 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
|
|
# 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/
|
|
#
|
|
# Documentation : https://docs.photoprism.app/getting-started/docker-compose/
|
|
# Docker Hub URL: https://hub.docker.com/r/photoprism/photoprism/
|
|
#
|
|
# 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
|
|
#
|
|
# 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
|
|
## 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_PASSWORD: "insecure" # !!! CHANGE YOUR INITIAL "admin" PASSWORD, MINIMUM 8 CHARACTERS !!!
|
|
PHOTOPRISM_SITE_URL: "http://localhost:2342/" # public server 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: "gzip" # improves transfer speed and bandwidth utilization (none or gzip)
|
|
PHOTOPRISM_DEBUG: "false" # run in debug mode (shows additional log messages)
|
|
PHOTOPRISM_PUBLIC: "false" # no authentication required (disables password protection)
|
|
PHOTOPRISM_READONLY: "false" # do not 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 UI and API
|
|
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_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 # image quality, a higher value reduces compression (25-100)
|
|
PHOTOPRISM_DETECT_NSFW: "false" # flag photos as private that MAY be offensive (requires TensorFlow)
|
|
PHOTOPRISM_UPLOAD_NSFW: "true" # allows uploads that MAY be offensive
|
|
PHOTOPRISM_DATABASE_DRIVER: "sqlite" # SQLite is an embedded database that doesn't require a server
|
|
PHOTOPRISM_SITE_TITLE: "PhotoPrism"
|
|
PHOTOPRISM_SITE_CAPTION: "AI-Powered Photos App"
|
|
PHOTOPRISM_SITE_DESCRIPTION: ""
|
|
PHOTOPRISM_SITE_AUTHOR: ""
|
|
## Run/install on first startup (options: update, gpu, tensorflow, davfs, clitools, clean):
|
|
# PHOTOPRISM_INIT: "gpu tensorflow"
|
|
## Run as a specific user, group, or with a custom umask (does not work together with "user:")
|
|
# PHOTOPRISM_UID: 1000
|
|
# PHOTOPRISM_GID: 1000
|
|
# PHOTOPRISM_UMASK: 0000
|
|
## Start as a non-root user (see https://docs.docker.com/engine/reference/run/#user)
|
|
# 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 (photos and videos)
|
|
# - "/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 (never remove)
|
|
|
|
## 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 |