No Description

André Colomb 1af87577e1 gui: Generate version-specific documentation link URLs (#8108) 3 years ago
.github 1242ac74ab github: Make docs commits as release bot 3 years ago
assets 9cc49aea77 assets, gui: Losslessly compress all JPG, PNG, and PDF images (#6265) 5 years ago
cmd 21d04b895a lib, gui: Default ignores for new folders (fixes #7428) (#7530) 3 years ago
etc 33212716cf etc: Fix start-limit parameters location in systemd units (ref #7439) (#7529) 4 years ago
gui 1af87577e1 gui: Generate version-specific documentation link URLs (#8108) 3 years ago
lib b6d1e16b4e lib/protocol: Switch to a newer lz4 package (#8122) 3 years ago
man 99f96c5cb7 gui, man, authors: Update docs, translations, and contributors 3 years ago
meta 7c3b267645 meta: Add test for deprecated package ioutil (#8053) 4 years ago
next-gen-gui f09dcb98eb gui: Semicolons (#7597) 4 years ago
proto 21d04b895a lib, gui: Default ignores for new folders (fixes #7428) (#7530) 3 years ago
script 4b750b6dc3 all: Remove usage of deprecated io/ioutil (#7971) 4 years ago
test 4b750b6dc3 all: Remove usage of deprecated io/ioutil (#7971) 4 years ago
.codecov.yml 9e857ed2d4 build: Add test coverage info (#7502) 4 years ago
.deepsource.toml c5ec6cd7ef build: Fix deepsource test & exclude patterns (#7969) 4 years ago
.gitattributes 6809d38cde lib/protocol: Revert protobuf encoder changes in v0.14.17 (fixes #3855) 8 years ago
.gitignore adf3f641ce Ignore GoLand cruft 4 years ago
.golangci.yml fb5f1bb56a golangci: Skip godox 5 years ago
AUTHORS f760ef15b0 gui, man, authors: Update docs, translations, and contributors 4 years ago
CONDUCT.md 6df3940c26 conduct: Upgrade to Contributor Covenant 7 years ago
CONTRIBUTING.md 08f6a91441 contributing: Fix GitHub format (#7713) 4 years ago
Dockerfile e2120c4728 docker: Expose 22000/udp (#7421) 4 years ago
Dockerfile.builder 8c94ce8d14 build: Simplify gem command in Debian Docker image 4 years ago
Dockerfile.buildx e2120c4728 docker: Expose 22000/udp (#7421) 4 years ago
Dockerfile.stdiscosrv 92905d30e8 docker: Accept Go version as --build-arg 5 years ago
Dockerfile.strelaysrv 92905d30e8 docker: Accept Go version as --build-arg 5 years ago
GOALS.md 509ae5e2d9 goals: Typo 8 years ago
LICENSE f7fc0c1d3e all: Update license url to https (ref #3976) 8 years ago
README-Docker.md 086508f51a docker: Remove sysctl from README (#7670) 4 years ago
README.md 445c5f13c3 readme: Add a link to docs source (#7909) 4 years ago
build.go 40bb52fdd8 build: Add an option to specify output dir for crosscompiling all (#8109) 3 years ago
build.ps1 04ff890263 build: Clean up build.sh, add build.ps1 (#6689) 5 years ago
build.sh 04ff890263 build: Clean up build.sh, add build.ps1 (#6689) 5 years ago
go.mod 4329ba316f build(deps): bump github.com/shirou/gopsutil/v3 from 3.21.8 to 3.21.12 (#8123) 3 years ago
go.sum 4329ba316f build(deps): bump github.com/shirou/gopsutil/v3 from 3.21.8 to 3.21.12 (#8123) 3 years ago
tools.go 3746c899b7 build: List go:generate tools in tools.go (#7599) 4 years ago

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.