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