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