Syncthing

https://docs.syncthing.net/
Admin
Syncthing is an open-source, continuous file synchronization application that synchronizes files...
Tokens:144,711
Snippets:1,236
Trust Score:9.8
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Install and configure Syncthing as a Windows service with NSSM

Source: https://docs.syncthing.net/users/autostart.html

Commands to install and configure Syncthing as a Windows service using NSSM. Run from an administrator Command Prompt after downloading NSSM. The arguments for the Application tab must be entered exactly as shown; logging is configured later and --logfile is not applied here. After installing, set AppExit actions to handle exits, restarts, and upgrades, then start the service with sc start syncthing.

```bash
nssm.exe install <syncthing service name>
```

```text
--no-restart --no-browser --home="<path to your Syncthing folder>"
```

```bash
nssm set syncthing AppExit Default Exit
```

```bash
nssm set syncthing AppExit 0 Exit
```

```bash
nssm set syncthing AppExit 3 Restart
```

```bash
nssm set syncthing AppExit 4 Restart
```

```bash
sc start syncthing
```

--------------------------------

### Start Syncthing from the command line

Source: https://docs.syncthing.net/intro/getting-started.html

Run the syncthing binary to start it. On first start, it generates configuration and encryption keys, then launches the admin GUI. The output shows log messages, the device ID, and the GUI URL.

```text
> syncthing
[monitor] 22:56:32 INFO: Log output saved to file "C:\Users\User\AppData\Local\Syncthing\syncthing.log"
[monitor] 22:56:32 INFO: Default folder created and/or linked to new config
[start] 22:56:32 INFO: syncthing v1.7.1 "Fermium Flea" (go1.14.4 windows-386) teamcity@build.syncthing.net 2020-07-11 18:17:41 UTC
[start] 22:56:32 INFO: Default folder created and/or linked to new config
[start] 22:56:32 INFO: Default config saved. Edit C:\Users\User\AppData\Local\Syncthing\config.xml to taste (with Syncthing stopped) or use the GUI
[6FOKX] 22:56:33 INFO: My ID: 6FOKXKK-SKUBWFW-GSKX6IQ-ZC4SYUZ-5IEVZKE-TC42AAX-HW7IBW4-GAZFAQ7
[6FOKX] 22:56:34 INFO: Single thread SHA256 performance is 123 MB/s using crypto/sha256 (108 MB/s using minio/sha256-simd).
[6FOKX] 22:56:34 INFO: Hashing performance is 106.31 MB/s
[6FOKX] 22:56:34 INFO: Overall send rate is unlimited, receive rate is unlimited
[6FOKX] 22:56:34 INFO: Using discovery server https://discovery.syncthing.net/v2/?noannounce&id=LYXKCHX-VI3NYZR-ALCJBHF-WMZYSPK-QG6QJA3-MPFYMSO-U56GTUK-NA2MIAW
[6FOKX] 22:56:34 INFO: Using discovery server https://discovery-v4.syncthing.net/v2/?nolookup&id=LYXKCHX-VI3NYZR-ALCJBHF-WMZYSPK-QG6QJA3-MPFYMSO-U56GTUK-NA2MIAW
[6FOKX] 22:56:34 INFO: Using discovery server https://discovery-v6.syncthing.net/v2/?nolookup&id=LYXKCHX-VI3NYZR-ALCJBHF-WMZYSPK-QG6QJA3-MPFYMSO-U56GTUK-NA2MIAW
[6FOKX] 22:56:34 INFO: Ready to synchronize "Default Folder" (default) (sendreceive)
[6FOKX] 22:56:34 INFO: QUIC listener ([::]:22000) starting
[6FOKX] 22:56:34 INFO: TCP listener ([::]:22000) starting
[6FOKX] 22:56:34 INFO: Relay listener (dynamic+https://relays.syncthing.net/endpoint) starting
[6FOKX] 22:56:34 INFO: Completed initial scan of sendreceive folder "Default Folder" (default)
[6FOKX] 22:56:34 INFO: GUI and API listening on 127.0.0.1:8384
[6FOKX] 22:56:34 INFO: Access the GUI via the following URL: http://127.0.0.1:8384/
[6FOKX] 22:56:34 INFO: My name is "This computer"
[6FOKX] 22:56:45 INFO: quic://0.0.0.0:22000 detected NAT type: Symmetric NAT
[6FOKX] 22:56:45 INFO: quic://0.0.0.0:22000 resolved external address quic://125.190.151.7:59296 (via stun.syncthing.net:3478)
[6FOKX] 22:56:46 INFO: Detected 0 NAT services
```

