octoleo/syncthing
1
0
Fork 0
mirror of https://github.com/octoleo/syncthing.git synced 2024-11-08 22:31:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Correct Docker README (#5480) (#5545)

Browse Source 
Plus some formatting.
This commit is contained in:
Jonas Thelemann 2019-02-25 21:37:59 +01:00 committed by Jakob Borg
parent 63c4e7f6d0
commit 8a05492622
1 changed files with 5 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README-Docker.md
View File

@ -1,39 +1,30 @@
# Docker Container for Syncthing # Docker Container for Syncthing
Use the Dockerfile in this repo, or pull the `syncthing/syncthing` image Use the Dockerfile in this repo, or pull the `syncthing/syncthing` image
from Docker Hub. Use volumes to have the synchronized files available on the from Docker Hub.
host.
The exposed volumes are by default: 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.
/var/syncthing/config - the configuration and index directory into the Container
/var/syncthing - the default sync folder into the Container
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 Note that Syncthing runs as UID 1000 and GID 1000 by default. These may be
altered with the ``PUID`` and ``PGID`` environment variables. altered with the ``PUID`` and ``PGID`` environment variables.
Example usage: ## Example Usage
``` ```
$ docker pull syncthing/syncthing $ docker pull syncthing/syncthing
$ docker run -p 8384:8384 -p 22000:22000 \ $ docker run -p 8384:8384 -p 22000:22000 \
-v /wherever/st-cfg:/var/syncthing/config \
-v /wherever/st-sync:/var/syncthing \ -v /wherever/st-sync:/var/syncthing \
syncthing/syncthing:latest syncthing/syncthing:latest
``` ```
Note that local device discovery will not work with the above command resulting 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.
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: To allow local discovery, the docker host network can be used instead:
``` ```
$ docker pull syncthing/syncthing $ docker pull syncthing/syncthing
$ docker run --network=host \ $ docker run --network=host \
-v /wherever/st-cfg:/var/syncthing/config \
-v /wherever/st-sync:/var/syncthing \ -v /wherever/st-sync:/var/syncthing \
syncthing/syncthing:latest syncthing/syncthing:latest
``` ```