Quelltext der Seite Paperless-ngx "Bare Metal" installieren (Debian 11/12)

{{Infobox
| Titel      = Testumgebung
| Bildname   = 
| Bildbreite = 
| Bildtext   = 
| Stil            = 2
| Titelfarbe      = 6
| Abschnittsfarbe = 
| Farbe           = 
| Style           = 
| Feldstyle       = 
| Feldname1 = OS    | Daten1 = Debian 11.11/12.10
| Feldname3 = paperless-ngx (Dev)    | Daten3 = 2.15.0
}}

Anleitung für die "Bare Metal" Installation von [https://docs.paperless-ngx.com/ paperless-ngx] mit dem Sourcecode vom [https://github.com/paperless-ngx/paperless-ngx Dev] oder [https://github.com/paperless-ngx/paperless-ngx/tree/beta Beta] Branch auf Debian 11 und 12.
==Abhängigkeiten installieren==
Das System auf den neusten Stand bringen:<syntaxhighlight lang="bash">
sudo apt update
sudo apt upgrade
</syntaxhighlight><syntaxhighlight lang="bash">
sudo apt install build-essential zlib1g-dev libncurses5-dev libgdbm-dev libnss3-dev libssl-dev libreadline-dev libffi-dev \
libpq-dev libsqlite3-dev libbz2-dev pkg-config libgdbm-compat-dev liblzma-dev tk-dev uuid-dev wget imagemagick unpaper \
fonts-liberation gnupg libpq-dev default-libmysqlclient-dev pkg-config libmagic-dev libzbar0 poppler-utils \
icc-profiles-free qpdf liblept5 libxml2 pngquant zlib1g tesseract-ocr redis git curl


</syntaxhighlight>
===Python 3.11 installieren===
'''Debian 11:'''
:<syntaxhighlight lang="bash">
wget https://www.python.org/ftp/python/3.11.11/Python-3.11.11.tgz
tar -xvf Python-3.11.11.tgz
cd Python-3.11.11
./configure --enable-optimizations
make -j$(nproc)
sudo make install
</syntaxhighlight>
'''Debian 12:'''
:<syntaxhighlight lang="bash">
sudo apt install python3.11 python3.11-venv python3-pip python3-setuptools python3-wheel
</syntaxhighlight>
===Ghostscript 10.05 installieren===
<syntaxhighlight lang="bash">
wget https://github.com/ArtifexSoftware/ghostpdl-downloads/releases/download/gs10050/ghostscript-10.05.0.tar.gz
tar -xvf ghostscript-10.05.0.tar.gz
cd ghostscript-10.05.0
./configure --without-x
make -j$(nproc)
sudo make install
</syntaxhighlight>
== Paperless-ngx installieren ==
Paperless Benutzer erstellen und Repository klonen:<syntaxhighlight lang="bash">
sudo adduser paperless --system --home /opt/paperless --group
cd /opt/paperless
sudo -Hu paperless git clone https://github.com/paperless-ngx/paperless-ngx.git .
</syntaxhighlight><syntaxhighlight lang="bash">
sudo -u paperless mkdir consume media
</syntaxhighlight>
'''Debian 11:'''
:<syntaxhighlight lang="bash">
sudo -Hu paperless pip3 install uv asyncio
sudo -Hu paperless uv export --no-dev --all-extras --format requirements-txt --output-file requirements.txt
sudo -Hu paperless pip3 install -r requirements.txt
</syntaxhighlight>
'''Debian 12:'''
:<syntaxhighlight lang="bash">
sudo -u paperless python3 -m venv /opt/paperless/venv
sudo -Hu paperless /opt/paperless/venv/bin/pip3 install uv asyncio
sudo -Hu paperless /opt/paperless/venv/bin/uv export --no-dev --all-extras --format requirements-txt --output-file requirements.txt
sudo -Hu paperless /opt/paperless/venv/bin/pip3 install -r requirements.txt
</syntaxhighlight>
<syntaxhighlight lang="bash">
sudo -Hu paperless cp paperless.conf.example paperless.conf
</syntaxhighlight><syntaxhighlight lang="bash">
sudo -u paperless vi paperless.conf
</syntaxhighlight><syntaxhighlight lang="bash">
PAPERLESS_SECRET_KEY=change-me

PAPERLESS_CONSUMPTION_DIR=/mnt/paperless-store/consume
PAPERLESS_DATA_DIR=/mnt/paperless-store/data
PAPERLESS_MEDIA_ROOT=/mnt/paperless-store/media

PAPERLESS_TIME_ZONE=Europe/Berlin
</syntaxhighlight>

=== Datenbank ===
'''Hinweis: SQLite kann Probleme beim Bearbeiten paralleler Tasks verursachen.'''

Wenn du postgresql statt sqlite verwendet möchtest:<syntaxhighlight lang="bash">
PAPERLESS_DBHOST=127.0.0.1 # Use postgresql
PAPERLESS_DBNAME=db_paperless
#PAPERLESS_DBUSER=paperless
PAPERLESS_DBPASS=<password>
</syntaxhighlight><syntaxhighlight lang="bash">
sudo apt install postgresql
sudo -u postgres psql
</syntaxhighlight><syntaxhighlight lang="sql">
CREATE DATABASE db_paperless;
CREATE USER paperless WITH ENCRYPTED PASSWORD '<password>';
GRANT ALL ON DATABASE db_paperless TO paperless;
\c db_paperless
GRANT ALL ON SCHEMA public TO paperless;
\q
</syntaxhighlight>

=== Frontend ===
<syntaxhighlight lang="bash">
cd src-ui

</syntaxhighlight><syntaxhighlight lang="bash">
sudo curl -sL https://deb.nodesource.com/setup_18.x | sudo -E bash -
sudo apt install nodejs
</syntaxhighlight><syntaxhighlight lang="bash">
sudo npm install -g @angular/cli
sudo npm install -g pnpm
sudo -Hu paperless pnpm install

sudo -Hu paperless ng build --configuration production
</syntaxhighlight>

=== Backend ===
<syntaxhighlight lang="bash">
cd ../src
</syntaxhighlight>
'''Debian 11:'''
:<syntaxhighlight lang="bash">
sudo -Hu paperless python3 manage.py migrate
sudo -Hu paperless python3 manage.py createsuperuser
sudo -Hu paperless python3 manage.py collectstatic
</syntaxhighlight>
'''Debian 12:'''
:<syntaxhighlight lang="bash">
sudo -Hu paperless /opt/paperless/venv/bin/python3 manage.py migrate
sudo -Hu paperless /opt/paperless/venv/bin/python3 manage.py createsuperuser
sudo -Hu paperless /opt/paperless/venv/bin/python3 manage.py collectstatic
</syntaxhighlight>

=== ImageMagick konfigurieren ===
<syntaxhighlight lang="bash">
sudo vi /etc/ImageMagick-6/policy.xml
</syntaxhighlight><syntaxhighlight lang="bash">
<policy domain="coder" rights="read|write" pattern="PDF" />
</syntaxhighlight>
=== Systemd Services anlegen ===
<syntaxhighlight lang="bash">
cd ../scripts
</syntaxhighlight>

==== paperless-consumer ====
'''Debian 12:'''
:<syntaxhighlight lang="bash">
sudo vi paperless-consumer.service
</syntaxhighlight>ExecStart ersetzen:
:<syntaxhighlight lang="bash">
ExecStart=/opt/paperless/venv/bin/python3 manage.py document_consumer
</syntaxhighlight>
<syntaxhighlight lang="bash">
sudo ln -s /opt/paperless/scripts/paperless-consumer.service /etc/systemd/system/paperless-consumer.service
sudo systemctl daemon-reload
sudo systemctl enable --now paperless-consumer.service
</syntaxhighlight><syntaxhighlight lang="bash">
systemctl status paperless-consumer.service

</syntaxhighlight>Sollte in etwa so aussehen:<syntaxhighlight lang="bash">
● paperless-consumer.service - Paperless consumer
     Loaded: loaded (/etc/systemd/system/paperless-consumer.service; enabled; preset: enabled)
     Active: active (running) since Sat 2025-03-22 22:25:06 CET; 6s ago
   Main PID: 6715 (python3)
      Tasks: 11 (limit: 9472)
     Memory: 97.2M
        CPU: 1.518s
     CGroup: /system.slice/paperless-consumer.service
             └─6715 /opt/paperless/venv/bin/python3 manage.py document_consumer
</syntaxhighlight>

==== paperless-scheduler ====
<syntaxhighlight lang="bash">
sudo vi paperless-scheduler.service
</syntaxhighlight>'''Debian 11:'''
:ExecStart ersetzen:
:<syntaxhighlight lang="bash">
ExecStart=/opt/paperless/.local/bin/celery --app paperless beat --loglevel INFO
</syntaxhighlight>
'''Debian 12:'''
:ExecStart ersetzen:
:<syntaxhighlight lang="bash">
ExecStart=/opt/paperless/venv/bin/celery --app paperless beat --loglevel INFO
</syntaxhighlight>
<syntaxhighlight lang="bash">
sudo ln -s /opt/paperless/scripts/paperless-scheduler.service /etc/systemd/system/paperless-scheduler.service
sudo systemctl daemon-reload
sudo systemctl enable --now paperless-scheduler.service
</syntaxhighlight><syntaxhighlight lang="bash">
systemctl status paperless-scheduler.service
</syntaxhighlight>Sollte in etwa so aussehen:<syntaxhighlight lang="bash">
● paperless-scheduler.service - Paperless Celery Beat
     Loaded: loaded (/etc/systemd/system/paperless-scheduler.service; enabled; preset: enabled)
     Active: active (running) since Sat 2025-03-22 22:29:33 CET; 4s ago
   Main PID: 6981 ([celery beat] -)
      Tasks: 22 (limit: 9472)
     Memory: 115.1M
        CPU: 1.831s
     CGroup: /system.slice/paperless-scheduler.service
             └─6981 "[celery beat] --app paperless beat --loglevel INFO"

</syntaxhighlight>

==== paperless-task-queue ====
<syntaxhighlight lang="bash">
sudo vi paperless-task-queue.service
</syntaxhighlight>'''Debian 11:'''
:ExecStart ersetzen:
:<syntaxhighlight lang="bash">
ExecStart=/opt/paperless/.local/bin/celery --app paperless worker --loglevel INFO
</syntaxhighlight>
'''Debian 12:'''
:ExecStart ersetzen:
:<syntaxhighlight lang="bash">
ExecStart=/opt/paperless/venv/bin/celery --app paperless worker --loglevel INFO
</syntaxhighlight>
<syntaxhighlight lang="bash">
sudo ln -s /opt/paperless/scripts/paperless-task-queue.service /etc/systemd/system/paperless-task-queue.service
sudo systemctl daemon-reload
sudo systemctl enable --now paperless-task-queue.service
</syntaxhighlight><syntaxhighlight lang="bash">
systemctl status paperless-task-queue.service
</syntaxhighlight>Sollte in etwa so aussehen:<syntaxhighlight lang="bash">
● paperless-task-queue.service - Paperless Celery Workers
     Loaded: loaded (/etc/systemd/system/paperless-task-queue.service; enabled; preset: enabled)
     Active: active (running) since Sat 2025-03-22 22:31:23 CET; 4s ago
   Main PID: 7122 ([celeryd: celer)
      Tasks: 24 (limit: 9472)
     Memory: 197.6M
        CPU: 2.177s
     CGroup: /system.slice/paperless-task-queue.service
             ├─7122 "[celeryd: celery@paperless-ngx-1:MainProcess] -active- (--app paperless worker --loglevel INFO)"
             ├─7153 "[celeryd: celery@paperless-ngx-1:ForkPoolWorker-1]"
             └─7154 "[celeryd: celery@paperless-ngx-1:ForkPoolWorker-2]"

</syntaxhighlight>
==== paperless-webserver ====
<syntaxhighlight lang="bash">
sudo vi paperless-webserver.service
</syntaxhighlight>'''Debian 11:'''
:exec ersetzen:
:<syntaxhighlight lang="bash">
exec /opt/paperless/.local/bin/granian --interface asginl --ws "paperless.asgi:application"'
</syntaxhighlight>
'''Debian 12:'''
:exec ersetzen:
:<syntaxhighlight lang="bash">
exec /opt/paperless/venv/bin/granian --interface asginl --ws "paperless.asgi:application"'
</syntaxhighlight>
<syntaxhighlight lang="bash">
sudo ln -s /opt/paperless/scripts/paperless-webserver.service /etc/systemd/system/paperless-webserver.service
sudo systemctl daemon-reload
sudo systemctl enable --now paperless-webserver.service
</syntaxhighlight><syntaxhighlight lang="bash">
systemctl status paperless-webserver.service
</syntaxhighlight>Sollte in etwa so aussehen:<syntaxhighlight lang="bash">
● paperless-webserver.service - Paperless webserver
     Loaded: loaded (/etc/systemd/system/paperless-webserver.service; enabled; preset: enabled)
     Active: active (running) since Sat 2025-03-22 22:34:41 CET; 3s ago
   Main PID: 7519 (granian asginl )
      Tasks: 18 (limit: 9472)
     Memory: 133.2M
        CPU: 1.746s
     CGroup: /system.slice/paperless-webserver.service
             ├─7519 "granian asginl :::8000 paperless.asgi:application"
             └─7521 "granian asginl :::8000 paperless.asgi:application worker-1"

</syntaxhighlight>

=== Zusätzliche Pakete installieren ===

==== stopwords & punkt_tab ====
<syntaxhighlight lang="bash">
cd ..
</syntaxhighlight>


'''Debian 11:'''
:<syntaxhighlight lang="bash">
sudo -Hu paperless python3 -m nltk.downloader stopwords
sudo -Hu paperless python3 -m nltk.downloader punkt_tab
</syntaxhighlight>
'''Debian 12:'''
:<syntaxhighlight lang="bash">
sudo -Hu paperless /opt/paperless/venv/bin/python3 -m nltk.downloader stopwords
sudo -Hu paperless /opt/paperless/venv/bin/python3 -m nltk.downloader punkt_tab
</syntaxhighlight>
<syntaxhighlight lang="bash">
sudo apt install tesseract-ocr-deu
</syntaxhighlight><syntaxhighlight lang="bash">
sudo -Hu paperless vi /opt/paperless/paperless.conf
</syntaxhighlight><syntaxhighlight lang="bash">
PAPERLESS_NLTK_DIR=/opt/paperless/nltk_data
</syntaxhighlight>

==== jbig2enc ====
<syntaxhighlight lang="bash">
sudo apt install autotools-dev automake libtool libleptonica-dev
</syntaxhighlight><syntaxhighlight lang="bash">
cd ~
</syntaxhighlight>'''Debian 11:'''
:<syntaxhighlight lang="bash">
wget https://ftp.gnu.org/gnu/autoconf/autoconf-2.71.tar.xz
tar -xf autoconf-2.71.tar.xz
cd autoconf-2.71/
./configure
make -j$(nproc)
sudo make install 
. ~/.profile
autoconf --version
</syntaxhighlight>
<syntaxhighlight lang="bash">
git clone https://github.com/agl/jbig2enc
cd jbig2enc
./autogen.sh
./configure && make -j$(nproc)
sudo make install
</syntaxhighlight>Für die Verarbeitung von Dokumenten in deutscher Sprache:<syntaxhighlight lang="bash">
sudo apt install tesseract-ocr-deu
</syntaxhighlight><syntaxhighlight lang="bash">
sudo -Hu paperless vi /opt/paperless/paperless.conf
</syntaxhighlight><syntaxhighlight lang="bash">
PAPERLESS_OCR_LANGUAGE=deu+eng
</syntaxhighlight>

==== Tika / Gotenberg installieren (Docker) ====
<syntaxhighlight lang="bash">
sudo install -m 0755 -d /etc/apt/keyrings
sudo curl -fsSL https://download.docker.com/linux/debian/gpg -o /etc/apt/keyrings/docker.asc
sudo chmod a+r /etc/apt/keyrings/docker.asc

echo \
  "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/debian \
  $(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \
  sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
</syntaxhighlight><syntaxhighlight lang="bash">
sudo apt update
sudo apt install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
</syntaxhighlight><syntaxhighlight lang="bash">
sudo docker pull apache/tika
sudo docker run -d --restart unless-stopped -p 127.0.0.1:9998:9998 apache/tika
</syntaxhighlight><syntaxhighlight lang="bash">
sudo docker pull gotenberg/gotenberg:8
sudo docker run -d --restart unless-stopped -p 127.0.0.1:3000:3000 gotenberg/gotenberg:8
</syntaxhighlight><syntaxhighlight lang="bash">
sudo -Hu paperless vi /opt/paperless/paperless.conf
</syntaxhighlight><syntaxhighlight lang="bash">
# Tika settings

PAPERLESS_TIKA_ENABLED=true
PAPERLESS_TIKA_ENDPOINT=http://localhost:9998
PAPERLESS_TIKA_GOTENBERG_ENDPOINT=http://localhost:3000
</syntaxhighlight>

== Quellen ==
*[https://wiki.crowncloud.net/?How_to_Install_Python_3_11_on_Debian_11 wiki.crowncloud.net]
*[https://askubuntu.com/questions/1076846/how-to-install-newer-version-of-ghostscript-on-server-than-provided-from-ubuntu askubuntu.com]
*[https://docs.paperless-ngx.com/setup/#bare_metal docs.paperless-ngx.com]
*[https://docs.docker.com/engine/install/debian/ docs.docker.com/]
*[https://gotenberg.dev/docs/getting-started/installation gotenberg.dev]
*[https://hub.docker.com/r/apache/tika hub.docker.com]
<references />