# bluegit-backup Een losse backup server voor één [BlueGit](https://git.timfalken.com/timfa/bluegit)-instantie. - Koppelt met een **Backupserver-Key** die een BlueGit-beheerder in BlueGit maakt (*Beheer → Backup*). - Haalt alle data en configuratie van BlueGit binnen: database, sleutels, SSH-hostkeys, logo's, avatars, repositories, releases en artifacts. Dat gaat **gedoseerd** (`rate_limit_kib`), zodat BlueGit er geen last van heeft. - BlueGit **meldt elke wijziging**. De backup server haalt dan alleen op wat veranderd is. Daarnaast loopt hij elk `full_sync_interval` alles na. - Elk `archive_interval` (standaard dagelijks) gaat de hele kopie gecomprimeerd in een archief (`tar.gz`). - Archieven ouder dan `retention_days` gaan weg. Is de schijf vol (minder dan `min_free_mb` vrij), dan gaat het oudste archief weg. Het nieuwste archief blijft altijd staan. - In BlueGit ziet de beheerder de archieven en kan hij een **rollback** starten, met een grote waarschuwing dat die niet terug te draaien is. De backup server pakt het archief uit, vervangt zijn kopie en stuurt alles naar BlueGit. BlueGit zet de data terug en herstart. - Eén backup server hoort bij één BlueGit. Koppel je een andere instantie, dan kies je: **oude backups wissen** of **de nieuwe instantie herstellen** met de backupdata. Het protocol staat in [docs/PROTOCOL.md](docs/PROTOCOL.md). De aannames staan in [docs/ASSUMPTIONS.md](docs/ASSUMPTIONS.md). ## Installeren ### Arch Linux (AUR) ```sh yay -S bluegit-backup ``` Het pakket zet de binary in `/usr/bin/bluegit-backup`, de config in `/etc/bluegit-backup/config.yml`, de data in `/var/lib/bluegit-backup` en een systemd-unit `bluegit-backup.service` (gebruiker `bluegit-backup`). ### Binary Bij een release staan `bluegit-backup-linux-amd64`, `bluegit-backup-linux-arm64` en `SHA256SUMS`. Zelf bouwen: ```sh go build -o bluegit-backup ./cmd/bluegit-backup ./bluegit-backup example-config > config.yml ./bluegit-backup serve --config config.yml ``` ## Koppelen 1. Zet in `config.yml` `public_url` op het adres waarop BlueGit deze server bereikt. 2. Start de server: `systemctl enable --now bluegit-backup`. 3. Maak in BlueGit onder *Beheer → Backup* een Backupserver-Key. Die wordt één keer getoond. 4. Koppel: ```sh BLUEGIT_BACKUP_KEY=bgbk_… bluegit-backup connect --url https://git.example.com ``` Had deze server al backups van een andere BlueGit, dan vraagt `connect`: ``` 1) oude backups wissen en opnieuw beginnen 2) de nieuwe BlueGit herstellen met de laatste backupdata ``` Zonder terminal kies je met `--on-conflict wipe` of `--on-conflict restore`. Daarna haalt de server meteen een volledige kopie op en maakt hij een eerste archief. ## Bedienen ```sh bluegit-backup status # koppeling, laatste sync, laatste archief bluegit-backup list # archieven bluegit-backup sync # nu synchroniseren bluegit-backup archive # nu een archief maken bluegit-backup prune # bewaarregels nu toepassen ``` Deze commando's praten met de draaiende server via `data_dir/admin.token` en moeten dus draaien als een gebruiker die dat bestand kan lezen (`sudo -u bluegit-backup …`). Een rollback start je in BlueGit, niet hier. ## Configuratie | Sleutel | Standaard | Betekenis | |---|---|---| | `listen` | `0.0.0.0:8790` | Adres van de HTTP-server | | `public_url` | (leeg) | Adres waarop BlueGit deze server bereikt | | `data_dir` | `/var/lib/bluegit-backup` | Kopie, archieven en koppeling | | `archive_interval` | `24h` | Hoe vaak een archief | | `retention_days` | `30` | Archieven ouder dan dit weg (0 = nooit) | | `min_free_mb` | `1024` | Minder vrij: oudste archief weg | | `rate_limit_kib` | `1024` | Downloadsnelheid in KiB/s (0 = onbeperkt) | | `full_sync_interval` | `1h` | Ook zonder melding alles nalopen | | `min_sync_interval` | `10s` | Minimale tijd tussen syncs na meldingen | In `data_dir`: - `mirror/` is de lopende kopie. - `archives/` bevat `bluegit-YYYYMMDD-HHMMSS.tar.gz` (UTC). - `state.json` (0600) is de koppeling met de key. - `admin.token` (0600) is voor de CLI. ## Releases Dezelfde opties als BlueGit: een AUR-pakket (`bluegit-backup`), een self-update van een geïnstalleerde server vanuit de pipeline en binaries bij een tag. Zie `blue-ci-cd.yml`. - Elke release-job hangt af van de job `integration`. Die bouwt een echte BlueGit (`scripts/build-bluegit.sh`, ref in `.bluegit-ref`), start hem, configureert hem en test daarmee elke feature. Faalt er één test, dan is er geen release. - Releases vanaf master staan pas aan zodra het bestand `.release-enabled` in de repository staat. De geheimen staan in de kop van `blue-ci-cd.yml`. - Een release bij een tag (`v*`) publiceert de binaries bij een bestaande tag. Self-update: zet `BLUEGIT_BACKUP_UPDATE_TOKEN` in `/etc/bluegit-backup/env` op de server. Zet in de pipeline hetzelfde token plus `BLUEGIT_BACKUP_UPDATE_URL`. De server bouwt dan `bluegit-backup` op het commit van master via `bluegit-backup-update.service`. ## Tests ```sh go test ./... # unit-tests ./scripts/build-bluegit.sh # bouwt .bluegit-bin/bluegit BLUEGIT_BIN=$PWD/.bluegit-bin/bluegit go test -tags integration -v ./integration/ ``` De integratietests starten per test een echte BlueGit in een tijdelijke map (dev-login, geen SSH, geen CI-runner). Ze maken een beheerderstoken en daarmee repositories, issues en een Backupserver-Key. Daarna testen ze tegen die BlueGit: | Test | Feature | |---|---| | `TestKeyGenerationAndConnect` | Key maken in BlueGit, koppelen, verkeerde key geweigerd | | `TestFullSyncCopiesAllData` | Alle data en configuratie komt binnen, en de kopie klopt | | `TestNotificationTriggersSync` | Een wijziging in BlueGit geeft een melding en daarna een sync | | `TestDownloadIsThrottled` | Downloaden blijft onder `rate_limit_kib` | | `TestArchiveIntervalAndListInBlueGit` | Archief per interval, lijst zichtbaar in BlueGit | | `TestRetentionAndDiskFull` | Weggooien op leeftijd en bij volle schijf | | `TestRollbackFromBlueGit` | Rollback vanuit BlueGit (met bevestiging), BlueGit staat daarna terug | | `TestNewInstanceWipe` | Nieuwe instantie, keuze wissen | | `TestNewInstanceRestore` | Nieuwe instantie, keuze herstellen | | `TestCLIConnectAsksOnConflict` | `connect` vraagt de keuze | De BlueGit-kant (key, meldingen, beheerpagina, rollback) zit in BlueGit op `feature/backup-server`. Zolang die niet gemerged is, bouwt de pipeline BlueGit van die branch (`.bluegit-ref`). Zet `.bluegit-ref` op `master` zodra hij gemerged is. ## Licentie Zie [LICENSE](LICENSE).