Skip to content

Commit d1c2329

Browse files
Bot Updating Templated Files
1 parent d7173ba commit d1c2329

File tree

2 files changed

+29
-23
lines changed

2 files changed

+29
-23
lines changed

.github/CONTRIBUTING.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ If you are proposing additional packages to be added, ensure that you added the
9696

9797
### Testing your changes
9898

99-
```
99+
```bash
100100
git clone https://github.com/linuxserver/docker-syncthing.git
101101
cd docker-syncthing
102102
docker build \
@@ -106,13 +106,14 @@ docker build \
106106
```
107107

108108
The ARM variants can be built on x86_64 hardware using `multiarch/qemu-user-static`
109-
```
109+
110+
```bash
110111
docker run --rm --privileged multiarch/qemu-user-static:register --reset
111112
```
112113

113114
Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64`.
114115

115-
## Update the chagelog
116+
## Update the changelog
116117

117118
If you are modifying the Dockerfiles or any of the startup scripts in [root](https://github.com/linuxserver/docker-syncthing/tree/master/root), add an entry to the changelog
118119

README.md

+25-20
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!-- DO NOT EDIT THIS FILE MANUALLY -->
2-
<!-- Please read the CONTRIBUTING.md -->
2+
<!-- Please read the https://github.com/linuxserver/docker-syncthing/blob/master/.github/CONTRIBUTING.md -->
33

44
[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)](https://linuxserver.io)
55

@@ -12,13 +12,14 @@
1212

1313
The [LinuxServer.io](https://linuxserver.io) team brings you another container release featuring:
1414

15-
* regular and timely application updates
16-
* easy user mappings (PGID, PUID)
17-
* custom base image with s6 overlay
18-
* weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
19-
* regular security updates
15+
* regular and timely application updates
16+
* easy user mappings (PGID, PUID)
17+
* custom base image with s6 overlay
18+
* weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
19+
* regular security updates
2020

2121
Find us at:
22+
2223
* [Blog](https://blog.linuxserver.io) - all the things you can do with our containers including How-To guides, opinions and much more!
2324
* [Discord](https://discord.gg/YWrKVTn) - realtime support / chat with the community and the team.
2425
* [Discourse](https://discourse.linuxserver.io) - post on our community forum.
@@ -56,6 +57,9 @@ The architectures supported by this image are:
5657
| arm64 | arm64v8-latest |
5758
| armhf | arm32v7-latest |
5859

60+
## Application Setup
61+
62+
**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.
5963

6064
## Usage
6165

@@ -90,7 +94,7 @@ services:
9094
9195
### docker cli
9296
93-
```
97+
```bash
9498
docker run -d \
9599
--name=syncthing \
96100
--hostname=syncthing `#optional` \
@@ -107,7 +111,6 @@ docker run -d \
107111
ghcr.io/linuxserver/syncthing
108112
```
109113

110-
111114
## Parameters
112115

113116
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.
@@ -131,7 +134,7 @@ You can set any environment variable from a file by using a special prepend `FIL
131134

132135
As an example:
133136

134-
```
137+
```bash
135138
-e FILE__PASSWORD=/run/secrets/mysecretpassword
136139
```
137140

@@ -150,23 +153,17 @@ Ensure any volume directories on the host are owned by the same user you specify
150153

151154
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
152155

153-
```
156+
```bash
154157
$ id username
155158
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
156159
```
157160

158-
159-
&nbsp;
160-
## Application Setup
161-
162-
**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.
163-
164161
## Docker Mods
162+
165163
[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=syncthing&query=%24.mods%5B%27syncthing%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=syncthing "view available mods for this container.") [![Docker Universal Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
166164

167165
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) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.
168166

169-
170167
## Support Info
171168

172169
* Shell access whilst the container is running: `docker exec -it syncthing /bin/bash`
@@ -183,38 +180,45 @@ Most of our images are static, versioned, and require an image update and contai
183180
Below are the instructions for updating containers:
184181

185182
### Via Docker Compose
183+
186184
* Update all images: `docker-compose pull`
187185
* or update a single image: `docker-compose pull syncthing`
188186
* Let compose update all containers as necessary: `docker-compose up -d`
189187
* or update a single container: `docker-compose up -d syncthing`
190188
* You can also remove the old dangling images: `docker image prune`
191189

192190
### Via Docker Run
191+
193192
* Update the image: `docker pull ghcr.io/linuxserver/syncthing`
194193
* Stop the running container: `docker stop syncthing`
195194
* Delete the container: `docker rm syncthing`
196195
* Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved)
197196
* You can also remove the old dangling images: `docker image prune`
198197

199198
### Via Watchtower auto-updater (only use if you don't remember the original parameters)
199+
200200
* Pull the latest image at its tag and replace it with the same env variables in one run:
201-
```
201+
202+
```bash
202203
docker run --rm \
203204
-v /var/run/docker.sock:/var/run/docker.sock \
204205
containrrr/watchtower \
205206
--run-once syncthing
206207
```
208+
207209
* You can also remove the old dangling images: `docker image prune`
208210

209211
**Note:** We do not endorse the use of Watchtower as a solution to automated updates of existing Docker containers. In fact we generally discourage automated updates. However, this is a useful tool for one-time manual updates of containers where you have forgotten the original parameters. In the long term, we highly recommend using [Docker Compose](https://docs.linuxserver.io/general/docker-compose).
210212

211213
### Image Update Notifications - Diun (Docker Image Update Notifier)
214+
212215
* We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported.
213216

214217
## Building locally
215218

216219
If you want to make local modifications to these images for development purposes or just to customize the logic:
217-
```
220+
221+
```bash
218222
git clone https://github.com/linuxserver/docker-syncthing.git
219223
cd docker-syncthing
220224
docker build \
@@ -224,7 +228,8 @@ docker build \
224228
```
225229

226230
The ARM variants can be built on x86_64 hardware using `multiarch/qemu-user-static`
227-
```
231+
232+
```bash
228233
docker run --rm --privileged multiarch/qemu-user-static:register --reset
229234
```
230235

0 commit comments

Comments
 (0)