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