comparison: README.md
README.md
- changeset 130
- 4c3b655a89c5
- parent 129
- 9f3ae6b3133f
- child 131
- d5351f9fe8b8
equal
deleted
inserted
replaced
| 129:9f3ae6b3133f | 130:4c3b655a89c5 |
|---|---|
| 1 # Borgend | 1 # Borgend |
| 2 | 2 |
| 3 <a href="media/borgend.png"><img src="media/borgend.jpg" style="max-width: 100%" alt="Borgend screenshot"></a> | 3 <a href="media/borgend.png"><img src="media/borgend.jpg" style="max-width: 100%" alt="Borgend screenshot"></a> |
| 4 | 4 |
| 5 Borgend is a retrying and queuing scheduler as well as a macOS tray icon for | 5 Borgend is a retrying and queuing scheduler as well as a macOS tray icon for |
| 6 [BorgBackup](https://borgbackup.readthedocs.io/en/stable/). If you are not | 6 [Borg Backup][]. If you are not |
| 7 on macOS, no tray icon will be displayed, but you can still use Borgend as a | 7 on macOS, no tray icon will be displayed, but you can still use Borgend as a |
| 8 scheduler. | 8 scheduler. |
| 9 | 9 |
| 10 * Designed with laptops in mind, Borgend works in “dreamtime”: on macOS the | 10 * Designed with laptops in mind, Borgend works in “dreamtime”: on macOS the |
| 11 scheduler discounts system sleep periods from the backup intervals. If | 11 scheduler discounts system sleep periods from the backup intervals. If |
| 21 remote `ssh` location, Borgend will also retry the backup at set shorter | 21 remote `ssh` location, Borgend will also retry the backup at set shorter |
| 22 intervals. | 22 intervals. |
| 23 | 23 |
| 24 The lead author is Tuomo Valkonen (<tuomov@iki.fi>). | 24 The lead author is Tuomo Valkonen (<tuomov@iki.fi>). |
| 25 | 25 |
| 26 [Borg Backup]: https://www.borgbackup.org/ | |
| 27 | |
| 26 ## Installation | 28 ## Installation |
| 27 | 29 |
| 28 Borgend is written in [Python](https://www.python.org/), and requires a working | 30 Borgend naturally requires [Borg Backup][] to be installed. Borgend is written |
| 29 python3 installation. Install it according to instructions for your operating | 31 in [Python](https://www.python.org/), and also requires a working python3 installation. |
| 30 system. Borgend also requires some additional Python libraries. To install these, | 32 Install both according to the instructions for your operating system. Borgend also |
| 31 on macOS, run | 33 requires some additional Python libraries. To install these, on macOS, run |
| 32 | 34 |
| 33 pip3 install keyring pyyaml rumps | 35 pip3 install keyring pyyaml rumps |
| 34 | 36 |
| 35 On other systems, run | 37 On other systems, run |
| 36 | 38 |
| 95 | 97 |
| 96 If you are keen on wasting your life, you can try to run py2app without the | 98 If you are keen on wasting your life, you can try to run py2app without the |
| 97 `-A` option to create a standalone app that you can copy to computers without | 99 `-A` option to create a standalone app that you can copy to computers without |
| 98 Python installed. This will, however, most likely not work because py2app | 100 Python installed. This will, however, most likely not work because py2app |
| 99 is shit. Currently (2018-09-18) it is not working with the keyring package. | 101 is shit. Currently (2018-09-18) it is not working with the keyring package. |
| 102 |
