</span></code></pre></div><h3id=docker-cli-click-here-for-more-info>docker cli (<ahref=https://docs.docker.com/engine/reference/commandline/cli/>click here for more info</a>)<aclass=headerlinkhref=#docker-cli-click-here-for-more-infotitle="Permanent link">¶</a></h3><divclass="language-bash highlight"><pre><span></span><code><spanid=__span-1-1><aid=__codelineno-1-1name=__codelineno-1-1href=#__codelineno-1-1></a>docker<spanclass=w></span>run<spanclass=w></span>-d<spanclass=w></span><spanclass=se>\</span>
</span></code></pre></div><h2id=parameters>Parameters<aclass=headerlinkhref=#parameterstitle="Permanent link">¶</a></h2><p>Containers are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <code><external>:<internal></code> respectively. For example, <code>-p 8080:80</code> would expose port <code>80</code> from inside the container to be accessible from the host's IP on port <code>8080</code> outside the container.</p><h3id=ports-p>Ports (<code>-p</code>)<aclass=headerlinkhref=#ports-ptitle="Permanent link">¶</a></h3><table><thead><tr><thstyle="text-align: center;">Parameter</th><th>Function</th></tr></thead><tbody><tr><tdstyle="text-align: center;"><code>8384</code></td><td>Application WebUI</td></tr><tr><tdstyle="text-align: center;"><code>22000/tcp</code></td><td>Listening port (TCP)</td></tr><tr><tdstyle="text-align: center;"><code>22000/udp</code></td><td>Listening port (UDP)</td></tr><tr><tdstyle="text-align: center;"><code>21027/udp</code></td><td>Protocol discovery</td></tr></tbody></table><h3id=environment-variables-e>Environment Variables (<code>-e</code>)<aclass=headerlinkhref=#environment-variables-etitle="Permanent link">¶</a></h3><table><thead><tr><thstyle="text-align: center;">Env</th><th>Function</th></tr></thead><tbody><tr><tdstyle="text-align: center;"><code>PUID=1000</code></td><td>for UserID - see below for explanation</td></tr><tr><tdstyle="text-align: center;"><code>PGID=1000</code></td><td>for GroupID - see below for explanation</td></tr><tr><tdstyle="text-align: center;"><code>TZ=Etc/UTC</code></td><td>specify a timezone to use, see this <ahref=https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List>list</a>.</td></tr></tbody></table><h3id=volume-mappings-v>Volume Mappings (<code>-v</code>)<aclass=headerlinkhref=#volume-mappings-vtitle="Permanent link">¶</a></h3><table><thead><tr><thstyle="text-align: center;">Volume</th><th>Function</th></tr></thead><tbody><tr><tdstyle="text-align: center;"><code>/config</code></td><td>Configuration files.</td></tr><tr><tdstyle="text-align: center;"><code>/data1</code></td><td>Data1</td></tr><tr><tdstyle="text-align: center;"><code>/data2</code></td><td>Data2</td></tr></tbody></table><h4id=miscellaneous-options>Miscellaneous Options<aclass=headerlinkhref=#miscellaneous-optionstitle="Permanent link">¶</a></h4><table><thead><tr><thstyle="text-align: center;">Parameter</th><th>Function</th></tr></thead><tbody><tr><tdstyle="text-align: center;"><code>--hostname=</code></td><td>Optionally the hostname can be defined.</td></tr></tbody></table><h2id=environment-variables-from-files-docker-secrets>Environment variables from files (Docker secrets)<aclass=headerlinkhref=#environment-variables-from-files-docker-secretstitle="Permanent link">¶</a></h2><p>You can set any environment variable from a file by using a special prepend <code>FILE__</code>.</p><p>As an example:</p><divclass="language-bash highlight"><pre><span></span><code><spanid=__span-2-1><aid=__codelineno-2-1name=__codelineno-2-1href=#__codelineno-2-1></a>-e<spanclass=w></span><spanclass=nv>FILE__MYVAR</span><spanclass=o>=</span>/run/secrets/mysecretvariable
</span></code></pre></div><p>Will set the environment variable <code>MYVAR</code> based on the contents of the <code>/run/secrets/mysecretvariable</code> file.</p><h2id=umask-for-running-applications>Umask for running applications<aclass=headerlinkhref=#umask-for-running-applicationstitle="Permanent link">¶</a></h2><p>For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional <code>-e UMASK=022</code> setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up <ahref=https://en.wikipedia.org/wiki/Umask>here</a> before asking for support.</p><h2id=user-group-identifiers>User / Group Identifiers<aclass=headerlinkhref=#user-group-identifierstitle="Permanent link">¶</a></h2><p>When using volumes (<code>-v</code> flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user <code>PUID</code> and group <code>PGID</code>.</p><p>Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.</p><p>In this instance <code>PUID=1000</code> and <code>PGID=1000</code>, to find yours use <code>id your_user</code> as below:</p><divclass="language-bash highlight"><pre><span></span><code><spanid=__span-3-1><aid=__codelineno-3-1name=__codelineno-3-1href=#__codelineno-3-1></a>id<spanclass=w></span>your_user
</span></code></pre></div><h2id=docker-mods>Docker Mods<aclass=headerlinkhref=#docker-modstitle="Permanent link">¶</a></h2><p><ahref="https://mods.linuxserver.io/?mod=syncthing"title="view available mods for this container."><imgalt="Docker Mods"src="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"></a><ahref="https://mods.linuxserver.io/?mod=universal"title="view available universal mods."><imgalt="Docker Universal Mods"src="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"></a></p><p>We publish various <ahref=https://github.com/linuxserver/docker-mods>Docker Mods</a> 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.</p><h2id=support-info>Support Info<aclass=headerlinkhref=#support-infotitle="Permanent link">¶</a></h2><ul><li><p>Shell access whilst the container is running:</p><divclass="language-bash highlight"><pre><span></span><code><spanid=__span-5-1><aid=__codelineno-5-1name=__codelineno-5-1href=#__codelineno-5-1></a>docker<spanclass=w></span><spanclass=nb>exec</span><spanclass=w></span>-it<spanclass=w></span>syncthing<spanclass=w></span>/bin/bash
</span></code></pre></div></li><li><p>To monitor the logs of the container in realtime:</p><divclass="language-bash highlight"><pre><span></span><code><spanid=__span-6-1><aid=__codelineno-6-1name=__codelineno-6-1href=#__codelineno-6-1></a>docker<spanclass=w></span>logs<spanclass=w></span>-f<spanclass=w></span>syncthing
</span></code></pre></div></li><li><p>Container version number:</p><divclass="language-bash highlight"><pre><span></span><code><spanid=__span-7-1><aid=__codelineno-7-1name=__codelineno-7-1href=#__codelineno-7-1></a>docker<spanclass=w></span>inspect<spanclass=w></span>-f<spanclass=w></span><spanclass=s1>'{{ index .Config.Labels "build_version" }}'</span><spanclass=w></span>syncthing
</span></code></pre></div></li><li><p>Image version number:</p><divclass="language-bash highlight"><pre><span></span><code><spanid=__span-8-1><aid=__codelineno-8-1name=__codelineno-8-1href=#__codelineno-8-1></a>docker<spanclass=w></span>inspect<spanclass=w></span>-f<spanclass=w></span><spanclass=s1>'{{ index .Config.Labels "build_version" }}'</span><spanclass=w></span>lscr.io/linuxserver/syncthing:latest
</span></code></pre></div></li></ul><h2id=updating-info>Updating Info<aclass=headerlinkhref=#updating-infotitle="Permanent link">¶</a></h2><p>Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), we do not recommend or support updating apps inside the container. Please consult the <ahref=#application-setup>Application Setup</a> section above to see if it is recommended for the image.</p><p>Below are the instructions for updating containers:</p><h3id=via-docker-compose>Via Docker Compose<aclass=headerlinkhref=#via-docker-composetitle="Permanent link">¶</a></h3><ul><li><p>Update images:</p><ul><li><p>All images:</p><divclass="language-bash highlight"><pre><span></span><code><spanid=__span-9-1><aid=__codelineno-9-1name=__codelineno-9-1href=#__codelineno-9-1></a>docker-compose<spanclass=w></span>pull
</span></code></pre></div></li></ul></li><li><p>You can also remove the old dangling images:</p><divclass="language-bash highlight"><pre><span></span><code><spanid=__span-13-1><aid=__codelineno-13-1name=__codelineno-13-1href=#__codelineno-13-1></a>docker<spanclass=w></span>image<spanclass=w></span>prune
</span></code></pre></div></li></ul><h3id=via-docker-run>Via Docker Run<aclass=headerlinkhref=#via-docker-runtitle="Permanent link">¶</a></h3><ul><li><p>Update the image:</p><divclass="language-bash highlight"><pre><span></span><code><spanid=__span-14-1><aid=__codelineno-14-1name=__codelineno-14-1href=#__codelineno-14-1></a>docker<spanclass=w></span>pull<spanclass=w></span>lscr.io/linuxserver/syncthing:latest
</span></code></pre></div></li><li><p>Stop the running container:</p><divclass="language-bash highlight"><pre><span></span><code><spanid=__span-15-1><aid=__codelineno-15-1name=__codelineno-15-1href=#__codelineno-15-1></a>docker<spanclass=w></span>stop<spanclass=w></span>syncthing
</span></code></pre></div></li><li><p>Delete the container:</p><divclass="language-bash highlight"><pre><span></span><code><spanid=__span-16-1><aid=__codelineno-16-1name=__codelineno-16-1href=#__codelineno-16-1></a>docker<spanclass=w></span>rm<spanclass=w></span>syncthing
</span></code></pre></div></li><li><p>Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your <code>/config</code> folder and settings will be preserved)</p></li><li><p>You can also remove the old dangling images:</p><divclass="language-bash highlight"><pre><span></span><code><spanid=__span-17-1><aid=__codelineno-17-1name=__codelineno-17-1href=#__codelineno-17-1></a>docker<spanclass=w></span>image<spanclass=w></span>prune
</span></code></pre></div></li></ul><h3id=image-update-notifications-diun-docker-image-update-notifier>Image Update Notifications - Diun (Docker Image Update Notifier)<aclass=headerlinkhref=#image-update-notifications-diun-docker-image-update-notifiertitle="Permanent link">¶</a></h3><divclass="admonition tip"><pclass=admonition-title>Tip</p><p>We recommend <ahref=https://crazymax.dev/diun/>Diun</a> for update notifications. Other tools that automatically update containers unattended are not recommended or supported.</p></div><h2id=building-locally>Building locally<aclass=headerlinkhref=#building-locallytitle="Permanent link">¶</a></h2><p>If you want to make local modifications to these images for development purposes or just to customize the logic:</p><divclass="language-bash highlight"><pre><span></span><code><spanid=__span-18-1><aid=__codelineno-18-1name=__codelineno-18-1href=#__codelineno-18-1></a>git<spanclass=w></span>clone<spanclass=w></span>https://github.com/linuxserver/docker-syncthing.git
</span></code></pre></div><p>The ARM variants can be built on x86_64 hardware using <code>multiarch/qemu-user-static</code></p><divclass="language-bash highlight"><pre><span></span><code><spanid=__span-19-1><aid=__codelineno-19-1name=__codelineno-19-1href=#__codelineno-19-1></a>docker<spanclass=w></span>run<spanclass=w></span>--rm<spanclass=w></span>--privileged<spanclass=w></span>multiarch/qemu-user-static:register<spanclass=w></span>--reset
</span></code></pre></div><p>Once registered you can define the dockerfile to use with <code>-f Dockerfile.aarch64</code>.</p><h2id=versions>Versions<aclass=headerlinkhref=#versionstitle="Permanent link">¶</a></h2><ul><li><strong>05.09.23:</strong> - Rebase to Alpine 3.18.</li><li><strong>01.07.23:</strong> - Deprecate armhf. As announced <ahref=https://www.linuxserver.io/blog/a-farewell-to-arm-hf>here</a></li><li><strong>13.02.23:</strong> - Rebase to Alpine 3.17, migrate to s6v3.</li><li><strong>17.08.22:</strong> - Build on alpine 3.16 for go 1.18).</li><li><strong>03.05.22:</strong> - Rebase to alpine 3.15 (builds on edge for go 1.18).</li><li><strong>05.10.21:</strong> - Rebase to alpine 3.14.</li><li><strong>12.05.21:</strong> - Remove sysctl parameter again</li><li><strong>03.05.21:</strong> - Raise maximum UDP buffer size.</li><li><strong>03.05.21:</strong> - Add port mapping for 22000/udp.</li><li><strong>29.01.21:</strong> - Deprecate <code>UMASK_SET</code> in favor of UMASK in baseimage, see above for more information.</li><li><strong>23.01.21:</strong> - Rebasing to alpine 3.13.</li><li><strong>15.09.20:</strong> - Use go from alpine edge repo to compile. Remove duplicate UMASK env var. Add hostname setting.</li><li><strong>01.06.20:</strong> - Rebasing to alpine 3.12.</li><li><strong>19.12.19:</strong> - Rebasing to alpine 3.11.</li><li><strong>28.06.19:</strong> - Rebasing to alpine 3.10.</li><li><strong>23.03.19:</strong> - Switching to new Base images, shift to arm32v7 tag.</li><li><strong>05.03.19:</strong> - Update Build process for v1.1.0 release.</li><li><strong>22.02.19:</strong> - Rebasing to alpine 3.9.</li><li><strong>16.01.19:</strong> - Add pipeline logic and multi arch.</li><li><strong>30.07.18:</strong> - Rebase to alpine 3.8 and use buildstage.</li><li><strong>13.12.17:</strong> - Rebase to alpine 3.7.</li><li><strong>25.10.17:</strong> - Add env for manual setting of umask.</li><li><strong>29.07.17:</strong> - Simplify build structure as symlinks failing on > 0.14.32</li><li><strong>28.05.17:</strong> - Rebase to alpine 3.6.</li><li><strong>08.02.17:</strong> - Rebase to alpine 3.5.</li><li><strong>01.11.16:</strong> - Switch to compiling latest version from git source.</li><li><strong>14.10.16:</strong> - Add version layer information.</li><li><strong>30.09.16:</strong> - Fix umask.</li><li><strong>09.09.16:</strong> - Add layer badges to README.</li><li><strong>28.08.16:</strong> - Add badges to README.</li><li><strong>11.08.16:</strong> - Rebase to alpine linux.</li><li><strong>18.12.15:</strong> - Initial testing / release (IronicBadger)</li><li><strong>24.09.15:</strong> - Inital dev complete (Lonix)</li></ul><asideclass=md-source-file><spanclass=md-source-file__fact><spanclass=md-icontitle="Last update"><svgxmlns=http://www.w3.org/2000/svgviewbox="0 0 24 24"><pathd="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1-2.1-2M12.5 7v5.2l4 2.4-1 1L11 13V7h1.5M11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2v1.8Z"/></svg></span><spanclass="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">January 13, 2024</span></span><spanclass=md-source-file__fact><spanclass=md-icontitle=Created><svgxmlns=http://www.w3.org/2000/svgviewbox="0 0 24 24"><pathd="M14.47 15.08 11 13V7h1.5v5.25l3.08 1.83c-.41.28-.79.62-1.11 1m-1.39 4.84c-.36.05-.71.08-1.08.08-4.42 0-8-3.58-8-8s3.58-8 8-8 8 3.58 8 8c0 .37-.03.72-.08 1.08.69.1 1.33.32 1.92.64.1-.56.16-1.13.16-1.72 0-5.5-4.5-10-10-10S2 6.5 2 12s4.47 10 10 10c.59 0 1.16-.06 1.72-.16-.32-.59-.54-1.23-.64-1.92M18 15v3h-3v2h3v3h2v-3h3v-2h-3v-3h-2Z"/></svg></span><spanclass="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">February 5, 2019</span></span></aside></article></div><script>vartarget=document.getElementById(location.hash.slice(1));target&&target.name&&(t
