comparison: README.md
README.md
- changeset 20
- fdfbe5d7b677
- parent 13
- 1813654427d7
- child 22
- c3e95212e3f0
equal
deleted
inserted
replaced
| 19:f9ce2442f14f | 20:fdfbe5d7b677 |
|---|---|
| 1 # Borgend | |
| 2 | |
| 1 This is a retrying and queuing scheduler as well as a MacOS tray icon for [BorgBackup](https://borgbackup.readthedocs.io/en/stable/). | 3 This is a retrying and queuing scheduler as well as a MacOS tray icon for [BorgBackup](https://borgbackup.readthedocs.io/en/stable/). |
| 2 | 4 |
| 3 The lead author is Tuomo Valkonen (<tuomov@iki.fi>). | 5 The lead author is Tuomo Valkonen (<tuomov@iki.fi>). |
| 4 | 6 |
| 5 # LICENSE | 7 ## Installation |
| 8 | |
| 9 You will need to install the following non-standard Python packages: | |
| 10 | |
| 11 - [rumps](https://github.com/jaredks/rumps) (Ridiculously Uncomplicated macOS Python Statusbar apps) | |
| 12 - [keyring](https://pypi.python.org/pypi/keyring) | |
| 13 | |
| 14 ## Usage | |
| 15 | |
| 16 ### Passphrases | |
| 17 | |
| 18 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: | |
| 19 | |
| 20 security add-generic-password -a my-borg-backup -s borg-backup -w [PASSWORD] | |
| 21 | |
| 22 | |
| 23 ## License | |
| 6 | 24 |
| 7 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: | 25 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: |
| 8 | 26 |
| 9 (a) Always redistribute the **unmodified** and **latest** version provided | 27 (a) Always redistribute the **unmodified** and **latest** version provided |
| 10 by the lead author. If the lead author releases a new version (on a specific branch, such as 'stable' or 'development'), you must promptly make that new | 28 by the lead author. If the lead author releases a new version (on a specific branch, such as 'stable' or 'development'), you must promptly make that new |
| 11 version the default version offered to your users (on that specific branch). | 29 version the default version offered to your users (on that specific branch). |
| 12 | 30 |
| 13 (b) Rename the software, and make it obvious that your modified or obsolete software is in no way connected to the lead author of the original software. The users of your version should under no circumstances be under the illusion that they can contact the lead author or any of the authors of the original software if they have any complaints or queries. | 31 (b) Rename the software, and make it obvious that your modified or obsolete software is in no way connected to the lead author of the original software. The users of your version should under no circumstances be under the illusion that they can contact the lead author or any of the authors of the original software if they have any complaints or queries. |
| 14 | 32 |
| 15 Otherwise, do whatever you want with this software. | 33 Otherwise, do whatever you want with this software. |
| 34 |
