Skip to content
Documentation site
Python Makefile Batchfile CSS Shell HTML
Branch: master
Clone or download

Latest commit

Pitxyoki users/stdiscosrv: Add Apache Reverse Proxy config to the discosrv doc…
…umentation (#517)

* users/stdiscosrv: Add Apache Reverse Proxy config to the discosrv documentation

* users/stdiscosrv: Improve documentation for proxying the discovery server with Apache httpd.

* Move the Apache configurations further down in the discovery server
  configuration page;
* Make it explicit what is required and what may be optional;
* Improve the information regarding modules that have to be enabled beforehand
  for proxying to work.

* users/stdiscosrv: Minor phrasing improvements, addressing review comments

* users/stdiscosrv: Further clarifications about when the id parameter is required when the discovery server is behind a proxy
Latest commit b544538 May 16, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
_ext all: Use Alabaster theme Nov 13, 2019
_static Prevent horizontal overflowing on mobile Jan 2, 2020
_templates all: Use Alabaster theme Nov 13, 2019
advanced advanced: Document disableFsync May 12, 2020
dev all: Unmention snaps Apr 14, 2020
draft users/syncing: Add article describing the underlying mechanisms Apr 29, 2016
events events: Lowercase data keys for DownloadProgress event (#481) Jan 2, 2020
includes env-vars: Fix recheck interval May 5, 2020
intro Syncthing-GTK links and such Mar 2, 2020
rest rest: Update db/completion and db/status examples with total properti… Apr 6, 2020
specs specs/relay-v1: Clarify relay spec (fixes #488) (#489) Feb 5, 2020
users users/stdiscosrv: Add Apache Reverse Proxy config to the discosrv doc… May 16, 2020
.gitignore Spacing, deploy May 28, 2015
AUTHORS thanks: With nicknames May 12, 2020
Makefile Allow SPHINXBUILD to be read from the environment. (#461) Jul 16, 2019
README.rst Build script, Docker note in README Feb 4, 2018
conf.py Update donations URL Dec 15, 2019
docker-build.sh script: Do normal build (not versioned) Mar 22, 2019
index.rst index: Thank the docs authors May 11, 2020
issues.png optimize png images using zopflipng Jun 29, 2016
make.bat Initial May 28, 2015
netlify.toml Better pdf redirect Jan 16, 2020
refresh-authors.sh thanks: With nicknames May 12, 2020
requirements.txt Add Netlify config Jan 15, 2020
runtime.txt Add Netlify config Jan 15, 2020
thanks.txt thanks: With nicknames May 12, 2020

README.rst

Syncthing Docs

This repo is the source behind https://docs.syncthing.net/.

Editing

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 https://github.com/syncthing/docs.git
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:

./docker-build.sh html

Structure

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

License

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

You can’t perform that action at this time.