HowTo: OpenMediaVault – PhotoPrism via Docker auf dem Raspberry Pi installieren

PhotoPrism ist eine sehr cooel Software, welche Ihr zur lokalen Verwaltung Eurer Fotosammlung nutzen könnt.

Einmal eingerichtet werden Eure Fotos gescannt und mithilfe von KI Modellen Kategorisiert. Das heißt Ihr könnt die Bilder später nicht nur nach Personen (dank Gesichtserkennung) sortiert angucken. Es ist auch möglich sich alle Strandfotos, alle Fotos auf denen Autos, Tiere oder gar Regenschirme zu sehen sind, anzeigen zu lassen.

Dadurch, dass dabei alle Fotos als auch die Nutzdaten auf eurere eigenen Festplatte bleiben müsst ihr euch keine Sorgen um die üblichen sorgenbringer wie Datenschutz oder Cloud machen.

Was ich persönlich sehr praktisch finde ist, dass man PhotoPrism auch in einem Schreibgeschützten Modus betreiben kann. Ist dieser Modus aktiviert greift PhotoPrism nur lesend auf Eure Fotos zu. So ist sichergestellt, dass über die PhotoPrism Oberfläche keine Fotos verändert oder gelöscht werden können. Wer letzteres dagegen wünscht kann den Schreibschutz natürlich auch deaktivieren. Dann lassen sich Fotos nicht nur löschen und bearbeiten. Auch der Upload neuer Fotos über die Oberfläche oder WebDAV ist möglich.

Wer vorab mal eine LiveDemo testen will. Unter folgendem Link stellen die Entwickler eine Demo zur Verfügung.

• PhotoPrism Live Demo: https://demo.photoprism.app/library/browse

Dank vorbereitetem Docker Image ist die Installation auf dem RaspberryPi schnell und sicher erledigt. Hier gibt es nur ein kleines Manko: PhotoPrism läuft nur auf einem 64Bit Betriebssystem. Ggf. müsst Ihr also ein 64Bit RaspberryPi OS auf der Sd karte Eures RaspberryPis installieren.

Sobald Ihr das erledigt hab kann es aber losgehen. Alles was Ihr dazu wissen müsste habe ich Schritt für Schritt in diesem Artikel beschrieben.

---

Sicherheitshinweise

Ich weiß die folgenden Hinweise sind immer irgendwie lästig und wirken unnötig. Aber leider haben schon viele Menschen die es "besser" wussten aus Leichtsinnigkeit Augen, Finger oder anderes verloren bzw. sich verletzt. Im Vergleich dazu ist ein Datenverlust fast nicht der Rede Wert, aber auch diese können echt ärgerlich sein. Deswegen nehmt Euch bitte fünf Minuten Zeit um die Sicherheitshinweise zu lesen. Denn auch das coolste Projekt ist keine Verletzung oder anderen Ärger wert.
https://www.nerdiy.de/sicherheitshinweise/

Affiliatelinks/Werbelinks

Die hier in aufgeführten Links zu Online-Shops sind sogenannte Affiliate-Links. Wenn Du auf so einen Affiliate-Link klickst und über diesen Link einkaufst, bekommt Nerdiy.de von dem betreffenden Online-Shop oder Anbieter eine Provision. Für Dich verändert sich der Preis nicht. Falls Du Deine Einkäufe über diese Links tätigst unterstützt Du Nerdiy.de dabei auch in Zukunft weitere nützliche Projekte anbieten zu können. 🙂 

---

Voraussetzungen

Bevor ihr mit diesem Artikel startet solltet ihr den Raspberry Pi soweit vorbereitet haben, dass dieser über das Netzwerk erreichbar und per SSH Steuerbar ist.

Die folgenden Artikel beschreiben was zu tun ist um Euren Raspberry Pi soweit vorzubereiten:

• RaspberryPi – Einrichten für Nerdiys!
• RaspberryPi – Die Erste Konfiguration!
• RaspberryPi – Den RaspberryPi über SSH steuern
• Raspberry Pi – NetworkAttachedStorage / NAS mit einem Raspberry Pi 4 selber bauen
• RaspberryPi – NetworkAttachedStorage / NAS aus einem RaspberryPi 4 selber bauen
• RaspberryPi – OpenMediaVault / OMV auf dem RaspberryPi installieren

In der folgenden Listen findet Ihr alle Teile die Ihr zur Umsetzung dieses Artikels benötigt.

Benötigtes Werkzeug:

Number	Link
1x	Schraubendreher Set  Bei Amazon kaufen
1x	SD Kartenleser  Bei Amazon kaufen

Benötigtes Material:

Number	Link
1x	Raspberry Pi  Bei Amazon kaufen
1x	Raspberry Pi Netzteil  Bei Amazon kaufen
1x	Raspberry Pi Gehäuse  Bei Amazon kaufen
1x	Micro SD Karte 64GB  Bei Amazon kaufen