--------------------------------

### Install Syncthing with Homebrew

Source: https://docs.syncthing.net/users/autostart.html

Install Syncthing on macOS using Homebrew. After installation, follow the information presented by brew to autostart Syncthing using launchctl.

```bash
brew install syncthing
```

--------------------------------

### Install stsigtool with go install

Source: https://docs.syncthing.net/dev/release-signing.html

Install the stsigtool command-line utility using Go's package manager. Requires Go to be installed on the system.

```bash
$ go install github.com/syncthing/syncthing/cmd/stsigtool

```

--------------------------------

### Directory layout starting at synced folder root

Source: https://docs.syncthing.net/users/ignoring.html

Shows the initial directory tree used as input for the ignore pattern example. Files and directories listed here are evaluated against the .stignore patterns.

```text
.DS_Store
.stignore
foo
foofoo
bar/
    baz
    quux
    quuz
bar2/
    baz
    frobble
My Pictures/
    Img15.PNG

```

--------------------------------

### build.go install subcommand

Source: https://docs.syncthing.net/dev/building.html

Installs binaries in ./bin. This is the default command when build.go is run without any commands or parameters.

```bash
go run build.go install
```

--------------------------------

### Start Syncthing with Supervisord

Source: https://docs.syncthing.net/users/autostart.html

Start the Syncthing service managed by Supervisord.

```bash
supervisorctl start syncthing
```

--------------------------------

### Configure the GUI element with address, apikey, and theme

Source: https://docs.syncthing.net/users/config.html

Example of a minimal GUI configuration element. The `gui` element is mandatory and must appear exactly once. It controls the GUI, REST API, and Event API. The `enabled` attribute must be `true` for the GUI and API to start; `tls` set to `true` enforces HTTPS and redirects non-HTTPS requests.

```xml
<gui enabled="true" tls="false">
    <address>127.0.0.1:8384</address>
    <apikey>k1dnz1Dd0rzTBjjFFh7CXPnrF12C49B1</apikey>
    <theme>default</theme>
</gui>
```

--------------------------------

### GET /rest/system/connections response example

Source: https://docs.syncthing.net/rest/system-connections-get.html

Example response from the GET /rest/system/connections endpoint. Shows the connections object keyed by device ID with fields such as address, connected, inBytesTotal, outBytesTotal, and type, plus a total object with aggregate byte counts. The connection type can be tcp-client, tcp-server, relay-client, relay-server, quic-client, or quic-server.

```json
{
  "connections": {
    "DOVII4U-SQEEESM-VZ2CVTC-CJM4YN5-QNV7DCU-5U3ASRL-YVFG6TH-W5DV5AA": {
      "address": "",
      "at": "0001-01-01T00:00:00Z",
      "clientVersion": "",
      "connected": false,
      "inBytesTotal": 0,
      "isLocal": false,
          "outBytesTotal": 0,
      "paused": false,
      "startedAt": "0001-01-01T00:00:00Z",
      "type": ""
    },
    "UYGDMA4-TPHOFO5-2VQYDCC-7CWX7XW-INZINQT-LE4B42N-4JUZTSM-IWCSXA4": {
      "address": "",
      "at": "0001-01-01T00:00:00Z",
      "clientVersion": "",
      "connected": false,
      "inBytesTotal": 0,
      "isLocal": false,
      "outBytesTotal": 0,
      "paused": false,
      "startedAt": "0001-01-01T00:00:00Z",
      "type": ""
    },
    "YZJBJFX-RDBL7WY-6ZGKJ2D-4MJB4E7-ZATSDUY-LD6Y3L3-MLFUYWE-AEMXJAC": {
      "address": "127.0.0.1:22002",
      "at": "2015-11-07T17:29:47.691548971+01:00",
      "clientVersion": "v0.12.1",
      "connected": true,
      "inBytesTotal": 556,
      "isLocal": true,
      "outBytesTotal": 550,
      "paused": false,
      "startedAt": "2015-11-07T00:09:47Z",
      "type": "tcp-client"
    }
  },
  "total": {
    "at": "2015-11-07T17:29:47.691637262+01:00",
    "inBytesTotal": 1479,
    "outBytesTotal": 1318
  }
}
```

