--- a/README.md Sun Jan 21 01:53:10 2018 +0000 +++ b/README.md Sun Jan 21 02:44:00 2018 +0000 @@ -11,7 +11,7 @@ - [rumps](https://github.com/jaredks/rumps) (Ridiculously Uncomplicated macOS Python Statusbar apps) - [keyring](https://pypi.python.org/pypi/keyring) -For passphrase use authentication to work correctly, it is useful to create create a standalone Mac app. This can be don with `py2app`. You can install it with +For passphrase use authentication to work correctly, it is useful to create a standalone Mac app. This can be don with `py2app`. You can install it with pip install py2app @@ -21,11 +21,16 @@ The apps hould be placed under `dist/`. -## Usage +## Usage and configuration + +### Configuration file + +See the included `config.example.yaml`, which shoud be relatively self-explanatory. Everything under `common_parameters`, `create_parameters`, and `prune_parameters` are simply Borg command line key–value parameters. +Edit the sample configuration it and copy it to `~/.config/borgend/config.yaml`. ### Passphrases -Passphrases are stored in the OS X Keychain (or whatever the keyring package support 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 ‘my-borg-backup’, you may use: +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 ‘my-borg-backup’, you may use: security add-generic-password -a my-borg-backup -s borg-backup -w [PASSWORD]