Custom Upgrade Server

Syncthing by default upgrades automatically from the official release packages on GitHub. If this is unsuitable, Syncthing can instead be configured to look for upgrades on a local or private upgrade server.

New in version 0.12.0.

Usage

The URL used to fetch release information can be set in Advanced Configuration, under the name releasesURL. The URL should point to a location serving a valid release list. The release list is a JSON file on the following format:

  1. [
  2.   {
  3.     "tag_name": "v0.11.24",
  4.     "prerelease": false,
  5.     "assets": [
  6.       {
  7.         "url": "https://example.com/dl/syncthing-dragonfly-amd64-v0.11.24.tar.gz",
  8.         "name": "syncthing-dragonfly-amd64-v0.11.24.tar.gz"
  9.       },
  10.       {
  11.         "url": "https://example.com/dl/syncthing-freebsd-386-v0.11.24.tar.gz",
  12.         "name": "syncthing-freebsd-386-v0.11.24.tar.gz"
  13.       },
  14.       {
  15.         "url": "https://example.com/dl/syncthing-freebsd-amd64-v0.11.24.tar.gz",
  16.         "name": "syncthing-freebsd-amd64-v0.11.24.tar.gz"
  17.       },
  18.       {
  19.         "url": "https://example.com/dl/syncthing-linux-386-v0.11.24.tar.gz",
  20.         "name": "syncthing-linux-386-v0.11.24.tar.gz"
  21.       }
  22.     ]
  23.   },
  24.   {
  25.     "tag_name": "v0.11.23",
  26.     "prerelease": false,
  27.     "assets": [
  28.       {
  29.         "url": "https://example.com/dl/syncthing-dragonfly-amd64-v0.11.23.tar.gz",
  30.         "name": "syncthing-dragonfly-amd64-v0.11.23.tar.gz"
  31.       },
  32.       {
  33.         "url": "https://example.com/dl/syncthing-freebsd-386-v0.11.23.tar.gz",
  34.         "name": "syncthing-freebsd-386-v0.11.23.tar.gz"
  35.       },
  36.       {
  37.         "url": "https://example.com/dl/syncthing-freebsd-amd64-v0.11.23.tar.gz",
  38.         "name": "syncthing-freebsd-amd64-v0.11.23.tar.gz"
  39.       },
  40.       {
  41.         "url": "https://example.com/dl/syncthing-linux-386-v0.11.23.tar.gz",
  42.         "name": "syncthing-linux-386-v0.11.23.tar.gz"
  43.       }
  44.     ]
  45.   }
  46. ]

The file may include additional attributes; these are ignored. Syncthing looks for a version number in tag_name, then for an asset name matching syncthing-$os-$arch-$version.$ext. Only beta releases (i.e. releases with version numbers of the form v0.11.24-beta...) will consider an upgrade to a release marked as "prerelease": true. The actual assets must be official releases downloaded from GitHub, or they must be custom compiled and signed according to the process outlined in Release Signing.