summaryrefslogtreecommitdiffstats
path: root/network/syncthing/README
diff options
context:
space:
mode:
Diffstat (limited to 'network/syncthing/README')
-rw-r--r--network/syncthing/README25
1 files changed, 18 insertions, 7 deletions
diff --git a/network/syncthing/README b/network/syncthing/README
index b5d5498278..d5672c9ded 100644
--- a/network/syncthing/README
+++ b/network/syncthing/README
@@ -1,9 +1,20 @@
-Syncthing provides synchronization of a folder between a number of
-collaborating devices.
+Syncthing (two way file sync between devices)
-To start automatic at boot make /etc/rc.d/rc.syncthing executable:
-chmod +x /etc/rc.d/rc.syncthing
-and add it to /etc/rc.d/rc.local
-syncthing will then be started as root
+Syncthing is a free, open-source peer-to-peer, two-way file
+syncronisation application available for Windows, Mac, Linux, iOS,
+Android, Solaris, Darwin and BSD. It can sync files between devices
+on a local network, or between remote devices over the Internet.
-Use your browser to configure syncthing: http://127.0.0.1:8080/
+Before you can build Syncthing, you have to create a syncthing
+user and group:
+
+# groupadd -g 307 syncthing
+# useradd -d /var/lib/syncthing -g syncthing -s /bin/bash -u 307 syncthing
+
+This package includes a rc.syncthing startup script, suitable for
+running Syncthing as a system daemon - such as on a server.
+
+The default location for the Syncthing config *and* sync repository
+if run using the enclosed rc.syncthing is under /var/lib/syncthing,
+but Syncthing is normally configured through its own web interface.
+See project page for further details.