doc: add readme

This commit is contained in:
Jan Bader 2025-01-03 00:29:32 +01:00
parent 95c91b530f
commit 6e53b0cf51

23
README.md Normal file
View File

@ -0,0 +1,23 @@
# Docspell Consumedir Cleaner
Ein Tool zum Aufräumen des Docspell-Importverzeichnisses und zum automatischen Archivieren von bestätigten Dokumenten.
## Funktionsweise
Das Programm:
- Überprüft Dateien in konfigurierten Import-Verzeichnissen
- Prüft für jede Datei, ob sie bereits in Docspell existiert
- Wenn die Datei existiert und bestätigt ist:
- Verschiebt sie in ein Archiv-Verzeichnis
- Organisiert sie nach Datum und Ordnerstruktur
- Optional: Lädt noch nicht existierende Dateien automatisch nach Docspell hoch
## Voraussetzungen
- [Docspell Command Line Client (dsc)](https://docspell.org/docs/tools/cli/)
- `jq` Kommandozeilentool
- Eine Konfigurationsdatei unter `~/docspell-import.json`
## Konfiguration
Erstellen Sie eine `docspell-import.json` Datei in Ihrem Home-Verzeichnis: