https://github.com/himbeerserverde/hbak

Simple distributed backup utility for btrfs.
https://github.com/himbeerserverde/hbak

Last synced: 21 days ago
JSON representation

Simple distributed backup utility for btrfs.

• Host: GitHub
• URL: https://github.com/himbeerserverde/hbak
• Owner: HimbeerserverDE
• License: agpl-3.0
• Created: 2023-12-17T09:36:37.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-08-17T21:49:33.000Z (5 months ago)
• Last Synced: 2024-10-27T16:24:23.368Z (2 months ago)
• Language: Rust
• Size: 485 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
hbak

====

Distributed backup utility for btrfs.

This project aims to automate decentralised and end-to-end encrypted

backups of all of my machines and to provide a simple command-line interface

for administration and recovery.

Install

=======

Artix Linux

-----------

```

makepkg -si

makepkg -si -p PKGBUILD.openrc

```

Alpine

------

Cross-compile the binaries:

```

cargo build --release --all --target -unknown-linux-musl

```

Then copy the following files to the correct locations on the host:

```

install -Dm 755 hbak /usr/bin/hbak

install -Dm 755 hbakd /usr/bin/hbakd

install -Dm 755 hbakd.initd /etc/init.d/hbakd

```

Architecture

============

This program is designed primarily for use in an internal home network.

There will be support for both push and pull models in order to enable usage

across unidirectional firewalls, making it possible to use this tool

on multiple VLANs or even the public internet.

All backups will be encrypted before leaving the host they originated from.

The nodes will also transmit encrypted metadata to handle multi-host setups,

timestamps and storage locations.

Nodes will mutually authenticate using an HMAC-derived symmetric key

that the authenticator already knows and that can be computed by the

client if it's sent a stored random value from the authenticator

and knows the password.

The backups themselves will be btrfs snapshots with some being fully exported

and others being incremental with respect to the latest full backup at the time

of their creation.

The `/etc/fstab` file should be handled in some way, though the final solution

doesn't exist yet. It could be updated automatically or manually using a

command-line flag or subcommand, or be left to the user with a warning message.

Components

----------

There are two main components:

* hbak: Snapshotting and recovery tool handling encryption and file distribution.

* hbakd: Background process responsible for handling push and pull requests.

* hbak\_common: Main library for node authentication and communication.

Both binaries require root privileges. Automation is handled externally

by tools like cron or anacron.