comparison: README.md
README.md
- changeset 41
- e2641cb9ca6d
- parent 37
- 9fab8200f7eb
- child 43
- 8f3ac19f11b6
equal
deleted
inserted
replaced
| 40:cfbeeec8cb82 | 41:e2641cb9ca6d |
|---|---|
| 6 | 6 |
| 7 ## Installation | 7 ## Installation |
| 8 | 8 |
| 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 - [keyring](https://pypi.python.org/pypi/keyring) to extract passphrases from the keychain | |
| 12 | |
| 13 The use the tray icon on Mac OS, you will need: | |
| 14 | |
| 11 - [rumps](https://github.com/jaredks/rumps) (Ridiculously Uncomplicated macOS Python Statusbar apps) | 15 - [rumps](https://github.com/jaredks/rumps) (Ridiculously Uncomplicated macOS Python Statusbar apps) |
| 12 - [keyring](https://pypi.python.org/pypi/keyring) to extracdt passphrases from the keychain | |
| 13 | 16 |
| 14 If you want to try to run Borgend without the Tray icon on other systems, you will also want: | 17 If you are not on Mac OS, you will need: |
| 15 | 18 |
| 16 - [xdg](https://pypi.python.org/pypi/xdg/3.0.0) for configuration file location | 19 - [xdg](https://pypi.python.org/pypi/xdg/3.0.0) for configuration file location |
| 17 | 20 |
| 18 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 | 21 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 |
| 19 | 22 |
| 22 (for alternatives see [py2app documentation](https://py2app.readthedocs.io/en/latest/install.html)). Then, to build the standalone app, run | 25 (for alternatives see [py2app documentation](https://py2app.readthedocs.io/en/latest/install.html)). Then, to build the standalone app, run |
| 23 | 26 |
| 24 python3 setup.py py2app | 27 python3 setup.py py2app |
| 25 | 28 |
| 26 The apps hould be placed under `dist/`. | 29 The apps hould be placed under `dist/`. |
| 30 | |
| 27 | 31 |
| 28 ## Usage and configuration | 32 ## Usage and configuration |
| 29 | 33 |
| 30 ### Configuration file | 34 ### Configuration file |
| 31 | 35 |
| 36 | 40 |
| 37 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: | 41 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: |
| 38 | 42 |
| 39 security add-generic-password -a my-borg-backup -s borg-backup -w [PASSWORD] | 43 security add-generic-password -a my-borg-backup -s borg-backup -w [PASSWORD] |
| 40 | 44 |
| 45 ### Running on non-Mac OS systems | |
| 46 | |
| 47 You will need to start Borgend with the `--no-tray` option. | |
| 48 | |
| 41 | 49 |
| 42 ## License | 50 ## License |
| 43 | 51 |
| 44 This software is distributed under an ANTI-ABUSE LICENSE (aka. *fuck copyright and fuck distributions license*), and without any warranty whatsoever. If you redistribute this software as part of a larger collection/distribution/suite of software, you must do either of the following: | 52 This software is distributed under an ANTI-ABUSE LICENSE (aka. *fuck copyright and fuck distributions license*), and without any warranty whatsoever. If you redistribute this software as part of a larger collection/distribution/suite of software, you must do either of the following: |
| 45 | 53 |
