Borgend

Borgend screenshot

Borgend is a retrying and queuing scheduler as well as a macOS tray icon for Borg Backup. If you are not on macOS, no tray icon will be displayed, but you can still use Borgend as a scheduler.

The lead author is Tuomo Valkonen (tuomov@iki.fi).

Installation

Borgend naturally requires Borg Backup to be installed. Borgend is written in Python, and also requires a working python3 installation. Install both according to the instructions for your operating system. Borgend also requires some additional Python libraries. To install these, on macOS, run

pip3 install keyring pyyaml rumps

On other systems, run

pip3 install keyring pyyaml xdg

This will install the following Python packages:

With the dependencies satisfied, and Borgend downloaded, it may be run from its download location with

python3 borgend.py

Before this, you will probably, however, want to create a configuration file as detailed below.

Usage and configuration

Configuration file

See the included config.example.yaml, which shoud be relatively self-explanatory. The lists common_parameters, create_parameters, and prune_parameters are simply Borg command line key–value parameters, passed to it after expansion of environment variables.

Edit the sample configuration file and copy it to its proper location. On macOS this should be ~/Library/Application Support/borgend/config.yaml, and on other systems this will usually be ~/.config/borgend/config.yaml. You can find out the actual location by launching Borgend from the command line with the --help option.

Passphrases

Passphrases are stored in the OS X Keychain (or whatever the keyring package supports on other systems). In the Borgend configuration file, you only configure the ‘account’ of the of the password using keychain_account keyword of each backup set. The ‘service’ of the password has to be borg-backup. To add a password into the keychain for the myrepo ‘account’, you may use:

security add-generic-password -a myrepo -s borg-backup -w [PASSWORD]

To permanently authenticate Borgend to use the keychain, and therefore not have to enter the keychain password every time Borgend is launched, it is useful to encapculate it into a macOS app. This can be done with

To create an app that you can launch at startup and give permanent permissions to the keychain, use

python3 setup.py py2app -A

The app hould be placed under dist/. Copy it to your Applications directory, and set it up to launch on login.

If you are keen on wasting your life, you can try to run py2app without the -A option to create a standalone app that you can copy to computers without Python installed. This will, however, most likely not work because py2app is shit. Currently (2018-09-18) it is not working with the keyring package.

Downloads

borgend is available from its Mercurial repository. You may either use Mercurial to clone the entire repository or you may download a snapshot as a zip or tarball. To clone use the command

hg clone https://tuomov.iki.fi/repos/borgend/

Contributing

If you would like to contribute to this project, simply clone the repository and email me a hg bundle of your changes.