Skip to content

Commit f3165de

Browse files
authored
chore(config): clarify repeated XML tags vs. comma-separated in GUI (#890)
Add similar text to all repeatable configuration options, mentioning the difference between comma-separated lists in the GUI vs. repeating the tag (without plural "s") in the XML file. Loosely based on the existing sentence for <listenAddress>.
1 parent acbc51c commit f3165de

File tree

1 file changed

+32
-9
lines changed

1 file changed

+32
-9
lines changed

users/config.rst

Lines changed: 32 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -757,6 +757,8 @@ From the following child elements at least one ``address`` child must exist.
757757
<address>dynamic</address>
758758
</device>
759759
760+
In the GUI, multiple values are separated by commas.
761+
760762
.. option:: device.paused
761763

762764
True if synchronization with this devices is (temporarily) suspended.
@@ -766,7 +768,9 @@ From the following child elements at least one ``address`` child must exist.
766768

767769
If given, this restricts connections to this device to only this network.
768770
The mechanism is described in detail in a :doc:`separate chapter
769-
</advanced/device-allowednetworks>`).
771+
</advanced/device-allowednetworks>`). To configure multiple networks, you
772+
can either: repeat ``<allowedNetwork>`` tags in the configuration file or
773+
enter several networks separated by commas in the GUI.
770774

771775
.. option:: device.autoAcceptFolders
772776

@@ -794,6 +798,8 @@ From the following child elements at least one ``address`` child must exist.
794798
Contains the ID of the folder that should be ignored. This folder will
795799
always be skipped when advertised from the containing remote device,
796800
i.e. this will be logged, but there will be no dialog shown in the web GUI.
801+
Multiple ignored folders are represented by repeated ``<ignoredFolder>``
802+
tags in the configuration file.
797803

798804
.. option:: device.maxRequestKiB
799805

@@ -1055,7 +1061,10 @@ The ``options`` element contains all other global configuration options.
10551061
:aliases: options.listenAddresses
10561062

10571063
The listen address for incoming sync connections. See
1058-
:ref:`listen-addresses` for the allowed syntax.
1064+
:ref:`listen-addresses` for the allowed syntax. To configure multiple
1065+
addresses, you can either: repeat ``<listenAddress>`` tags in the
1066+
configuration file or enter several addresses separated by commas in the
1067+
GUI.
10591068

10601069
.. option:: options.globalAnnounceServer
10611070
:aliases: options.globalAnnounceServers
@@ -1066,7 +1075,10 @@ The ``options`` element contains all other global configuration options.
10661075
HTTPS URL. A number of options may be added as query options to the URL:
10671076
``insecure`` to prevent certificate validation (required for HTTP URLs)
10681077
and ``id=<device ID>`` to perform certificate pinning. The device ID to
1069-
use is printed by the discovery server on startup.
1078+
use is printed by the discovery server on startup. To configure multiple
1079+
servers, you can either: repeat ``<globalAnnounceServer>`` tags in the
1080+
configuration file or enter several servers separated by commas in the
1081+
GUI.
10701082

10711083
.. option:: options.globalAnnounceEnabled
10721084

@@ -1206,7 +1218,10 @@ The ``options`` element contains all other global configuration options.
12061218
.. option:: options.alwaysLocalNet
12071219
:aliases: options.alwaysLocalNets
12081220

1209-
Network that should be considered as local given in CIDR notation.
1221+
Network that should be considered as local given in CIDR notation. To
1222+
configure multiple networks, you can either: repeat ``<alwaysLocalNet>``
1223+
tags in the configuration file or enter several networks separated by
1224+
commas in the GUI.
12101225

12111226
.. option:: options.overwriteRemoteDeviceNamesOnConnect
12121227

@@ -1223,7 +1238,9 @@ The ``options`` element contains all other global configuration options.
12231238
:aliases: options.unackedNotificationIDs
12241239

12251240
ID of a notification to be displayed in the web GUI. Will be removed once
1226-
the user acknowledged it (e.g. an transition notice on an upgrade).
1241+
the user acknowledged it (e.g. a transition notice on an upgrade). Multiple
1242+
IDs are represented by repeated ``<unackedNotificationID>`` tags in the
1243+
configuration file.
12271244

12281245
.. option:: options.trafficClass
12291246

@@ -1246,6 +1263,10 @@ The ``options`` element contains all other global configuration options.
12461263
``stun.voiparound.com:3478``, ``stun.voipbuster.com:3478``,
12471264
``stun.voipstunt.com:3478`` and ``stun.xten.com:3478`` (this is the default).
12481265

1266+
To configure multiple servers, you can either: repeat ``<stunServer>`` tags
1267+
in the configuration file or enter several servers separated by commas in
1268+
the GUI.
1269+
12491270
.. option:: options.stunKeepaliveStartS
12501271

12511272
Interval in seconds between contacting a STUN server to maintain NAT
@@ -1316,7 +1337,9 @@ The ``options`` element contains all other global configuration options.
13161337
Feature flags are simple strings that, when added to the configuration, may
13171338
unleash unfinished or still-in-development features to allow early user
13181339
testing. Any supported value will be separately announced with the feature,
1319-
so that regular users do not enable it by accident.
1340+
so that regular users do not enable it by accident. To configure multiple
1341+
flags, you can either: repeat ``<featureFlag>`` tags in the configuration
1342+
file or enter several flags separated by commas in the GUI.
13201343

13211344
.. option:: options.connectionLimitEnough
13221345

@@ -1439,9 +1462,9 @@ Listen Addresses
14391462
^^^^^^^^^^^^^^^^
14401463

14411464
The following address types are accepted in sync protocol listen addresses.
1442-
If you want Syncthing to listen on multiple addresses, you can either: add
1443-
multiple ``<listenAddress>`` tags in the configuration file or enter several
1444-
addresses separated by commas in the GUI.
1465+
If you want Syncthing to listen on multiple addresses, you can either: repeat
1466+
``<listenAddress>`` tags in the configuration file or enter several addresses
1467+
separated by commas in the GUI.
14451468

14461469
Default listen addresses (``default``)
14471470
This is equivalent to ``tcp://0.0.0.0:22000``, ``quic://0.0.0.0:22000``

0 commit comments

Comments
 (0)