---

Docker installieren

PhotoPrism wird als Docker Image installiert. Dazu sollte Docker und Portainer bereits installiert sein.

Falls Ihr diese beiden Tools noch nicht installiert habt: In dem Artikel Raspberry Pi – Docker Container mit OpenMediaVault OMV und Portainer nutzen habe ich die Installation beschrieben.

---

OMV System Benutzer zum Ausführen von PhotoPrism erstellen

Zum Ausführen von PhotoPrism solltet ihr einen Benutzer erstellen.

Wie ihr das geht habe ich zum einen in dem Artikel OpenMediaVault – Weiteren Benutzer erstellen beschrieben. Zum anderen ist es aber auch in den nächsten Schritten nochmal gezeigt.

---

System Benutzer ID herausfinden

Später während der Konfiguration des Docker Images benötigt Ihr unter anderem die Benutzer ID des zuvor erstellten Benutzers. Diese könnt Ihr über den SSH Zugriff auf Euren Raspberry Pi (oder jede andere Linux Maschine) abrufen.

---

Ordner zum Speichern der PhotoPrism Dateien erstellen

Während des Betriebs von PhotoPrism werden verschiedene Nutzdaten wie zum Beispiel Datenbanken oder Miniaturansichten erzeugt. Damit diese auch nach einem Neustart nicht verloren gehen solltet ihr nun einen Ordner dafür auf der an euren OMV angeschlossene Festplatte erstellen.

---

PhotoPrism Docker Compose Konfiguration mithilfe von Portainer einrichten

Nachdem Ihr alle Ordner vorbereitet habt könnt Ihr nun das PhotoPrism Docker Image mithilfe der Docker Compose Konfiguration einrichten.

Nun geht es an die Anpassung der Docker Compose Konfiguration an eure Bedürfnisse. Kopiert dazu zunächst den kompletten unten stehenden Text und fügt Ihn in das Große Textfeld der “Create Stack” Oberfläche ein.

In den nachfolgenden Schritten werden die wichtigen Stellen dann angepasst.

version: '3.5'

