refactor: finish moving ssh-* scripts to own installers

[webi-installers/.git] / syncthing / README.md

diff --git a/syncthing/README.md b/syncthing/README.md
index d7787842658c70b7e7b73c27b1465c6c16fc47a9..54a0b0db388240d8f170ce9e2580a6e3074b4194 100644 (file)
--- a/syncthing/README.md
+++ b/syncthing/README.md
@@ -5,7 +5,7 @@ tagline: |
   Syncthing is a continuous file synchronization program. It synchronizes files between two or more computers.
 ---
 
-To update or switch versions, run `webi keypairs@stable` (or use `@beta` for
+To update or switch versions, run `webi syncthing@stable` (or use `@beta` for
 pre-releases).
 
 ## Cheat Sheet
@@ -13,25 +13,46 @@ pre-releases).
 > Syncthing is like a self-hosted Dropbox or Google Drive. It keeps data safe,
 > secure, and accessible.
 
-Once installed you launch the setup like so:
+You can have multiple syncs and shares. The "Default Folder" is `~/Sync/` (ex:
+`/Users/me/Sync`).
+
+Files are updated about every 30 seconds.
+
+### How to run Syncthing
+
+You can test that syncthing was installed correctly by checking it's version:
 
 ```bash
-syncthing
+syncthing --version
 ```
 
-You can have multiple syncs and shares. The "Default Folder" is `~/Sync/` (ex:
-`/Users/me/Sync`).
+If that works, you'll want to set your system launcher to run it on login. You
+can install and use [serviceman](/serviceman) to do this:
 
-Files are updated about every 30 seconds.
+```bash
+webi serviceman
+```
+
+```bash
+mkdir -p ~/.config/syncthing/
+env PATH="$PATH" serviceman add --user --name syncthing -- \
+  syncthing --home ~/.config/syncthing/
+```
+
+Serviceman is cross-platform and will create the correct _launchd_, _systemd_,
+or Windows Startup config file.
+
+If successful your browser will open to <http://127.0.0.1:8384/#settings-gui>
+automatically.
 
-### Basic Setup
+### Basic Setup & Sharing
 
 You need to install syncthing on TWO OR MORE devices for it to be effective.
 
 Go to <http://127.0.0.1:8384/#settings-gui> and make these changes:
 
-- Actions > Settings > General > Minimum Free Disk Space > 15%
 - Actions > Settings > GUI > Uncheck "Start Browser"
+- Actions > Settings > General > Minimum Free Disk Space > 15%
 - Default Folder > Edit > File Versioning > Staggared File Versioning
 - Actions > Show ID > (copy to clipboard)
 - Remote Devices > Add Remote Device > (paste ID from other computer)
@@ -39,26 +60,15 @@ Go to <http://127.0.0.1:8384/#settings-gui> and make these changes:
   - Set the remote computer name
   - Then go to "Sharing" and select "Default Folder"
   - Save
-  - NOTE: You will need to accept the device share on the first computer, and
-    then the folder on the second (alternatively you can set Auto-Accept on
-    both)
-
-You may also want to password protect the local GUI.
-
-### How to run on Login
-
-You can use [serviceman](/serviceman) to run syncthing as a user-level service:
-
-```bash
-webi serviceman
-```
+  - NOTE: For every device add and folder share action you will get a popup
+    notification in the web admin, possibly alternating between both computers.
+    You will need to accept those for the sync to begin (oralternatively you can
+    set Auto-Accept on both).
 
-```bash
-env PATH="$PATH" serviceman add --user --name syncthing -- syncthing
-```
+You may also want to password protect the local GUI. It only runs on localhost
+by default, so this may not be strictly necessary.
 
-Serviceman is cross-platform and will create the correct _launchd_, _systemd_,
-or Windows Startup config file.
+- Actions > Settings > GUI > (set username and password)
 
 ### Do you need to Port Forward?
 
@@ -68,3 +78,12 @@ Syncthing will try to use UPnP. Check your router config and make sure UPnP is
 enabled.
 
 Otherwise, yes, forward both UDP and TCP ports 22000.
+
+### How to run Syncthing manually
+
+It can be useful for debugging and testing configuration to run syncthing from
+your Terminal. Just run `syncthing` pointing to the config directory:
+
+```bash
+syncthing --home ~/.config/syncthing/
+```