A
Alle Themen

Offertly Sync Agent

Der Sync Agent verbindet Offertly mit Paperless-ngx.

Überblick

Der Offertly Sync Agent ist ein leichtgewichtiger Docker-Container, der die Verbindung zwischen Offertly und Paperless-ngx herstellt. Er läuft neben deiner Paperless-Instanz und synchronisiert Dokumente in beide Richtungen.

Installation

Füge den Sync Agent zu deiner bestehenden docker-compose.yml hinzu:

offertly-sync-agent:
  image: offertly/sync-agent
  environment:
    OFFERTLY_URL: "https://deine-instanz.offertly.de"
    OFFERTLY_SYNC_KEY: "dein-sync-key"
    PAPERLESS_URL: "http://paperless:8000"
    PAPERLESS_TOKEN: "dein-paperless-token"
    PAPERLESS_SYNC_TAG: "Rechnungen"
    SYNC_INTERVAL_SECONDS: "300"
  restart: unless-stopped

Starte den Container mit docker compose up -d offertly-sync-agent.

Konfiguration

Der Sync Agent wird über Umgebungsvariablen konfiguriert:

  • OFFERTLY_URL — Die URL deiner Offertly-Instanz
  • OFFERTLY_SYNC_KEY — Der Sync-Key aus Offertly (siehe Sync-Key generieren)
  • PAPERLESS_URL — Die URL deiner Paperless-ngx-Instanz
  • PAPERLESS_TOKEN — Ein API-Token aus Paperless (unter Admin → API-Tokens)
  • PAPERLESS_SYNC_TAG — Der Tag, nach dem gefiltert wird (Standard: „Rechnungen")
  • SYNC_INTERVAL_SECONDS — Intervall zwischen Sync-Durchläufen in Sekunden (Standard: 300)

Tag-Filter einrichten

Der Sync Agent synchronisiert nur Dokumente, die in Paperless mit dem konfigurierten Tag versehen sind. Standardmäßig ist das Rechnungen.

  1. Erstelle den Tag in Paperless (z.B. „Rechnungen").
  2. Setze PAPERLESS_SYNC_TAG auf exakt denselben Namen.
  3. Weise in Paperless den gewünschten Dokumenten diesen Tag zu.

Dokumente ohne den Tag werden vom Sync Agent ignoriert.

Status prüfen

Den Status des Sync Agents siehst du unter Einstellungen → Integrationen → Paperless.

  • Heartbeat: Zeigt an, wann der Sync Agent sich zuletzt gemeldet hat
  • Letzter Sync: Zeitpunkt der letzten erfolgreichen Synchronisation
  • Ist der Heartbeat älter als 10 Minuten, läuft der Sync Agent möglicherweise nicht mehr

Logs lesen

Prüfe die Logs des Sync Agents mit:

docker logs offertly-sync-agent
docker logs offertly-sync-agent --tail 50 -f

Häufige Fehlermeldungen:

  • 401 Unauthorized: Sync-Key oder Paperless-Token ungültig
  • Connection refused: URL nicht erreichbar — Netzwerk oder Firewall prüfen
  • Tag not found: Der konfigurierte Tag existiert nicht in Paperless