Paperless-ngx auf Synology

Da ich noch keine kurze Anleitung zum Installieren von paperless-ngx in der normalen Docker-Umgebung auf der Synology gefunden habe, kommt hier eine.

Ich gehe davon aus, dass Docker-Paket installiert ist und funktioniert.

  1. Verzeichnis anlegen um alle relevanten Daten von paperless-ngx außerhalb des Docker-Containers zu lagern. Das wird im docker-Ordner gemacht damit der Container dann auch Schreibrechte hat.

2.Download der benötigten Docker-Images

Zum Betrieb von paperless-nx benötigen wir die beiden Images redis und paperlessngx/paperless-ngx. Diese findet man im Registry-Bereich in Docker.

paperless-ngx in der Registry
Das redis-Paket in der Registry

Wenn der Download fertig ist, findet man sie unter Image

Meine Docker-Images

3. Redis-Container erzeugen

paperless benötigt redis um zu funktionieren. Deshalb erzeugen wir den Container mit dem Launch-Knopf während das Redis-Image markiert ist.

Auf der ersten Seite des Assistenten müssen wir die Netzwerkanbindung des Containers wählen. Ich wähle hier immer “Use same network as Docker Host”

Auswahl der Netzwerkanbindung

Alle anderen Einstellungen auf den Folgeseiten einfach auf den Standardeinstellungen stehen lassen und auch den Container danach starten lassen.

4. paperless-ngx-Container erzeugen.

Hierzu auch den Lauch-Knopf drücken während paperlessngx/paperless-ngx markiert ist.

Auf der ersten Wizard-Seite wieder die zweite Option auswählen:

Auf der zweiten Seite drücken wir den “Advanced Settings”-Knopf.

In dem Menü müssen wir zwei Umgebungsvariablen hinzufügen um uns später mit einem Admin-User einloggen zu können In der Variable PAPERLESS_ADMIN_USER kommt der Nutzername des ersten Benutzers rein.

PAPERLESS_ADMIN_PASSWORD enthält das Passwort

zwei Variablen um Paperless den Nutzer mitzuteilen.

Auf der Folgeseite kommen dann die Volume Settings. Hier fügen wir das in Schritt 1 angelegte Verzeichnis an zwei Stellen im Container ein. Dadurch kann dann der komplette Container gelöscht werden und trotzdem sind noch alle Daten da. Hier drücken wir also den “Add Folder”-Knopf und wählen dann den paperless-Ordner aus

als Mount-Path kommt /usr/src/paperless/media/ rein. Danach fügen wir den selben Ordner nochmal hinzu und wählen als Mount-Path stattdessen /usr/src/paperless/data/

Mount-Paths

Auf der Summary-Seite einfach Done drücken und der paperless-ngx-Container sollte loslaufen. Den Erfolg können wir auf der Container-Seite überprüfen.

Laufende Container auf der Synology

Sollte irgendetwas nicht in Ordnung sein, beendet sich der Container nach einigen Sekunden wieder. Den Fehler kann man dann auf dem Log-Tab der Container-Details erlesen.

Wenn alles geklappt hat, können wir uns mit den vorher festgelegten Zugangsdaten auf dem Webinterface von Paperless einloggen. Das finden wir unter Port 8000 der Synology

3 thoughts on “Paperless-ngx auf Synology”

  1. Noch ein kurzer Kommentar:
    ich bin an der Einbindung eines ‘Consume’ Ordners verzweifelt da ich den gerne in einem Unterordner des Scancverzeichnisses, welcher per SMB freigegeben ist, hierfür nutzen wollte. Da Docker wohl nur Zugriff auf Unterverzeichnisse im Dockerlaufwerk hat bin ich folgendermaßen vorgegangen:
    1. Verzeichnis ‘paperless-consume’ parallel zum ‘paperless’-Verzeichnis unter Docker angelegt (vgl Punkt 1)
    2. unter ‘Volume Settings’ diesen Ordner ausgewählt und mit ‘/usr/src/paperless/consume/’ gemountet
    3. Verknüpfung zum Scanverzeichnis über Mount-Bind erstellt:
    Einloggen per SSH und dann ‘sudo mount –bind Quelle Ziel’ bspw bei mir:
    sudo mount –bind volume1/Scanner/paperless-consume/ volume1/docker/paperless-consume/
    dieser Mount wird nach einem Neustart gelöscht ist aber für das Ausprobieren nützlich. Sollte die Einstellung dauerhaft gewünscht sein geht dies über eine Einbindung in ‘rc.local’:
    sudo vi /etc/rc.local
    sudo mount –bind volume1/Scanner/paperless-consume/ volume1/docker/paperless-consume/

    1. Das steht mir noch bevor. Aktuell habe ich noch keinen Scanner, der direkt in einen SMB-Share scannt. Es wäre halt schön, wenn man dafür keinen Hack auf der Shell machen müsste,…

      1. Das sind so ein paar Eigenheiten die man dann mit der Zeit lernt… Ich habe mich auch lange damit herumgeschlagen bis ich herausgefunden habe warum das Einbinden des fremden Verzeichnisses nicht direkt gegangen ist sondern der Umweg über das Verzeichnis in Docker gegangen werden muss…

        Der Mount ist notwendig da man bei SMB-shares unter Synology keine Verknüpfungen machen kann, wohl aus Sicherheitsaspekten (https://www.albertogonzalez.net/how-to-create-a-symbolic-link-to-a-folder-on-a-synology-nas/)

Leave a Reply

Your email address will not be published.

This site uses Akismet to reduce spam. Learn how your comment data is processed.