Skip to content


Switch branches/tags

Latest commit

Removed the filter `-i eth0' since predictable network interface names like ens2 are nowadays common. This makes it easier for most of the users setting up a working relay server on Port 443, since copy and paste now works. More advanced users with multiple NICs should be familiar with iptables more and can add the NIC filter on their own.

Git stats


Failed to load latest commit information.
Latest commit message
Commit time

Syncthing Docs

This repo is the source behind


To edit the documentation you need a GitHub account. Once you have created one and logged in, you can edit any page by navigating to the corresponding file and clicking the edit (pen) icon. This will create a so called "fork" and a "pull request", which will be approved by one of the existing documentation team members. Once you have made a contribution or two, you can be added to the documentation team and perform edits without requiring approval.

In the long run, learning to use Git and running Sphinx on your computer is beneficial.

First steps to run it locally:

git clone
pip install -U Sphinx
cd docs
make html
# open _build/html/index.html

You can also use our Docker image to build the documentation, which is the same thing the build server does in the end:

./ html


The documentation is divided into an index page (index.rst) and various subsections. The sections are:

  • Introductory information in intro.
  • Information for users in users.
  • Information for developers in dev.

The documentation uses the rst format. For a starting point check out the reStructuredText Primer.


All documentation and protocol specifications are licensed under the Creative Commons Attribution 4.0 International License.