--------------------------------

### Build Syncthing on Windows: clone and compile

Source: https://docs.syncthing.net/dev/building.html

Commands to set up a development directory, clone the Syncthing repository, and build the binary. Run these in a cmd window after installing prerequisites. The result is a syncthing.exe binary in %USERPROFILE%\dev\syncthing\bin.

```batch
# Pick a place for your Syncthing source.
> md "%USERPROFILE%\dev"
> cd /d "%USERPROFILE%\dev"

# Grab the code.
> git clone https://github.com/syncthing/syncthing.git

# Now we have the source. Time to build!
> cd syncthing
> go run build.go

```

--------------------------------

### GET /rest/db/ignores response example

Source: https://docs.syncthing.net/rest/db-ignores-get.html

Example response from the GET /rest/db/ignores endpoint. The 'ignore' field contains the raw .stignore content, while 'expanded' lists the globbing patterns (using gobwas/glob) that match the patterns in .stignore and all includes, with modifiers like '!' for negation, '(?i)' for case-insensitive matching, and '(?d)' for removing ignored files in empty directories.

```json
{
  "ignore": [
    "(?i)/Backups"
  ],
  "expanded": [
    "(?i)Backups",
    "(?i)Backups/**"
  ]
}

```

--------------------------------

### build.go options example: linux-386 tar

Source: https://docs.syncthing.net/dev/building.html

Builds a tar.gz distribution of Syncthing for linux-386 using the --goos and --goarch options.

```bash
go run build.go --goos linux --goarch 386 tar
```

--------------------------------

### GET /rest/db/file: Platform Specific Data Example

Source: https://docs.syncthing.net/rest/db-file-get.html

Example of platform-specific data entry for macOS (darwin) with an extended attribute, and unix with ownership information (gid, groupName, ownerName, uid). Other platforms set to null. This structure appears in the file entry's 'platform' field.

```json
{
  "darwin": {
    "xattrs": [
      {
        "name": "net.kastelo.xattrtest",
        "value": "aGVsbG8="
      }
    ]
  },
  "freebsd": null,
  "linux": null,
  "netbsd": null,
  "unix": {
    "gid": 20,
    "groupName": "staff",
    "ownerName": "jb",
    "uid": 501
  },
  "windows": null
}
```

--------------------------------

### Start stdiscosrv with certificate and key

Source: https://docs.syncthing.net/users/stdiscosrv.html

Start the discovery server with a certificate and key. The server prints its device ID at startup, which is needed for client configuration when using a non-CA-signed certificate.

```bash
$ stdiscosrv --cert=/path/to/cert.pem --key=/path/to/key.pem
Server device ID is 7DDRT7J-UICR4PM-PBIZYL3-MZOJ7X7-EX56JP6-IK6HHMW-S7EK32W-G3EUPQA

```

--------------------------------

### GET /rest/db/file: File Entry Example

Source: https://docs.syncthing.net/rest/db-file-get.html

A file entry object as included in the 'local' and 'global' fields of the response. Contains metadata such as permissions, modification time, size, type, version vector, and platform-specific data placeholder. Shows a directory entry example with type FILE_INFO_TYPE_DIRECTORY.