# Example Docker Compose config file for PhotoPrism (Raspberry Pi 3/4 and other ARM64-based devices)
#
# Note:
# - You have to boot your Raspberry Pi 3/4 with the parameter "arm_64bit=1" in config.txt to use our ARM64 (64-bit) image.
#   An "exec format" error will occur otherwise.
# - Try explicitly pulling the ARM64 version if you've booted your device with the "arm_64bit=1" flag and you see
#   the "no matching manifest" error on Raspberry Pi OS (Raspbian). See documentation for details.
# - Use https://dl.photoprism.app/docker/armv7/docker-compose.yml to run PhotoPrism and MariaDB on ARMv7-based devices
#   as well as Raspberry Pi OS (Raspbian) installations without 64-bit support.
# - Hardware transcoding is only available for sponsors due to the high maintenance and support effort.
# - 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.
# - In case you see Docker errors related to "cgroups", try adding the following parameters to /boot/firmware/cmdline.txt
#   or /boot/cmdline.txt (file location depends on the OS in use): cgroup_enable=cpuset cgroup_enable=memory cgroup_memory=1
# - 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/
#
# Setup Guides:
# - https://docs.photoprism.app/getting-started/docker-compose/
# - https://docs.photoprism.app/getting-started/raspberry-pi/
#
# 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
#
# 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-arm64 for testing preview builds:
    image: photoprism/photoprism:arm64
    depends_on:
      - mariadb
    ## 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_USER: "!ENTER_USERNAME_HERE!"             # superadmin username
      PHOTOPRISM_ADMIN_PASSWORD: "!ENTER_PASSWORD_HERE!"          # initial superadmin password (minimum 8 characters)
      PHOTOPRISM_AUTH_MODE: "password"               # authentication mode (public, password)
      PHOTOPRISM_SITE_URL: "http://!ENTER_HOSTNAME_OR_IP_HERE!:2342/"  # server URL in the format "http(s)://domain.name(:port)/(path)"
      PHOTOPRISM_ORIGINALS_LIMIT: 50000               # 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_WORKERS: 2                          # limits the number of indexing workers to reduce system load
      PHOTOPRISM_LOG_LEVEL: "info"                   # log level: trace, debug, info, warning, error, fatal, or panic
      PHOTOPRISM_READONLY: "true"                   # 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 in Web UI
      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_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                    # a higher value increases the quality and file size of JPEG images and thumbnails (25-100)
      PHOTOPRISM_DETECT_NSFW: "false"                # automatically flags 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: "insecure"       # 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
      ## Run/install on first startup (options: update, gpu, tensorflow, davfs, clean):
      #PHOTOPRISM_INIT: "update clean"
      ## Hardware Video Transcoding:
      # PHOTOPRISM_FFMPEG_ENCODER: "raspberry"       # FFmpeg encoder ("software", "intel", "nvidia", "apple", "raspberry")
      # PHOTOPRISM_FFMPEG_BITRATE: "32"              # FFmpeg encoding bitrate limit in Mbit/s (default: 50)
      ## Run as a non-root user after initialization (supported: 0, 33, 50-99, 500-600, and 900-1200):
      PHOTOPRISM_UID: 10XX
      PHOTOPRISM_GID: 100
      # PHOTOPRISM_UMASK: 0000
    ## Share hardware devices with FFmpeg and TensorFlow (optional):
    ## See: https://www.raspberrypi.com/documentation/accessories/camera.html#driver-differences-when-using-libcamera-or-the-legacy-stack
    # devices:
    #  - "/dev/video11:/dev/video11" # Video4Linux Video Encode Device (h264_v4l2m2m)
    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
      - "!real_photoLocationFolder1_path!:/photoprism/originals/photoLocation1"               # Original media files (DO NOT REMOVE)
      - "!real_photoLocationFolder2_path!:/photoprism/originals/photoLocation2"               # Original media files (DO NOT REMOVE)
      - "!real_photoLocationFolderX_path!:/photoprism/originals/photoLocationX"               # Original media files (DO NOT REMOVE)
      # - "/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
      - "!real_photoprism_folder_path!/storage:/photoprism/storage"                  # *Writable* storage folder for cache, database, and sidecar files (DO NOT REMOVE)

  ## Database Server (recommended)
  ## see https://docs.photoprism.app/getting-started/faq/#should-i-use-sqlite-mariadb-or-mysql
  mariadb:
    ## 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
    image: arm64v8/mariadb:10.10 # ARM64 IMAGE ONLY, DOES NOT WORK ON ARMv7, AMD or Intel
    security_opt:
      - seccomp:unconfined
      - apparmor:unconfined
    command: mysqld --innodb-buffer-pool-size=256M --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:
      - "!real_photoprism_folder_path!/database:/var/lib/mysql" # DO NOT REMOVE
    environment:
      MARIADB_AUTO_UPGRADE: "1"
      MARIADB_INITDB_SKIP_TZINFO: "1"
      MARIADB_DATABASE: "photoprism"
      MARIADB_USER: "photoprism"
      MARIADB_PASSWORD: "insecure"
      MARIADB_ROOT_PASSWORD: "insecure"

  ## 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

---

In die PhotoPrism Oberfläche einloggen und Indexierung der Bilder anstoßen

Nach dem Start des Docker Containers könnt Ihr nun die Weboberfläche von PhotoPrism aufrufen und die Indexierung der Bilder anstoßen. Die Indexierung ist wichtig um die Bilder zu scannen und ggf. zu Kategorisieren. Dieser Vorgang kann je nach Größe Eurer Fotosammlung recht lange (zum Beispiel mehrere Tage) dauern.

Gebt zum öffnen der PhotoPrism Oberfläche einfach die IP Adresse eures OMV Servers gefolgt von dem konfigurierten Port an.

Falls die die IP Adresse eures OMV Servers “192.168.0.3” lautet und Ihr den oben vorkonfigurierten Port(2342) genutzt habt müsst Ihr also “192.168.0.3:2342” in die Adresszeiles eures Browsers eingeben um die Oberfläche von PhotoPrism zu öffnen.

Den Fortschritt der Indexierung könnt Ihr auch im “Logs” Tab auf der gleichen Seite überwachen.

Der Indexierungsvorgang dauert nun je nach Größe der Fotosammlung eine Weile.

---

Weitere Artikel zum Thema OpenMediaVault

Die vielen weiteren Funktionen von OpenMediaVault habe ich in weiteren Artikeln beschrieben. Diese Artikel sind alle in der folgenden Kategorie zusammengefasst.

• https://nerdiy.de/category/raspberry-pi/open-media-vault/

---

Viel Spaß mit dem Projekt

Ich hoffe bei euch hat alles wie beschrieben funktioniert. Falls nicht oder ihr Fragen oder Anregungen habt lasst es mich in den Kommentaren bitte wissen. Ich trage dies dann ggf. in den Artikel nach.
Auch Ideen für neue Projekte sind immer gerne willkommen. 🙂

P.S. Viele dieser Projekte - besonders die Hardwareprojekte - kosten viel Zeit und Geld. Natürlich mache ich das weil ich Spaß daran habe, aber wenn Du es cool findest, dass ich die Infos dazu mit Euch teile, würde ich mich über eine kleine Spende an die Kaffeekasse freuen. 🙂