Skip to content
This repository has been archived by the owner on Oct 4, 2020. It is now read-only.

enkore/borgcube

Repository files navigation

BorgCube

Documentation Status

Project status: Dead. No patches will be accepted. I do not recommend forking this prototype's code base. Feel free to contact me if you are interested in doing something similar.

A backup system built on Borg.

Scope

  • Web console for management
  • Backups are pulled from clients
  • Scheduling, logging.
  • Lightweight, untrusted clients:
    • They can't manipulate the repository
    • They don't know where the repository is
    • They don't get encryption keys
    • They can't read backups (of other clients and also themselves)
    • They don't need to maintain a Borg cache
    • They don't have to encrypt (if any of the BLAKE2 key types are used)
  • Deduplication is still done on the clients, saving time and bandwidth. Inadvertedly this means that all clients know about the hash / MAC of all chunks in the underlying repository.
  • The server is responsible for encryption, cache maintenance and storage and logging/error reporting.
  • Clients don't need Borg installed; BorgCube can deploy an appropriate binary on the fly.
  • Multiple backups into the same repository at once

Inner workings

  • Web console written on top of Django
  • Data is mostly stored in SQL database (per-job logs in plain text files)
  • Live progress information is streamed via web sockets into the frontend
  • Background workers are used for tasks that may take longer (accessing repositories etc)
  • Workers are coordinated by borgcubed. Frontend and borgcubed talk via ZeroMQ (planned: UDS, automatic authentication).
  • SSH server on the BorgCube server and on all clients required.
  • BorgCube doesn't include SSH key management: just deploy the keys as usual.

Releases

No releases published

Packages

No packages published