gerald77/borgbackup-repo-manager-api repository overview

⁠borgbackup-repo-manager-api

Schnittstelle zu BorgBackup⁠ für die Webseite gerald77/borgbackup-repo-manager⁠. Reines Node ohne npm-Abhängigkeiten plus borg 1.4 aus Debian trixie, kein veröffentlichter Port.

⁠Was sie tut

• Liest die Repos unterhalb von /repos: jeder Unterordner mit einer Datei config und dem Abschnitt [repository] ist ein Repo. Archive und Größen kommen aus borg list --json und borg info --json; die Übersicht liegt im Speicher und wird beim Start, auf Wunsch und optional nach Zeitplan neu eingelesen.
• Aktionen (nur mit AKTIONEN_ERLAUBT=1): Archive löschen (erst Probelauf mit --dry-run), Compact, Prune (erst Vorschau), Check und Sperre aufheben. Lange Aktionen laufen als Job im Hintergrund, pro Repo höchstens einer.
• Ein ganzes Repo löschen gibt es nicht: weder einen Endpunkt noch einen borg-Aufruf ohne ::archiv.
• Jeder borg-Aufruf wartet mit --lock-wait 10 auf die Sperre; ist das Repo länger gesperrt (läuft gerade ein Backup), meldet die Schnittstelle „gesperrt“ (HTTP 409).
• borg wird mit Benutzer und Gruppe des Repo-Ordners gestartet, damit neue Dateien im Repo nicht root gehören (Backups anderer Rechner schreiben ins selbe Repo).

⁠ACHTUNG: verändert die echten Repos

Mit AKTIONEN_ERLAUBT=1 löscht und komprimiert die Schnittstelle Archive in den eingehängten Repos. Gelöschte Archive lassen sich nicht wiederherstellen. Erst an einem Test-Repo ausprobieren.

⁠Schnellstart

Zusammen mit der Webseite am einfachsten über Docker Compose (siehe Quellcode-Repository). Einzeln:

docker run -d --name borgbackup-repo-manager-api \
  --read-only --tmpfs /tmp \
  --cap-drop ALL --cap-add SETUID --cap-add SETGID --cap-add DAC_OVERRIDE \
  --security-opt no-new-privileges:true \
  -e AKTIONEN_ERLAUBT=0 \
  -v /pfad/zu/den/repos:/repos \
  -v borg-home:/borg-home \
  gerald77/borgbackup-repo-manager-api:latest

Die Webseite erreicht die Schnittstelle unter dem Containernamen borgbackup-repo-manager-api auf Port 3011; beide Container müssen im selben Docker-Netz liegen. Der Ordner mit den Repos muss beschreibbar eingehängt sein, weil borg auch beim Lesen die Sperre im Repo anlegt.

⁠Schnittstelle

⁠Einstellungen

⁠Sicherheit

• Die Schnittstelle selbst prüft keine Anmeldung. Sie darf nie direkt veröffentlicht werden; der Port gehört nur ins interne Docker-Netz. Die Anmeldung (Basic-Auth für alles außer GET) übernimmt der nginx der Webseite.
• Schreibende Anfragen verlangen Content-Type: application/json und, falls ein Origin mitkommt, die eigene Adresse oder einen Eintrag aus ERLAUBTE_ORIGINS.
• Als <repo> sind nur erkannte Repo-Namen zulässig, nie ein Pfad aus der Anfrage; Archivnamen müssen im Repo vorkommen. borg wird ohne Shell gestartet.
• Der Container läuft als root mit den Rechten SETUID, SETGID und DAC_OVERRIDE (borg als Besitzer des Repo-Ordners starten, Ordner mit Rechten 700 lesen), sonst ohne Zusatzrechte.
• BORG_DELETE_I_KNOW_WHAT_I_AM_DOING wird nicht gesetzt; das Löschen ganzer Repos scheitert damit auch auf borg-Ebene.

⁠Lizenz und Haftungsausschluss

MIT-Lizenz (maßgeblich ist der englische Originaltext):

MIT License

Copyright (c) 2026 Gerald Brunner

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Haftungsausschluss: Die Software wird „wie besehen" ohne jegliche Gewährleistung bereitgestellt. Die Nutzung erfolgt auf eigene Gefahr; die Autoren haften nicht für Schäden oder Datenverlust, die aus der Nutzung entstehen. Das gilt besonders für die Schnittstelle borgbackup-repo-manager-api, die Archive in den eingehängten borg-Repos löscht und komprimiert.