```json
{
  "deleted": false,
  "ignored": false,
  "inodeChange": "1970-01-01T01:00:00+01:00",
  "invalid": false,
  "localFlags": 0,
  "modified": "2022-09-28T08:07:19.979723+02:00",
  "modifiedBy": "523ITIE",
  "mustRescan": false,
  "name": "img",
  "noPermissions": false,
  "numBlocks": 0,
  "permissions": "0755",
  "platform": { /* platform specific data */ },
  "sequence": 914,
  "size": 128,
  "type": "FILE_INFO_TYPE_DIRECTORY",
  "version": [
    "523ITIE:1664345275"
  ]
}
```

--------------------------------

### GET /rest/svc/deviceid: curl examples

Source: https://docs.syncthing.net/rest/svc-deviceid-get.html

Two curl invocations of the device ID endpoint. The first passes an invalid ID and returns an error; the second passes a valid ID and returns the formatted device ID.

```bash
$ curl -s http://localhost:8384/rest/svc/deviceid?id=1234 | json
{
  "error": "device ID invalid: incorrect length"
}

```

```bash
$ curl -s http://localhost:8384/rest/svc/deviceid?id=p56ioi7m--zjnu2iq-gdr-eydm-2mgtmgl3bxnpq6w5btbbz4tjxzwicq | json
{
  "id": "P56IOI7-MZJNU2Y-IQGDREY-DM2MGTI-MGL3BXN-PQ6W5BM-TBBZ4TJ-XZWICQ2"
}

```

--------------------------------

### POST /rest/folder/versions curl example

Source: https://docs.syncthing.net/rest/folder-versions-post.html

Restores archived versions for files 'dir1/dir2/bar' and 'baz' in the 'default' folder. The timestamps must match valid versionTime entries from the GET /rest/folder/versions response. The response is an object with error messages keyed by file path.

```bash
curl -X POST -H X-API-key:... http://127.0.0.1:8384/rest/folder/versions?folder=default -d '{
  "dir1/dir2/bar": "2022-02-06T20:44:12+01:00",
  "baz": "2022-02-06T20:44:20+01:00"
}'

```

--------------------------------

### Set up strelaysrv user and start relay

Source: https://docs.syncthing.net/users/strelaysrv.html

Creates a dedicated user and directory for the relay server, then starts strelaysrv with the -keys flag. Keys are generated on first startup. The relay joins the global relay pool unless -pools="" is given.

```bash
$ sudo useradd strelaysrv
$ sudo mkdir /etc/strelaysrv
$ sudo chown strelaysrv /etc/strelaysrv
$ sudo -u strelaysrv /usr/local/bin/strelaysrv -keys /etc/strelaysrv

```

--------------------------------

### build.go options example: windows zip with no-upgrade

Source: https://docs.syncthing.net/dev/building.html

Builds a zip distribution of Syncthing for Windows (current architecture) with upgrading disabled using the --goos and --no-upgrade options.

```bash
go run build.go --goos windows --no-upgrade zip
```

--------------------------------

### GET /rest/db/file: Example Request

Source: https://docs.syncthing.net/rest/db-file-get.html

Fetches file information using required folder ID and URL-encoded relative file path. Requires a valid API key and running Syncthing instance on localhost:8384. 'folder' is the folder ID from the Web GUI (e.g., '5camp-slpa8'); 'file' is the relative path from the folder root, correctly URL-encoded.

```bash
curl -s -H X-API-KEY:... "http://localhost:8384/rest/db/file?folder=YOUR_FOLDER_ID" --url-query "file=path/to/file.pdf"
```

--------------------------------

### Build Syncthing from source on Unix

Source: https://docs.syncthing.net/dev/building.html

Build Syncthing from source on Unix systems. Run these commands in a terminal after installing the prerequisites, including a C compiler and Git. The resulting binary will be placed in ~/dev/syncthing/bin.

```bash
# Pick a place for your Syncthing source.
$ mkdir -p ~/dev
$ cd ~/dev

# Grab the code.
$ git clone https://github.com/syncthing/syncthing.git

# Now we have the source. Time to build!
$ cd syncthing

# You should be inside ~/dev/syncthing right now.
$ go run build.go

```

