diff --git a/images/photoprism.png b/images/photoprism.png new file mode 100644 index 0000000..77a3c4f Binary files /dev/null and b/images/photoprism.png differ diff --git a/stack/photoprism.yml b/stack/photoprism.yml new file mode 100644 index 0000000..662475e --- /dev/null +++ b/stack/photoprism.yml @@ -0,0 +1,136 @@ +version: '3.5' + +# 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"), especially 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, Caddy, or NGINX. Your files and passwords will otherwise be transmitted +# in clear text and can be intercepted by anyone, including your provider, hackers, and governments. +# +# Documentation : https://docs.photoprism.org/getting-started/docker-compose/ +# Docker Hub URL: https://hub.docker.com/r/photoprism/photoprism/ +# +# DOCKER COMPOSE COMMAND REFERENCE +# see https://docs.photoprism.org/getting-started/docker-compose/#command-line-interface +# -------------------------------------------------------------------------- +# 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 placeholder ~ to /root in volume mounts. + +services: + ## App Server (required) + photoprism: + ## Use photoprism/photoprism:preview for testing preview builds: + image: photoprism/photoprism:latest + depends_on: + - mariadb + ## Only enable automatic restarts once your installation is properly + ## configured as it otherwise may get stuck in a restart loop, + ## see https://docs.photoprism.org/getting-started/faq/#why-is-photoprism-getting-stuck-in-a-restart-loop + container_name: photoprism + 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" # HTTP port (host:container) + environment: + PHOTOPRISM_ADMIN_PASSWORD: "${PHOTOPRISM_ADMIN_PASSWORD}" # PLEASE CHANGE: Your initial admin password (min 4 characters) + PHOTOPRISM_SITE_URL: "${PHOTOPRISM_SITE_URL}" # 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: "${PHOTOPRISM_PUBLIC:-false}" # No authentication required (disables password protection) + PHOTOPRISM_READONLY: "${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: "${PHOTOPRISM_DISABLE_FACES:-false}" # Disables facial recognition + PHOTOPRISM_DISABLE_CLASSIFICATION: "false" # Disables 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 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: "${MYSQL_PASSWORD}" # 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 + ## Enable TensorFlow AVX2 support for modern Intel CPUs (requires starting the container as root): + # PHOTOPRISM_INIT: "tensorflow-amd64-avx2" + ## Hardware video transcoding config (optional): + # PHOTOPRISM_FFMPEG_BUFFERS: "64" # FFmpeg capture buffers (default: 32) + # PHOTOPRISM_FFMPEG_BITRATE: "32" # FFmpeg encoding bitrate limit in Mbit/s (default: 50) + # PHOTOPRISM_FFMPEG_ENCODER: "h264_v4l2m2m" # Use Video4Linux for AVC transcoding (default: libx264) + # PHOTOPRISM_FFMPEG_ENCODER: "h264_qsv" # Use Intel Quick Sync Video for AVC transcoding (default: libx264) + # PHOTOPRISM_INIT: "intel-graphics tensorflow-amd64-avx2" # Enable TensorFlow AVX2 & Intel Graphics support + HOME: "/photoprism" + ## Hardware devices for video transcoding and machine learning (optional): + # devices: + # - "/dev/video11:/dev/video11" # Video4Linux (h264_v4l2m2m) + # - "/dev/dri/renderD128:/dev/dri/renderD128" # Intel GPU + # - "/dev/dri/card0:/dev/dri/card0" + working_dir: "/photoprism" + volumes: + ## The *originals* folder contains your original photo and video files (- "[host folder]:/photoprism/originals"): + - "${HOST_MEDIA_PATH}:/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): + - "/portainer/Files/AppData/Config/PhotoPrism/storage:/photoprism/storage" + + ## Database Server (recommended) + ## see https://docs.photoprism.org/getting-started/faq/#should-i-use-sqlite-mariadb-or-mysql + mariadb: + restart: unless-stopped + image: 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: + - "/portainer/Files/AppData/Config/PhotoPrism/database:/var/lib/mysql" # never remove + environment: + MYSQL_ROOT_PASSWORD: "${MYSQL_ROOT_PASSWORD}" + MYSQL_DATABASE: photoprism + MYSQL_USER: photoprism + MYSQL_PASSWORD: "${MYSQL_PASSWORD}" + + ## Watchtower upgrades services automatically (optional) + ## 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 diff --git a/template/portainer-v2-arm64.json b/template/portainer-v2-arm64.json index 80ad4fb..9becfe7 100644 --- a/template/portainer-v2-arm64.json +++ b/template/portainer-v2-arm64.json @@ -3597,6 +3597,94 @@ } ] }, + { + "categories": [ + "Photos" + ], + "description": "PhotoPrism® is an AI-powered app for browsing, organizing & sharing your photo collection. It makes use of the latest technologies to tag and find pictures automatically without getting in your way. You can run it at home, on a private server, or in the cloud.", + "env": [ + { + "default": "change me to a secure password", + "label": "PHOTOPRISM_ADMIN_PASSWORD", + "name": "PHOTOPRISM_ADMIN_PASSWORD" + }, + { + "default": "http://localhost:2342/", + "label": "PHOTOPRISM_SITE_URL", + "name": "PHOTOPRISM_SITE_URL" + }, + { + "label": "PHOTOPRISM_PUBLIC", + "name": "PHOTOPRISM_PUBLIC", + "select": [ + { + "text": "Enable Password Protection", + "value": "false", + "default": true + }, + { + "text": "No authentication required", + "value": "true" + } + ] + }, + { + "label": "PHOTOPRISM_READONLY", + "name": "PHOTOPRISM_READONLY", + "select": [ + { + "text": "Photo folder in Read/Write mode", + "value": "false", + "default": true + }, + { + "text": "Don't modify originals directory (reduced functionality)", + "value": "true" + } + ] + }, + { + "label": "PHOTOPRISM_DISABLE_FACES", + "name": "PHOTOPRISM_DISABLE_FACES", + "select": [ + { + "text": "Enable facial recognition", + "value": "false", + "default": true + }, + { + "text": "Disable facial recognition", + "value": "true" + } + ] + }, + { + "default": "change me to a secure password", + "label": "MYSQL_PASSWORD", + "name": "MYSQL_PASSWORD" + }, + { + "default": "change me to a secure password", + "label": "MYSQL_ROOT_PASSWORD", + "name": "MYSQL_ROOT_PASSWORD" + }, + { + "default": "/portainer/PhotoPrism", + "label": "HOST_MEDIA_PATH", + "name": "HOST_MEDIA_PATH" + } + ], + "logo": "https://raw.githubusercontent.com/novaspirit/pi-hosted/master/images/photoprism.png", + "name": "PhotoPrism", + "note": "Your device should have at least \u003cb\u003e4 GB\u003c/b\u003e of memory. Running PhotoPrism on a server with less than 4 GB of swap space or setting a memory/swap limit can cause unexpected restarts, especially when the indexer temporarily needs more memory to process large files.\u003cbr\u003eIt's important to boot your Rapsberry Pi 3/4 with the parameter \u003cb\u003earm_64bit=1\u003c/b\u003e in \u003cb\u003econfig.txt\u003c/b\u003e to use ARM64 image.\u003cbr\u003eIf you see Docker errors related to \u003cb\u003e\"cgroups\"\u003c/b\u003e, it may help to add the following to \u003cb\u003e/boot/firmware/cmdline.txt\u003c/b\u003e:\u003cbr\u003e\u003cbr\u003e\u003cb\u003ecgroup_enable=cpuset cgroup_enable=memory cgroup_memory=1\u003c/b\u003e\u003cbr\u003e\u003cbr\u003eUser pi needs to have access to \u003cb\u003eHOST_MEDIA_PATH\u003c/b\u003e, you can force it with:\u003cbr\u003e\u003cbr\u003e\u003cb\u003esudo chown -R pi:pi /path/to/media\u003c/b\u003e\u003cbr\u003e\u003cbr\u003eRun \u003cb\u003einstall_photoprism.sh\u003c/b\u003e before deploying this container.", + "platform": "linux", + "title": "PhotoPrism", + "type": 3, + "repository": { + "stackfile": "stack/photoprism.yml", + "url": "https://github.com/novaspirit/pi-hosted" + } + }, { "categories": [ "Photos" diff --git a/tools/install_photoprism.sh b/tools/install_photoprism.sh new file mode 100755 index 0000000..74b29f3 --- /dev/null +++ b/tools/install_photoprism.sh @@ -0,0 +1,19 @@ +#!/bin/bash + +function error { + echo -e "\\e[91m$1\\e[39m" + exit 1 +} + +echo "Creating directories..." +sudo mkdir -p /portainer/Files/AppData/Config/PhotoPrism/{storage,database} || error "Failed to create storage and database directories!" + +echo "Setting permissions..." +sudo chown -R 1000:1000 /portainer/Files/AppData/Config/PhotoPrism/{storage,database} || error "Failed to set permissions for PhotoPrism data!" + +echo +echo -e "If you already have a folder for images, make sure the user \\e[32mpi\\e[m has access to it." +echo -e "If required, you can change permissions with:" +echo -e " \\e[32msudo chown -R pi:pi /path/to/folder\\e[m" +echo -e "If not, create it now and give user \\e[32mpi\\e[m permission" +echo -e "When done you can continue to install PhotoPrism Stack"