Paperless

Installation von Paperless 2.5.0 unter Xubuntu 18.04

Paperless ist auf Github unter folgenden Link zu finden.

Die Installation bzw. das Setup von Paperless ist hier beschrieben. Bevor dies jedoch durchgeführt werden kann, müssten die hier beschriebenen Voraussetzungen erfüllt sein.

Voraussetzungen installieren

Zur Installation der Voraussetzungen werden folgenden Commands ausgeführt.

GNU Privacy Guard

gnupg ist bei Xubuntu ab Version 17.10 vorinstalliert.

Tesseract

sudo apt install tesseract-ocr tesseract-ocr-deu tesseract-ocr-eng

ImageMagic

sudo apt install imagemagick imagemagick-doc 

Unpaper

sudo apt install unpaper libtiff-tools netpbm 

libpoppler-cpp-dev

sudo apt install libpoppler-cpp-dev

optipng

sudo apt install optipng

Python Virtual Environment

sudo apt install python-virtualenv

g++

sudo apt install g++

Python3 Development

sudo apt install python3-dev

Setup

Zum Durchführen des Setups werden folgenden Commands ausgeführt.

Paperless installieren

Entpacken und nach /opt/paperless kopieren

sudo chown -R $$user$$:$$group$$ /opt/paperless/

Die Platzhalter $$user$$ und $$group$$ müssen entsprechend ersetzt werden.

Python-specific Requirements: Virtualenv

mkdir ~/virtualenv
mkdir ~/virtualenv/paperless
virtualenv --python=/usr/bin/python3 ~/virtualenv/paperless
source ~/virtualenv/paperless/bin/activate
pip install --requirement /opt/paperless/requirements.txt

/opt/paperless/src

cd /opt/paperless/src

cp ../paperless.conf.example /etc/paperless.conf

Anpassen folgender Variablen der Ziel-Konfigurationsdatei (paperless.conf):

• PAPERLESS_CONSUMPTION_DIR und/oder
• PAPERLESS_OCR_THREADS und/oder
• PAPERLESS_PASSPHRASE

./manage.py migrate

./manage.py createsuperuser

./manage.py runserver --insecure

Der Development Server läuft nun unter http://localhost:8000/.

Nun muss eine neue Shell geöffnet werden.

./manage.py document_consumer

Ausführen des Document Consumers als Daemon

Das Ausführen des Document Consumers als Daemon wird in der Paperless Dikumentation hier beschrieben.

cp /opt/paperless/scripts/paperless-consumer.service /etc/systemd/system/

Danach sollte die Datei wie folgt modifiziert werden. Die Platzhalter $$user$$ und $$group$$ müssen entsprechend ersetzt werden.

#[Unit]
Description=Paperless consumer

[Service]
User=$$user$$
Group=$$group$$
ExecStart=/home/$$user$$/virtualenv/paperless/bin/python3 /opt/paperless/src/manage.py document_consumer  

[Install]
WantedBy=multi-user.target

Nun wir der Service aktiviert und gestartet.

systemctl enable paperless-consumer

systemctl start paperless-consumer 

Hosten der Web Site durch einen Apache Web Server

Die Paperless Dokumentation beschreibt das Hosten von Paperless durch einen Apache Web Server hier.

Zuerst muss der Apache2 Web Server installiert werden.

sudo apt install apache2

Dieser ist nun unter http://localhost/ erreichbar.

Paperless benötig das mod_wsgi. Dies wird wie folgt installiert.

sudo apt install libapache2-mod-wsgi-py3 

Weiterhin muss der Paperless Installation und allen darunter liegenden Verzeichnissen und Dateien das Ausführungsrecht gegeben werden.

chmod -R a+x /opt/paperless/

Bevor nun der Virtual Host des Apache Servers angepasst wird, müssen alle statischen Komponenten kopiert werden. Hierzu führt man folgendes Kommando im Verzeichnis /opt/paperless/src aus.

./manage.py collectstatic

Als nächstes muss die Datei (der Virtual Host) /etc/apache2/sites-available/000-default.conf modifiziert werden. Im Folgenden ist ein möglicher Virtual Host dargestellt, welcher zu der obigen Paperless Konfiguration passt. Die Platzhalter $$user$$ und $$group$$ müssen entsprechend ersetzt werden.

<VirtualHost *:80>
    ServerName example.com

    Alias /static/ /opt/paperless/static/
    <Directory /opt/paperless/static>
        Require all granted
    </Directory>

    WSGIScriptAlias / /opt/paperless/src/paperless/wsgi.py
    WSGIDaemonProcess example.com user=$$user$$ group=$$group$$ threads=5 python-home=/home/$$user$$/virtualenv/paperless/ python-path=/opt/paperless/src:/opt/paperless/.env/lib/python3.4/site-packages
    WSGIProcessGroup example.com

    <Directory /opt/paperless/src/paperless>
        <Files wsgi.py>
            Require all granted
        </Files>
    </Directory>
</VirtualHost>

Logging

Das Log von Paperless kann mit Hilfe des Ubuntu System Journals eingesehen werden.

journalctl -f

Probleme und Lösungen

Paperless Consumer: Probleme beim Lesen von PDF Dateien

Ist im Paperless Log (journalctl) beim Einlesen einer PDF Datei die folgende Fehlermeldung zu sehen, so liegt dies an den Policy Einstellungen von ImageMagick.

convert-im6.q16: not authorized...

Dieses Problem lässt sich lösen, indem die Policy Einstellungen des Programms ImageMagick teilweise oder komplett gelöscht werden. Detailliert wird dies hier beschrieben. Der folgende Befehl entfernt die Policy Einstellungen komplett.

sudo mv /etc/ImageMagick-6/policy.xml /etc/ImageMagick-6/policy.xmlout