mirror
/
docker-documentation
kopia lustrzana https://github.com/linuxserver/docker-documentation
1
0
Forkuj 0
Kod Zgłoszenia Packages Projekty Wydania Wiki Aktywność

Bot Updating Templated Files

pull/9/head
LinuxServer-CI 2019-10-01 07:32:55 +01:00
rodzic b02e8fbe9b
commit 44c59bad74
1 zmienionych plików z 29 dodań i 18 usunięć
Pokaż statystyki Ściągnij plik aktualizacji Ściągnij plik porównania Expand all files Collapse all files

47
images/docker-syncthing.md
Wyświetl plik

@ -1,6 +1,12 @@
# linuxserver/syncthing # [linuxserver/syncthing](https://github.com/linuxserver/docker-syncthing)
[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-syncthing.svg?style=flat-square&color=E68523)](https://github.com/linuxserver/docker-syncthing/releases) [![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/syncthing.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/syncthing) [![MicroBadger Size](https://img.shields.io/microbadger/image-size/linuxserver/syncthing.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/syncthing) [![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/syncthing.svg?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/syncthing) [![Docker Stars](https://img.shields.io/docker/stars/linuxserver/syncthing.svg?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/syncthing) [![Build Status](https://ci.linuxserver.io/view/all/job/Docker-Pipeline-Builders/job/docker-syncthing/job/master/badge/icon?style=flat-square)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-syncthing/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/syncthing/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/syncthing/latest/index.html) [![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-syncthing.svg?style=flat-square&color=E68523)](https://github.com/linuxserver/docker-syncthing/releases)
[![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/syncthing.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/syncthing "Get your own version badge on microbadger.com")
[![MicroBadger Size](https://img.shields.io/microbadger/image-size/linuxserver/syncthing.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/syncthing "Get your own version badge on microbadger.com")
[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/syncthing.svg?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/syncthing)
[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/syncthing.svg?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/syncthing)
[![Build Status](https://ci.linuxserver.io/view/all/job/Docker-Pipeline-Builders/job/docker-syncthing/job/master/badge/icon?style=flat-square)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-syncthing/job/master/)
[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/syncthing/latest/badge.svg)](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. [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 +19,19 @@ Simply pulling `linuxserver/syncthing` should retrieve the correct image for you
The architectures supported by this image are: The architectures supported by this image are:
| Architecture | Tag | | Architecture | Tag |
| :---: | :--- | | :----: | --- |
| x86-64 | amd64-latest | | x86-64 | amd64-latest |
| arm64 | arm64v8-latest | | arm64 | arm64v8-latest |
| armhf | arm32v7-latest | | armhf | arm32v7-latest |
## Usage ## Usage
Here are some example snippets to help you get started creating a container from this image. Here are some example snippets to help you get started creating a container from this image.
### docker ### docker
```text ```
docker create \ docker create \
--name=syncthing \ --name=syncthing \
-e PUID=1000 \ -e PUID=1000 \
@ -41,6 +48,7 @@ docker create \
linuxserver/syncthing linuxserver/syncthing
``` ```
### docker-compose ### docker-compose
Compatible with docker-compose v2 schemas. Compatible with docker-compose v2 schemas.
@ -70,49 +78,53 @@ services:
## Parameters ## 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 | | Parameter | Function |
| :---: | :--- | | :----: | --- |
| `8384` | Application WebUI | | `8384` | Application WebUI |
| `22000` | Listening port | | `22000` | Listening port |
| `21027/udp` | Protocol discovery | | `21027/udp` | Protocol discovery |
### Environment Variables \(`-e`\)
### Environment Variables (`-e`)
| Env | Function | | Env | Function |
| :---: | :--- | | :----: | --- |
| `PUID=1000` | for UserID - see below for explanation | | `PUID=1000` | for UserID - see below for explanation |
| `PGID=1000` | for GroupID - see below for explanation | | `PGID=1000` | for GroupID - see below for explanation |
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London. | | `TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
| `UMASK_SET=<022>` | Umask setting - [explaination](https://askubuntu.com/questions/44542/what-is-umask-and-how-does-it-work) | | `UMASK_SET=<022>` | Umask setting - [explaination](https://askubuntu.com/questions/44542/what-is-umask-and-how-does-it-work) |
### Volume Mappings \(`-v`\) ### Volume Mappings (`-v`)
| Volume | Function | | Volume | Function |
| :---: | :--- | | :----: | --- |
| `/config` | Configuration files. | | `/config` | Configuration files. |
| `/data1` | Data1 | | `/data1` | Data1 |
| `/data2` | Data2 | | `/data2` | Data2 |
## User / Group Identifiers ## 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. 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: In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
```text ```
$ id username $ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup) uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
``` ```
## Application Setup ## 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.
## Support Info ## Support Info
@ -135,7 +147,7 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel
* **30.07.18:** - Rebase to alpine 3.8 and use buildstage. * **30.07.18:** - Rebase to alpine 3.8 and use buildstage.
* **13.12.17:** - Rebase to alpine 3.7. * **13.12.17:** - Rebase to alpine 3.7.
* **25.10.17:** - Add env for manual setting of umask. * **25.10.17:** - Add env for manual setting of umask.
* **29.07.17:** - Simplify build structure as symlinks failing on &gt; 0.14.32 * **29.07.17:** - Simplify build structure as symlinks failing on > 0.14.32
* **28.05.17:** - Rebase to alpine 3.6. * **28.05.17:** - Rebase to alpine 3.6.
* **08.02.17:** - Rebase to alpine 3.5. * **08.02.17:** - Rebase to alpine 3.5.
* **01.11.16:** - Switch to compiling latest version from git source. * **01.11.16:** - Switch to compiling latest version from git source.
@ -144,6 +156,5 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel
* **09.09.16:** - Add layer badges to README. * **09.09.16:** - Add layer badges to README.
* **28.08.16:** - Add badges to README. * **28.08.16:** - Add badges to README.
* **11.08.16:** - Rebase to alpine linux. * **11.08.16:** - Rebase to alpine linux.
* **18.12.15:** - Initial testing / release \(IronicBadger\) * **18.12.15:** - Initial testing / release (IronicBadger)
* **24.09.15:** - Inital dev complete \(Lonix\) * **24.09.15:** - Inital dev complete (Lonix)