diff options
author | Jakob Borg <jakob@kastelo.net> | 2019-09-22 11:33:29 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-09-22 11:33:29 +0100 |
commit | c744a75cddb724857f5081eabae00315ddfa8a48 (patch) | |
tree | 0917aa5906bf6727ccd4d5d569a9e4b64629a4cb /README-Docker.md | |
parent | 35b699dc77a23df3511940fb58d78a47308259fe (diff) | |
download | syncthing-c744a75cddb724857f5081eabae00315ddfa8a48.tar.gz syncthing-c744a75cddb724857f5081eabae00315ddfa8a48.zip |
docker: Make it easy to disable the GUI, document it (#6021)
Diffstat (limited to 'README-Docker.md')
-rw-r--r-- | README-Docker.md | 27 |
1 files changed, 26 insertions, 1 deletions
diff --git a/README-Docker.md b/README-Docker.md index 8f1614834..8c078ae5f 100644 --- a/README-Docker.md +++ b/README-Docker.md @@ -18,7 +18,11 @@ $ docker run -p 8384:8384 -p 22000:22000 \ syncthing/syncthing:latest ``` -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. +## 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: @@ -32,3 +36,24 @@ $ docker run --network=host \ 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. |