cjrun/syncthing repository overview

⁠cjrun/syncthing:remote

This branch builds the image cjrun/syncthing:remote that cjr⁠ uses to run Syncthing on a remote host. The image is part of the official cjr repository syncthing⁠. A container that is run from image will not start any ssh connections. Instead it waits for a connection from the local container.

IMPORTANT: These containers are meant to be used by cjr using ssh tunneling. Do not use these containers as a starting point for running a publicly exposed syncthing server, unless you change the private keys and the config files.

⁠Usage

If the entrypoint and command are left unchange, then any container that runs from the image cjrun/syncthing:remote will respond to the following environment variables:

• USER_ID: user id of container user; to sync bound directories, this must match the id of current user.
• GROUP_ID: group id of container user; to sync bound directories, this must match the group id of current user.
• SYNCTHING_SYNC_DIRECTORY (optional) : the directory in the container that syncthing should keep syncronized. The default is /home/syncthing/sync-directory
• SYNCTHING_GUI_PORT (optional) : port that syncthing uses for the web GUI. The default is 8384.
• SYNCTHING_LISTEN_PORT (optional) : port that Syncthing uses to listen to remote connections. The default is 22000.
• SYNCTHING_CONNECT_PORT (optional) : port that local Syncthing uses to connect to remote Syncthing. The default is 22001.

IMPORTANT: If SYNCTHING_LISTEN_PORT or SYNCTHING_CONNECT_PORT are specified, then their values should be equivalent to the values used for the local container.

⁠Example start command

The container must be run using the flag --network=host. The container will synchronize the directory $SYNCTHING_SYNC_DIRECTORY. You must bind the local directory that you wish to sync to this path (or inside this directory).

$ docker run -ti --network=host \
    -v /path/to/sync/directory:/home/syncthing/sync-directory \
    --env USER_ID=$(id -u) --env GROUP_ID=$(id -g) \
    --env SYNCTHING_GUI_PORT=8384 --env SYNCTHING_LISTEN_PORT=22000 --env SYNCTHING_CONNECT_PORT=22001 \
    cjrun/syncthing:remote

⁠Description of build directories and files

• config : Syncthing configuration files for the image
• entrypoint.sh : creates a new linux user with specified UID and GID, configures Syncthing for this user, and runs the start command
• start.sh : default starting script for the image