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