Update configuration description

This commit is contained in:
Jakob Borg
2015-06-14 23:55:40 +02:00
parent d07c5b07b1
commit 8b2d790131
+307 -91
View File
@@ -1,16 +1,12 @@
Syncthing Configuration Syncthing Configuration
======================= =======================
.. warning::
This page may be outdated and requires review.
Attributes have been added that are not documented.
Synopsis Synopsis
-------- --------
:: ::
$HOME/.config/syncthing/config.xml $HOME/.config/syncthing
$HOME/Library/Application Support/Syncthing $HOME/Library/Application Support/Syncthing
%AppData%/Syncthing %AppData%/Syncthing
%localappdata%/Syncthing %localappdata%/Syncthing
@@ -21,23 +17,25 @@ Description
Syncthing uses a single directory to store configuration, crypto keys Syncthing uses a single directory to store configuration, crypto keys
and index caches. The location defaults to ``$HOME/.config/syncthing`` and index caches. The location defaults to ``$HOME/.config/syncthing``
(Unix-like), ``$HOME/Library/Application Support/Syncthing`` (Mac), (Unix-like), ``$HOME/Library/Application Support/Syncthing`` (Mac),
``%AppData%/Syncthing`` (Windows XP) or ``%localappdata%/Syncthing`` ``%AppData%/Syncthing`` (Windows XP) or ``%LocalAppData%/Syncthing``
(Windows 7/8). It can be changed at runtime using the ``-home`` flag. In this (Windows 7+). It can be changed at runtime using the ``-home`` flag. In this
directory the following files are located: directory the following files are located:
cert.pem
The device's RSA public key, named "cert" for legacy reasons.
key.pem
The device's RSA private key. This needs to be protected.
config.xml config.xml
The configuration file, in XML format. The configuration file, in XML format.
https-cert.pem
The certificate for HTTPS GUI connections. cert.pem, key.pem
https-key.pem The device's RSA public and private key. These form the basis for the
The key for HTTPS GUI connections. device ID. The key must be kept private.
index/
https-cert.pem, https-key.pem
The certificate and key for HTTPS GUI connections. These may be replaced
with a custom certificate for HTTPS as desired.
index-v0.11.0.db (and similar)
A directory holding the database with metadata and hashes of the files A directory holding the database with metadata and hashes of the files
currently on disk and available from peers. currently on disk and available from peers.
csrftokens.txt csrftokens.txt
A list of recently issued CSRF tokens (for protection against browser cross A list of recently issued CSRF tokens (for protection against browser cross
site request forgery). site request forgery).
@@ -49,143 +47,361 @@ The following is shows the default configuration file:
.. code-block:: xml .. code-block:: xml
<configuration version="2"> <configuration version="10">
<folder id="default" directory="/Users/jb/Sync" ro="false" ignorePerms="false"> <folder id="default" path="/Users/jb/Sync" ro="false" rescanIntervalS="60" ignorePerms="false" autoNormalize="false">
<device id="GXN5ECCWTA2B7EB5FXYL5OWGOADX5EF5VNJAQSIBAY6XHJ24BNOA"></device> <device id="5SYI2FS-LW6YAXI-JJDYETS-NDBBPIO-256MWBO-XDPXWVG-24QPUM4-PDW4UQU"></device>
<versioning></versioning>
<copiers>0</copiers>
<pullers>0</pullers>
<hashers>0</hashers>
<order>random</order>
</folder> </folder>
<device id="GXN5ECCWTA2B7EB5FXYL5OWGOADX5EF5VNJAQSIBAY6XHJ24BNOA" name="jborg-mbp"> <device id="5SYI2FS-LW6YAXI-JJDYETS-NDBBPIO-256MWBO-XDPXWVG-24QPUM4-PDW4UQU" name="syno" compression="metadata" introducer="false">
<address>dynamic</address> <address>dynamic</address>
</device> </device>
<gui enabled="true" tls="true"> <gui enabled="true" tls="false">
<address>127.0.0.1:54096</address> <address>127.0.0.1:8384</address>
<user>jb</user> <apikey>l7jSbCqPD95JYZ0g8vi4ZLAMg3ulnN1b</apikey>
<password>$2a$10$EKaTIcpz2...</password>
<apikey>O80CDOJ9LVUVCMHFK2OJDO4T882735</apikey>
</gui> </gui>
<options> <options>
<listenAddress>:54097</listenAddress> <listenAddress>0.0.0.0:56847</listenAddress>
<globalAnnounceServer>announce.syncthing.net:22025</globalAnnounceServer> <globalAnnounceServer>udp4://announce.syncthing.net:22026</globalAnnounceServer>
<globalAnnounceServer>udp6://announce-v6.syncthing.net:22026</globalAnnounceServer>
<globalAnnounceEnabled>true</globalAnnounceEnabled> <globalAnnounceEnabled>true</globalAnnounceEnabled>
<localAnnounceEnabled>true</localAnnounceEnabled> <localAnnounceEnabled>true</localAnnounceEnabled>
<parallelRequests>16</parallelRequests> <localAnnouncePort>21025</localAnnouncePort>
<localAnnounceMCAddr>[ff32::5222]:21026</localAnnounceMCAddr>
<maxSendKbps>0</maxSendKbps> <maxSendKbps>0</maxSendKbps>
<rescanIntervalS>60</rescanIntervalS> <maxRecvKbps>0</maxRecvKbps>
<reconnectionIntervalS>60</reconnectionIntervalS> <reconnectionIntervalS>60</reconnectionIntervalS>
<maxChangeKbps>10000</maxChangeKbps>
<startBrowser>true</startBrowser> <startBrowser>true</startBrowser>
<upnpEnabled>true</upnpEnabled> <upnpEnabled>true</upnpEnabled>
<upnpLeaseMinutes>60</upnpLeaseMinutes>
<upnpRenewalMinutes>30</upnpRenewalMinutes>
<upnpTimeoutSeconds>10</upnpTimeoutSeconds>
<urAccepted>0</urAccepted> <urAccepted>0</urAccepted>
<urUniqueID></urUniqueID>
<restartOnWakeup>true</restartOnWakeup>
<autoUpgradeIntervalH>12</autoUpgradeIntervalH>
<keepTemporariesH>24</keepTemporariesH>
<cacheIgnoredFiles>true</cacheIgnoredFiles>
<progressUpdateIntervalS>5</progressUpdateIntervalS>
<symlinksEnabled>true</symlinksEnabled>
<limitBandwidthInLan>false</limitBandwidthInLan>
<databaseBlockCacheMiB>0</databaseBlockCacheMiB>
</options> </options>
</configuration> </configuration>
configuration Configuration Element
~~~~~~~~~~~~~ ---------------------
This is the root element. This is the root element.
version version
The config version. The current version is ``2``. The config version. Increments whenever a change is made that requires migration from previous formats.
folder Folder Element
~~~~~~ --------------
One or more ``folder`` elements must be present in the file. Each .. code-block:: xml
element describes one folder.
Within the ``folder`` element one or more ``device`` element should be <folder id="default" path="/Users/jb/Sync" ro="false" rescanIntervalS="60" ignorePerms="false" autoNormalize="false">
present. These must contain the ``id`` attribute and nothing else. <device id="5SYI2FS-LW6YAXI-JJDYETS-NDBBPIO-256MWBO-XDPXWVG-24QPUM4-PDW4UQU"></device>
Mentioned devices are those that will be sharing the folder in question. <versioning></versioning>
Each mentioned device must have a separate ``device`` element later in <copiers>0</copiers>
the file. It is customary that the local device ID is included in all <pullers>0</pullers>
repositories. Syncthing will currently add this automatically if it is <hashers>0</hashers>
not present in the configuration file. <order>random</order>
</folder>
One or more ``folder`` elements must be present in the file. Each element
describes one folder. The following attributes may be set on the ``folder``
element:
id id
The folder ID, must be unique. (mandatory) The folder ID, must be unique. (mandatory)
directory
The directory where the folder is stored on this path
The oath to the directory where the folder is stored on this
device; not sent to other devices. (mandatory) device; not sent to other devices. (mandatory)
ro ro
True if the folder is read only (will not be modified by Syncthing) on this True if the folder is read only (Master mode; will not be modified by
device. (optional, defaults to ``false``) Syncthing) on this device.
rescanIntervalS
The rescan interval, in seconds.
ignorePerms ignorePerms
True if the folder should `ignore permissions <http://forum.syncthing.net/t/263>`_. True if the folder should ignore permissions.
autoNormalize
Automatically correct UTF-8 normalization errors found in file names.
The following child elements may exist:
device device
~~~~~~ These must have the ``id`` attribute and nothing else. Mentioned devices
are those that will be sharing the folder in question. Each mentioned
device must have a separate ``device`` element later in the file. It is
customary that the local device ID is included in all repositories.
Syncthing will currently add this automatically if it is not present in
the configuration file.
One or more ``device`` elements must be present in the file. Each versioning
element describes a device participating in the cluster. It is customary Specifies a versioning configuration.
to include a ``device`` element for the local device; Syncthing will
currently add one if it is not present. .. note:: Needs explanation.
copiers, pullers, hashers
The number of copier, puller and hasher routines to use, or zero for the
system determined optimum. These are low level performance options for
advanced users only; do not change unless requested to or you've actually
read and understood the code yourself. :)
order
The order in which needed files should be pulled from the cluster. The possibles values are:
random
Pull files in random order. This optimizes for balancing resources among the devices in a cluster.
alphabetic
Pull files ordered by file name alphabetically.
smallestFirst, largestFirst
Pull files ordered by file size; smallest and largest first respectively.
oldestFirst, newestFirst
Pull files ordered by modification time; oldest and newest first respectively.
Device Element
--------------
.. code-block:: xml
<device id="5SYI2FS-LW6YAXI-JJDYETS-NDBBPIO-256MWBO-XDPXWVG-24QPUM4-PDW4UQU" name="syno" compression="metadata" introducer="false">
<address>dynamic</address>
</device>
One or more ``device`` elements must be present in the file. Each element
describes a device participating in the cluster. It is customary to include a
``device`` element for the local device; Syncthing will currently add one if
it is not present. The following attributes may be set on the ``device``
element:
id id
The device ID. This must be written in canonical form, that is without any The device ID. This must be written in canonical form, that is without any
spaces or dashes. (mandatory) spaces or dashes. (mandatory)
name name
A friendly name for the device. (optional) A friendly name for the device. (optional)
address
The address section is only valid inside of ``device`` elements. It contains
a single address, on one of the following forms:
- IPv4 addresses, IPv6 addresses within brackets, or DNS names, all compression
optionally followed by a port number. Whether to use protocol compression when sending messages to this device.
- ``dynamic``: The address will be resolved using discovery. The possible values are:
gui metadata
~~~ Compress metadata packets, such as index information. Metadata is
usually very compression friendly so this is a good default.
There must be *exactly one* ``gui`` element. always
Compress all packets, including file data. This is recommended if the
folders contents are mainly compressible data such as documents or
text files.
never
Disable all compression.
introducer
Set to true if this device should be trusted as an introducer, i.e. we
should copy their list of devices per folder when connecting.
In addition, one or more ``address`` child elements must be present. Each
contains an address to use when attempting to connect to this device and will
be tried in order. Accepted formats are:
IPv4 address (``192.0.2.42``)
The default port (22000) is used.
IPv4 address and port (``192.0.2.42:12345``)
The address and port is used as given.
IPv6 address (``2001:db8::23:42``)
The default port (22000) is used.
IPv6 address and port (``[2001:db8::23:42]:12345``)
The address and port is used as given. The address must be enclosed in angled brackets.
``dynamic``
The word ``dynamic`` means to use local and global discovery to find the device.
GUI Element
-----------
.. code-block:: xml
<gui enabled="true" tls="false">
<address>127.0.0.1:8384</address>
<apikey>l7jSbCqPD95JYZ0g8vi4ZLAMg3ulnN1b</apikey>
</gui>
There must be exactly one ``gui`` element. The GUI configuration is also used
by the :ref:`rest-api` and the :ref:`event-api`. The following attributes may
be set on the ``gui`` element:
enabled enabled
``true``/``false`` If not ``true``, the GUI and API will not be started.
tls tls
``true``/``false``: If true then the GUI will use HTTPS. If set to ``true``, TLS (HTTPS) will be enforced. Non-HTTPS requests will
be redirected to HTTPS. When this is set to ``false``, TLS connections are
still possible but it is not mandatory.
The following child elements may be present:
address address
One or more address elements must be present, containing an ``ip:port`` Set the listen addresses. One or more address elements must be present.
listen address. Allowed address formats are:
IPv4 address and port (``127.0.0.1:8384``)
The address and port is used as given.
IPv6 address and port (``[::1]:8384``)
The address and port is used as given. The address must be enclosed in angled brackets.
Wildcard and port (``0.0.0.0:12345``, ``[::]:12345``, ``:12345``)
These are equivalent and will result in Syncthing listening on all interfaces and both IPv4 and IPv6.
username username
Set to require authentication. Set to require authentication.
password password
Contains the bcrypt hash of the real password. Contains the bcrypt hash of the real password.
apikey apikey
If set, this is the API key that enables usage of the REST interface. If set, this is the API key that enables usage of the REST interface.
Additionally, there must be *exactly one* ``options`` element. It contains the Options Element
following configuration settings as children: ---------------
.. code-block:: xml
<options>
<listenAddress>0.0.0.0:56847</listenAddress>
<globalAnnounceServer>udp4://announce.syncthing.net:22026</globalAnnounceServer>
<globalAnnounceServer>udp6://announce-v6.syncthing.net:22026</globalAnnounceServer>
<globalAnnounceEnabled>true</globalAnnounceEnabled>
<localAnnounceEnabled>true</localAnnounceEnabled>
<localAnnouncePort>21025</localAnnouncePort>
<localAnnounceMCAddr>[ff32::5222]:21026</localAnnounceMCAddr>
<maxSendKbps>0</maxSendKbps>
<maxRecvKbps>0</maxRecvKbps>
<reconnectionIntervalS>60</reconnectionIntervalS>
<startBrowser>true</startBrowser>
<upnpEnabled>true</upnpEnabled>
<upnpLeaseMinutes>60</upnpLeaseMinutes>
<upnpRenewalMinutes>30</upnpRenewalMinutes>
<upnpTimeoutSeconds>10</upnpTimeoutSeconds>
<urAccepted>0</urAccepted>
<urUniqueID></urUniqueID>
<restartOnWakeup>true</restartOnWakeup>
<autoUpgradeIntervalH>12</autoUpgradeIntervalH>
<keepTemporariesH>24</keepTemporariesH>
<cacheIgnoredFiles>true</cacheIgnoredFiles>
<progressUpdateIntervalS>5</progressUpdateIntervalS>
<symlinksEnabled>true</symlinksEnabled>
<limitBandwidthInLan>false</limitBandwidthInLan>
<databaseBlockCacheMiB>0</databaseBlockCacheMiB>
</options>
The ``options`` element contains all other global configuration options.
listenAddress listenAddress
``host:port`` or ``:port`` string denoting an address to listen for BEP The listen address for incoming sync connections. See the ``address``
connections. More than one ``listenAddress`` may be given. element under the `GUI Element` for allowed syntax.
(default: ``0.0.0.0:22000``)
globalAnnounceServer globalAnnounceServer
``host:port`` string denoting where a global announce server may be A URI to a global announce (discvoery) server. Allowed protocol prefixes
reached. (default: ``announce.syncthing.net:22025``) are ``udp4://`` (UDP over IPv4), ``udp6://`` (UDP over IPv6) and
``udp://`` (UDP over any available protocol).
globalAnnounceEnabled globalAnnounceEnabled
``true``/``false`` (default: ``true``) Whether to announce this device to the global announce (discovery) server,
and also use it to look up other device.
localAnnounceEnabled localAnnounceEnabled
``true``/``false`` (default: ``true``) Whether to send announcements to the local LAN, also use such
parallelRequests announcements to find other devices.
The maximum number of outstanding block requests to have against any given
peer. (default: ``16``) localAnnouncePort
The port on which to listen and send IPv4 broadcast announcements to.
localAnnounceMCAddr
The group address and port to join and send IPv6 multicast announcements on.
maxSendKbps maxSendKbps
Rate limit Outgoing data rate limit, in kibibits per second.
rescanIntervalS
The number of seconds to wait between each scan for modification of the maxRecvKbps
local repositories. A value of ``0`` disables the scanner. (default: ``60``) Incoming data rate limits, in kibibits per second.
reconnectionIntervalS reconnectionIntervalS
The number of seconds to wait between each attempt to connect to currently The number of seconds to wait between each attempt to connect to currently
unconnected devices. (default: ``60``) unconnected devices.
maxChangeKbps
The maximum rate of change allowed for a single file. When this rate is
exceeded, further changes to the file are not announced, until the rate is
reduced below the limit. (default: ``10000``)
startBrowser startBrowser
``true``/``false`` (default: ``true``) Whether to attempt to start a browser to show the GUI when Syncthing starts.
upnpEnabled upnpEnabled
``true``/``false`` (default: ``true``) Whether to attempt to perform an UPnP port mapping for incoming sync connections.
upnpLeaseMinutes
Request a lease for this many minutes; zero to request a permanent lease.
upnpRenewalMinutes
Attempt to renew the lease after this many minutes.
upnpTimeoutSeconds
When scanning for UPnP devices, wait this long for responses.
urAccepted urAccepted
Whether the user as accepted to submit anonymous usage data. The default, Whether the user as accepted to submit anonymous usage data. The default,
``0``, mean the user has not made a choice, and Syncthing will ask at some ``0``, mean the user has not made a choice, and Syncthing will ask at some
point in the future. ``-1`` means no, ``1`` means yes. point in the future. ``-1`` means no, a number above zero means that that
version of usage reporting has been accepted.
urUniqueID
The unique ID sent together with the usage report. Generated when usage
reporting is enabled.
restartOnWakeup
Whether to perform a restart of Syncthing when it is detected that we are
waking from sleep mode (i.e. a folded up laptop).
autoUpgradeIntervalH
Check for a newer version after this many hours. Set to zero to disable
automatic upgrades.
keepTemporariesH
Keep temporary failed transfers for this many hours. While the temporaries
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.
progressUpdateIntervalS
.. note:: Requires explanation.
symlinksEnabled
Whether to sync symlinks, if supported by the system.
limitBandwidthInLan
Whether to apply bandwidth limits to devices in the same broadcast domain
as the local device.
databaseBlockCacheMiB
Override the automatically calculated database block cache size. Don't,
unless you're very short on memory, in which case you want to set this to
``8``.