Thorsten/shell_ntfy_paperless
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

readme

Browse Source
This commit is contained in:
Thorsten
2024-12-21 16:16:03 +01:00
parent b63e7aa94e
commit c3187be784
1 changed files with 9 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@@ -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. Dieses Bash-Skript sendet eine Benachrichtigung über `NTFY`, wenn ein neues Dokument im Consume-Ordner von Paperless-ngx hinzugefügt wurde.
## Anforderungen ## 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`). 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-ngx Server
PAPERLESS_URL=http://192.168.178.25:8200 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 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.
2. Geben Sie den Speicherort des Skripts bei Paperless-ngx als Variable an. In der Docker Compose z.B.: Beispiel in der `docker-compose.yml`:
```bash ```bash
PAPERLESS_POST_CONSUME_SCRIPT: /usr/src/paperless/scripts/shell_ntfy_paperless.sh PAPERLESS_POST_CONSUME_SCRIPT: /usr/src/paperless/scripts/shell_ntfy_paperless.sh
``` ```