Paperless ngx installieren

In dieser Anleitung wurde Paperless auf einem Proxmox-Server installiert. Ich empfehle ausdrücklich die Installation als VM statt als LXC (Linux Container). Die Verwendung von Docker in einem LXC-Container kann zu Problemen führen, die bei einer VM-Installation nicht auftreten.

Paperless Systemvoraussetzungen

Ressourcen	Paperless
CPU	4 Kerne
RAM	8192 MB
Festplatte	50GB

Die Basis: Debian 12 oder Ubuntu 24.04, Docker, Docker Compose und Portainer

Zuerst müssen wir Docker, Docker Compose und Portainer installieren. Dies lässt sich ganz einfach mit den folgenden vier Schritten erledigen.

Schritt 1: Linux aktualisieren und Curl installieren

apt update && apt upgrade -y && apt install curl -y

Schritt 2: Docker installieren

curl -fsSL https://get.docker.com -o get-docker.sh && sh get-docker.sh

Schritt 3: Docker-Compose installieren

Überprüfe vor der Eingabe des Befehls, ob eine aktuellere Version von Docker Compose verfügbar ist, und passe dann die Versionsnummer v2.29.0 im Befehl entsprechend an. Den neuesten Release findest du auf GitHub: Docker Compose Releases.

curl -SL https://github.com/docker/compose/releases/download/v2.29.0/docker-compose-linux-x86_64 -o /usr/local/bin/docker-compose && chmod +x /usr/local/bin/docker-compose && ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose

Schritt 4: Portainer installieren

docker run -d -p 18510:8000 -p 19510:9000 --name portainer --restart unless-stopped -v /var/run/docker.sock:/var/run/docker.sock -v /opt/portainer:/data portainer/portainer-ce:latest

Portainer öffnen und einrichten

http://DeineIP:19510

Anschließend einen Stack anlegen

Folgende .yml einbinden und anpassen

In der .yml Datei müssen einige Parameter angepasst werden:

• PAPERLESS_SECRET_KEY: deinSecretkey
• PAPERLESS_ADMIN_USER: AdminUser
• PAPERLESS_ADMIN_PASSWORD: deinPassword

version: "3.4"
services:
  broker:
    image: docker.io/library/redis:7
    restart: unless-stopped
    volumes:
      - redisdata:/data
  db:
    image: docker.io/library/postgres:13
    restart: unless-stopped
    volumes:
      - pgdata:/var/lib/postgresql/data
    environment:
      POSTGRES_DB: paperless
      POSTGRES_USER: paperless
      POSTGRES_PASSWORD: paperless
  webserver:
    image: ghcr.io/paperless-ngx/paperless-ngx:latest
    restart: unless-stopped
    depends_on:
      - db
      - broker
    ports:
      - 8010: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
    environment:
      PAPERLESS_REDIS: redis://broker:6379
      PAPERLESS_DBHOST: db
      PAPERLESS_SECRET_KEY: <DeinSecretkey>
      PAPERLESS_ADMIN_USER: <DeinAdminUser>
      PAPERLESS_ADMIN_PASSWORD: <DeinAdminPassword>
      PAPERLESS_OCR_LANGUAGE: deu
      USERMAP_UID: 1000
      USERMAP_GID: 100
volumes:
  data:
  media:
  pgdata:
  redisdata:

Anschließend den Stack starten

Samba installieren und einrichten

Wir werden dem Linux Benutzer den Zugriff mit einem separaten SMB Passwort ermöglichen.

sudo apt update && sudo apt upgrade -y && sudo apt install samba -y

cd /etc/samba

Jetzt sichern wir die Standard smb.conf, indem wir sie umbenennen, und erstellen anschließend eine neue, leere smb.conf.

mv smb.conf smb.bak

nano smb.conf

Dort binden wir jetzt folgendes ein.

[global]
#workgroup: Der Arbeitsgruppenname, zu dem der Samba-Server gehört.
    workgroup = WORKGROUP
#server string: Eine Beschreibung des Servers.
    server string = Samba Server
#netbios name: Der Name des Samba-Servers im Netzwerk.
    netbios name = paperless
#security: Die Authentifizierungsmethode, hier "user", was bedeutet, dass Benutzer sich anmelden müssen.
    security = user
#map to guest: Gästezugangseinstellung, hier "bad user", was bedeutet, dass unbekannte Benutzer als Gast b>
    map to guest = bad user
#dns proxy: Legt fest, ob DNS-Abfragen weitergeleitet werden sollen.
    dns proxy = no

[Data]
#path: Der Pfad zu dem freigegebenen Ordner auf dem Server.
    path = /data
#browsable: Legt fest, ob der Ordner durchsucht werden kann.
    browsable = yes
#writable: Legt fest, ob in den Ordner geschrieben werden kann.
    writable = yes
#valid users: Eine Liste der Benutzer, die auf diesen Ordner zugreifen dürfen.
    valid users = linuxer
#guest ok: Legt fest, ob Gäste zugreifen dürfen.
    guest ok = no
#read only: Legt fest, ob der Ordner schreibgeschützt ist.
    read only = no
#create mask und directory mask: Berechtigungen für neu erstellte Dateien und Verzeichnisse.
    create mask = 0775
    directory mask = 0775

Damit alle Änderungen übernommen werden, starten wir den SMB-Service neu.

sudo systemctl restart smbd

sudo smbpasswd -a DeinLinuxBenutzername

sudo chown -R DeinLinuxBenutzername:DeinLinuxBenutzername /data && sudo chmod -R 775 /data

Im Explorer rechtsklick und auf „Eine benutzerdefinierte Netzwerkadresse auswählen“ klicken.

Folgende Internet- oder Netzwerkadresse eingeben: \\paperless\data\compose\1\consume und auf weiter klicken.

Benenne deinen Ordner ganz nach belieben bei mir heißt er PAPERLESS (Data)

Klicke auf „Fertig stellen“ 🙂

Der Paperless (Data) Ordner wird dir jetzt angezeigt!

Paperless öffnen und einrichten

http://DeineIP:8010