From c3187be7841c6b39f25121f8676b9a3da79f66fa Mon Sep 17 00:00:00 2001 From: Thorsten Date: Sat, 21 Dec 2024 16:16:03 +0100 Subject: [PATCH] readme --- README.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 9e25c0e..8ddc05d 100644 --- a/README.md +++ b/README.md @@ -3,11 +3,12 @@ Dieses Bash-Skript sendet eine Benachrichtigung über `NTFY`, wenn ein neues Dokument im Consume-Ordner von Paperless-ngx hinzugefügt wurde. ## Anforderungen -- Ein ntfy-Server für das Senden von Benachrichtigungen +- Ein ntfy-Server für das Senden von Benachrichtigungen. +- Eine funktionierende Paperless-ngx-Instanz. -## Verwendung +## Vorbereitung -### Konfigurationsdatei erstellen +### 1. Konfigurationsdatei erstellen Platzieren Sie das Skript und eine .env-Datei im gleichen Verzeichnis. Die .env-Datei muss denselben Namen wie das Skript haben, jedoch mit der Endung `.env` (z. B. `sshell_ntfy_paperless.sh` und `shell_ntfy_paperless.env`). @@ -19,12 +20,13 @@ AUTH_TOKEN=tk_elwqvm6niscdn30f45iksdfh6sope #Paperless-ngx Server PAPERLESS_URL=http://192.168.178.25:8200 ``` +Passen Sie die Variablen an Ihre Gegebenheiten an. -### Konfiguration von Paperless-ngx +### 2. Konfiguration von Paperless-ngx -1. Speichern sie das Skript und die gleichnamige `.env` Datei innerhalb Ihres Paperless Ordners - -2. Geben Sie den Speicherort des Skripts bei Paperless-ngx als Variable an. In der Docker Compose z.B.: +1. Speichern Sie das Skript und die gleichnamige `.env`-Datei im Ordner Ihrer Paperless-ngx-Instanz. +2. Legen Sie den Pfad des Skripts in den Umgebungsvariablen von Paperless-ngx fest. +Beispiel in der `docker-compose.yml`: ```bash PAPERLESS_POST_CONSUME_SCRIPT: /usr/src/paperless/scripts/shell_ntfy_paperless.sh ```