--------------------------------

### GET /qr/ - Generate QR code from text

Source: https://docs.syncthing.net/dev/http-services.html

Fetches the /qr/ endpoint, which encodes the content given in the text URL parameter into a QR code and returns it as a black-and-white PNG image. The example pipes the output to the display command to view the image. Can be used to encode device IDs for quick exchange in a machine-readable optical format.

```bash
$ curl http://localhost:8384/qr/?text=Hello%2C%20world%21 | display

```

--------------------------------

### Set STGUIASSETS and run syncthing (Unix-like)

Source: https://docs.syncthing.net/dev/web.html

Set the STGUIASSETS environment variable to the source GUI directory and run syncthing. The GUI will be served directly from the source files, so changes can be seen by reloading the browser.

```bash
$ export STGUIASSETS=~/dev/syncthing/gui
$ syncthing

```

--------------------------------

### Enable and start Syncthing user service

Source: https://docs.syncthing.net/users/autostart.html

Enable and start the Syncthing user service. Run these commands after copying the syncthing.service file to ~/.config/systemd/user/. If your home directory is encrypted with eCryptfs on Debian/Ubuntu, apply the change described in Ubuntu bug 1734290 first, otherwise the service will not start.

```bash
systemctl --user enable syncthing.service
systemctl --user start syncthing.service

```

--------------------------------

### Install Syncthing on macOS/Linux via Webi

Source: https://docs.syncthing.net/users/contrib.html

Install Syncthing on macOS or Linux using the Webi installer. Requires curl and a bash shell.

```bash
$ curl -sS https://webinstall.dev/syncthing | bash
```

--------------------------------

### Install Syncthing on Windows via Webi

Source: https://docs.syncthing.net/users/contrib.html

Install Syncthing on Windows 10 (build 1803) or later using the Webi installer. Requires curl.exe and PowerShell.

```powershell
> curl.exe -A MS https://webinstall.dev/syncthing | powershell
```

--------------------------------

### Enable and start Syncthing systemd system service

Source: https://docs.syncthing.net/users/autostart.html

Enable and start Syncthing as a systemd system service. Replace 'myuser' with the actual Syncthing user after the @.

```bash
systemctl enable syncthing@myuser.service
systemctl start syncthing@myuser.service
```

--------------------------------

### Build with BUILD_USER and BUILD_HOST

Source: https://docs.syncthing.net/dev/building.html

Builds Syncthing with custom user and host metadata, then verifies the version string. The BUILD_USER and BUILD_HOST environment variables override the username and hostname embedded in the binary.

```shell
$ BUILD_USER=builder BUILD_HOST=buildhost.local go run build.go
$ ./bin/syncthing --version
syncthing v1.8.0 ... builder@buildhost.local 2020-07-30 11:49:14 UTC

```

--------------------------------

### GET /rest/svc/deviceid

Source: https://docs.syncthing.net/rest/svc-deviceid-get.html

Documentation for the GET /rest/svc/deviceid endpoint, which verifies and formats a device ID.

```APIDOC
## GET /rest/svc/deviceid

### Description
Verifies and formats a device ID. Accepts all currently valid formats (52 or 56 characters with or without separators, upper or lower case, with trivial substitutions). Takes one parameter, `id`, and returns either a valid device ID in modern format, or an error.

### Method
GET

### Endpoint
/rest/svc/deviceid

### Parameters
#### Query Parameters
- **id** (string) - Required - The device ID to verify and format.

### Request Example
```
$ curl -s http://localhost:8384/rest/svc/deviceid?id=1234 | json
```

### Response
#### Success Response (200)
- **id** (string) - The formatted device ID in modern format.

#### Response Example
```
{
  "id": "P56IOI7-MZJNU2Y-IQGDREY-DM2MGTI-MGL3BXN-PQ6W5BM-TBBZ4TJ-XZWICQ2"
}
```

#### Error Response
- **error** (string) - Description of the error.

#### Error Response Example
```
{
  "error": "device ID invalid: incorrect length"
}
```
```
Tokens:
Raw