diff --git a/users/config.rst b/users/config.rst index c1df3b140..f18776812 100644 --- a/users/config.rst +++ b/users/config.rst @@ -49,8 +49,8 @@ The following shows the default configuration file: .. code-block:: xml - - + + 1 @@ -62,34 +62,35 @@ The following shows the default configuration file: 0 0 0 - 0 + -1 + false + false
dynamic
 -
127.0.0.1:52620
+
127.0.0.1:8384
k1dnz1Dd0rzTBjjFFh7CXPnrF12C49B1 + default - tcp://0.0.0.0:22000 + default default true true 21027 [ff12::8384]:21027 - dynamic+https://relays.syncthing.net/endpoint 0 0 60 true 10 - false true - true - 60 - 30 - 10 + true + 60 + 30 + 10 0 https://data.syncthing.net/newdata @@ -98,13 +99,14 @@ The following shows the default configuration file: true 12 24 - true + false 5 true false - 0 1 https://api.github.com/repos/syncthing/syncthing/releases?per_page=30 + false + 10 @@ -122,7 +124,7 @@ Folder Element .. code-block:: xml - + 1 @@ -134,7 +136,9 @@ Folder Element 0 0 0 - 0 + -1 + false + false One or more ``folder`` elements must be present in the file. Each element @@ -145,17 +149,22 @@ id The folder ID, must be unique. (mandatory) label - The label of a folder is a human readable and a descriptive local name. Can be different on each device. (optional) + The label of a folder is a human readable and descriptive local name. + Can be different on each device. (optional) path The path to the directory where the folder is stored on this device; not sent to other devices. (mandatory) type - - ``readonly`` if the folder is in *master* mode, it will not be modified by - syncthing on this device. - - - ``readwrite`` if the folder is in default mode. Sending local and accepting remote changes. + Controls how the folder is handled by Syncthing. Possible values are: + + readwrite + The folder is in default mode. Sending local and accepting remote changes. + + readonly + The folder is in "master" mode -- it will not be modified by + syncthing on this device. rescanIntervalS The rescan interval, in seconds. Can be set to zero to disable when external @@ -229,6 +238,16 @@ maxConflicts The default, -1, means an unlimited number. Setting this to zero disables conflict copies altogether. +disableSparseFiles + By default, blocks containing all zeroes are not written, causing files + to be sparse on filesystems that support the concept. When set to true, + sparse files will not be created. + +disableTempIndexes + By default, devices exchange information about blocks available in + transfers that are still in progress. When set to true, such information + is not exchanged for this folder. + Device Element -------------- @@ -320,6 +339,7 @@ GUI Element
127.0.0.1:8384
l7jSbCqPD95JYZ0g8vi4ZLAMg3ulnN1b + default @@ -335,6 +355,9 @@ tls be redirected to HTTPS. When this is set to ``false``, TLS connections are still possible but it is not mandatory. +theme + The name of the theme to use. + The following child elements may be present: address @@ -343,14 +366,10 @@ address IPv4 address and port (``127.0.0.1:8384``) The address and port is used as given. - IPv4 wildcard and port (``tcp4://0.0.0.0``, ``tcp4://:8384``) - These are equivalent and will result in Syncthing listening on all interfaces via IPv4 only. IPv6 address and port (``[::1]:8384``) The address and port is used as given. The address must be enclosed in square brackets. - IPv6 wildcard and port (``tcp6://[::]:8384``, ``tcp6://:8384``) - These are equivalent and will result in Syncthing listening on all interfaces via IPv6 only. Wildcard and port (``0.0.0.0:12345``, ``[::]:12345``, ``:12345``) These are equivalent and will result in Syncthing listening on all @@ -371,24 +390,22 @@ Options Element .. code-block:: xml - tcp://0.0.0.0:22000 + default default true true 21027 [ff12::8384]:21027 - dynamic+https://relays.syncthing.net/endpoint 0 0 60 true 10 - false true - true - 60 - 30 - 10 + true + 60 + 30 + 10 0 https://data.syncthing.net/newdata @@ -397,22 +414,21 @@ Options Element true 12 24 - true + false 5 true false - 0 1 https://api.github.com/repos/syncthing/syncthing/releases?per_page=30 + false + 10 The ``options`` element contains all other global configuration options. listenAddress - The listen address for incoming sync connections. See the ``address`` - element under the `GUI Element`_ for allowed syntax, with the addition - that the address must have a protocol scheme prefix. Currently ``tcp://`` - is the only supported protocol scheme. + The listen address for incoming sync connections. See + `Listen Addresses`_ for allowed syntax. globalAnnounceServer A URI to a global announce (discovery) server, or the word ``default`` to @@ -459,25 +475,20 @@ relaysEnabled relayReconnectIntervalM Sets the interval, in minutes, between relay reconnect attempts. -relayWithoutGlobalAnn - When set to true, relay connections will be attempted even when global - discovery is disabled. This is useful only in the case where devices are - known to be connected to the same relays. The default is ``false``. - startBrowser Whether to attempt to start a browser to show the GUI when Syncthing starts. -upnpEnabled - Whether to attempt to perform an UPnP port mapping for incoming sync - connections. +natEnabled + Whether to attempt to perform an UPnP and NAT-PMP port mapping for + incoming sync connections. -upnpLeaseMinutes +natLeaseMinutes Request a lease for this many minutes; zero to request a permanent lease. -upnpRenewalMinutes +natRenewalMinutes Attempt to renew the lease after this many minutes. -upnpTimeoutSeconds +natTimeoutSeconds When scanning for UPnP devices, wait this long for responses. urAccepted @@ -514,8 +525,9 @@ keepTemporariesH are kept, the data they contain need not be transferred again. cacheIgnoredFiles - Whether to cache the results of ignore pattern evaluation. Performance at - the price of memory. + Whether to cache the results of ignore pattern evaluation. Performance + at the price of memory. Defaults to ``false`` as the cost for evaluating + ignores is usually not significant. progressUpdateIntervalS How often in seconds the progress of ongoing downloads is made available to @@ -547,6 +559,54 @@ minHomeDiskFreePct releasesURL The URL from which release information is loaded, for automatic upgrades. +overwriteRemoteDeviceNamesOnConnect + If set, device names will always be overwritten with the name given by + remote on each connection. By default, the name that the remote device + announces will only be adopted when a name has not already been set. + +tempIndexMinBlocks + When exchanging index information for incomplete transfers, only take + into account files that have at least this many blocks. + +Listen Addresses +^^^^^^^^^^^^^^^^ + +The following address types are accepted in sync protocol listen addresses: + +TCP wildcard and port (``tcp://0.0.0.0:22000``, ``tcp://:22000``) + These are equivalent and will result in Syncthing listening on all + interfaces, IPv4 and IPv6, on the specified port. + +TCP IPv4 wildcard and port (``tcp4://0.0.0.0:22000``, ``tcp4://:22000``) + These are equivalent and will result in Syncthing listening on all + interfaces via IPv4 only. + +TCP IPv4 address and port (``tcp4://192.0.2.1:22000``) + These are equivalent and will result in Syncthing listening on the + specified address and port only. + +TCP IPv6 wildcard and port (``tcp6://[::]:22000``, ``tcp6://:22000``) + These are equivalent and will result in Syncthing listening on all + interfaces via IPv6 only. + +TCP IPv6 address and port (``tcp6://[2001:db8::42]:22000``) + These are equivalent and will result in Syncthing listening on the + specified address and port only. + +Static relay address (``relay://192.0.2.42:22067?id=abcd123...``) + Syncthing will connect to and listen for incoming connections via the + specified relay address. + + .. todo:: Document available URL parameters. + +Dynamic relay pool (``dynamic+https://192.0.2.42/relays``) + Syncthing will fetch the specified HTTPS URL, parse it for a JSON payload + describing relays, select a relay from the available ones and listen via + that as if specified as a static relay above. + + .. todo:: Document available URL parameters. + + Syncing Configuration files --------------------------- @@ -564,3 +624,4 @@ If you'd like to sync your home folder in non-master mode, you may add the folder that stores the configuration files to the :ref:`ignore list `. If you'd also like to backup your configuration files, add another folder in master mode for just the configuration folder. +