nventiveux/syncthing repository overview

⁠Syncthing Docker image

Syncthing Docker image for RaspberryPi / amd64 systems.

See Syncthing⁠ website for more.

Tested on following archs:

• x64

Following arch are missing tests:

• arm32v6
• armv7

⁠Available image tags

• nventiveux/syncthing⁠
  • Image version: latest, 3.3.0 (Dockerfile⁠)
  • Syncthing version: v2.1.3

⁠Usage

Run the container manually (select tag according to the target architecture):

{
mkdir -p "${HOME}/Sync";
docker run \
  -d \
  --name syncthing \
  -p 8384:8384/tcp \
  -p 22000:22000/tcp \
  -p 21027:21027/udp \
  -v syncthing_config:/etc/syncthing \
  -v "${HOME}/Sync":/var/lib/syncthing \
  nventiveux/syncthing:latest;
}

Open the administration website with https://localhost:8384/⁠ and connect using admin / admin.

This will make available for syncing all folders within ~/Sync. You may be interested to adapt environment variables SYNCTHING_USER_UID and SYNCTHING_GROUP_GID to match your user UID / GID at the host (verify with id).

⁠Persisting data

Following paths within the container should be persisted:

• /var/lib/syncthing holds synced content.
• /etc/syncthing holds the syncthing configuration.

⁠Network ports

• Default ports:
  • 21027/udp --> Local discovery (see Known issues)
  • 22000/tcp --> Sync protocol
  • 8384/tcp --> Admin interface

⁠Environment variables

You can configure Syncthing injecting following environment variables:

Example to set another password for the admin user:

docker run \
  ...
  -e SYNCTHING_ADMIN_PASSWORD="anotherpassword" \
  ...

⁠Known issues

• Local discovery does not work without --network=host. Need more testing if this can be avoided.

⁠Contribute

Pre-requisites:

• asdf⁠
• Bash >=4
• Git >=2.18

Prepare your environment:

asdf plugin install git-cliff
asdf plugin install task
asdf install

Tweak Dockerfile to your convenience.

Note: if you are upgrading Syncthing to a newer version, also sync the config file version⁠ !

Commit changes and submit a Pull Request.

⁠Releasing a new version

Bump syncthing version using:

git switch -c release/next
task bump:syncthing
# Open a pull request
# Tests...

Bump project's version:

task bump
# Merge pull request
# Delete release/next

Release with:

git switch master && git pull
task tag
git push origin --tags

⁠References

• Inspiration taken from tianon/dockerfiles⁠.