kaktuss/syncthing-auto repository overview

⁠docker-syncthing-auto

Automated syncthing: just run container and it automagically discover other containers, connects to them and start syncing. No need to any manual configuration to start syncing.

You need running instance of Consul⁠ to discovery.

⁠Run example

sudo docker run --rm -it -e CONSUL_HTTP_ADDR=consul.service.consul:8500 -e CONSUL_TOKEN=<SOME_CONSUL_TOKEN> -e SYNC_SERVICE=sync -e SYNC_FOLDERS='test:/home/user/test' -e SYNC_IP=<CONTAINER_1_IP> -v /tmp/sync1:/home/user/test kaktuss/syncthing-auto:latest

sudo docker run --rm -it -e CONSUL_HTTP_ADDR=consul.service.consul:8500 -e CONSUL_TOKEN=<SOME_CONSUL_TOKEN> -e SYNC_SERVICE=sync -e SYNC_FOLDERS='test:/home/user/test' -e SYNC_IP=<CONTAINER_2_IP> -v /tmp/sync2:/home/user/test kaktuss/syncthing-auto:latest

Copy file to /tmp/sync1 at host system and then it appear at /tmp/sync2.

⁠Configuration

CONSUL_HTTP_ADDR - address of consul. Required.

CONSUL_TOKEN - Consul ACL token. Optional.

SYNC_SERVICE - some service name. Must be identical thru syncthing-auto cluster. Required.

SYNC_FOLDERS - folders to sync. Required. Format:

SYNC_FOLDERS="
<uniq_folder_tag_in_syncthing_auto_cluster_1:folder_path_in_container_1>
<uniq_folder_tag_in_syncthing_auto_cluster_2:folder_path_in_container_2>
...
"

SYNC_IP - external IP of container. Required.

SYNC_PORT - external port of container. Optional. Default value 22000.

USER_UID - UID for synced files.

USER_GID - GID for synced files.

SYNC_MASTER_MODE - Optional. Default 1. To select master or slave mode. See "Master mode" section.

⁠Run in production

You need to pass SYNC_IP to each container and expose 22000 (or SYNC_PORT) port to connectivity containers to each other. You can expose 8384 port to connect to GUI. Don't expose GUI port to worldwide access.

⁠Master mode

By default service start in master mode. It get folder config from environment, save it to Consul and start sync all of these folders.

Sometimes you need to sync only one/two of these folders and optionaly change destination. To do this - you must set SYNC_MASTER_MODE="" (empty value). After that service not do save folders to Consul. And you can change destination. And only this folders (not all folders from Consul) will be used to sync.