Files
shell_ntfy_paperless/README.md
2024-12-21 16:10:52 +01:00

32 lines
1.0 KiB
Markdown

# Paperless-ngx Notification Script
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
## Verwendung
### 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`).
```bash
# NTFY Server
NTFY_URL=https://ntfy.server.net/
AUTH_TOKEN=tk_elwqvm6niscdn30f45iksdfh6sope
#Paperless-ngx Server
PAPERLESS_URL=http://192.168.178.25:8200
```
### 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.:
```bash
PAPERLESS_POST_CONSUME_SCRIPT: /usr/src/paperless/scripts/shell_ntfy_paperless.sh
```