diff --git a/docker/examples/ofelia/docker-compose.yml b/docker/examples/ofelia/docker-compose.yml new file mode 100644 index 000000000..c1006e5d2 --- /dev/null +++ b/docker/examples/ofelia/docker-compose.yml @@ -0,0 +1,125 @@ +version: '3.5' + +# Example Docker Compose config file for PhotoPrism (Linux / AMD64) +# +# Includes Ophelia, a docker job scheduler: https://github.com/mcuadros/ofelia +# +# Documentation : https://docs.photoprism.org/getting-started/docker-compose/ +# Docker Hub URL: https://hub.docker.com/r/photoprism/photoprism/ +# +# Please run behind a reverse proxy like Caddy, Traefik or Nginx if you need HTTPS / SSL support +# e.g. when running PhotoPrism on a public server outside your home network. +# +# ------------------------------------------------------------------ +# 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 -a +# Import | docker-compose exec photoprism photoprism import +# ------------------------------------------------------------------- +# Note: All commands may have to be prefixed with "sudo" when not running as root. +# This will change the home directory "~" to "/root" in your configuration. + +services: + photoprism: + # Use photoprism/photoprism:preview instead for testing preview builds: + image: photoprism/photoprism:latest + container_name: photoprism + # 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 + ports: + - 2342:2342 # [local port]:[container port] + environment: + PHOTOPRISM_ADMIN_PASSWORD: "insecure" # PLEASE CHANGE: Your initial admin password (min 4 characters) + PHOTOPRISM_ORIGINALS_LIMIT: 1000 # 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" # Don't modify originals directory (reduced functionality) + PHOTOPRISM_EXPERIMENTAL: "false" # Enables experimental features + PHOTOPRISM_DISABLE_WEBDAV: "false" # Disables built-in WebDAV server + PHOTOPRISM_DISABLE_SETTINGS: "false" # Disables Settings in Web UI + PHOTOPRISM_DISABLE_TENSORFLOW: "false" # Disables using TensorFlow for image classification + PHOTOPRISM_DARKTABLE_PRESETS: "false" # Enables Darktable presets and disables concurrent RAW conversion + PHOTOPRISM_DETECT_NSFW: "false" # Flag photos as private that MAY be offensive (requires TensorFlow) + 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 (or MySQL) instead of SQLite for improved performance + PHOTOPRISM_DATABASE_SERVER: "mariadb:3306" # MariaDB database server (hostname:port) + PHOTOPRISM_DATABASE_NAME: "photoprism" # MariaDB database schema name + PHOTOPRISM_DATABASE_USER: "photoprism" # MariaDB database user name + PHOTOPRISM_DATABASE_PASSWORD: "insecure" # MariaDB database user password + PHOTOPRISM_SITE_URL: "http://localhost:2342/" # Public PhotoPrism URL + PHOTOPRISM_SITE_TITLE: "PhotoPrism" + PHOTOPRISM_SITE_CAPTION: "Browse Your Life" + PHOTOPRISM_SITE_DESCRIPTION: "" + PHOTOPRISM_SITE_AUTHOR: "" + # You may optionally set a user / group id using environment variables if your Docker version or NAS does not + # support this natively (see next example): + # UID: 1000 + # GID: 1000 + # UMASK: 0000 + # Uncomment and edit the following line to set a specific user / group id (native): + # user: "1000:1000" + volumes: + # Your photo and video files ([local path]:[container path]): + - "~/Pictures:/photoprism/originals" + # Multiple folders can be indexed by mounting them as sub-folders 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] + # Mounting an import folder is optional (see docs): + # - "~/Import:/photoprism/import" + # Permanent storage for settings, index & sidecar files (DON'T REMOVE): + - "./storage:/photoprism/storage" + + mariadb: + image: mariadb:10.5 + container_name: mariadb + restart: unless-stopped + 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=50 + volumes: # Don't remove permanent storage for index database files! + - "./database:/var/lib/mysql" + environment: + MYSQL_ROOT_PASSWORD: please_change + MYSQL_DATABASE: photoprism + MYSQL_USER: photoprism + MYSQL_PASSWORD: insecure + + ofelia: + restart: unless-stopped + image: mcuadros/ofelia:latest + container_name: ofelia + volumes: + - "/var/run/docker.sock:/var/run/docker.sock:ro" + - "./jobs.ini:/etc/ofelia/config.ini" + +# Uncomment the following lines to upgrade automatically, whenever there is a new Docker image available: +# +# watchtower: +# image: containrrr/watchtower +# container_name: watchtower +# restart: unless-stopped +# 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/ofelia/jobs.ini b/docker/examples/ofelia/jobs.ini new file mode 100644 index 000000000..85150dc9e --- /dev/null +++ b/docker/examples/ofelia/jobs.ini @@ -0,0 +1,16 @@ +# see https://github.com/mcuadros/ofelia/blob/master/docs/jobs.md + +[job-exec "photoprism index"] +schedule = @every 3h +container = photoprism +command = photoprism index --cleanup + +[job-exec "photoprism convert"] +schedule = @daily +container = photoprism +command = photoprism convert + +[job-exec "photoprism backup"] +schedule = @daily +container = photoprism +command = photoprism backup -a -i -f /photoprism/storage/index-backup.sql