Session mode example (#1)

* chore(contrib): move syncthing-android and SyncTrayzor to old list (syncthing#895)

SyncTrayzor hasn't received any commits in 4 years, and
syncthing-android is officially discontinued, so add them to the old
list.

Fixes syncthing#892.

* chore(contrib): stop calling Syncthing-Fork an "alternative" (syncthing#896)

Co-authored-by: André Colomb <[email protected]>

* Update author list

* fix: word order in ignoring.rst (syncthing#897)

* Update author list

* fix(faq): update info about checking if a device is relaying (syncthing#899)

Devices now still show "Address", even if connected via a relay, so
we change the information to still be accurate.

The "address" that it shows refers to the address of the relay, if
connected via a relay.

* Update author list

* Update version list

* chore(config): simplify list of STUN servers (syncthing#902)

We're removing discontinued STUN servers in syncthing/syncthing#10012,
so we update the documentation accordingly, while simplifying.

* fix(config): update default `stunKeepaliveStartS` (syncthing#903)

Ever since syncthing/syncthing@e714df0,
`stunKeepaliveStartS` has defaulted to 180, and not 24.

* Update version list

* Update author list

* fix(strings): differentiate setup(n) and set(v) up (syncthing#905)

* Update author list

* chore(config): add MetricsWithoutAuth (syncthing#906)

syncthing/syncthing#10045

* fix(relay-v1): state that both A and B are in session mode (fixes syncthing#802)

Permanent protocol and temporary protocol submodes don't exist in
session mode.

---------

Co-authored-by: Pander <[email protected]>
Co-authored-by: André Colomb <[email protected]>
Co-authored-by: Syncthing Release Automation <[email protected]>
Co-authored-by: Wojciech Geisler <[email protected]>
Co-authored-by: Paul Donald <[email protected]>
Co-authored-by: Sébastien WENSKE <[email protected]>

Author: 7 people

AUTHORS

@@ -146,6 +146,7 @@ Marc Laporte <[email protected]> <[email protected]>
 Marcin Orlowski <[email protected]>
 Marco Köpcke <[email protected]>
 marco-m <[email protected]>
+Marcus B Spencer <[email protected]>
 Mariano Rodríguez <[email protected]>
 Marius Volkhart <[email protected]>
 Martchus <[email protected]>
@@ -180,6 +181,8 @@ Oliver Freyermuth <[email protected]>
 Ooker <[email protected]>
 Oskar Okuno <[email protected]>
 Otto Jongerius <[email protected]>
+Pander <[email protected]>
+Paul Donald <[email protected]>
 Paweł Woźniak <[email protected]>
 Peter Badida <[email protected]>
 Peter Butkovic <[email protected]>
@@ -245,6 +248,7 @@ Vincent Rischmann <[email protected]>
 Vium <[email protected]>
 Wieland Hoffmann <[email protected]>
 Willem Oosting <[email protected]>
+Wojciech Geisler <[email protected]>
 Wulf Weich (wweich) <[email protected]> <[email protected]> <[email protected]>
 Yakov Litvin <[email protected]>
 zertrin <[email protected]>

specs/relay-v1.rst

@@ -137,8 +137,11 @@ relayed between the two devices in the session directly.
 Example Exchange
 ^^^^^^^^^^^^^^^^
 
-Client A - Permanent protocol mode
-Client B - Temporary protocol mode
+Client A is the first to join the session.
+
+Client B is the second to join the session.
+
+Both are in session mode.
 
 ===  =======================  ====================== =====================
  #         Client (A)                 Relay                Client (B)

thanks.txt

@@ -1 +1 @@
-Jakob Borg (calmh), Audrius Butkevicius, Syncthing Release Automation, Stefan Tatschner (rumpelsepp), André Colomb (acolomb), Adam Piggott (ProactiveServices), Simon Frei (imsodin), Tomasz Wilczyński, Ross Smith II, Lode Hoste (Zillode), Nate Morrison (nrm21), Max, Lars K.W. Gohlke (lkwg82), JohnVeness, Jerry Jacobs (xor-gate), Scott Klupfel (kluppy), Antony Male (canton7), Marc Laporte, Cedric Staniewski (xduugu), Alexandre Viau (aviau), bt90, Stefan Kuntz (Stefan-Code), Matic Potočnik, Catfriend1, Stephen, Pierre-Alain TORET, Peter Kaminski, raferobinson, Peter Gervai, Peter Badida, alex2108, Austin S. Hemmelgarn, Otto Jongerius, novoid, Tom Hale, Alex Chan, Matt Sieren, Matt Burke (burkemw3), Brian, sa3dany, bugith, C Bhushan, Salim B, Martin Lazarov, camoz, Andrey D (scienmind), Scott Hansen, Martchus, Emil Lundberg, Majed Abdulaziz (majedev), Louis Sautier, Unrud, Leo Arias (elopio), Laurent Etiemble (letiemble), Valerii Hiora, Ken Marsh, Daniel Clay Smith, Wulf Weich (wweich), jodusnodus, Jesse Lucas, 93-infinity, DavidFair, zertrin, Iliyan, hlovdal, Gal Szkolnik, Frank Sachsenheim, Evgeny Kuznetsov, Eric P, Kramoule, MikeLund, Edd Barrett, Duncan Smart, Dominik Schrempf, fejese, Felix Ableitner (Nutomic), fferrann, Filip Harald, Francois-Xavier Gsell (zukoo), Frank Harper, djtm, Function-10, dinosore, Gavrilov Aleksej, Girish Ramakrishnan, graboluk, Gusted, Göran Roseen, Heiko Zuerker (Smiley73), digital, Ian Sullivan, dertalai, iTob191, Ivan Vyshnevskyi, Dennis Gaida, Jakob Egger, James Hartshorn, Jason, Jason Lingohr, jbratu, Jean-Denis Vauguet, Jeroen Evens, David Rimmer (dinosore), Dave Holland, Jimmy Jones, Jip-Hop, Jo Wouters, Daniel O'Connor, John Buckley, Johnny Rock, Daniel Krol, Jonathan Cross, Jonathan Vasquez, JsBergbau, jtagcat, ka7, Karol Pucyński, Kelong Cong (kc1212), dan2468, Kiryuu Sakuya, 2nv2u, krmathis, 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, Mariano Rodríguez, Marius Volkhart, Christian Kellermann, 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, eddsalkield, Mingwei Samuel, Morphy99, Moviuro, MrChenWithCapsule, mseravalli, bestlibre, NCDanielH, ngirard, NickPyz, Nico Stapelbroek, Nicolas Perraut, Benjamin Schmid, 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, 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, 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 Abell, Tim Boudreau, Tobbe, Tobi, Alex Gorichev, AJ ONeal, Tommy van der Vorst, tuathail, twomice, Tyler Kropp, uglygus, Adrian Rudnik, abdeoliveira, Vincent Ardern, Vincent Rischmann, Vium, Wieland Hoffmann, Willem Oosting, Abdelrahman Abdelhafez, Yakov Litvin, 4cdn, zocker-160
+Jakob Borg (calmh), Audrius Butkevicius, Syncthing Release Automation, Stefan Tatschner (rumpelsepp), André Colomb (acolomb), Adam Piggott (ProactiveServices), Simon Frei (imsodin), Tomasz Wilczyński, Ross Smith II, Lode Hoste (Zillode), Nate Morrison (nrm21), Max, Lars K.W. Gohlke (lkwg82), JohnVeness, Jerry Jacobs (xor-gate), Scott Klupfel (kluppy), Antony Male (canton7), Marc Laporte, Marcus B Spencer, Cedric Staniewski (xduugu), Alexandre Viau (aviau), Stefan Kuntz (Stefan-Code), bt90, Matic Potočnik, Salim B, Pierre-Alain TORET, Peter Kaminski, Andrey D (scienmind), Peter Gervai, Peter Badida, alex2108, Austin S. Hemmelgarn, Otto Jongerius, novoid, Tom Hale, Alex Chan, Matt Sieren, Matt Burke (burkemw3), Brian, raferobinson, bugith, C Bhushan, sa3dany, Martin Lazarov, camoz, Catfriend1, Stephen, Martchus, Scott Hansen, Emil Lundberg, Majed Abdulaziz (majedev), Louis Sautier, Unrud, Leo Arias (elopio), Laurent Etiemble (letiemble), Valerii Hiora, Daniel Clay Smith, Ken Marsh, Wulf Weich (wweich), jodusnodus, Jesse Lucas, DavidFair, 93-infinity, zertrin, Iliyan, hlovdal, Gal Szkolnik, Frank Sachsenheim, Evgeny Kuznetsov, Eric P, krmathis, Morphy99, Edd Barrett, Duncan Smart, fejese, Felix Ableitner (Nutomic), fferrann, Filip Harald, Francois-Xavier Gsell (zukoo), Frank Harper, Dominik Schrempf, Function-10, djtm, Gavrilov Aleksej, Girish Ramakrishnan, graboluk, Gusted, Göran Roseen, Heiko Zuerker (Smiley73), dinosore, Ian Sullivan, digital, iTob191, Ivan Vyshnevskyi, dertalai, Jakob Egger, James Hartshorn, Jason, Jason Lingohr, jbratu, Jean-Denis Vauguet, Jeroen Evens, Dennis Gaida, David Rimmer (dinosore), Jimmy Jones, Jip-Hop, Jo Wouters, Dave Holland, John Buckley, Johnny Rock, Daniel O'Connor, Jonathan Cross, Jonathan Vasquez, JsBergbau, jtagcat, ka7, Karol Pucyński, Kelong Cong (kc1212), Daniel Krol, Kiryuu Sakuya, Kramoule, 2nv2u, Kyle Manna, dan2468, Dakota, daftaupe, Leo Famulari, Linger206, Liu Siyuan (liusy182), cron410, Cromefire\_, Luni, Cristian Mircea Messel, Cory Salveson, Marcin Orlowski, Marco Köpcke, marco-m, cmillsa2, Mariano Rodríguez, Marius Volkhart, Christian Kellermann, 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, eddsalkield, Moviuro, MrChenWithCapsule, mseravalli, bestlibre, NCDanielH, ngirard, NickPyz, Nico Stapelbroek, Nicolas Perraut, Benjamin Schmid, 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, 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 Abell, Tim Boudreau, Tobbe, Tobi, Alex Gorichev, AJ ONeal, Tommy van der Vorst, 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

users/address.png

@@ -948,6 +948,9 @@ The following child elements may be present:
     When this setting is disabled, the GUI will not send 401 responses so users
     won't see browser popups prompting for username and password.
 
+.. option:: gui.metricsWithoutAuth
+
+    If true, this allows access to the '/metrics' without authentication.
 
 LDAP Element
 ------------
@@ -1253,15 +1256,7 @@ The ``options`` element contains all other global configuration options.
     :aliases: options.stunServers
 
     Server to be used for STUN, given as ip:port. The keyword ``default`` gets
-    expanded to
-    ``stun.callwithus.com:3478``, ``stun.counterpath.com:3478``,
-    ``stun.counterpath.net:3478``, ``stun.ekiga.net:3478``,
-    ``stun.hitv.com:3478``, ``stun.ideasip.com:3478``,
-    ``stun.internetcalls.com:3478``, ``stun.miwifi.com:3478``,
-    ``stun.schlund.de:3478``,``stun.sipgate.net:10000``,
-    ``stun.sipgate.net:3478``, ``stun.voip.aebc.com:3478``,
-    ``stun.voiparound.com:3478``, ``stun.voipbuster.com:3478``,
-    ``stun.voipstunt.com:3478`` and ``stun.xten.com:3478`` (this is the default).
+    expanded to a set of public STUN servers.
 
     To configure multiple servers, you can either: repeat ``<stunServer>`` tags
     in the configuration file or enter several servers separated by commas in
@@ -1270,7 +1265,7 @@ The ``options`` element contains all other global configuration options.
 .. option:: options.stunKeepaliveStartS
 
     Interval in seconds between contacting a STUN server to maintain NAT
-    mapping. Default is ``24`` and you can set it to ``0`` to disable contacting
+    mapping. Default is ``180`` and you can set it to ``0`` to disable contacting
     STUN servers.  The interval is automatically reduced if needed, down to a
     minimum of :opt:`stunKeepaliveMinS`.
 

users/config.rst

@@ -20,24 +20,18 @@ Cross-platform
 Android
 ~~~~~~~
 
-- `syncthing-android <https://github.com/syncthing/syncthing-android>`_
-
-  A wrapper app for the Syncthing binary.
-
 - `Syncthing-Fork <https://github.com/catfriend1/syncthing-android>`_
 
-  An alternative wrapper app for the Syncthing binary with extended
-  functionality.
+  An Android app for the Syncthing binary with extended functionality.
 
 .. _contrib-windows:
 
 Windows
 ~~~~~~~
 
-- `SyncTrayzor <https://github.com/canton7/SyncTrayzor>`_
+We currently don't have any actively updated Windows-specific GUI wrappers here.
 
-  Windows host for Syncthing.  Installer, auto-start, built-in browser, tray
-  icon, and more.
+.. seealso:: :ref:`Cross-platform GUI Wrappers <contrib-all>`.
 
 macOS
 ~~~~~
@@ -278,6 +272,8 @@ Older, Possibly Unmaintained
    these and you have revived the project, please update this page
    accordingly.
 
+- `syncthing-android <https://github.com/syncthing/syncthing-android>`_ (Archived on 2024-12-03)
+- `SyncTrayzor <https://github.com/canton7/SyncTrayzor>`_
 - `a-sync <https://github.com/davide-imbriaco/a-sync>`_
 - `syncthing-tray-gtk3 <https://github.com/abdeoliveira/syncthing-tray-gtk3>`_ (Archived as of 2023-12-29)
 - `Syncthing-GTK <https://github.com/syncthing-gtk/syncthing-gtk>`_ (Fork from `Kozec <https://github.com/kozec/syncthing-gtk>`_)

users/contrib.rst

@@ -20,10 +20,12 @@ Why is the sync so slow?
 When troubleshooting a slow sync, there are a number of things to check.
 
 First of all, verify that you are not connected via a relay. In the "Remote
-Devices" list on the right side of the GUI, double check that you see
-"Address: <some address>" and *not* "Relay: <some address>".
+Devices" list on the right side of the GUI, double check that the Connection
+Type does *not* start with "Relay".
 
-.. image:: address.png
+Here is an example of a device connected via a relay:
+
+.. image:: relay.png
 
 If you are connected via a relay, this is because a direct connection could
 not be established. Double check and follow the suggestions in
@@ -72,7 +74,7 @@ system's CPU power.
 Why is the setup more complicated than BitTorrent/Resilio Sync?
 ---------------------------------------------------------------
 
-Security over convenience. In Syncthing you have to setup both sides to
+Security over convenience. In Syncthing you have to set up both sides to
 connect two devices. An attacker can't do much with a stolen device ID, because
 you have to add the device on the other side too. You have better control
 where your files are transferred.

users/faq-parts/troubleshooting.rst

@@ -241,7 +241,7 @@ You are probably reading this because you encountered the following error with
 the filesystem watcher on linux:
 
     Failed to start filesystem watcher for folder yourLabel (yourID): failed to
-    setup inotify handler. Please increase inotify limits, see https://docs.syncthing.net/users/faq.html#inotify-limits
+    set up inotify handler. Please increase inotify limits, see https://docs.syncthing.net/users/faq.html#inotify-limits
 
 Linux typically restricts the number of watches per user (usually 8192). If
 you have many directories, you will need to adjust that number.

users/faq-parts/usage.rst

@@ -187,6 +187,6 @@ all files and directories called "foo", ending in a "2" or starting with
 .. versionadded:: 1.19.0
 
    Default patterns can be configured which will take effect when automatically
-   accepting a folder from a remote device.  The GUI suggests same the patterns
+   accepting a folder from a remote device.  The GUI suggests the same patterns
    when adding a folder manually.  In either case, the ``.stignore`` file is
    created with these defaults if none is present yet.

users/ignoring.rst

@@ -1,4 +1,6 @@
 Version,Runtime,Date
+v1.29.4,go1.24.1,2025-03-27
+v1.29.3,go1.24.1,2025-03-07
 v1.29.2,go1.23.4,2025-01-11
 v1.29.1,go1.23.4,2025-01-09
 v1.29.0,go1.23.4,2024-12-30