Paperless-ngx

• Installation
• Startseite
• Dokument hinzufügen
• Verwaltung
• Korrespondenten
• Tags
• Dokumententypen
• Speicherpfade
• Benutzerdefinierte Felder
• Arbeitsabläufe
• Dokument betrachten
• Benutzer & Gruppen
• Berechtigungen
• Massenbearbeitung
• Handy App

Installation

Die Installation ist Dank Docker schnell und einfach erledigt.

Am besten zuerst einen neuen Ordner anlegen, in welchen dann eine docker-compose.yml sowie eine docker-compose.env angelegt werden.

Zuerst folgende Docker Compose Konfiguration anpassen und speichern.

services:
  paperless_redis:
    image: redis
    container_name: paperless_redis
    restart: unless-stopped
    volumes:
      - /pfad/zu/paperless-ngx/redis_data:/data
  paperless_db:
    image: mariadb
    container_name: paperless_db
    restart: unless-stopped
    volumes:
      - /pfad/zu/paperless-ngx/db_data:/var/lib/mysql
    environment:
      MARIADB_HOST: paperless
      MARIADB_DATABASE: paperless
      MARIADB_USER: paperless
      MARIADB_PASSWORD: paperless
      MARIADB_ROOT_PASSWORD: paperless
  paperless_gotenberg:
    image: docker.io/gotenberg/gotenberg
    container_name: paperless_gotenberg
    restart: unless-stopped
    # The gotenberg chromium route is used to convert .eml files. We do not
    # want to allow external content like tracking pixels or even javascript.
    command:
      - "gotenberg"
      - "--chromium-disable-javascript=true"
      - "--chromium-allow-list=file:///tmp/.*"
  paperless_tika:
    image: ghcr.io/paperless-ngx/tika:latest
    container_name: paperless_tika
    restart: unless-stopped
  paperless_web:
    image: ghcr.io/paperless-ngx/paperless-ngx:latest
    container_name: paperless_web
    restart: unless-stopped
    depends_on:
      - paperless_db
      - paperless_redis
      - paperless_gotenberg
      - paperless_tika
    ports:
      - "8000:8000"
    volumes:
      - /pfad/zu/paperless-ngx/data:/usr/src/paperless/data
      - /pfad/zu/paperless-ngx/media:/usr/src/paperless/media
      - /pfad/zu/paperless-ngx/export:/usr/src/paperless/export
      - /pfad/zu/paperless-ngx/consume:/usr/src/paperless/consume
    env_file: /pfad/zu/paperless-ngx/docker-compose.env
    environment:
      PAPERLESS_REDIS: redis://paperless_redis:6379
      PAPERLESS_DBENGINE: mariadb
      PAPERLESS_DBHOST: paperless_db
      PAPERLESS_DBUSER: paperless # only needed if non-default username
      PAPERLESS_DBPASS: paperless # only needed if non-default password
      PAPERLESS_DBPORT: 3306
      PAPERLESS_TIKA_ENABLED: 1
      PAPERLESS_TIKA_GOTENBERG_ENDPOINT: http://paperless_gotenberg:3000
      PAPERLESS_TIKA_ENDPOINT: http://paperless_tika:9998

Anstelle einer MariaDB kann auch PostgreSQL oder SQLite (würde ich nicht empfehlen) verwendet werden. Weitere Informationen hierzu können in der offiziellen Dokumentation nachgelesen werden: GitHub Paperless-ngx

Nun kann die docker-compose.env erstellt werden, welche folgenden Inhalt erhält. Bitte auch hier ggf. die Einstellungen nach Wunsch anpassen z. B. die Sprache für die OCR-Erkennung.

# The UID and GID of the user used to run paperless in the container. Set this
# to your UID and GID on the host so that you have write access to the
# consumption directory.
USERMAP_UID=1000
USERMAP_GID=1000

# Additional languages to install for text recognition, separated by a
# whitespace. Note that this is
# different from PAPERLESS_OCR_LANGUAGE (default=eng), which defines the
# language used for OCR.
# The container installs English, German, Italian, Spanish and French by
# default.
# See https://packages.debian.org/search?keywords=tesseract-ocr-&searchon=names&suite=buster
# for available languages.
PAPERLESS_OCR_LANGUAGES=deu eng

