update README
authorAJ ONeal <aj@therootcompany.com>
Mon, 14 Dec 2020 18:52:26 +0000 (18:52 +0000)
committerAJ ONeal <aj@therootcompany.com>
Mon, 14 Dec 2020 18:52:26 +0000 (18:52 +0000)
syncthing/README.md

index d7787842658c70b7e7b73c27b1465c6c16fc47a9..ca690e5b27686f9f0108c472bb408247355fdefe 100644 (file)
@@ -5,7 +5,7 @@ tagline: |
   Syncthing is a continuous file synchronization program. It synchronizes files between two or more computers.
 ---
 
   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
 pre-releases).
 
 ## Cheat Sheet
@@ -13,25 +13,43 @@ pre-releases).
 > Syncthing is like a self-hosted Dropbox or Google Drive. It keeps data safe,
 > secure, and accessible.
 
 > 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
 
 ```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
+env PATH="$PATH" serviceman add --user --name syncthing -- 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:
 
 
 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 > 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)
 - Default Folder > Edit > File Versioning > Staggared File Versioning
 - Actions > Show ID > (copy to clipboard)
 - Remote Devices > Add Remote Device > (paste ID from other computer)
@@ -43,22 +61,10 @@ Go to <http://127.0.0.1:8384/#settings-gui> and make these changes:
     then the folder on the second (alternatively you can set Auto-Accept on
     both)
 
     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
-```
-
-```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?
 
 
 ### Do you need to Port Forward?
 
@@ -68,3 +74,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.
 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` without any arguments.
+
+```bash
+syncthing
+```