comparison: README.md
README.md
- changeset 25
- efa4c61c6f01
- parent 23
- 86b42610d5a8
- child 26
- 814937cbe9db
equal
deleted
inserted
replaced
| 24:94d58d514d69 | 25:efa4c61c6f01 |
|---|---|
| 9 You will need to install the following non-standard Python packages: | 9 You will need to install the following non-standard Python packages: |
| 10 | 10 |
| 11 - [rumps](https://github.com/jaredks/rumps) (Ridiculously Uncomplicated macOS Python Statusbar apps) | 11 - [rumps](https://github.com/jaredks/rumps) (Ridiculously Uncomplicated macOS Python Statusbar apps) |
| 12 - [keyring](https://pypi.python.org/pypi/keyring) | 12 - [keyring](https://pypi.python.org/pypi/keyring) |
| 13 | 13 |
| 14 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 | 14 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 |
| 15 | 15 |
| 16 pip install py2app | 16 pip install py2app |
| 17 | 17 |
| 18 (for alternatives see [py2app documentation](https://py2app.readthedocs.io/en/latest/install.html#installing-with-pip)). Then, to build the standalone app, run | 18 (for alternatives see [py2app documentation](https://py2app.readthedocs.io/en/latest/install.html#installing-with-pip)). Then, to build the standalone app, run |
| 19 | 19 |
| 20 python3 setup.py py2app | 20 python3 setup.py py2app |
| 21 | 21 |
| 22 The apps hould be placed under `dist/`. | 22 The apps hould be placed under `dist/`. |
| 23 | 23 |
| 24 ## Usage | 24 ## Usage and configuration |
| 25 | |
| 26 ### Configuration file | |
| 27 | |
| 28 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. | |
| 29 Edit the sample configuration it and copy it to `~/.config/borgend/config.yaml`. | |
| 25 | 30 |
| 26 ### Passphrases | 31 ### Passphrases |
| 27 | 32 |
| 28 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: | 33 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: |
| 29 | 34 |
| 30 security add-generic-password -a my-borg-backup -s borg-backup -w [PASSWORD] | 35 security add-generic-password -a my-borg-backup -s borg-backup -w [PASSWORD] |
| 31 | 36 |
| 32 | 37 |
| 33 ## License | 38 ## License |