###############################################################################
# Paperless-specific settings                                                 #
###############################################################################

# All settings defined in the paperless.conf.example can be used here. The
# Docker setup does not use the configuration file.
# A few commonly adjusted settings are provided below.

# This is required if you will be exposing Paperless-ngx on a public domain
# (if doing so please consider security measures such as reverse proxy)
#PAPERLESS_URL=https://paperless.example.com

# Adjust this key if you plan to make paperless available publicly. It should
# be a very long sequence of random characters. You don't need to remember it.
#PAPERLESS_SECRET_KEY=change-me

# Use this variable to set a timezone for the Paperless Docker containers. If not specified, defaults to UTC.
PAPERLESS_TIME_ZONE=Europe/Berlin

# The default language to use for OCR. Set this to the language most of your
# documents are written in.
PAPERLESS_OCR_LANGUAGE=deu

# Set if accessing paperless via a domain subpath e.g. https://domain.com/PATHPREFIX and using a reverse-proxy like traefik or nginx
#PAPERLESS_FORCE_SCRIPT_NAME=/PATHPREFIX
#PAPERLESS_STATIC_URL=/PATHPREFIX/static/ # trailing slash required

Nachdem die beiden Dateien erstellt und angepasst worden sind, können die Container erstellt und gestartet werden.

Um die Docker Compose Konfiguration auszuführen, kann am besten in das Verzeichnis der YAML Datei gewechselt werden. Danach wird je nach nach gewählter Installation sudo docker-compose up -d oder sudo docker compose up -d (keine Bindestrich zwischen docker und compose) eingegeben, um die Standard Konfiguration docker-compose.yml zu starten. Compose erstellt dann die gewünschten Container mit den angegeben Optionen. Sollten die Container bereits mit dieser Compose Konfiguration erstellt worden sein, so werden die Container in dieser neu erstellt, dessen Konfiguration geändert wurde.

