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
  • Configuration Tuning
  • Prometheus-Style Metrics
  • 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), Tomasz Wilczyński, Audrius Butkevicius, Syncthing Release Automation, Adam Piggott (ProactiveServices), Simon Frei (imsodin), André Colomb (acolomb), Stefan Tatschner (rumpelsepp), Ross Smith II, Lars K.W. Gohlke (lkwg82), Lode Hoste (Zillode), Marcus B Spencer, Max, Nate Morrison (nrm21), JohnVeness, Jerry Jacobs (xor-gate), Scott Klupfel (kluppy), Antony Male (canton7), Alexandre Viau (aviau), Marc Laporte, Cedric Staniewski (xduugu), Stefan Kuntz (Stefan-Code), camoz, Martchus, bt90, bugith, sa3dany, Peter Gervai, Stephen, Peter Badida, Otto Jongerius, Tom Hale, Austin S. Hemmelgarn, novoid, Tommy van der Vorst, Unrud, Matt Sieren, Matt Burke (burkemw3), Matic Potočnik, Martin Lazarov, Brian, Andrey D (scienmind), Emil Lundberg, C Bhushan, Pierre-Alain TORET, Valerii Hiora, raferobinson, Catfriend1, Peter Kaminski, Salim B, Majed Abdulaziz (majedev), Louis Sautier, Wulf Weich (wweich), Leo Arias (elopio), Laurent Etiemble (letiemble), zertrin, alex2108, Ken Marsh, Alex Chan, jodusnodus, Daniel Clay Smith, Jesse Lucas, 93-infinity, Scott Hansen, Iliyan, DavidFair, hlovdal, Gal Szkolnik, Frank Sachsenheim, Evgeny Kuznetsov, Eric P, Kramoule, Mingwei Samuel, Edd Barrett, eddsalkield, Dominik Schrempf, djtm, Ethan, dinosore, fejese, Felix Ableitner (Nutomic), fferrann, Filip Harald, Francois-Xavier Gsell (zukoo), Frank Harper, digital, Function-10, dertalai, Gavrilov Aleksej, Girish Ramakrishnan, graboluk, Gusted, Göran Roseen, Heiko Zuerker (Smiley73), Dennis Gaida, Ian Sullivan, David Rimmer (dinosore), iTob191, Ivan Vyshnevskyi, Dave Holland, Jakob Egger, James Hartshorn, Jason, Jason Lingohr, jbratu, Jean-Denis Vauguet, Jeroen Evens, Daniel O’Connor, Daniel Krol, Jimmy Jones, Jip-Hop, Jo Wouters, dan2468, John Buckley, Johnny Rock, Dan Dascalescu, Jonathan Cross, Jonathan Vasquez, JsBergbau, jtagcat, ka7, kaitlyn, Karol Pucyński, Kelong Cong (kc1212), Dakota, Kiryuu Sakuya, daftaupe, krmathis, Kyle Manna, cron410, Cromefire_, Cristian Mircea Messel, Leo Famulari, Linger206, Liu Siyuan (liusy182), Cory Salveson, cmillsa2, Luni, Christian Kellermann, chaosORCHESTRA, Marcin Orlowski, Marco Köpcke, marco-m, Cameron Steffen, Mariano Rodríguez, Marius Volkhart, calvin ardi, Martin Freund, brad2014, Martin Michlmayr, Marwâne Chahed, Boris Rybalkin, bitinerant, Matt Kantor, bigscoop, Matthew Davis, Matthew Harris, Matthias Braun, bestlibre, Michael Vorburger ⛑️, Mike Nolta, MikeLund, Duncan Smart, Morphy99, Moviuro, MrChenWithCapsule, mseravalli, Benjamin Schmid, NCDanielH, ngirard, NickPyz, Nico Stapelbroek, Nicolas Perraut, Benjamin Masters, nware-lab, Oliver Freyermuth, Ooker, Oskar Okuno, Arthur Lutz, Pander, Paul Donald, Paweł Woźniak, arneko, Peter Butkovic, Peter Dave Hello, Antoni Sawicki, André-Patrick Bubel, Phil Davis, Andrew Colin Kissa, Pitxyoki, Quentin Hibon, Andrej Shadura, Rahmi Pruitt, Rajshekhar K, realtobman, Reto Kaiser, RichardUUU, Rikiub%, rollbrettler, Romain Gay, Andreas Gohr, rrosini, Andreas Deininger, Anderson Mesquita (andersonvom), Samuel Li, Samuel Smoker, Sanjeev Gupta, sapient_cogbag, schnappijedi, Anatoli Babenia, Amin Vakil, Sergio Livi, alexvoda, sliterok, Stefaan Ghysels, Alexandre Maurer, Alexander Graf (alex2108), StefanKopieczek, Stefano Probst, Alexander Baumann, Alex Scammon, Sébastien Wains, Sébastien WENSKE, Tamás Sallai, terrycloth, terzinnorbert, theincogtion, Thomas Dalichow, Thomas De Rocker, Thovthe, Tim Abell, Tim Boudreau, Tobbe, Tobi, Alex Gorichev, AJ ONeal, Adrian Rudnik, tuathail, twomice, Tyler Kropp, uglygus, abdeoliveira, Abdelrahman Abdelhafez, Vincent Ardern, Vincent Rischmann, Vium, Wieland Hoffmann, Willem Oosting, Wojciech Geisler, 4cdn, Yakov Litvin, 2nv2u, zocker-160