kopia lustrzana https://github.com/linuxserver/docker-documentation
Bot Updating Documentation
LinuxServer-CI
rodzic
1893f7f8f2
commit
dfe19f06e9
|
|
@ -1,6 +1,14 @@
|
|||
# linuxserver/syncthing
|
||||
# [linuxserver/syncthing](https://github.com/linuxserver/docker-syncthing)
|
||||
|
||||
[](https://github.com/linuxserver/docker-syncthing) [](https://github.com/linuxserver/docker-syncthing/releases) [](https://github.com/linuxserver/docker-syncthing/packages) [](https://gitlab.com/Linuxserver.io/docker-syncthing/container_registry) [](https://microbadger.com/images/linuxserver/syncthing) [](https://hub.docker.com/r/linuxserver/syncthing) [](https://hub.docker.com/r/linuxserver/syncthing) [](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-syncthing/job/master/) [](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/syncthing/latest/index.html)
|
||||
[](https://github.com/linuxserver/docker-syncthing)
|
||||
[](https://github.com/linuxserver/docker-syncthing/releases)
|
||||
[](https://github.com/linuxserver/docker-syncthing/packages)
|
||||
[](https://gitlab.com/Linuxserver.io/docker-syncthing/container_registry)
|
||||
[](https://microbadger.com/images/linuxserver/syncthing "Get your own version badge on microbadger.com")
|
||||
[](https://hub.docker.com/r/linuxserver/syncthing)
|
||||
[](https://hub.docker.com/r/linuxserver/syncthing)
|
||||
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-syncthing/job/master/)
|
||||
[](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/syncthing/latest/index.html)
|
||||
|
||||
[Syncthing](https://syncthing.net) replaces proprietary sync and cloud services with something open, trustworthy and decentralized. Your data is your data alone and you deserve to choose where it is stored, if it is shared with some third party and how it's transmitted over the Internet.
|
||||
|
||||
|
|
@ -13,18 +21,19 @@ Simply pulling `linuxserver/syncthing` should retrieve the correct image for you
|
|||
The architectures supported by this image are:
|
||||
|
||||
| Architecture | Tag |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| x86-64 | amd64-latest |
|
||||
| arm64 | arm64v8-latest |
|
||||
| armhf | arm32v7-latest |
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
Here are some example snippets to help you get started creating a container from this image.
|
||||
|
||||
### docker
|
||||
|
||||
```text
|
||||
```
|
||||
docker create \
|
||||
--name=syncthing \
|
||||
-e PUID=1000 \
|
||||
|
|
@ -41,6 +50,7 @@ docker create \
|
|||
linuxserver/syncthing
|
||||
```
|
||||
|
||||
|
||||
### docker-compose
|
||||
|
||||
Compatible with docker-compose v2 schemas.
|
||||
|
|
@ -70,40 +80,43 @@ services:
|
|||
|
||||
## Parameters
|
||||
|
||||
Docker images are configured using parameters passed at runtime \(such as those above\). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
|
||||
Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
|
||||
|
||||
### Ports \(`-p`\)
|
||||
### Ports (`-p`)
|
||||
|
||||
| Parameter | Function |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| `8384` | Application WebUI |
|
||||
| `22000` | Listening port |
|
||||
| `21027/udp` | Protocol discovery |
|
||||
|
||||
### Environment Variables \(`-e`\)
|
||||
|
||||
### Environment Variables (`-e`)
|
||||
|
||||
| Env | Function |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| `PUID=1000` | for UserID - see below for explanation |
|
||||
| `PGID=1000` | for GroupID - see below for explanation |
|
||||
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
|
||||
| `UMASK_SET=<022>` | Umask setting - [explanation](https://askubuntu.com/questions/44542/what-is-umask-and-how-does-it-work) |
|
||||
|
||||
### Volume Mappings \(`-v`\)
|
||||
### Volume Mappings (`-v`)
|
||||
|
||||
| Volume | Function |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| `/config` | Configuration files. |
|
||||
| `/data1` | Data1 |
|
||||
| `/data2` | Data2 |
|
||||
|
||||
## Environment variables from files \(Docker secrets\)
|
||||
|
||||
|
||||
## Environment variables from files (Docker secrets)
|
||||
|
||||
You can set any environment variable from a file by using a special prepend `FILE__`.
|
||||
|
||||
As an example:
|
||||
|
||||
```text
|
||||
```
|
||||
-e FILE__PASSWORD=/run/secrets/mysecretpassword
|
||||
```
|
||||
|
||||
|
|
@ -111,30 +124,32 @@ Will set the environment variable `PASSWORD` based on the contents of the `/run/
|
|||
|
||||
## Umask for running applications
|
||||
|
||||
For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional `-e UMASK=022` setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up [here](https://en.wikipedia.org/wiki/Umask) before asking for support.
|
||||
For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional `-e UMASK=022` setting.
|
||||
Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up [here](https://en.wikipedia.org/wiki/Umask) before asking for support.
|
||||
|
||||
|
||||
## User / Group Identifiers
|
||||
|
||||
When using volumes \(`-v` flags\), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`.
|
||||
When using volumes (`-v` flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`.
|
||||
|
||||
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
|
||||
|
||||
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
|
||||
|
||||
```text
|
||||
```
|
||||
$ id username
|
||||
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
|
||||
```
|
||||
|
||||
## Application Setup
|
||||
|
||||
**Note:** The Syncthing devs highly suggest setting a password for this container as it listens on 0.0.0.0. To do this go to `Actions -> Settings -> set user/password` for the webUI.
|
||||
**Note: ** The Syncthing devs highly suggest setting a password for this container as it listens on 0.0.0.0. To do this go to `Actions -> Settings -> set user/password` for the webUI.
|
||||
|
||||
## Docker Mods
|
||||
[](https://mods.linuxserver.io/?mod=syncthing "view available mods for this container.")
|
||||
|
||||
[](https://mods.linuxserver.io/?mod=syncthing)
|
||||
We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to enable additional functionality within the containers. The list of Mods available for this image (if any) can be accessed via the dynamic badge above.
|
||||
|
||||
We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to enable additional functionality within the containers. The list of Mods available for this image \(if any\) can be accessed via the dynamic badge above.
|
||||
|
||||
## Support Info
|
||||
|
||||
|
|
@ -158,7 +173,7 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to
|
|||
* **30.07.18:** - Rebase to alpine 3.8 and use buildstage.
|
||||
* **13.12.17:** - Rebase to alpine 3.7.
|
||||
* **25.10.17:** - Add env for manual setting of umask.
|
||||
* **29.07.17:** - Simplify build structure as symlinks failing on > 0.14.32
|
||||
* **29.07.17:** - Simplify build structure as symlinks failing on > 0.14.32
|
||||
* **28.05.17:** - Rebase to alpine 3.6.
|
||||
* **08.02.17:** - Rebase to alpine 3.5.
|
||||
* **01.11.16:** - Switch to compiling latest version from git source.
|
||||
|
|
@ -167,6 +182,5 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to
|
|||
* **09.09.16:** - Add layer badges to README.
|
||||
* **28.08.16:** - Add badges to README.
|
||||
* **11.08.16:** - Rebase to alpine linux.
|
||||
* **18.12.15:** - Initial testing / release \(IronicBadger\)
|
||||
* **24.09.15:** - Inital dev complete \(Lonix\)
|
||||
|
||||
* **18.12.15:** - Initial testing / release (IronicBadger)
|
||||
* **24.09.15:** - Inital dev complete (Lonix)
|
||||
|
|
|
|||
Ładowanie…
Reference in New Issue