Open Source Continuous File Synchronization.

Jakob Borg 1a6159f765 Verboser info on index updates %!s(int64=2) %!d(string=hai) anos
.github 5675644341 build: Upgrade to GitHub-native Dependabot (#7607) %!s(int64=3) %!d(string=hai) anos
assets 9cc49aea77 assets, gui: Losslessly compress all JPG, PNG, and PDF images (#6265) %!s(int64=4) %!d(string=hai) anos
cmd 1a6159f765 Verboser info on index updates %!s(int64=2) %!d(string=hai) anos
etc 33212716cf etc: Fix start-limit parameters location in systemd units (ref #7439) (#7529) %!s(int64=3) %!d(string=hai) anos
gui cb607e8551 gui: Add direct link to Ignore Patterns from folder panel (fixes #4293) (#7993) %!s(int64=2) %!d(string=hai) anos
lib 1a6159f765 Verboser info on index updates %!s(int64=2) %!d(string=hai) anos
man 36c044562c gui, man, authors: Update docs, translations, and contributors %!s(int64=2) %!d(string=hai) anos
meta 3d91f7c975 lib: Use counterfeiter to mock interfaces in tests (#7375) %!s(int64=3) %!d(string=hai) anos
next-gen-gui f09dcb98eb gui: Semicolons (#7597) %!s(int64=3) %!d(string=hai) anos
proto ac2988a485 gui, lib: Handle pw adding remote encrypted folder (fixes #7705) (#7772) %!s(int64=3) %!d(string=hai) anos
script 3e3954eb38 gui: Translate theme names in settings (#8006) %!s(int64=2) %!d(string=hai) anos
test d47745a86b all: Update build constraints to Go 1.17 style (#7894) %!s(int64=3) %!d(string=hai) anos
.codecov.yml 9e857ed2d4 build: Add test coverage info (#7502) %!s(int64=3) %!d(string=hai) anos
.deepsource.toml c5ec6cd7ef build: Fix deepsource test & exclude patterns (#7969) %!s(int64=3) %!d(string=hai) anos
.gitattributes 6809d38cde lib/protocol: Revert protobuf encoder changes in v0.14.17 (fixes #3855) %!s(int64=7) %!d(string=hai) anos
.gitignore adf3f641ce Ignore GoLand cruft %!s(int64=3) %!d(string=hai) anos
.golangci.yml fb5f1bb56a golangci: Skip godox %!s(int64=4) %!d(string=hai) anos
AUTHORS f760ef15b0 gui, man, authors: Update docs, translations, and contributors %!s(int64=2) %!d(string=hai) anos
CONDUCT.md 6df3940c26 conduct: Upgrade to Contributor Covenant %!s(int64=6) %!d(string=hai) anos
CONTRIBUTING.md 08f6a91441 contributing: Fix GitHub format (#7713) %!s(int64=3) %!d(string=hai) anos
Dockerfile e2120c4728 docker: Expose 22000/udp (#7421) %!s(int64=3) %!d(string=hai) anos
Dockerfile.builder 8c94ce8d14 build: Simplify gem command in Debian Docker image %!s(int64=3) %!d(string=hai) anos
Dockerfile.buildx e2120c4728 docker: Expose 22000/udp (#7421) %!s(int64=3) %!d(string=hai) anos
Dockerfile.stdiscosrv 92905d30e8 docker: Accept Go version as --build-arg %!s(int64=4) %!d(string=hai) anos
Dockerfile.strelaysrv 92905d30e8 docker: Accept Go version as --build-arg %!s(int64=4) %!d(string=hai) anos
GOALS.md 509ae5e2d9 goals: Typo %!s(int64=6) %!d(string=hai) anos
LICENSE f7fc0c1d3e all: Update license url to https (ref #3976) %!s(int64=7) %!d(string=hai) anos
README-Docker.md 086508f51a docker: Remove sysctl from README (#7670) %!s(int64=3) %!d(string=hai) anos
README.md 445c5f13c3 readme: Add a link to docs source (#7909) %!s(int64=3) %!d(string=hai) anos
build.go e557ba82e7 build: Fix error in Debian install scripts preventing restarts for stdiscosrv + strelaysrv (#8001) %!s(int64=3) %!d(string=hai) anos
build.ps1 04ff890263 build: Clean up build.sh, add build.ps1 (#6689) %!s(int64=4) %!d(string=hai) anos
build.sh 04ff890263 build: Clean up build.sh, add build.ps1 (#6689) %!s(int64=4) %!d(string=hai) anos
go.mod 73c5184518 build: Update all dependencies (#7968) %!s(int64=3) %!d(string=hai) anos
go.sum 73c5184518 build: Update all dependencies (#7968) %!s(int64=3) %!d(string=hai) anos
tools.go 3746c899b7 build: List go:generate tools in tools.go (#7599) %!s(int64=3) %!d(string=hai) anos

README-Docker.md

Docker Container for Syncthing

Use the Dockerfile in this repo, or pull the syncthing/syncthing image from Docker Hub.

Use the /var/syncthing volume to have the synchronized files available on the host. You can add more folders and map them as you prefer.

Note that Syncthing runs as UID 1000 and GID 1000 by default. These may be altered with the PUID and PGID environment variables. In addition the name of the Syncthing instance can be optionally defined by using --hostname=syncthing parameter.

Example Usage

Docker cli

$ docker pull syncthing/syncthing
$ docker run -p 8384:8384 -p 22000:22000/tcp -p 22000:22000/udp \
    -v /wherever/st-sync:/var/syncthing \
    --hostname=my-syncthing \
    syncthing/syncthing:latest

Docker compose

---
version: "3"
services:
  syncthing:
    image: syncthing/syncthing
    container_name: syncthing
    hostname: my-syncthing
    environment:
      - PUID=1000
      - PGID=1000
    volumes:
      - /wherever/st-sync:/var/syncthing
    ports:
      - 8384:8384
      - 22000:22000/tcp
      - 22000:22000/udp
    restart: unless-stopped

Discovery

Note that local device discovery will not work with the above command, resulting in poor local transfer rates if local device addresses are not manually configured.

To allow local discovery, the docker host network can be used instead:

$ docker pull syncthing/syncthing
$ docker run --network=host \
    -v /wherever/st-sync:/var/syncthing \
    syncthing/syncthing:latest

Be aware that syncthing alone is now in control of what interfaces and ports it listens on. You can edit the syncthing configuration to change the defaults if there are conflicts.

GUI Security

By default Syncthing inside the Docker image listens on 0.0.0.0:8384 to allow GUI connections via the Docker proxy. This is set by the STGUIADDRESS environment variable in the Dockerfile, as it differs from what Syncthing would otherwise use by default. This means you should set up authentication in the GUI, like for any other externally reachable Syncthing instance. If you do not require the GUI, or you use host networking, you can unset the STGUIADDRESS variable to have Syncthing fall back to listening on 127.0.0.1:

$ docker pull syncthing/syncthing
$ docker run -e STGUIADDRESS= \
    -v /wherever/st-sync:/var/syncthing \
    syncthing/syncthing:latest

With the environment variable unset Syncthing will follow what is set in the configuration file / GUI settings dialog.