From eb79978adf4817de7d7835fb7ac23ae81dc3dedf Mon Sep 17 00:00:00 2001 From: Chad Date: Fri, 15 Sep 2023 10:01:25 -0700 Subject: [PATCH] Add PhotoPrism (#15) * Add initial configuration for PhotoPrism. Has not been tested yet, but options have been analyzed and tweaked. * Begin testing. Fixes. Running pretty well, seems neat! Need to figure out user management other than admin. * Add output to source so that we know it worked. * Modify comments to explain a use free-to-win use case. * Go ahead and give the full path on the success path. --- Config/PhotoPrism/docker-compose.yml | 161 +++++++++++++++++++++++++++ Config/PhotoPrism/env.example | 34 ++++++ source.env | 9 ++ 3 files changed, 204 insertions(+) create mode 100644 Config/PhotoPrism/docker-compose.yml create mode 100644 Config/PhotoPrism/env.example diff --git a/Config/PhotoPrism/docker-compose.yml b/Config/PhotoPrism/docker-compose.yml new file mode 100644 index 0000000..0f2045f --- /dev/null +++ b/Config/PhotoPrism/docker-compose.yml @@ -0,0 +1,161 @@ +# PhotoPrism: (https://www.photoprism.app/) +# Host media on a web server rather then emailing and texting individuals. + +## +# Membership Note: +# Public sharing can be done without an account/membership/subscription. Share +# a folder, change the secret to something like "public", then share that link. +# If other folders have the same done then they are accessible by the same URL +# which was sent previously, such as https://FQDN/s/public for secret "public". +## + +## +# Documentation: +# +# Official: +# - https://docs.photoprism.app/getting-started/docker-compose/ +# +# Alternative: +# - https://www.linuxlinks.com/machine-learning-linux-photoprism-ai-powered-photos-app/ +# +# Activation? +# - 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/ +# +# CLI Commands: +# - https://docs.photoprism.app/getting-started/docker-compose/#command-line-interface +# +## + +## +# Changelog: +# 2023-09-15: File created and tweaked based on 'https://dl.photoprism.app/docker/docker-compose.yml'. +## + +version: '3.5' + +services: + pp-app: + container_name: pp-app + 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: + - pp-db + security_opt: + - seccomp:unconfined + - apparmor:unconfined + ports: + - "2342:2342" # HTTP port (host:container) + environment: + PHOTOPRISM_ADMIN_USER: $PHOTOPRISM_ADMIN_USER # admin login username + PHOTOPRISM_ADMIN_PASSWORD: $PHOTOPRISM_ADMIN_PASSWORD # 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: $PHOTOPRISM_ORIGINALS_LIMIT # 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_LOG_LEVEL: "info" # log level: trace, debug, info, warning, error, fatal, or panic + PHOTOPRISM_READONLY: "false" # do not modify originals directory (reduced functionality) + 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: $PHOTOPRISM_DETECT_NSFW # automatically flags photos as private that MAY be offensive (requires TensorFlow) + PHOTOPRISM_UPLOAD_NSFW: $PHOTOPRISM_UPLOAD_NSFW # allows uploads that MAY be offensive (no effect without TensorFlow) + # 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: "pp-db:3306" # MariaDB or MySQL database server (hostname:port) + PHOTOPRISM_DATABASE_NAME: $MARIADB_DATABASE # MariaDB or MySQL database schema name + PHOTOPRISM_DATABASE_USER: $MARIADB_USER # MariaDB or MySQL database user name + PHOTOPRISM_DATABASE_PASSWORD: $MARIADB_PASSWORD # 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: $PHOTOPRISM_FFMPEG_ENCODER # H.264/AVC encoder (software, intel, nvidia, apple, raspberry, or vaapi) + PHOTOPRISM_FFMPEG_SIZE: $PHOTOPRISM_FFMPEG_SIZE # video size limit in pixels (720-7680) (default: 3840) + PHOTOPRISM_FFMPEG_BITRATE: $PHOTOPRISM_FFMPEG_BITRATE # video bitrate limit in Mbit/s (default: 50) + ## Run/install on first startup (options: update https gpu tensorflow davfs clitools clean): + # PHOTOPRISM_INIT: "https gpu tensorflow" + ## Run as a non-root user after initialization (supported: 0, 33, 50-99, 500-600, and 900-1200): + # PHOTOPRISM_UID: 1000 + # PHOTOPRISM_GID: 1000 + # PHOTOPRISM_UMASK: 0000 + ## Start as non-root user before initialization (supported: 0, 33, 50-99, 500-600, and 900-1200): + # user: "1000:1000" + ## Share hardware devices with FFmpeg and TensorFlow (optional): + # devices: + # - "/dev/dri:/dev/dri" # Intel QSV + # - "/dev/nvidia0:/dev/nvidia0" # Nvidia CUDA + # - "/dev/nvidiactl:/dev/nvidiactl" + # - "/dev/nvidia-modeset:/dev/nvidia-modeset" + # - "/dev/nvidia-nvswitchctl:/dev/nvidia-nvswitchctl" + # - "/dev/nvidia-uvm:/dev/nvidia-uvm" + # - "/dev/nvidia-uvm-tools:/dev/nvidia-uvm-tools" + # - "/dev/video11:/dev/video11" # Video4Linux Video Encode Device (h264_v4l2m2m) + working_dir: "/photoprism" # do not change or remove + ## Storage Folders ## + volumes: + # Original media files (DO NOT REMOVE) + - "../../Volumes/PhotoPrism/originals:/photoprism/originals" + # *Writable* storage folder for cache, database, and sidecar files (DO NOT REMOVE) + - "../../Volumes/PhotoPrism/storage:/photoprism/storage" + # *Optional* base folder from which files can be imported to originals + # Importing reorganizes files+folders, would rather they remain intact. + #- "../../Volumes/PhotoPrism/imports_go_here:/photoprism/import" + + ## Database Server (recommended) + ## see https://docs.photoprism.app/getting-started/faq/#should-i-use-sqlite-mariadb-or-mysql + pp-db: + container_name: pp-db + image: mariadb:10.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 + command: mariadbd --innodb-buffer-pool-size=512M --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 + ## Never store database files on an unreliable device such as a USB flash drive, an SD card, or a shared network folder: + volumes: + - "../../Volumes/PhotoPrism/database:/var/lib/mysql" # DO NOT REMOVE + environment: + MARIADB_AUTO_UPGRADE: "1" + MARIADB_INITDB_SKIP_TZINFO: "1" + MARIADB_DATABASE: $MARIADB_DATABASE + MARIADB_USER: $MARIADB_USER + MARIADB_PASSWORD: $MARIADB_PASSWORD + MARIADB_ROOT_PASSWORD: $MARIADB_ROOT_PASSWORD + + # Configured but not using this, would prefer to update manually, and the + # volume needs also seem sort of odd. Do not want it to harm other projects. + ## Watchtower upgrades services automatically (optional) + ## see https://docs.photoprism.app/getting-started/updates/#watchtower + ## activate via "COMPOSE_PROFILES=update docker compose up -d" + #pp-watchtower: + # restart: unless-stopped + # image: containrrr/watchtower + # profiles: ["update"] + # 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/Config/PhotoPrism/env.example b/Config/PhotoPrism/env.example new file mode 100644 index 0000000..3229362 --- /dev/null +++ b/Config/PhotoPrism/env.example @@ -0,0 +1,34 @@ + +## +# PhotoPrism +## + +# Admin Details +PHOTOPRISM_ADMIN_USER = "admin" # admin login username +PHOTOPRISM_ADMIN_PASSWORD = "PleaseChangeMe" # initial admin password (8-72 characters) + +# Max Storage Space? +PHOTOPRISM_ORIGINALS_LIMIT = 5000 # file size limit for originals in MB (increase for high-res video) + +# Site Metadata +PHOTOPRISM_SITE_CAPTION = "AI-Powered Photos App" +PHOTOPRISM_SITE_DESCRIPTION = "" # meta site description +PHOTOPRISM_SITE_AUTHOR = "" # meta site author + +# NSFW +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) + +# Data Limits +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 = "8" # video bitrate limit in Mbit/s (default: 50) + +## +# MariaDB +## + +MARIADB_DATABASE = "photoprism" +MARIADB_USER = "photoprism" +MARIADB_PASSWORD = "PleaseChangeMe" +MARIADB_ROOT_PASSWORD = "PleaseChangeMe" diff --git a/source.env b/source.env index 4600df0..ceb7290 100755 --- a/source.env +++ b/source.env @@ -4,6 +4,7 @@ # source /PATH_TO_PROJECT/source.env DIR="$(dirname -- "${BASH_SOURCE[0]}")" +PROG="$(basename -- "${BASH_SOURCE[0]}")" if [[ "$DIR" == '.'* ]]; then RETURN="`pwd`" cd $DIR @@ -16,3 +17,11 @@ DOCKER_PATH="$DOCKER_HOME/bin" PATH="$DOCKER_PATH:$PATH" export DOCKER_HOME DOCKER_PATH PATH + +if [[ -e $DOCKER_HOME/$PROG ]]; then + echo "'$DOCKER_HOME/$PROG' has been loaded successfully." +else + echo "ERROR: Something has gone wrong, could not find '$PROG' from absolute " + echo "path, Docker Home '$DOCKER_HOME' is likely wrong." + exit 1 +fi