mirror of
https://github.com/webinstall/webi-installers.git
synced 2026-05-06 08:46:35 +00:00
update README
This commit is contained in:
@@ -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,41 +13,21 @@ 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:
|
||||
|
||||
```bash
|
||||
syncthing
|
||||
```
|
||||
|
||||
You can have multiple syncs and shares. The "Default Folder" is `~/Sync/` (ex:
|
||||
`/Users/me/Sync`).
|
||||
|
||||
Files are updated about every 30 seconds.
|
||||
|
||||
### Basic Setup
|
||||
### How to run Syncthing
|
||||
|
||||
You need to install syncthing on TWO OR MORE devices for it to be effective.
|
||||
You can test that syncthing was installed correctly by checking it's version:
|
||||
|
||||
Go to <http://127.0.0.1:8384/#settings-gui> and make these changes:
|
||||
```bash
|
||||
syncthing --version
|
||||
```
|
||||
|
||||
- Actions > Settings > General > Minimum Free Disk Space > 15%
|
||||
- Actions > Settings > GUI > Uncheck "Start Browser"
|
||||
- Default Folder > Edit > File Versioning > Staggared File Versioning
|
||||
- Actions > Show ID > (copy to clipboard)
|
||||
- Remote Devices > Add Remote Device > (paste ID from other computer)
|
||||
- (if you're on the same network you may be able to click to add)
|
||||
- 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:
|
||||
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:
|
||||
|
||||
```bash
|
||||
webi serviceman
|
||||
@@ -60,6 +40,32 @@ 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: 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 > 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)
|
||||
- (if you're on the same network you may be able to click to add)
|
||||
- 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. It only runs on localhost
|
||||
by default, so this may not be strictly necessary.
|
||||
|
||||
- Actions > Settings > GUI > (set username and password)
|
||||
|
||||
### Do you need to Port Forward?
|
||||
|
||||
Maybe.
|
||||
@@ -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.
|
||||
|
||||
### 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
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user