comparison: README.md
README.md
- changeset 129
- 9f3ae6b3133f
- parent 128
- 3e9d88b2c14b
- child 130
- 4c3b655a89c5
equal
deleted
inserted
replaced
| 128:3e9d88b2c14b | 129:9f3ae6b3133f |
|---|---|
| 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 ## Installation | 26 ## Installation |
| 27 | 27 |
| 28 On macOS, first run | 28 Borgend is written in [Python](https://www.python.org/), and requires a working |
| 29 python3 installation. Install it according to instructions for your operating | |
| 30 system. Borgend also requires some additional Python libraries. To install these, | |
| 31 on macOS, run | |
| 29 | 32 |
| 30 pip3 install keyring pyyaml rumps | 33 pip3 install keyring pyyaml rumps |
| 31 | 34 |
| 32 On other systems, run | 35 On other systems, run |
| 33 | 36 |
| 41 - [rumps](https://github.com/jaredks/rumps) (Ridiculously Uncomplicated | 44 - [rumps](https://github.com/jaredks/rumps) (Ridiculously Uncomplicated |
| 42 macOS Python Statusbar apps) | 45 macOS Python Statusbar apps) |
| 43 - [xdg](https://pypi.python.org/pypi/xdg/3.0.0) for configuration file | 46 - [xdg](https://pypi.python.org/pypi/xdg/3.0.0) for configuration file |
| 44 location (not needed on macOS) | 47 location (not needed on macOS) |
| 45 | 48 |
| 46 With the dependencies satisfied, Borgend may be run with | 49 With the dependencies satisfied, and Borgend downloaded, it may be run from |
| 50 its download location with | |
| 47 | 51 |
| 48 python3 borgend.py | 52 python3 borgend.py |
| 49 | 53 |
| 50 To permanently authenticate Borgend to use the keychain, and therefore not | 54 Before this, you will probably, however, want to create a configuration file as detailed below. |
| 51 have to enter the keychain password every time Borgend is launched, it is | |
| 52 useful to create a standalone Mac app. This can be done with | |
| 53 | |
| 54 - [py2app](https://py2app.readthedocs.io/en/latest/install.html). | |
| 55 | |
| 56 To create an app that you can launch at startup and give permanent permissions | |
| 57 to the keychain, use | |
| 58 | |
| 59 python3 setup.py py2app -A | |
| 60 | |
| 61 The app hould be placed under `dist/`. Copy it to your `Applications` | |
| 62 directory, and set it up to launch on login. | |
| 63 | |
| 64 If you are keen on wasting your life, you can try to run py2app without the | |
| 65 `-A` option to create a standalone app that you can copy to computers without | |
| 66 Python installed, but it will probably most likely not work because py2app | |
| 67 is shit. Currently (2018-09-18) it is not working with the keyring package. | |
| 68 | |
| 69 | 55 |
| 70 ## Usage and configuration | 56 ## Usage and configuration |
| 71 | 57 |
| 72 ### Configuration file | 58 ### Configuration file |
| 73 | 59 |
| 91 `borg-backup`. To add a password into the keychain for the `myrepo` | 77 `borg-backup`. To add a password into the keychain for the `myrepo` |
| 92 ‘account’, you may use: | 78 ‘account’, you may use: |
| 93 | 79 |
| 94 security add-generic-password -a myrepo -s borg-backup -w [PASSWORD] | 80 security add-generic-password -a myrepo -s borg-backup -w [PASSWORD] |
| 95 | 81 |
| 82 To permanently authenticate Borgend to use the keychain, and therefore not | |
| 83 have to enter the keychain password every time Borgend is launched, it is | |
| 84 useful to encapculate it into a macOS app. This can be done with | |
| 85 | |
| 86 - [py2app](https://py2app.readthedocs.io/en/latest/install.html). | |
| 87 | |
| 88 To create an app that you can launch at startup and give permanent permissions | |
| 89 to the keychain, use | |
| 90 | |
| 91 python3 setup.py py2app -A | |
| 92 | |
| 93 The app hould be placed under `dist/`. Copy it to your `Applications` | |
| 94 directory, and set it up to launch on login. | |
| 95 | |
| 96 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 | |
| 98 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. |
