Welcome to Syncthing’s documentation!

As a new user, the getting started guide is a good place to start, then perhaps moving on to the FAQ. If you run into trouble getting devices to connect to each other, the page about firewall setup explains the networking necessary to get it to work.

As a developer looking to get started with a contribution, see how to build, how to debug and the contribution guidelines. This documentation site can be edited on GitHub.

Contact

• If you’re looking for specific people to talk to, check out the Project Presentation.

• To report bugs or request features, please use the issue tracker. Before you do so, make sure you are running the latest version, and please do a quick search to see if the issue has already been reported.

  

• To report security issues, please follow the instructions on the Security page.

• To get help and support, discuss scenarios, or just connect with other users and developers you can head over to the friendly forum.

• For other concerns you may reach out to members of the maintainers, currently @calmh, @AudriusButkevicius and @imsodin.

• Introduction

  • Getting Started
  • An Intro to the GUI
  • Project Presentation
• Usage
  • Command Line Operation
  • FAQ
  • Versions & Releases
  • Configuration
  • Advanced Configuration
  • Folder Types
  • Introducer Configuration
  • The GUI Listen Address
  • LDAP Authentication
  • Understanding Synchronization
  • Untrusted (Encrypted) Devices
  • Firewall Setup
  • Relaying
  • Using Proxies
  • SSH Tunneling
  • Ignoring Files
  • File Versioning
  • Syncthing Discovery Server
  • Syncthing Relay Server
  • Custom Upgrade Server
  • Starting Syncthing Automatically
  • Community Contributions
  • Profiling
  • Reverse Proxy Setup
  • Security Principles
  • Automatic Crash Reporting
• Development
  • Introduction
  • Working on the Web GUI
  • Building Syncthing
  • Contribution Guidelines
  • Debugging Syncthing
  • Automatic Crash Reporting for Developers
  • Understanding Device IDs
  • Syncthing Infrastructure
  • Issue Management
  • Creating a Release
  • Release Signing
  • REST API
  • Event API
  • HTTP Utility Services API
• Specifications
  • Block Exchange Protocol v1
  • Global Discovery v3
  • Local Discovery Protocol v4
  • Relay Protocol v1
  • Untrusted Device Encryption

Thanks

We thank all the documentation contributors for their hard work:

Jakob Borg (calmh), Audrius Butkevicius, Adam Piggott (ProactiveServices), Simon Frei (imsodin), Stefan Tatschner (rumpelsepp), Jerry Jacobs (xor-gate), JohnVeness, Lars K.W. Gohlke (lkwg82), Tomasz Wilczyński, Nate Morrison (nrm21), Lode Hoste (Zillode), Stefan Kuntz (Stefan-Code), Scott Klupfel (kluppy), Cedric Staniewski (xduugu), Alexandre Viau (aviau), Antony Male (canton7), hlovdal, André Colomb (acolomb), Andrey D (scienmind), Austin S. Hemmelgarn, Stephen, Scott Hansen, sa3dany, Pierre-Alain TORET, Brian, bugith, C Bhushan, Peter Gervai, Peter Badida, raferobinson, Otto Jongerius, novoid, Tom Hale, Max, Matt Sieren, Matt Burke (burkemw3), Matic Potočnik, Martin Lazarov, Martchus, Marc Laporte, Majed Abdulaziz (majedev), Louis Sautier, Iliyan, Laurent Etiemble (letiemble), Unrud, Ken Marsh, alex2108, jodusnodus, Valerii Hiora, Alex Chan, Leo Arias (elopio), Frank Sachsenheim, Gal Szkolnik, Wulf Weich (wweich), Jesse Lucas, 4cdn, Heiko Zuerker (Smiley73), graboluk, Ian Sullivan, Girish Ramakrishnan, iTob191, Gavrilov Aleksej, Jason, Jason Lingohr, jbratu, Frank Harper, Francois-Xavier Gsell (zukoo), Felix Ableitner (Nutomic), Jimmy Jones, Jo Wouters, fejese, John Buckley, Johnny Rock, Evgeny Kuznetsov, Jonathan Cross, Jonathan Vasquez, ka7, Karol Pucyński, Kelong Cong (kc1212), Emil Lundberg, Kiryuu Sakuya, Kramoule, krmathis, Kyle Manna, eddsalkield, Edd Barrett, Jean-Denis Vauguet, Leo Famulari, Liu Siyuan (liusy182), Duncan Smart, Dominik Schrempf, Luni, djtm, dinosore, Marcin Orlowski, marco-m, Mariano Rodríguez, Marius Volkhart, David Rimmer (dinosore), Martin Freund, Daniel O’Connor, Martin Michlmayr, Marwâne Chahed, Dakota, daftaupe, Matt Kantor, cron410, Matthew Davis, Matthew Harris, Cromefire_, Mike Nolta, MikeLund, Mingwei Samuel, Morphy99, Moviuro, Cristian Mircea Messel, NCDanielH, NickPyz, Nico Stapelbroek, Cory Salveson, Oliver Freyermuth, Christian Kellermann, Paweł Woźniak, Cameron Steffen, Peter Butkovic, Peter Dave Hello, calvin ardi, Phil Davis, Boris Rybalkin, Pitxyoki, zertrin, Rajshekhar K, Reto Kaiser, rollbrettler, Romain Gay, bigscoop, Samuel Li, Samuel Smoker, Sanjeev Gupta, schnappijedi, bestlibre, Benjamin Masters, Sergio Livi, Arthur Lutz, Stefaan Ghysels, arneko, André-Patrick Bubel, StefanKopieczek, Stefano Probst, Andrew Colin Kissa, Sébastien Wains, Andreas Gohr, terzinnorbert, theincogtion, Thomas Dalichow, Thovthe, Tim Boudreau, Tobbe, Anderson Mesquita (andersonvom), alexvoda, tuathail, twomice, Tyler Kropp, uglygus, Alexander Graf (alex2108), Alex Scammon, Vincent Ardern, Vincent Rischmann, Vium, Wieland Hoffmann, Willem Oosting, Adrian Rudnik, terrycloth