syncthing/README.md

   1 ---
   2 title: Syncthing
   3 homepage: https://syncthing.net/
   4 tagline: |
   5   Syncthing is a continuous file synchronization program. It synchronizes files between two or more computers.
   6 ---
   7
   8 To update or switch versions, run `webi keypairs@stable` (or use `@beta` for
   9 pre-releases).
  10
  11 ## Cheat Sheet
  12
  13 > Syncthing is like a self-hosted Dropbox or Google Drive. It keeps data safe,
  14 > secure, and accessible.
  15
  16 Once installed you launch the setup like so:
  17
  18 ```bash
  19 syncthing
  20 ```
  21
  22 You can have multiple syncs and shares. The "Default Folder" is `~/Sync/` (ex:
  23 `/Users/me/Sync`).
  24
  25 Files are updated about every 30 seconds.
  26
  27 ### Basic Setup
  28
  29 You need to install syncthing on TWO OR MORE devices for it to be effective.
  30
  31 Go to <http://127.0.0.1:8384/#settings-gui> and make these changes:
  32
  33 - Actions > Settings > General > Minimum Free Disk Space > 15%
  34 - Actions > Settings > GUI > Uncheck "Start Browser"
  35 - Default Folder > Edit > File Versioning > Staggared File Versioning
  36 - Actions > Show ID > (copy to clipboard)
  37 - Remote Devices > Add Remote Device > (paste ID from other computer)
  38   - (if you're on the same network you may be able to click to add)
  39   - Set the remote computer name
  40   - Then go to "Sharing" and select "Default Folder"
  41   - Save
  42   - NOTE: You will need to accept the device share on the first computer, and
  43     then the folder on the second (alternatively you can set Auto-Accept on
  44     both)
  45
  46 You may also want to password protect the local GUI.
  47
  48 ### How to run on Login
  49
  50 You can use [serviceman](/serviceman) to run syncthing as a user-level service:
  51
  52 ```bash
  53 webi serviceman
  54 ```
  55
  56 ```bash
  57 env PATH="$PATH" serviceman add --user --name syncthing -- syncthing
  58 ```
  59
  60 Serviceman is cross-platform and will create the correct _launchd_, _systemd_,
  61 or Windows Startup config file.
  62
  63 ### Do you need to Port Forward?
  64
  65 Maybe.
  66
  67 Syncthing will try to use UPnP. Check your router config and make sure UPnP is
  68 enabled.
  69
  70 Otherwise, yes, forward both UDP and TCP ports 22000.