Synology Wiki - Benutzerbeiträge [de]

Paperless-ngx auf Synology-DiskStations

2025-03-22T16:57:25Z

JohneDoe: Backup hinzugefügt

== Paperless-ngx – Ein Sammelthread für ein DMS via Docker auf dem NAS==
<div style="float: right; margin-left: 1em; margin-right: 0; padding: 1em; border: 1px solid darkgray; font-size: 85%; background: #F5F5F5; max-width: 33%;">
'''Aktuelle Version von Paperless-ngx'''

''[https://github.com/paperless-ngx/paperless-ngx/releases/tag/v2.14.7 '''2.14.7''']''

=== Features ===

* Enhancement: require totp code for obtain auth token by @shamoon in #8936

=== Bug Fixes ===

* Enhancement: require totp code for obtain auth token by @shamoon in #8936
* Fix: reflect doc links in bulk modify custom fields by @shamoon in #8962
* Fix: also ensure symmetric doc link removal on bulk edit by @shamoon in #8963<br />
</div>
=== Was ist Paperless-ngx? ===
Paperless-ngx ist ein Fork von Paperless-ng, einem Dokumentenmanagementsystem (DMS), welches als Container unter Docker/Container Manager (ab DSM 7.2) läuft. Zusammen mit einem Scanner könnt ihr euer Büro zu Hause papierlos machen und findet über Schlagwörter schnell die Dokumente, die ihr sucht. Eigentlich können gescannte Dokumente auch nummeriert werden, sodass ihr sie auch im Original schnell wiederfindet, wenn ihr sie doch mal brauchen solltet.

=== Ist Paperless-ngx überhaupt etwas für mich? ===
Das kann man natürlich immer nur für sich selbst beantworten. Manche Personen greifen lieber direkt auf ihre Dokumente in den Ordnern zu, für diejenigen ist vielleicht synOCR besser geeignet. Wer Paperless-ngx nutzen möchte, sollte die gesamte Verwaltung von dem Programm machen lassen und Änderungen nur über die Oberfläche vornehmen. Die Dateien lassen sich trotzdem ohne große Probleme aus der Ordnerstruktur heraus kopieren oder über die Oberfläche herunterladen.

Wer noch weitere Gedanken zur Entscheidung braucht, dem sei der Thread [https://www.synology-forum.de/threads/paperless-ngx-ein-kurzer-erfahrungsbericht-sowie-ein-erstes-resuemee.133974/ Paperless-ngx: Ein kurzer Erfahrungsbericht sowie ein erstes Resümee] von [[Benutzer:Tommes|Tommes]] empfohlen. Dort wird über viele Fragen diskutiert, die immer mal wieder hier im Forum aufkommen, weil Paperless-ngx schon eine feine Sache, aber nicht für jede Arbeitsweise geeignet ist. Solche Fragen sollte man jedenfalls klären, bevor man die ersten 1000 Dokumente verarbeitet 😉

=== Wie installiere ich Paperless-ngx? ===
Wie so oft bei Docker gibt es hier unterschiedliche Herangehensweisen. Man kann für die Verwaltung aller seiner Container andere Containerdienste wie Portainer verwenden oder auch den Container-Manager vom Synology selbst; allerdings verwende ich selbst ausschließlich die Konfigurationsdateien im YML-Format. Deswegen beachtet bitte, dass beispielsweise Anleitungen von Magnus auf seiner Seite Magnus Hosting ein wenig anders aussehen als das, was ihr hier seht.

==== Ordner und Konfigurationsdatei erstellen ====
Geht zu Eurem Docker-Ordner (meistens: <code>/volume1/docker</code>) und erstellt einen Unterordner <code>/paperlessngx</code> und innerhalb des Ordners noch die Ordner:

* config
* consume
* data
* export
* exportpostgres
* media
* pgdata
* redis

Hier werden die Daten außerhalb des Containers gespeichert, das ermöglicht Euch, bei Problemen im Zweifelsfalle den ganzen Ordner wieder zu kopieren und nach Eingabe der Befehle unten dort weiterarbeiten zu können.

Dann wenden wir uns der Konfigurationsdatei zu. Die Macher von Paperless-ngx haben dazu auf der GitHub-Seite bereits mehrere Beispiele veröffentlicht. Im Zweifelsfalle nehmt einfach eine der vorhandenen Dateien, man kann diese jederzeit nachträglich an seine Bedürfnisse anpassen. Erstellt werden

* docker-compose.yml
* docker-compose.env

Und zwar im Ordner <code>config</code>. Die env-Datei kann man auch anders benennen, dann muss die entsprechende Zeile in der yml halt anpassen. Für die yml-Datei nutze ich folgende Einstellungen:<syntaxhighlight lang="docker">
version: "3.6"
services:
broker:
container_name: redis
image: redis:latest
restart: unless-stopped
volumes:
- ../redis:/data

db:
container_name: postgres
image: postgres:15
restart: unless-stopped
volumes:
- ../pgdata:/var/lib/postgresql/data
- /volume1/docker/paperlessngx/exportpostgres:/var/lib/postgresql/data/backup
environment:
POSTGRES_DB: paperless
POSTGRES_USER: paperless
POSTGRES_PASSWORD: paperless

webserver:
container_name: paperlessngx
image: ghcr.io/paperless-ngx/paperless-ngx:latest
restart: unless-stopped
depends_on:
- db
- broker
ports:
- 34343:8000
healthcheck:
test: ["CMD", "curl", "-fs", "-S", "--max-time", "2", "http://localhost:8000"]
interval: 30s
timeout: 10s
retries: 5
volumes:
- ../data:/usr/src/paperless/data
- ../media:/usr/src/paperless/media
- ../export:/usr/src/paperless/export
- ../consume:/usr/src/paperless/consume
env_file: docker-compose.env
environment:
PAPERLESS_REDIS: redis://broker:6379
PAPERLESS_DBHOST: db
</syntaxhighlight>Sehr wichtig ist es hier, die Version der Datenbank festzuschreiben, wenn ihr Postgres verwendet. Solltet ihr die Version hier nicht festlegen, zumindest auf die Hauptversion, dann wird es bei einem Wechsel auf die nächste Hauptversion, nach meiner Anleitung wäre das Version 16, dazu kommen, dass die Datenbank nicht mehr erreichbar ist. Da müsst ihr wirklich aufpassen. Im schlimmsten Fall zerschießt ihr euch die komplette Datenbank. Und wenn ihr dann keine Sicherung habt, dann könnt ihr die ganze Installation neu aufsetzen. Auch bei Paperless gilt, Backup ist Trumpf!

==== Einrichtung via Terminal bzw. Aufgabenplaner ====
Die nächsten Schritte nehmt Ihr im Terminal (macOS) bzw. der Konsole (Windows) vor via SSH (''Systemsteuerung → Terminal/SSH'', orange) oder ihr nutzt einfach den Aufgabenplaner unter DSM. Den findet Ihr unter ''Systemsteuerung → Aufgabenplaner, rot''. Folgende Befehle bitte dort eingeben, sudo erfordert das Admin-Passwort oder Ihr loggt Euch direkt als root ein. Die Konfiguration habe ich selbst über das Terminal/Konsole gemacht.

# cd /volume1/docker/paperlessngx/config
# sudo docker-compose pull
# sudo docker-compose run --rm webserver createsuperuser
# sudo docker-compose up -d

Folgendes machen die Befehle dabei:

# Navigiert in das entsprechende Verzeichnis (cd → «change directory»)
# „Pullt“ das/die entsprechenden Images, lädt also hier Paperless, redis und PostgreSQL in der festgelegten Version herunter.
# Erstellt einen Admin – das habe ich nicht über den Aufgabenplaner ausgeführt, da fehlt die entsprechende Eingabemöglichkeit!
# Startet die Container

Wenn alles geklappt hat, findet Ihr nach der Anleitung oben Paperless unter <code><nowiki>http://domain:34343</nowiki></code>. Den Port 34343 könnt Ihr logischerweise anpassen.

=== Das „leidige“ Thema PostgreSQL-Updates… ===

==== Grundsätzliches ====
Immer wieder wird die Frage gestellt, wie im Zusammenhang mit Paperless-ngx eine Datenbankversion aktualisiert werden kann nach einem Major Update, wenn als Datenbank PostgreSQL zum Einsatz kommt. Da der ganze Vorgang nicht trivial ist und ich bei meinem Update von Version 15 auf 16 die eine oder andere Hürde gefunden habe, für die ich mir diverse Tips hier zusammengesucht habe nunmehr ein Versuch, das ganze in einer ausführlichen Anleitung zusammenzufassen.

Stand 2. Februar 2024 ist die aktuellste Major Version von PostgreSQL v16, unterstützt und weiter mit Updates versorgt werden noch v12–v15. v11 hat im November 2023 das letzte Update erhalten. Folgende Versionen von PostgreSQL sind innerhalb ihrer Major Version derzeit aktuell:

* 9. November 2023: <code>16.1</code>, <code>15.5</code>, <code>14.10</code>, <code>13.13</code>, <code>12.17</code> und <code>11.22</code> ( EOL)

Anbei ein Bild, wo ihr, egal welcher Tag gesetzt wurde, seht, welche Version Eure Datenbank gerade verwendet.

Auch wenn Updates immer eine sinnvolle Sache sind, so sei an dieser Stelle zunächst auch erwähnt, dass ein Update der Datenbank-Version keinerlei Vorteile im Betrieb von Paperless-ngx mit sich bringt. Neue Funktionen gibt es mit dem Update des Webservers, solange eine alte Version nicht zu Problemen führt, kann diese auch weiterverwendet werden.

Wer erst mit Paperless-ngx startet, dem sei auch empfohlen, von Beginn an auf MariaDB als Datenbank zu setzen; wer bisher PostgreSQL einsetzt und gerne auf MariaDB wechseln möchte, dem sei diese Anleitung von @Adama ans Herz gelegt: Paperless-ngx: Migration Postgresql zu MariaDB. Bei großen Versionsupdates der MariaDB sind hier im Forum bisher keine Probleme bekannt und das im Vergleich umständliche Prozedere unten entfällt.

==== Grundlagen ====
Bevor ich beginne, möchte ich ein paar Begriffe klären, damit es nachher nicht zu Missverständnissen kommt bzw. ihr wisst, was ihr wo mit eventuell anderen Bezeichnungen ersetzen müsst.

* Verwende ich <code>PGDBNAME</code>, so ist der Name eures PostgreSQL-Containers gemeint. Verwendet ihr paperless-ngx-db, nutzt ihr also diesen Namen.
* Verwende ich <code>PGUSER</code>, ist der Name gemeint, der in Eurer Installation für die Anmeldung an der PostgreSQL-Datenbank verwendet wird. Standardmäßig ist das in der yaml-Beispielsdatei <code>paperless</code>

Dann möchte ich grundsätzlich anmerken, dass ich die ganzen Befehle in der Regel über mein Terminal absetze, weil ich dort sofort das Ergebnis sehe. Die ganzen Befehle können aber selbstverständlich auch über den Aufgabenplaner eingegeben werden, dann erhaltet ihr je nach eurer Einstellung die Antwort per Mail. Das erschwert bei Problemen aber im Zweifelsfall die Ursachenfindung.

==== Anleitung ====
Vor solchen Arbeiten solltet ihr sicherstellen, dass hier ein aktuelles und funktionierendes Back-up eurer Installation habt. Kein Backup → kein Mitleid

# Stoppt die Container des Webservers und des Brokers (redis), um zu verhindern, dass weitere Daten in die Datenbank geschrieben werden können (der PostgreSQL-Container muss weiterlaufen, weil sonst kein „Dump“ erstellt werden kann)
# Erstellt einen so genannten „Dump“, also eine Sicherung der Datenbank mit folgendem Befehl: <code>docker exec PGDBNAME bash -c "psql -U PGUSER > /var/lib/postgresql/data/backup/backup.dump"</code>
# Stoppt den PostgreSQL-Container und benennt den bisherigen Ordner (z. B. <code>/pgdata</code>) um, der Einfachheit halber etwa <code>pgdatav15</code> für die alte Version und erstellt /pgdata neu. Der Ordner muss (!) leer sein!
# Passt in der Konfiguration (yaml) die Version von PostgreSQL an (z. B. auf <code>postgres:16</code>) (*1)
# Startet zunächst nur die Datenbank neu, in dem ihr in den Ordner navigiert <code>cd /volume1/docker/paperless/oder/so</code> und dann folgenden Befehl ausführt <code>docker-compose up -d db</code>
# Kopiert den Backup-Ordner mit dem Dump in <code>/pgdata</code>
# Führt folgenden Befehl aus <code>docker exec PGDBNAME bash -c "psql -U PGUSER < /var/lib/postgresql/data/backup/backup.dump"</code>, danach seht ihr im Terminal, wie die Daten eingelesen werden
# Wenn der Befehl ohne Fehler durchgelaufen ist, startet Webserver und Broker erneut: <code>docker-compose up -d</code>

Danach solltet ihr euch mit den bekannten Anmeldedaten wieder anmelden können. Wird die Anmeldeseite geladen, funktioniert das Anmelden aber nicht mit Verweis auf falsche Anmeldedaten, dann hat das zurückspielen der Datenbank nicht funktioniert.

=== Backup ===
Es reicht nicht aus, dass man den Ordner mit den Dokumenten und der Datenbank sichert, weil man dabei immer eine korrupte Datenbank bekommen könnte. Dies passiert in dem z.B. zu dem Zeitpunkt vom kopieren der Daten noch etwas in die Datenbank geschrieben wird. Daher sollte man immer einen Datenbank Dump erzeugen. Um den Dump zu erzeugen geht ihr genau so vor wie vor einem DB Update. Einfach regelmäßig erzeugen und mit eurem Backup mit sichern.

=== Zusätzliche Links ===
Folgende zusätzliche Links können euch helfen, wenn ihr doch mal an Probleme kommt, die ihr so nicht klären könnt:

* MariusHosting (Marius Bogdan Lixandru): [https://mariushosting.com/how-to-install-paperless-ngx-on-your-synology-nas/ How to Install Paperless NGX on Your Synology NAS]
* [https://www.youtube.com/@DigitalisierungmitKopf/videos Digitalisierung mit Kopf] (Stefan Lachner)
** Paperless-ngx: Automatische Texterkennung (OCR) in Scans mit Synology NAS / Raspberry Pi
** Paperless-ngx auf Synology-NAS installieren: Schritt-für-Schritt-Anleitung (papierloses Büro)
** HTTPS: Paperless-ngx aus dem Internet erreichbar machen mit Synology NAS

Hauptseite

2025-03-21T04:45:52Z

JohneDoe: Verlinkung auf die Paperless Installation hinzugefügt in DSM-Pakete & Virtualisierung

__NOTOC__

{| style="width: 100%; border: 1px solid #F8F9FA; background: #CFE7FF; margin: 1em 0 1em 0;"

|style="text-align: center;"|
<div style="font-size: 165%; margin: 0; padding: .1em;">Willkommen im deutschen SynologyWiki</div>
<div>Die Community-Site zu allen Themen rund um [http://www.synology.de/ Synology Produkte]</div>
<div>
[http://www.synology-forum.de/ Deutsches Support Forum] | [https://www.synology.com/de-de/company/contact_us Synology Support] | [https://kb.synology.com/de-de Knowledge Center] | [https://www.synology.com/de-de/compatibility Kompatibilitätslisten]
</div>
|}


{| style="width: 100%; border: 1px solid #EAECF0; background: #FFFACD; margin: 1em 0 1em 0;"

|
<div style="margin: 0; padding: .5em;">'''Hier entsteht das neue Synology Wiki.'''
Es wird das alte Synology Wiki (www.synology-wiki.de) ersetzen, das [https://www.synology-forum.de/wiki/Hauptseite-archiviert-20141214 '''hier'''] archiviert wurde.

'''Wissenswertes zum neuen Wiki'''
* [https://www.synology-forum.de/forums/wiki-forum.56/ Diskussionen im Wiki-Forum über Inhalt und Struktur des neuen Wikis]
* [https://www.synology-forum.de/threads/neue-wiki-funktionalitaet.137789/ Weitere Informationen über das neue Wiki]
* [https://www.synology-forum.de/threads/wiki-anmeldung-berechtigungen-und-bestaetigungen-von-aenderungen.137790/ Beschreibung der Funktionsweise des neuen Wikis]
* [[Hauptseite#Starthilfen für das neue Synology Wiki|Starthilfen für das neue Synology Wiki]]

Lasst uns zusammen hier das beste Synology Wiki bauen ;-)
</div>
|}


== Allgemeines ==
{| style="width: 100%; border: 1px solid #EAECF0; background: #F8F9FA;"
|[https://www.synology-forum.de/threads/nutzerleitfaden-von-usern-fuer-user.131833/ <big>Nutzerleitfaden - von Usern für User</big>]<div style="margin: 0; padding: .5em;">'''Vorbereitungen für die Installation'''
* [[Platten, RAIDs und Dateisysteme]]
* [[Planung der Festplatten und Raidlevel]]</div>
|}

== DSM-Systemsteuerung ==
{| style="width: 100%; border: 1px solid #EAECF0; background: #F8F9FA;"
|
<div style="margin: 0; padding: .5em;">
*'''Benutzer und Gruppe'''
** [[Einrichtung und Besonderheiten des Benutzer-Home-Dienstes]] '''<sup>★</sup>'''<sup>NEW'''★'''</sup>

* '''Freigegebener Ordner'''
** [[SMB-Netzwerkfreigaben mit Autofs auf einer Debian-basierten Linux-Distribution]] '''<sup>★</sup>'''<sup>NEW'''★'''</sup>
* '''Info-Center'''
** [[Hardware der Synology Stations]]
** [[Stromverbrauchswerte User]]

* '''Terminal & SNMP'''
** [[SSH-Verbindung zu einem Synology NAS herstellen]] '''<sup>★</sup>'''<sup>NEW'''★'''</sup>
** [[Schlüsselbasierte SSH-Verbindung über ein Linux Terminal einrichten]] '''<sup>★</sup>'''<sup>NEW'''★'''</sup>
** [[Schlüsselbasierte SSH-Verbindung über die Windows PowerShell einrichten]] '''<sup>★</sup>'''<sup>NEW'''★'''</sup>
** [[Schlüsselbasierte SSH-Verbindung mit PuTTY und PuTTYgen]] '''<sup>★</sup>'''<sup>NEW'''★'''</sup>
** [[Schlüsselbasierte SCP-Verbindung mit WinSCP]] '''<sup>★</sup>'''<sup>NEW'''★'''</sup>
</div>
|}

== DSM-Pakete & Virtualisierung ==
{| style="width: 100%; border: 1px solid #EAECF0; background: #F8F9FA;"
|
<div style="margin: 0; padding: .5em;">'''Container Manager (früher Docker)'''
* [[Guacamole mit Docker]]
* [[Synapse mit Docker]]
* [[TvHeadend mit Docker und Sundtek SkyTV Ultimate]]
* [[Paperless-ngx auf Synology-DiskStations|Paperless-NGX mit Docker Compose einrichte]]
'''Third-Party''' '''(Drittanbieter) Pakete'''

* '''AutoPilot'''
** [[AutoPilot herunterladen, installieren und einrichten]]
** [[Einen externen Datenträger an AutoPilot binden]]
** [[Eine Hyper Backup Aufgabe an AutoPilot binden]]
*'''LogAnalysis'''
**[[LogAnalysis herunterladen, installieren und einrichten]]
</div>
|}

== Modifikationen ==
{| style="width: 100%; border: 1px solid #EAECF0; background: #F8F9FA;"
|
<div style="margin: 0; padding: .5em;">[[Wichtige Informationen zum Modden der Synology Stations|<big>Wichtige Informationen zum Modden der Synology Stations</big>]]
* '''Datenträgerverwaltung'''
** [[Analysieren und Bereinigen einer überfüllten Systempartition]] '''<sup>★</sup>'''<sup>NEW'''★'''</sup>
** [[M.2 NVME SSD als Speicherpool/Volume nutzen]] '''<sup>★</sup>'''<sup>NEW'''★'''</sup>

* '''Systemmanagement'''
** [[Cron]]
** [[Mount Bind]]
** [[SSMTP: Mit Bordmitteln eine E-Mail über die Konsole versenden.]]

* '''Sonstiges'''
** [[LEDs und Buttons]]
</div>
|}

== Einführung in die Kommandozeile (Bash) ==
{| style="width: 100%; border: 1px solid #EAECF0; background: #F8F9FA;"
|
<div style="margin: 0; padding: .5em;">
*'''Grundlagen'''
**[[Die Kommandozeile]]
**[[Shell-Initialisierungsdateien und Benutzerprofile]] '''<sup>★</sup>'''<sup>NEW'''★'''</sup>
**[[Wo ist was im Linux-System|'''Wo ist was im Linux-System''']]
*** [[Dateien im /etc-Verzeichnis|/etc-Verzeichnis]]
*** [[Dateien im /dev-Verzeichnis|/dev-Verzeichnis]]
*** [[Dateien im /lib-Verzeichnis|/lib-Verzeichnis]]
*** [[Dateien im /tmp-Verzeichnis|/tmp-Verzeichnis]]
*** [[Dateien im /usr-Verzeichnis|/usr-Verzeichnis]]
*** [[Dateien im /var-Verzeichnis|/var-Verzeichnis]]
*** [[Dateien im /volume1-Verzeichnis|/volume1-Verzeichnis]]
*'''Befehle und Programme'''
** [[Dateioperationen]] <sup>'''★'''NEW'''★'''</sup>
** [[Verzeichnisoperationen]] <sup>'''★'''NEW'''★'''</sup>
** [[Datei- und Verzeichnisrechte]] '''<sup>★</sup>'''<sup>NEW'''★'''</sup>
** Vergleich von Pager
*** [[cat und tac|cat, tac und tail]] '''<sup>★</sup>'''<sup>NEW'''★'''</sup>
*** [[more]] '''<sup>★</sup>'''<sup>NEW'''★'''</sup>
*** [[less]]
** [[Vergleich von Texteditoren]]
*** [[vi]]
*** [[vim]]
*** [[nano]]
** [[synogear: weitere Tools]]
</div>
|}

== Starthilfen für das neue Synology Wiki ==
{| style="width: 100%; border: 1px solid #EAECF0; background: #F8F9FA;"
|
<div style="margin: 0; padding: .5em;">
* [[mediawikiwiki:Special:MyLanguage/Manual:Configuration_settings|Liste der Konfigurationsparameter]]
* [[mediawikiwiki:Special:MyLanguage/Manual:FAQ|Häufige Fragen zu MediaWiki]]
* [https://lists.wikimedia.org/postorius/lists/mediawiki-announce.lists.wikimedia.org/ Mailingliste zu neuen Versionen von MediaWiki]
* [[mediawikiwiki:Special:MyLanguage/Localisation#Translation_resources|Übersetze MediaWiki für deine Sprache]]
* [[mediawikiwiki:Special:MyLanguage/Manual:Combating_spam|Erfahre, wie du Spam auf deinem Wiki bekämpfen kannst]]
* Hilfe zur Verwendung und Konfiguration der Wiki-Software findest du im [[mediawikiwiki:Special:MyLanguage/Help:Contents|Benutzerhandbuch]].</div>
|}

Paperless-ngx auf Synology-DiskStations

2025-03-20T15:04:30Z

JohneDoe: In der Docker Compose Datei werden keine Docker Volumes verwendet. Dann müssen diese auch nicht erstellt werden. Ansonsten erzeugt Docker Volumes im Systemordner die nie verwendet werden. Ist zwar nicht schlimm, aber einfach unschön.

== Paperless-ngx – Ein Sammelthread für ein DMS via Docker auf dem NAS==
<div style="float: right; margin-left: 1em; margin-right: 0; padding: 1em; border: 1px solid darkgray; font-size: 85%; background: #F5F5F5; max-width: 33%;">
'''Aktuelle Version von Paperless-ngx'''

''[https://github.com/paperless-ngx/paperless-ngx/releases/tag/v2.14.7 '''2.14.7''']''

=== Features ===

* Enhancement: require totp code for obtain auth token by @shamoon in #8936

=== Bug Fixes ===

* Enhancement: require totp code for obtain auth token by @shamoon in #8936
* Fix: reflect doc links in bulk modify custom fields by @shamoon in #8962
* Fix: also ensure symmetric doc link removal on bulk edit by @shamoon in #8963<br />
</div>
=== Was ist Paperless-ngx? ===
Paperless-ngx ist ein Fork von Paperless-ng, einem Dokumentenmanagementsystem (DMS), welches als Container unter Docker/Container Manager (ab DSM 7.2) läuft. Zusammen mit einem Scanner könnt ihr euer Büro zu Hause papierlos machen und findet über Schlagwörter schnell die Dokumente, die ihr sucht. Eigentlich können gescannte Dokumente auch nummeriert werden, sodass ihr sie auch im Original schnell wiederfindet, wenn ihr sie doch mal brauchen solltet.

=== Ist Paperless-ngx überhaupt etwas für mich? ===
Das kann man natürlich immer nur für sich selbst beantworten. Manche Personen greifen lieber direkt auf ihre Dokumente in den Ordnern zu, für diejenigen ist vielleicht synOCR besser geeignet. Wer Paperless-ngx nutzen möchte, sollte die gesamte Verwaltung von dem Programm machen lassen und Änderungen nur über die Oberfläche vornehmen. Die Dateien lassen sich trotzdem ohne große Probleme aus der Ordnerstruktur heraus kopieren oder über die Oberfläche herunterladen.

Wer noch weitere Gedanken zur Entscheidung braucht, dem sei der Thread [https://www.synology-forum.de/threads/paperless-ngx-ein-kurzer-erfahrungsbericht-sowie-ein-erstes-resuemee.133974/ Paperless-ngx: Ein kurzer Erfahrungsbericht sowie ein erstes Resümee] von [[Benutzer:Tommes|Tommes]] empfohlen. Dort wird über viele Fragen diskutiert, die immer mal wieder hier im Forum aufkommen, weil Paperless-ngx schon eine feine Sache, aber nicht für jede Arbeitsweise geeignet ist. Solche Fragen sollte man jedenfalls klären, bevor man die ersten 1000 Dokumente verarbeitet 😉

=== Wie installiere ich Paperless-ngx? ===
Wie so oft bei Docker gibt es hier unterschiedliche Herangehensweisen. Man kann für die Verwaltung aller seiner Container andere Containerdienste wie Portainer verwenden oder auch den Container-Manager vom Synology selbst; allerdings verwende ich selbst ausschließlich die Konfigurationsdateien im YML-Format. Deswegen beachtet bitte, dass beispielsweise Anleitungen von Magnus auf seiner Seite Magnus Hosting ein wenig anders aussehen als das, was ihr hier seht.

==== Ordner und Konfigurationsdatei erstellen ====
Geht zu Eurem Docker-Ordner (meistens: <code>/volume1/docker</code>) und erstellt einen Unterordner <code>/paperlessngx</code> und innerhalb des Ordners noch die Ordner:

* config
* consume
* data
* export
* exportpostgres
* media
* pgdata
* redis

Hier werden die Daten außerhalb des Containers gespeichert, das ermöglicht Euch, bei Problemen im Zweifelsfalle den ganzen Ordner wieder zu kopieren und nach Eingabe der Befehle unten dort weiterarbeiten zu können.

Dann wenden wir uns der Konfigurationsdatei zu. Die Macher von Paperless-ngx haben dazu auf der GitHub-Seite bereits mehrere Beispiele veröffentlicht. Im Zweifelsfalle nehmt einfach eine der vorhandenen Dateien, man kann diese jederzeit nachträglich an seine Bedürfnisse anpassen. Erstellt werden

* docker-compose.yml
* docker-compose.env

Und zwar im Ordner <code>config</code>. Die env-Datei kann man auch anders benennen, dann muss die entsprechende Zeile in der yml halt anpassen. Für die yml-Datei nutze ich folgende Einstellungen:<syntaxhighlight lang="docker">
version: "3.6"
services:
broker:
container_name: redis
image: redis:latest
restart: unless-stopped
volumes:
- ../redis:/data

db:
container_name: postgres
image: postgres:15
restart: unless-stopped
volumes:
- ../pgdata:/var/lib/postgresql/data
- /volume1/docker/paperlessngx/exportpostgres:/var/lib/postgresql/data/backup
environment:
POSTGRES_DB: paperless
POSTGRES_USER: paperless
POSTGRES_PASSWORD: paperless

webserver:
container_name: paperlessngx
image: ghcr.io/paperless-ngx/paperless-ngx:latest
restart: unless-stopped
depends_on:
- db
- broker
ports:
- 34343:8000
healthcheck:
test: ["CMD", "curl", "-fs", "-S", "--max-time", "2", "http://localhost:8000"]
interval: 30s
timeout: 10s
retries: 5
volumes:
- ../data:/usr/src/paperless/data
- ../media:/usr/src/paperless/media
- ../export:/usr/src/paperless/export
- ../consume:/usr/src/paperless/consume
env_file: docker-compose.env
environment:
PAPERLESS_REDIS: redis://broker:6379
PAPERLESS_DBHOST: db
</syntaxhighlight>Sehr wichtig ist es hier, die Version der Datenbank festzuschreiben, wenn ihr Postgres verwendet. Solltet ihr die Version hier nicht festlegen, zumindest auf die Hauptversion, dann wird es bei einem Wechsel auf die nächste Hauptversion, nach meiner Anleitung wäre das Version 16, dazu kommen, dass die Datenbank nicht mehr erreichbar ist. Da müsst ihr wirklich aufpassen. Im schlimmsten Fall zerschießt ihr euch die komplette Datenbank. Und wenn ihr dann keine Sicherung habt, dann könnt ihr die ganze Installation neu aufsetzen. Auch bei Paperless gilt, Backup ist Trumpf!

==== Einrichtung via Terminal bzw. Aufgabenplaner ====
Die nächsten Schritte nehmt Ihr im Terminal (macOS) bzw. der Konsole (Windows) vor via SSH (''Systemsteuerung → Terminal/SSH'', orange) oder ihr nutzt einfach den Aufgabenplaner unter DSM. Den findet Ihr unter ''Systemsteuerung → Aufgabenplaner, rot''. Folgende Befehle bitte dort eingeben, sudo erfordert das Admin-Passwort oder Ihr loggt Euch direkt als root ein. Die Konfiguration habe ich selbst über das Terminal/Konsole gemacht.

# cd /volume1/docker/paperlessngx/config
# sudo docker-compose pull
# sudo docker-compose run --rm webserver createsuperuser
# sudo docker-compose up -d

Folgendes machen die Befehle dabei:

# Navigiert in das entsprechende Verzeichnis (cd → «change directory»)
# „Pullt“ das/die entsprechenden Images, lädt also hier Paperless, redis und PostgreSQL in der festgelegten Version herunter.
# Erstellt einen Admin – das habe ich nicht über den Aufgabenplaner ausgeführt, da fehlt die entsprechende Eingabemöglichkeit!
# Startet die Container

Wenn alles geklappt hat, findet Ihr nach der Anleitung oben Paperless unter <code><nowiki>http://domain:34343</nowiki></code>. Den Port 34343 könnt Ihr logischerweise anpassen.

=== Das „leidige“ Thema PostgreSQL-Updates… ===

==== Grundsätzliches ====
Immer wieder wird die Frage gestellt, wie im Zusammenhang mit Paperless-ngx eine Datenbankversion aktualisiert werden kann nach einem Major Update, wenn als Datenbank PostgreSQL zum Einsatz kommt. Da der ganze Vorgang nicht trivial ist und ich bei meinem Update von Version 15 auf 16 die eine oder andere Hürde gefunden habe, für die ich mir diverse Tips hier zusammengesucht habe nunmehr ein Versuch, das ganze in einer ausführlichen Anleitung zusammenzufassen.

Stand 2. Februar 2024 ist die aktuellste Major Version von PostgreSQL v16, unterstützt und weiter mit Updates versorgt werden noch v12–v15. v11 hat im November 2023 das letzte Update erhalten. Folgende Versionen von PostgreSQL sind innerhalb ihrer Major Version derzeit aktuell:

* 9. November 2023: <code>16.1</code>, <code>15.5</code>, <code>14.10</code>, <code>13.13</code>, <code>12.17</code> und <code>11.22</code> ( EOL)

Anbei ein Bild, wo ihr, egal welcher Tag gesetzt wurde, seht, welche Version Eure Datenbank gerade verwendet.

Auch wenn Updates immer eine sinnvolle Sache sind, so sei an dieser Stelle zunächst auch erwähnt, dass ein Update der Datenbank-Version keinerlei Vorteile im Betrieb von Paperless-ngx mit sich bringt. Neue Funktionen gibt es mit dem Update des Webservers, solange eine alte Version nicht zu Problemen führt, kann diese auch weiterverwendet werden.

Wer erst mit Paperless-ngx startet, dem sei auch empfohlen, von Beginn an auf MariaDB als Datenbank zu setzen; wer bisher PostgreSQL einsetzt und gerne auf MariaDB wechseln möchte, dem sei diese Anleitung von @Adama ans Herz gelegt: Paperless-ngx: Migration Postgresql zu MariaDB. Bei großen Versionsupdates der MariaDB sind hier im Forum bisher keine Probleme bekannt und das im Vergleich umständliche Prozedere unten entfällt.

==== Grundlagen ====
Bevor ich beginne, möchte ich ein paar Begriffe klären, damit es nachher nicht zu Missverständnissen kommt bzw. ihr wisst, was ihr wo mit eventuell anderen Bezeichnungen ersetzen müsst.

* Verwende ich <code>PGDBNAME</code>, so ist der Name eures PostgreSQL-Containers gemeint. Verwendet ihr paperless-ngx-db, nutzt ihr also diesen Namen.
* Verwende ich <code>PGUSER</code>, ist der Name gemeint, der in Eurer Installation für die Anmeldung an der PostgreSQL-Datenbank verwendet wird. Standardmäßig ist das in der yaml-Beispielsdatei <code>paperless</code>

Dann möchte ich grundsätzlich anmerken, dass ich die ganzen Befehle in der Regel über mein Terminal absetze, weil ich dort sofort das Ergebnis sehe. Die ganzen Befehle können aber selbstverständlich auch über den Aufgabenplaner eingegeben werden, dann erhaltet ihr je nach eurer Einstellung die Antwort per Mail. Das erschwert bei Problemen aber im Zweifelsfall die Ursachenfindung.

==== Anleitung ====
Vor solchen Arbeiten solltet ihr sicherstellen, dass hier ein aktuelles und funktionierendes Back-up eurer Installation habt. Kein Backup → kein Mitleid

# Stoppt die Container des Webservers und des Brokers (redis), um zu verhindern, dass weitere Daten in die Datenbank geschrieben werden können (der PostgreSQL-Container muss weiterlaufen, weil sonst kein „Dump“ erstellt werden kann)
# Erstellt einen so genannten „Dump“, also eine Sicherung der Datenbank mit folgendem Befehl: <code>docker exec PGDBNAME bash -c "psql -U PGUSER > /var/lib/postgresql/data/backup/backup.dump"</code>
# Stoppt den PostgreSQL-Container und benennt den bisherigen Ordner (z. B. <code>/pgdata</code>) um, der Einfachheit halber etwa <code>pgdatav15</code> für die alte Version und erstellt /pgdata neu. Der Ordner muss (!) leer sein!
# Passt in der Konfiguration (yaml) die Version von PostgreSQL an (z. B. auf <code>postgres:16</code>) (*1)
# Startet zunächst nur die Datenbank neu, in dem ihr in den Ordner navigiert <code>cd /volume1/docker/paperless/oder/so</code> und dann folgenden Befehl ausführt <code>docker-compose up -d db</code>
# Kopiert den Backup-Ordner mit dem Dump in <code>/pgdata</code>
# Führt folgenden Befehl aus <code>docker exec PGDBNAME bash -c "psql -U PGUSER < /var/lib/postgresql/data/backup/backup.dump"</code>, danach seht ihr im Terminal, wie die Daten eingelesen werden
# Wenn der Befehl ohne Fehler durchgelaufen ist, startet Webserver und Broker erneut: <code>docker-compose up -d</code>

Danach solltet ihr euch mit den bekannten Anmeldedaten wieder anmelden können. Wird die Anmeldeseite geladen, funktioniert das Anmelden aber nicht mit Verweis auf falsche Anmeldedaten, dann hat das zurückspielen der Datenbank nicht funktioniert.

=== Zusätzliche Links ===
Folgende zusätzliche Links können euch helfen, wenn ihr doch mal an Probleme kommt, die ihr so nicht klären könnt:

* MariusHosting (Marius Bogdan Lixandru): [https://mariushosting.com/how-to-install-paperless-ngx-on-your-synology-nas/ How to Install Paperless NGX on Your Synology NAS]
* [https://www.youtube.com/@DigitalisierungmitKopf/videos Digitalisierung mit Kopf] (Stefan Lachner)
** Paperless-ngx: Automatische Texterkennung (OCR) in Scans mit Synology NAS / Raspberry Pi
** Paperless-ngx auf Synology-NAS installieren: Schritt-für-Schritt-Anleitung (papierloses Büro)
** HTTPS: Paperless-ngx aus dem Internet erreichbar machen mit Synology NAS