Der erste Start dauert mehrere Sekunden, da die Datenbanken, Verzeichnisse usw. automatisch initialisiert werden. Diese Zeit kann genutzt werden, um auf der Kommandozeile einen Superadmin zu erstellen. Hierfür bitte folgenden Befehl ausführen (ggf. den Namen des Containers anpassen.

sudo docker compose exec -it paperless_web python3 manage.py createsuperuser

Anschließend steht die Weboberfläche unter http://localhost:8000 zur Verfügung und der soeben erstelle Superuser kann zum Login verwendet werden.

Nach dem erfolgreichen Login wird eine Willkommensseite angezeigt.

Hier wird eine Tour vorgeschlagen, welche die wichtigsten Funktionen kurz zeigt und erklärt. Diese ist unbedingt zu empfehlen, wenn Paperless vorher noch nie verwendet wurde.

Startseite

Die Startseite oder auch das Dashboard ist am Anfang noch leer. Hier können selbst Ansichten angeheftet werden.

Im folgenden Beispiel wurden bereits 2 Ansichten erstellt und zur Startseite hinzugefügt.

Die beiden Ansichten Infomaterial und Ohne Tag können auch mittels Drag&Drop vertauscht werden. Die Dokumente in diesen Ansichten können direkt angeklickt werden, um die Details des Dokumentes anzusehen.

Links von den beiden Ansichten sehen wir das Menü, welches je nach Berechtigung des Benutzers die verschiedenen Menüs anbietet.

Rechts von den Ansichten befindet sich eine Statistik, welche einige Informationen über die Dokumentenbibliothek anzeigt. Die Daten in der Statistik können angeklickt werden, um z. B. direkt in das Menü für die Tags zu springen.

Unter der Statistik befindet sich eine Schaltfläche, mit der neue Dokumente hochgeladen werden können. Aber diese lassen sich auch einfacher hinzufügen, indem einfach ein Dokument z. B. vom Desktop in das Browserfenster gezogen wird.

Dokument hinzufügen

Ein Dokument kann über mehrere Weg an Paperless übergeben werden. Zum einen die einfachste und intuitive Möglichkeit direkt im Browser mittels Drag&Drop oder über die Schaltfläche Dokument auswählen. Weiterhin kann auch der Posteingang eines E-Mail Postfaches eingebunden werden und die gewünschten Dokumente werden einfach in den Ordner consume abgelegt. Folgend werden die verschiedenen Möglichkeiten kurz vorgestellt.

Im Browser

Das Hochladen von neuen Dokumenten kann mittels Drag&Drop auf jeder Paperless-Seite erfolgen. Dazu einfach ein Dokument z. B. aus dem Dateiexplorer oder Dateiverzeichnis in das offene Browserfenster von Paperless ziehen, kurz warten, bis sich das Fenster grün einfärbt und loslassen.

Nun wird das Dokument hochgeladen und ein kleines Statusfenster gibt Auskunft über den Fortschritt.

Sobald das Dokument erfolgreich hochgeladen und von Paperless analysiert wurde, zeigt Paperless dies an und das Dokument kann direkt geöffnet werden, um die erfassten Inhalt zu prüfen und ggf. zu korrigieren.

In diesem Beispiel wurde eine Infobroschüre hochgeladen. Im Vorfeld wurden bereits einige andere Infobroschüren hochgeladen und mit dem Dokumententyp Informationsblatt zugewiesen. Dies hat Paperless nun erfolgreich erkannt und somit schon den passenden Typ ausgewählt. Außerdem wurde automatisch das Ausgestellt am Feld mit einem älteren Datum versehen, in diesem Fall wohl das Erstelldatum des Dokumentes.

E-Mail

In der Menüleiste gibt es unter Verwaltung den Eintrag E-Mail. Dadurch wird das Menü für die Einstellungen von Posteingängen geöffnet.

Zuerst muss ein E-Mail Konto hinzugefügt werden, dann können im 2. Schritt eine oder mehrere Regeln für dieses Postfach erstellt werden.

Das Hinzufügen eines neuen E-Mail Kontos ist soweit selbst erklärend. Das Konfigurationsfenster sieht wie folgt aus und ist je nach Mailserver anders einzustellen.

Nachdem ein Postfach hinzugefügt wurde, ist für dieses eine Regel zu erstellen, damit auch tatsächlich Mails abgerufen und verarbeitet werden. Jede Regel erhält einen Namen und es ist ein Konto auszuwählen. Standardmäßig wird der Ordner INBOX also der Posteingang eingelesen. Eine Empfehlung wäre, einen neuen Ordner im Mail Account zu erstellen und diesen hier anzugeben. Dann kann über den Mailclient gesteuert werden, welche Mails archiviert werden sollen. Ansonsten werden alle eingegangen Mails archiviert. Alle anderen Einstellungen sollten soweit selbst erklärend sein.

Ordner consume

Der Ordner wurde in der Docker Compose Konfiguration angegeben. Die Verwendung ist ganz simpel. Einfach ein oder mehrere Dokumente in den Ordner kopieren und fertig. Paperless wird diese nach und nach verarbeiten.

Tipp: Den Ordner als Netzlaufwerk freigeben oder einen FTP-Server aufsetzen, um von Scannern im eigenen Netzwerk direkt in Paperless scannen zu können. Dazu einfach den SMB- oder FTP-Ordner in den Einstellungen des Druckers (meist das Adressbuch) als Scan-Ziel hinterlegen.

Verwaltung

Korrespondenten

Jedem Dokument kann ein sog. Korrespondent zugewiesen werden. Ein Korrespondent kann z. B. eine Bank oder ein Online-Shop sein. Dadurch können Dokumente leichter wiedergefunden werden, wenn z. B. 1x im Jahr die Steuerunterlagen zu prüfen sind. In dem Fall könnten alle Dokumente des Steuerberaters mit einem Klick gefunden werden, indem dieser als Korrespondent für die entsprechenden Dokumente zugeordnet wird und später reicht ein Klick, um alle Dokumente zu finden.

Ein Korrespondent kann auf verschiedenen Wegen erstellt werden.

Erstellung bei Dokumentenänderung

Zum einen kann dieser direkt bei der Bearbeitung eines Dokumentes hinzugefügt werden. Hierzu einfach auf das Pluszeichen neben Korrespondent klicken.

Daraufhin öffnet sich ein Pop-Up in dem nun der Name einzugeben ist. Hierbei kann noch die Zuweisung angepasst werden sowie die Berechtigungen.

Nach einem Klick auf Speichern wird der neue Korrespondent erstellt und zugewiesen.

Verwaltung aller Korrespondenten

Wenn nun die bestehenden Korrespondenten verwaltet werden sollen, also bestehende zu bearbeiten oder löschen sind, dann geht dies am Besten über die Verwaltung - Korrespondenten. Hier wird eine Liste mit allen bestehenden Korrespondenten angezeigt.

In dieser Ansicht ist auch direkt ersichtlich, wie viele Dokumente zu dem jeweiligen Korrespondenten gespeichert sind. Zusätzlich gibt es die Möglichkeit mit einem Klick auf Dokumente alle Dokumente für diesen Korrespondenten einsehen zu können.

Automatische Erstellung bei Mail

Wenn ein Posteingang samt Regel konfiguriert wurde, so kann auch in den Regeleinstellungen die automatische Erstellung von Korrespondenten festgelegt werden. Hierfür die gewünschte Option unter Korrespondentenzuweisung auswählen.

Tags

Jedem Dokument können keine, ein oder mehrere Tags zugewiesen werden. Tags stellen wieder eine Möglichkeit zur schnellen Suche bzw. Filterung der Dokumente bereit. Hierdurch lassen sich Dokumente der selben Kategorie z. B. Investition oder Auto gruppieren und somit leichter wiederfinden. So gibt es bspw. für ein Auto Rechnungen von der Werkstatt und Verträge für Versicherungen. Werden nun die verschiedenen Dokumente mit dem selben Tag versehen wie Auto, dann können alle mit einem Klick bzw. der Filterung des Tags Auto gefunden werden. Zusätzlich könnten auch weitere Tags für verschiedene Autos hinterlegt werden, sodass die Unterlagen von mehreren Fahrzeugen problemlos auseinander gehalten werden können.

Tags lassen sich zum einen wie Korrespondenten direkt im Dokument erstellen und zuweisen sowie unter Verwaltung - Tags konfigurieren.

Auch hier können mit einem Klick auf Dokumente alle zugeordneten Dokumente eingesehen werden. Weiterhin können Tags mit Berechtigungen versehen werden, sodass bestimmte Tags nur für bestimmte Personen oder Gruppen sichtbar bzw. bearbeitbar sind.

Das Fenster zum Bearbeiten eines Tags sieht wie folgt aus.

Eine Besonderheit stellt hierbei die Option Posteingangs-Tag dar. Wird diese Option aktiviert, dann erhält jedes neue Dokument diesen Tag und dieser ist explizit zu entfernen, damit ein Dokument nicht mehr im Posteingang verbleibt.

Hier empfiehlt sich das Erstellen eines Tags Posteingang, welcher diese Option aktiviert hat. Dann landen alle neuen Dokumente im Posteingang und der Tag muss erst entfernt werden, bevor das Dokument aus diesem verschwindet. Dies ist für Workflows gedacht, wenn also jedes Dokument nochmal kurz geprüft und ggf. nachbearbeitet werden soll.

Dokumententypen

Jedes Dokument kann einem Dokumententyp zugeordnet werden. Der Dokumententyp hat keine Auswirkung auf das Dokument an sich, sondern ermöglicht nur, z. B. einfacher zwischen einer Rechnung und einem Vertrag unterscheiden zu können.

Es gilt wie bei den Korrespondenten, dass nur ein Typ pro Dokument ausgewählt werden kann. Auch der Typ kann entweder direkt bei der Bearbeitung eines Dokumentes erstellt und zugewiesen werden oder unter Verwaltung - Dokumenttypen.

Wie schon bei Korrespondenten und Tags können auch die Typen mit Berechtigungen versehen werden. Außerdem kann mit einem Klick auf Dokumente direkt nach den Dokumenten mit diesem Typ gesucht werden.

Speicherpfade

Paperless speichert die Dokumente in einer herkömmlichen Ordnerstruktur. Diese Struktur kann selbst konfiguriert werden. Es können sogar mehrere Speicherpfade konfiguriert werden, um z. B. Dokumente je nach Stichwort in anderen Strukturen zu speichern.

Das Menü zum Erstellen und Bearbeiten von Speicherpfaden befindet sich ebenfalls unter dem Punkt Verwaltung. Im folgenden Beispiel wurde bereits ein Speicherpfad konfiguriert, wie im folgenden Screenshot zu sehen.

Mit einem Klick auf den Namen des Speicherpfades kann dieser bearbeitet werden. Paperless unterstützt auch verschiedene Platzhalter, sodass die Ordnerstruktur z. B. nach dem Jahr und Korrespondenten des Dokumentes aufgebaut werden kann.

Eine gute Struktur ist wichtig, falls Paperless mal nicht mehr funktionieren sollte, dann kann einfach direkt in den Ordnern gesucht werden. Wenn die Struktur gut gewählt ist, lassen sich trotzdem die richtigen Dokumente finden.

Benutzerdefinierte Felder

Es können sog. Benutzerdefinierte Felder erstellt werden. Diese bieten die Möglichkeit zusätzliche Informationen zu den Dokumenten in den Metadaten zu speichern. Auch dieses Menü ist wieder unter Verwaltung zu finden.

Um ein neues Feld hinzuzufügen, einfach auf die Schaltfläche mit dem Pluszeichen rechts oben klicken. Daraufhin wird folgendes Menü geöffnet.

Hier kann nun ein Name festgelegt werden sowie ein Datentyp. Je nach Datentyp sieht das Eingabefeld anders aus.

Der Datentyp kann nur beim Erstellen festgelegt werden. Später kann dieser nicht mehr geändert werden.

Das neue benutzerdefinierte Feld wird jedoch nicht einfach allen Dokumenten hinzugefügt. Sondern es ist manuell bei der Bearbeitung eines Dokumentes hinzuzufügen oder mittels eines Arbeitsablaufes.

Erst danach wird es in den Details des Dokumentes angezeigt und kann dort bearbeitet werden.

Arbeitsabläufe

Mit Hilfe von sog. Arbeitsabläufe können z. B. bestimmte Metadaten je nach Bedingung beim Erstellen oder Bearbeiten eines Dokumentes gesetzt werden. Auch können über die Arbeitsabläufe Benutzerdefinierte Felder zu Dokumenten hinzugefügt werden.

Dieses Menü befindet sich ebenfalls in der Verwaltung. In diesem Menü werden alle bestehenden Arbeitsabläufe angezeigt und es können neue hinzugefügt werden.

Wird ein neues Ablauf erstellt, so sind ein Name und die Sortierreihenfolge einzustellen. Die Sortierreihenfolge gibt an, in welcher Reihenfolge die verschiedenen Arbeitsabläufe durchlaufen werden.

Danach werden ein oder mehrere Auslöser hinzugefügt, welche festlegen, wann der Ablauf gestartet werden soll und bei welchen Dokumenten.

Anschließend sind noch eine oder mehrere Aktionen hinzuzufügen, welche letztlich die Dokumente ändern.

Dokument betrachten

Wenn ein Dokument z. B. über die Ansichten der Startseite oder die Suche oder anderweitig angeklickt wird, öffnet sich folgender Dialog.

Eine Besonderheit ist nicht direkt ersichtlich. Links in der Menüleiste ist ein neuer Menüpunkt aufgetaucht, welcher alle geöffneten Dokumente, so auch dieses, anzeigt. So kann einfach in ein anderes Menü gewechselt werden, ohne das Dokument aus dem Blick zu verlieren und mit einem Klick kann in das Dokument zurückgesprungen werden.

Die Ansicht des Dokumentes ist zweigeteilt. Links werden die Metadaten zum Dokument angezeigt und können dort auch direkt bearbeitet werden. Diese sind auf verschiedene Reiter verteilt.

Die Informationen in den Reitern werden in den folgenden Screenshots kurz dargestellt.

Details

Jedes Dokument wird nach dem Hochladen gescannt (u. a. mit OCR) und auf Basis der so ermittelten Informationen werden die Details ausgefüllt. In diesem Beispiel wurde das Datum in Ausgestellt am automatisch aus der PDF gelesen und eingetragen.

Inhalt

Der Inhalt wird automatisch per OCR ermittelt und als durchsuchbarer Text gespeichert.

Metadaten

Notizen

Berechtigungen

Benutzer & Gruppen

Paperless bietet ein umfangreiches Berechtigungsmanagement auf Basis von Benutzern & Gruppen. Somit können z. B. bestimmte Benutzer oder Gruppen nur einen begrenzten Teil an Funktionen von Paperless erlaubt werden und auch Dokumente, Tags, Typen usw. eingeschränkt werden.

Benutzer

Damit jemand mit Paperless interagieren kann, wird ein Account bzw. Benutzer benötigt. Dieser kann von einem Administrator in der Weboberfläche angelegt werden. Hierzu unter Administration den Menüpunkt Benutzer & Gruppen aufrufen.

Über die Schaltfläche Benutzer hinzufügen kann nun ein neuer Benutzer erstellt werden.

Statt jedes Mal alle Berechtigungen setzen zu müssen, kann auch eine Gruppe erstellt werden. Wird die Gruppe dem Benutzer in diesem Erstellen Fenster zugewiesen, werden alle Berechtigungen der Gruppe für den Benutzer vorausgewählt. Dadurch kann viel Klickarbeit erspart werden.

Gruppen

Eine neue Gruppe wird im selben Menü erstellt wie ein neuer Benutzer. Hierzu unter Administration den Menüpunkt Benutzer & Gruppen aufrufen. Anschließend auf Gruppe hinzufügen klicken.

Berechtigungen

Wenn verschiedene Benutzer und Gruppen angelegt wurden, können auch Dokumente, Tags, Korrespondenten, Typen usw. mit anderen Benutzern/Gruppen geteilt werden.

Als Beispiel wollen wir nun mehrere Dokumente für die Gruppe Arbeitskollegen freigeben. Hierzu wird nun zuerst in die Ansicht Dokumente gewechselt und die gewünschten Dokumente werden gesucht. Dann werden diese durch anklicken ausgewählt. Anschließend wird auf Berechtigungen geklickt.

Daraufhin öffnet sich ein Pop-Up, in welchem die Berechtigungen konfiguriert werden können. Hierbei wird zwischen Anzeigen und Bearbeiten unterschieden. Außerdem ist es sogar möglich, den Eigentümer zu ändern, hierbei kann nur eine Person und keine Gruppe ausgewählt werden.

Nachdem die Berechtigungen angepasst wurden, wird nun unter den freigegebenen Dokumenten angezeigt, dass diese freigegeben wurden.

Massenbearbeitung

Paperless bietet die Möglichkeit bestimmte Metadaten für mehrere Dokumente auf einmal zu bearbeiten.

Zuerst werden die gewünschten Dokumente z. B. über die Suche gesucht. Danach sind diese auszuwählen, indem die Dokumente einzeln angeklickt werden oder über die Schaltfläche Auswählen, rechts oben in der Menüleiste. Im folgenden Screenshot wurde auf Alles auswählen geklickt, sodass alle Dokumente ausgewählt werden, die durch die Suche gefunden wurden.

Nun können für die gewählten Dokumente die Tags, der Korrespondent, der Dokumententyp, der Speicherplatz oder die Berechtigungen angepasst werden. Im folgenden Beispiel wird der Tag Fortbildung gesetzt, indem auf Tags und dann auf Fortbildung geklickt wurde. Die Tags sind dann durch einen klick auf die Schaltfläche Anwenden zu bestätigen.

Es muss nun nochmal die Tag-Zuweisung bestätigt werden. Danach erhalten die Dokumente den Tag.

Die Tags werden an den Dokumenten angezeigt.

Handy App

An sich ist die Webseite responsiv, sodass sie auch auf mobilen Geräten wie Smartphone oder Tablet gut aussieht und funktioniert. Jedoch gibt es sowohl für Android als auch für iOS inoffizielle Apps. Diese haben den Vorteil, dass z. B. mehrseitige Dokumente leichter gescannt und als ein einzelnes Dokument in Paperless hochgeladen werden können.

Da die Dokumente auf dem Server gespeichert werden, lassen sich Weboberfläche und Apps auf verschiedenen Geräten gleichzeitig nutzen. Also am besten per App Dokumente scannen bzw. fotografieren und dann am PC ggf. Nachbearbeitungen durchführen.

Android App

Eine gute inoffizielle App für Android gibt es von Anton Stubenbord, diese heißt Paperless Mobile.

https://play.google.com/store/apps/details?id=de.astubenbord.paperless_mobile&hl=de&gl=US

iOS App

Eine gute inoffizielle App für iOS gibt es von Paul Gessinger, diese heißt Swift Paperless.

https://apps.apple.com/de/app/swift-paperless/id6448698521