Skip to content

Commit 3b98967

Browse files
j0nnymoej0nnymoe
authored
Merge pull request #24 from IronicBadger/master
dynamic readme
2 parents e81f017 + 548c431 commit 3b98967

File tree

2 files changed

+199
-169
lines changed

2 files changed

+199
-169
lines changed

‎README.md‎

Lines changed: 146 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -1,102 +1,184 @@
1-
[linuxserverurl]: https://linuxserver.io
2-
[forumurl]: https://forum.linuxserver.io
3-
[ircurl]: https://www.linuxserver.io/irc/
4-
[podcasturl]: https://www.linuxserver.io/podcast/
5-
[appurl]: https://syncthing.net
6-
[hub]: https://hub.docker.com/r/linuxserver/syncthing/
1+
[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)](https://linuxserver.io)
72

8-
[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)][linuxserverurl]
3+
The [LinuxServer.io](https://linuxserver.io) team brings you another container release featuring :-
94

10-
The [LinuxServer.io][linuxserverurl] team brings you another container release featuring easy user mapping and community support. Find us for support at:
11-
* [forum.linuxserver.io][forumurl]
12-
* [IRC][ircurl] on freenode at `#linuxserver.io`
13-
* [Podcast][podcasturl] covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation!
5+
* regular and timely application updates
6+
* easy user mappings (PGID, PUID)
7+
* custom base image with s6 overlay
8+
* weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
9+
* regular security updates
1410

15-
# linuxserver/syncthing
16-
[![](https://images.microbadger.com/badges/version/linuxserver/syncthing.svg)](https://microbadger.com/images/linuxserver/syncthing "Get your own version badge on microbadger.com")[![](https://images.microbadger.com/badges/image/linuxserver/syncthing.svg)](https://microbadger.com/images/linuxserver/syncthing "Get your own image badge on microbadger.com")[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/syncthing.svg)][hub][![Docker Stars](https://img.shields.io/docker/stars/linuxserver/syncthing.svg)][hub][![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Builders/x86-64/x86-64-syncthing)](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-syncthing/)
11+
Find us at:
12+
* [Discord](https://discord.gg/YWrKVTn) - realtime support / chat with the community and the team.
13+
* [IRC](https://irc.linuxserver.io) - on freenode at `#linuxserver.io`. Our primary support channel is Discord.
14+
* [Blog](https://blog.linuxserver.io) - all the things you can do with our containers including How-To guides, opinions and much more!
15+
* [Podcast](https://anchor.fm/linuxserverio) - on hiatus. Coming back soon (late 2018).
1716

18-
Syncthing 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.
17+
# PSA: Changes are happening
1918

20-
You can find some of the best documentation available on the web at [docs.syncthing.net](http://docs.syncthing.net/).
19+
From August 2018 onwards, Linuxserver are in the midst of switching to a new CI platform which will enable us to build and release multiple architectures under a single repo. To this end, existing images for `arm64` and `armhf` builds are being deprecated. They are replaced by a manifest file in each container which automatically pulls the correct image for your architecture. You'll also be able to pull based on a specific architecture tag.
20+
21+
TLDR: Multi-arch support is changing from multiple repos to one repo per container image.
22+
23+
# [linuxserver/syncthing](https://github.com/linuxserver/docker-syncthing)
24+
[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn)
25+
[![](https://images.microbadger.com/badges/version/linuxserver/syncthing.svg)](https://microbadger.com/images/linuxserver/syncthing "Get your own version badge on microbadger.com")
26+
[![](https://images.microbadger.com/badges/image/linuxserver/syncthing.svg)](https://microbadger.com/images/linuxserver/syncthing "Get your own version badge on microbadger.com")
27+
![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/syncthing.svg)
28+
![Docker Stars](https://img.shields.io/docker/stars/linuxserver/syncthing.svg)
29+
[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-syncthing/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-syncthing/job/master/)
30+
[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/syncthing/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/syncthing/latest/index.html)
31+
32+
[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.
33+
34+
[![syncthing](https://syncthing.net/images/logo-horizontal.svg)](https://syncthing.net)
35+
36+
## Supported Architectures
37+
38+
Our images support multiple architectures such as `x86-64`, `arm64` and `armhf`. We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list).
39+
40+
Simply pulling `linuxserver/syncthing` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
41+
42+
The architectures supported by this image are:
43+
44+
| Architecture | Tag |
45+
| :----: | --- |
46+
| x86-64 | amd64-latest |
47+
| arm64 | arm64v8-latest |
48+
| armhf | arm32v6-latest |
2149

22-
[![syncthing](https://syncthing.net/images/logo-horizontal.svg)][appurl]
2350

2451
## Usage
2552

53+
Here are some example snippets to help you get started creating a container.
54+
55+
### docker
56+
2657
```
2758
docker create \
2859
--name=syncthing \
29-
-v *host path to config*:/config \
30-
-v *host path to data*:/mnt/any/dir/you/want \
31-
-e PGID=<gid> -e PUID=<uid> \
60+
-e PUID=1001 \
61+
-e PGID=1001 \
62+
-e TZ=Europe/London \
3263
-e UMASK_SET=<022> \
33-
-p 8384:8384 -p 22000:22000 -p 21027:21027/udp \
64+
-p 8384:8384 \
65+
-p 22000:22000 \
66+
-p 21027/udp:21027/udp \
67+
-v </path/to/appdata/config>:/config \
68+
-v </path/to/data1>:/data1 \
69+
-v </path/to/data2>:/data2 \
70+
--restart unless-stopped \
3471
linuxserver/syncthing
3572
```
3673

37-
## Parameters
3874

39-
`The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side.
40-
For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container.
41-
So -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080
42-
http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.`
75+
### docker-compose
4376

77+
Compatible with docker-compose v2 schemas.
4478

45-
* `-v /config` - This contain configuration to keep it static, as well as a default shared directory
46-
* `-v /mnt/dir` - Add multiple folders to allow Syncthing access to data you wish to sync
47-
* `-e PGID` for GroupID - see below for explanation
48-
* `-e PUID` for UserID - see below for explanation
49-
* `-e UMASK_SET` for umask setting , *optional* , default if left unset is 022.
50-
* `-p 8384` Webui Port
51-
* `-p 22000` Listening Port
52-
* `-p 21027/udp` Discovery Port
79+
```
80+
---
81+
version: "2"
82+
services:
83+
syncthing:
84+
image: linuxserver/syncthing
85+
container_name: syncthing
86+
environment:
87+
- PUID=1001
88+
- PGID=1001
89+
- TZ=Europe/London
90+
- UMASK_SET=<022>
91+
volumes:
92+
- </path/to/appdata/config>:/config
93+
- </path/to/data1>:/data1
94+
- </path/to/data2>:/data2
95+
ports:
96+
- 8384:8384
97+
- 22000:22000
98+
- 21027/udp:21027/udp
99+
mem_limit: 4096m
100+
restart: unless-stopped
101+
```
102+
103+
## Parameters
104+
105+
Container 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.
106+
107+
| Parameter | Function |
108+
| :----: | --- |
109+
| `-p 8384` | Application WebUI |
110+
| `-p 22000` | Listening port |
111+
| `-p 21027/udp` | Protocol discovery |
112+
| `-e PUID=1001` | for UserID - see below for explanation |
113+
| `-e PGID=1001` | for GroupID - see below for explanation |
114+
| `-e TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
115+
| `-e UMASK_SET=<022>` | Umask setting - [explaination](https://askubuntu.com/questions/44542/what-is-umask-and-how-does-it-work) |
116+
| `-v /config` | Configuration files. |
117+
| `-v /data1` | Data1 |
118+
| `-v /data2` | Data2 |
53119

54-
It is based on alpine linux with s6 overlay, for shell access whilst the container is running do `docker exec -it syncthing /bin/bash`.
120+
## User / Group Identifiers
55121

56-
### User / Group Identifiers
122+
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`.
57123

58-
Sometimes when using data 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 the data volume directory on the host is owned by the same user you specify and it will "just work" ™.
124+
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
59125

60-
In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as below:
126+
In this instance `PUID=1001` and `PGID=1001`, to find yours use `id user` as below:
61127

62128
```
63-
$ id <dockeruser>
129+
$ id username
64130
uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
65131
```
66132

67-
## Setting up the application
68133

69-
You can find some of the best documentation available on the web at [docs.syncthing.net](http://docs.syncthing.net/).
134+
&nbsp;
135+
## Application Setup
70136

71-
**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.
137+
**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.
72138

73-
## Info
139+
140+
## Support Info
74141

75142
* Shell access whilst the container is running: `docker exec -it syncthing /bin/bash`
76143
* To monitor the logs of the container in realtime: `docker logs -f syncthing`
77-
78-
* container version number
79-
80-
`docker inspect -f '{{ index .Config.Labels "build_version" }}' syncthing`
81-
144+
* container version number
145+
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' syncthing`
82146
* image version number
83-
84-
`docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/syncthing`
147+
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/syncthing`
148+
149+
## Updating Info
150+
151+
Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (ie. nextcloud, plex), we do not recommend or support updating apps inside the container. Please consult the [Application Setup](#application-setup) section above to see if it is recommended for the image.
152+
153+
Below are the instructions for updating containers:
154+
155+
### Via Docker Run/Create
156+
* Update the image: `docker pull linuxserver/syncthing`
157+
* Stop the running container: `docker stop syncthing`
158+
* Delete the container: `docker rm syncthing`
159+
* Recreate a new container with the same docker create parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved)
160+
* Start the new container: `docker start syncthing`
161+
* You can also remove the old dangling images: `docker image prune`
162+
163+
### Via Docker Compose
164+
* Update the image: `docker-compose pull linuxserver/syncthing`
165+
* Let compose update containers as necessary: `docker-compose up -d`
166+
* You can also remove the old dangling images: `docker image prune`
85167

86168
## Versions
87169

88-
+ **16.01.19:** Add pipeline logic and multi arch.
89-
+ **30.07.18:** Rebase to alpine 3.8 and use buildstage.
90-
+ **13.12.17:** Rebase to alpine 3.7.
91-
+ **25.10.17:** Add env for manual setting of umask.
92-
+ **29.07.17:** Simplify build structure as symlinks failing on > 0.14.32
93-
+ **28.05.17:** Rebase to alpine 3.6.
94-
+ **08.02.17:** Rebase to alpine 3.5.
95-
+ **01.11.16:** Switch to compiling latest version from git source.
96-
+ **14.10.16:** Add version layer information.
97-
+ **30.09.16:** Fix umask.
98-
+ **09.09.16:** Add layer badges to README.
99-
+ **28.08.16:** Add badges to README.
100-
+ **11.08.16:** Rebase to alpine linux.
101-
+ **18.12.15:** Initial testing / release (IronicBadger)
102-
+ **24.09.15:** Inital dev complete (Lonix)
170+
* **16.01.19:** - Add pipeline logic and multi arch.
171+
* **30.07.18:** - Rebase to alpine 3.8 and use buildstage.
172+
* **13.12.17:** - Rebase to alpine 3.7.
173+
* **25.10.17:** - Add env for manual setting of umask.
174+
* **29.07.17:** - Simplify build structure as symlinks failing on > 0.14.32
175+
* **28.05.17:** - Rebase to alpine 3.6.
176+
* **08.02.17:** - Rebase to alpine 3.5.
177+
* **01.11.16:** - Switch to compiling latest version from git source.
178+
* **14.10.16:** - Add version layer information.
179+
* **30.09.16:** - Fix umask.
180+
* **09.09.16:** - Add layer badges to README.
181+
* **28.08.16:** - Add badges to README.
182+
* **11.08.16:** - Rebase to alpine linux.
183+
* **18.12.15:** - Initial testing / release (IronicBadger)
184+
* **24.09.15:** - Inital dev complete (Lonix)

0 commit comments

Comments
 (0)