README.md

changeset 148
ff975e768112
parent 142
ad1d4a29ec75
--- a/README.md	Sun Dec 25 13:26:18 2022 +0200
+++ b/README.md	Mon Jun 02 08:38:59 2025 -0500
@@ -21,6 +21,8 @@
    remote `ssh` location, Borgend will also retry the backup at set shorter
    intervals.
 
+ * Can discover, e.g., home servers using SSDP/UPnP
+
 The lead author is Tuomo Valkonen (<tuomov@iki.fi>).
 
   [Borg Backup]: https://www.borgbackup.org/
@@ -37,6 +39,7 @@
 This will also install some additional Python libraries
 ([keyring](https://pypi.python.org/pypi/keyring),
 [pyyaml](http://pyyaml.org/),
+[ssdpy](https://pypi.org/project/ssdpy/),
 [rumps](https://github.com/jaredks/rumps), and, if not on MacOS,
 [xdg](https://pypi.python.org/pypi/xdg/3.0.0)).
 Now you can start borgend with
@@ -96,3 +99,18 @@
 then create a non-standalone application. While not easily transferrable
 between different machines, it will still help with keychain permissions.
 
+## SSDP
+
+Borgend can discover local servers using SDSP/UPnP. The server should have
+a corresponding annoucement service running. Relevant Python script and
+systemd setup files can be found under `announce/`. The `--uuid` parameter
+of the script should match the `ssdp_uuid` configuration setting of the
+repository, while `ssdp_path` should indicate the path within the server.
+The announce script can also communicate user ID on the server, as set with
+`--user`.
+
+For some additional security, `borgend` itself does not query the  service 
+with the `uuid`, but merely with the service type `borg`. It will only attempt
+to connect if a server with the correct UUID answers to its SSDP query.
+
+

mercurial