comparison: README.md
README.md
- changeset 148
- ff975e768112
- parent 142
- ad1d4a29ec75
equal
deleted
inserted
replaced
| 147:c42d69c44170 | 148:ff975e768112 |
|---|---|
| 19 | 19 |
| 20 * If there was an error, such as when you are offline and backup to a | 20 * If there was an error, such as when you are offline and backup to a |
| 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 * Can discover, e.g., home servers using SSDP/UPnP | |
| 25 | |
| 24 The lead author is Tuomo Valkonen (<tuomov@iki.fi>). | 26 The lead author is Tuomo Valkonen (<tuomov@iki.fi>). |
| 25 | 27 |
| 26 [Borg Backup]: https://www.borgbackup.org/ | 28 [Borg Backup]: https://www.borgbackup.org/ |
| 27 | 29 |
| 28 ## Installation | 30 ## Installation |
| 35 pip3 install . | 37 pip3 install . |
| 36 | 38 |
| 37 This will also install some additional Python libraries | 39 This will also install some additional Python libraries |
| 38 ([keyring](https://pypi.python.org/pypi/keyring), | 40 ([keyring](https://pypi.python.org/pypi/keyring), |
| 39 [pyyaml](http://pyyaml.org/), | 41 [pyyaml](http://pyyaml.org/), |
| 42 [ssdpy](https://pypi.org/project/ssdpy/), | |
| 40 [rumps](https://github.com/jaredks/rumps), and, if not on MacOS, | 43 [rumps](https://github.com/jaredks/rumps), and, if not on MacOS, |
| 41 [xdg](https://pypi.python.org/pypi/xdg/3.0.0)). | 44 [xdg](https://pypi.python.org/pypi/xdg/3.0.0)). |
| 42 Now you can start borgend with | 45 Now you can start borgend with |
| 43 | 46 |
| 44 borgend | 47 borgend |
| 94 the above command may not create a working standalone application. If this is | 97 the above command may not create a working standalone application. If this is |
| 95 the case, you may attempt to add the `-A` option to the command. It will | 98 the case, you may attempt to add the `-A` option to the command. It will |
| 96 then create a non-standalone application. While not easily transferrable | 99 then create a non-standalone application. While not easily transferrable |
| 97 between different machines, it will still help with keychain permissions. | 100 between different machines, it will still help with keychain permissions. |
| 98 | 101 |
| 102 ## SSDP | |
| 103 | |
| 104 Borgend can discover local servers using SDSP/UPnP. The server should have | |
| 105 a corresponding annoucement service running. Relevant Python script and | |
| 106 systemd setup files can be found under `announce/`. The `--uuid` parameter | |
| 107 of the script should match the `ssdp_uuid` configuration setting of the | |
| 108 repository, while `ssdp_path` should indicate the path within the server. | |
| 109 The announce script can also communicate user ID on the server, as set with | |
| 110 `--user`. | |
| 111 | |
| 112 For some additional security, `borgend` itself does not query the service | |
| 113 with the `uuid`, but merely with the service type `borg`. It will only attempt | |
| 114 to connect if a server with the correct UUID answers to its SSDP query. | |
| 115 | |
| 116 |
