olberger / borg_ynh

An experimental Borg implementation for YunoHost

Borg Backup for YunoHost

Read this README in other languages.

This package allows you to install Borg Backup quickly and simply on a YunoHost server.
If you don't have YunoHost, please consult the guide to learn how to install it.

Overview

A Borg integration to backup your YunoHost server to another remote server (e.g. one of your friends).

This app is the "client" part, meant to be installed on the server to be backed up. It works in combination with the borg server app installed on a diffent machine.

Features

• Backup on a remote machine, in comination with the borg server app
• ... or on a commercial borg service
• Backups are encrypted (the remote server can't read the content) and deduplicated (optimize space)
• Backups are ran automatically, you can choose when and at which frequency
• You can choose what apps are backuped
• Receive email alerts if the backup fails (the borg server app also checks that new content arrives and send an email to your friend otherwise)

Install procedure

Maybe counter-intuitively, you should first install this app (borg_ynh) and then (borgserver_ynh) on the other machine. In fact, at the end of the install of borg_ynh, you will be provided with the info, in particular the SSH public key, to be used to setup borgserver_ynh on the other machine.

Shipped version: 1.2.8~ynh1

Documentation and resources

• Official app website: https://borgbackup.readthedocs.io
• YunoHost Store: https://apps.yunohost.org/app/borg
• Report a bug: https://github.com/YunoHost-Apps/borg_ynh/issues

Developer info

Please send your pull request to the testing branch.

To try the testing branch, please proceed like that:

sudo yunohost app install https://github.com/YunoHost-Apps/borg_ynh/tree/testing --debug
or
sudo yunohost app upgrade borg -u https://github.com/YunoHost-Apps/borg_ynh/tree/testing --debug

More info regarding app packaging: https://yunohost.org/packaging_apps