1SYNCTHING-CONFIG(5) Syncthing SYNCTHING-CONFIG(5)
2
6 syncthing-config - Syncthing Configuration
7
9 $HOME/.config/syncthing
10 $HOME/Library/Application Support/Syncthing
11 %AppData%/Syncthing
12 %localappdata%/Syncthing
13
15 Syncthing uses a single directory to store configuration, crypto keys
16 and index caches. The location defaults to $HOME/.config/syncthing
17 (Unix-like), $HOME/Library/Application Support/Syncthing (Mac), %App‐
18 Data%/Syncthing (Windows XP) or %LocalAppData%/Syncthing (Windows 7+).
19 It can be changed at runtime using the -home flag. In this directory
20 the following files are located:
21 config.xml
23 The configuration file, in XML format.
24 cert.pem, key.pem
26 The device’s RSA public and private key. These form the basis
27 for the device ID. The key must be kept private.
28 https-cert.pem, https-key.pem
30 The certificate and key for HTTPS GUI connections. These may be
31 replaced with a custom certificate for HTTPS as desired.
32 index-*.db
34 A directory holding the database with metadata and hashes of the
35 files currently on disk and available from peers.
36 csrftokens.txt
38 A list of recently issued CSRF tokens (for protection against
39 browser cross site request forgery).
40
42 The following shows an example of the default configuration file (IDs
43 will differ):
44 <configuration version="26">
46 <folder id="zj2AA-q55a7" label="Default Folder" path="/Users/jb/Sync/" type="sendreceive" rescanIntervalS="60" fsWatcherEnabled="false" fsWatcherDelayS="10" ignorePerms="false" autoNormalize="true">
47 <device id="3LT2GA5-CQI4XJM-WTZ264P-MLOGMHL-MCRLDNT-MZV4RD3-KA745CL-OGAERQZ"></device>
48 <filesystemType>basic</filesystemType>
49 <minDiskFree unit="%">1</minDiskFree>
50 <versioning></versioning>
51 <copiers>0</copiers>
52 <pullers>0</pullers>
53 <hashers>0</hashers>
54 <order>random</order>
55 <ignoreDelete>false</ignoreDelete>
56 <scanProgressIntervalS>0</scanProgressIntervalS>
57 <pullerPauseS>0</pullerPauseS>
58 <maxConflicts>-1</maxConflicts>
59 <disableSparseFiles>false</disableSparseFiles>
60 <disableTempIndexes>false</disableTempIndexes>
61 <paused>false</paused>
62 <weakHashThresholdPct>25</weakHashThresholdPct>
63 <markerName>.stfolder</markerName>
64 </folder>
65 <device id="3LT2GA5-CQI4XJM-WTZ264P-MLOGMHL-MCRLDNT-MZV4RD3-KA745CL-OGAERQZ" name="syno" compression="metadata" introducer="false" skipIntroductionRemovals="false" introducedBy="">
66 <address>dynamic</address>
67 <paused>false</paused>
68 </device>
69 <gui enabled="true" tls="false" debugging="false">
70 <address>127.0.0.1:8384</address>
71 <apikey>k1dnz1Dd0rzTBjjFFh7CXPnrF12C49B1</apikey>
72 <theme>default</theme>
73 </gui>
74 <options>
75 <listenAddress>default</listenAddress>
76 <globalAnnounceServer>default</globalAnnounceServer>
77 <globalAnnounceEnabled>true</globalAnnounceEnabled>
78 <localAnnounceEnabled>true</localAnnounceEnabled>
79 <localAnnouncePort>21027</localAnnouncePort>
80 <localAnnounceMCAddr>[ff12::8384]:21027</localAnnounceMCAddr>
81 <maxSendKbps>0</maxSendKbps>
82 <maxRecvKbps>0</maxRecvKbps>
83 <reconnectionIntervalS>60</reconnectionIntervalS>
84 <relaysEnabled>true</relaysEnabled>
85 <relayReconnectIntervalM>10</relayReconnectIntervalM>
86 <startBrowser>true</startBrowser>
87 <natEnabled>true</natEnabled>
88 <natLeaseMinutes>60</natLeaseMinutes>
89 <natRenewalMinutes>30</natRenewalMinutes>
90 <natTimeoutSeconds>10</natTimeoutSeconds>
91 <urAccepted>0</urAccepted>
92 <urSeen>0</urSeen>
93 <urUniqueID>LFWe2vn3</urUniqueID>
94 <urURL>https://data.syncthing.net/newdata</urURL>
95 <urPostInsecurely>false</urPostInsecurely>
96 <urInitialDelayS>1800</urInitialDelayS>
97 <restartOnWakeup>true</restartOnWakeup>
98 <autoUpgradeIntervalH>12</autoUpgradeIntervalH>
99 <upgradeToPreReleases>false</upgradeToPreReleases>
100 <keepTemporariesH>24</keepTemporariesH>
101 <cacheIgnoredFiles>false</cacheIgnoredFiles>
102 <progressUpdateIntervalS>5</progressUpdateIntervalS>
103 <limitBandwidthInLan>false</limitBandwidthInLan>
104 <minHomeDiskFree unit="%">1</minHomeDiskFree>
105 <releasesURL>https://upgrades.syncthing.net/meta.json</releasesURL>
106 <overwriteRemoteDeviceNamesOnConnect>false</overwriteRemoteDeviceNamesOnConnect>
107 <tempIndexMinBlocks>10</tempIndexMinBlocks>
108 <trafficClass>0</trafficClass>
109 <weakHashSelectionMethod>auto</weakHashSelectionMethod>
110 <stunServer>default</stunServer>
111 <stunKeepaliveSeconds>24</stunKeepaliveSeconds>
112 <kcpNoDelay>false</kcpNoDelay>
113 <kcpUpdateIntervalMs>25</kcpUpdateIntervalMs>
114 <kcpFastResend>false</kcpFastResend>
115 <kcpCongestionControl>true</kcpCongestionControl>
116 <kcpSendWindowSize>128</kcpSendWindowSize>
117 <kcpReceiveWindowSize>128</kcpReceiveWindowSize>
118 <defaultFolderPath>~</defaultFolderPath>
119 <minHomeDiskFreePct>0</minHomeDiskFreePct>
120 <setLowPriority>true</setLowPriority>
121 </options>
122 </configuration>
123
125 <configuration version="26">
126 <folder></folder>
127 <device></device>
128 <gui></gui>
129 <options></options>
130 <ignoredDevice>5SYI2FS-LW6YAXI-JJDYETS-NDBBPIO-256MWBO-XDPXWVG-24QPUM4-PDW4UQU</ignoredDevice>
131 <ignoredFolder>bd7q3-zskm5</ignoredFolder>
132 </configuration>
133 This is the root element. It has one attribute:
135 version
137 The config version. Increments whenever a change is made that
138 requires migration from previous formats.
139 It contains the elements described in the following sections and these
141 two additional child elements:
142 ignoredDevice
144 Contains the ID of the device that should be ignored. Connection
145 attempts from this device are logged to the console but never
146 displayed in the web GUI.
147 ignoredFolder
149 Contains the ID of the folder that should be ignored. This
150 folder will always be skipped when advertised from a remote
151 device, i.e. this will be logged, but there will be no dialog
152 about it in the web GUI.
153
155 <folder id="zj2AA-q55a7" label="Default Folder" path="/Users/jb/Sync/" type="sendreceive" rescanIntervalS="60" fsWatcherEnabled="false" fsWatcherDelayS="10" ignorePerms="false" autoNormalize="true">
156 <device id="3LT2GA5-CQI4XJM-WTZ264P-MLOGMHL-MCRLDNT-MZV4RD3-KA745CL-OGAERQZ"></device>
157 <filesystemType>basic</filesystemType>
158 <minDiskFree unit="%">1</minDiskFree>
159 <versioning></versioning>
160 <copiers>0</copiers>
161 <pullers>0</pullers>
162 <hashers>0</hashers>
163 <order>random</order>
164 <ignoreDelete>false</ignoreDelete>
165 <scanProgressIntervalS>0</scanProgressIntervalS>
166 <pullerPauseS>0</pullerPauseS>
167 <maxConflicts>-1</maxConflicts>
168 <disableSparseFiles>false</disableSparseFiles>
169 <disableTempIndexes>false</disableTempIndexes>
170 <paused>false</paused>
171 <weakHashThresholdPct>25</weakHashThresholdPct>
172 <markerName>.stfolder</markerName>
173 </folder>
174 One or more folder elements must be present in the file. Each element
176 describes one folder. The following attributes may be set on the folder
177 element:
178 id The folder ID, must be unique. (mandatory)
180 label The label of a folder is a human readable and descriptive local
182 name. May be different on each device, empty, and/or identical
183 to other folder labels. (optional)
184 path The path to the directory where the folder is stored on this
186 device; not sent to other devices. (mandatory)
187 type Controls how the folder is handled by Syncthing. Possible values
189 are:
190 sendreceive
192 The folder is in default mode. Sending local and accept‐
193 ing remote changes. Note that this type was previously
194 called “readwrite” which is deprecated but still accepted
195 in incoming configs.
196 sendonly
198 The folder is in “send only” mode – it will not be modi‐
199 fied by Syncthing on this device. Note that this type
200 was previously called “readonly” which is deprecated but
201 still accepted in incoming configs.
202 receiveonly
204 The folder is in “receive only” mode – it will not propa‐
205 gate changes to other devices.
206 rescanIntervalS
208 The rescan interval, in seconds. Can be set to zero to disable
209 when external plugins are used to trigger rescans.
210 fsWatcherEnabled
212 If enabled this detects changes to files in the folder and scans
213 them.
214 fsWatcherDelayS
216 The duration during which changes detected are accumulated,
217 before a scan is scheduled (only takes effect if fsWatcherEn‐
218 abled is true).
219 ignorePerms
221 True if the folder should ignore permissions.
222 autoNormalize
224 Automatically correct UTF-8 normalization errors found in file
225 names.
226 The following child elements may exist:
228 device These must have the id attribute and can have an introducedBy
230 attribute, identifying the device that introduced us to share
231 this folder with the given device. If the original introducer
232 unshares this folder with this device, our device will follow
233 and unshare the folder (subject to skipIntroductionRemovals
234 being false on the introducer device). All mentioned devices
235 are those that will be sharing the folder in question. Each
236 mentioned device must have a separate device element later in
237 the file. It is customary that the local device ID is included
238 in all folders. Syncthing will currently add this automatically
239 if it is not present in the configuration file.
240 minDiskFree
242 The minimum required free space that should be available on the
243 disk this folder resides. The folder will be stopped when the
244 value drops below the threshold. Accepted units are %, kB, MB,
245 GB and TB. Set to zero to disable.
246 versioning
248 Specifies a versioning configuration.
249 SEE ALSO:
251 versioning
252 copiers, pullers, hashers
254 The number of copier, puller and hasher routines to use, or zero
255 for the system determined optimum. These are low level perfor‐
256 mance options for advanced users only; do not change unless
257 requested to or you’ve actually read and understood the code
258 yourself. :)
259 order The order in which needed files should be pulled from the clus‐
261 ter. The possibles values are:
262 random Pull files in random order. This optimizes for balancing
264 resources among the devices in a cluster.
265 alphabetic
267 Pull files ordered by file name alphabetically.
268 smallestFirst, largestFirst
270 Pull files ordered by file size; smallest and largest
271 first respectively.
272 oldestFirst, newestFirst
274 Pull files ordered by modification time; oldest and new‐
275 est first respectively.
276 Note that the scanned files are sent in batches and the sorting
278 is applied only to the already discovered files. This means the
279 sync might start with a 1 GB file even if there is 1 KB file
280 available on the source device until the 1 KB becomes known to
281 the pulling device.
282 ignoreDelete
284 When set to true, this device will pretend not to see instruc‐
285 tions to delete files from other devices.
286 scanProgressIntervalS
288 The interval with which scan progress information is sent to the
289 GUI. Zero means the default value (two seconds).
290 pullerPauseS
292 Tweak for rate limiting the puller when it retries pulling
293 files. Don’t change these unless you know what you’re doing.
294 maxConflicts
296 The maximum number of conflict copies to keep around for any
297 given file. The default, -1, means an unlimited number. Setting
298 this to zero disables conflict copies altogether.
299 disableSparseFiles
301 By default, blocks containing all zeroes are not written, caus‐
302 ing files to be sparse on filesystems that support the concept.
303 When set to true, sparse files will not be created.
304 disableTempIndexes
306 By default, devices exchange information about blocks available
307 in transfers that are still in progress. When set to true, such
308 information is not exchanged for this folder.
309 paused True if this folder is (temporarily) suspended.
311 weakHashThresholdPct
313 Use weak hash if more than the given percentage of the file has
314 changed. Set to -1 to always use weak hash. Default value is 25.
315 markerName
317 Name of a directory or file in the folder root to be used as
318 marker-faq. Default is “.stfolder”.
319 fsync Deprecated since version v0.14.37.
321 Transfer updated (from other devices) files to permanent storage
324 before committing the changes to the internal database.
325 pullerSleepS
327 Deprecated since version v0.14.41.
328 Tweak for rate limiting the puller. Don’t change these unless
331 you know what you’re doing.
332
334 <device id="5SYI2FS-LW6YAXI-JJDYETS-NDBBPIO-256MWBO-XDPXWVG-24QPUM4-PDW4UQU" name="syno" compression="metadata" introducer="false" skipIntroductionRemovals="false" introducedBy="2CYF2WQ-AKZO2QZ-JAKWLYD-AGHMQUM-BGXUOIS-GYILW34-HJG3DUK-LRRYQAR">
335 <address>dynamic</address>
336 </device>
337 <device id="2CYF2WQ-AKZO2QZ-JAKWLYD-AGHMQUM-BGXUOIS-GYILW34-HJG3DUK-LRRYQAR" name="syno local" compression="metadata" introducer="false">
338 <address>tcp://192.0.2.1:22001</address>
339 <paused>true<paused>
340 <allowedNetwork>192.168.0.0/16<allowedNetwork>
341 </device>
342 One or more device elements must be present in the file. Each element
344 describes a device participating in the cluster. It is customary to
345 include a device element for the local device; Syncthing will currently
346 add one if it is not present. The following attributes may be set on
347 the device element:
348 id The device ID. This must be written in canonical form, that is
350 without any spaces or dashes. (mandatory)
351 name A friendly name for the device. (optional)
353 compression
355 Whether to use protocol compression when sending messages to
356 this device. The possible values are:
357 metadata
359 Compress metadata packets, such as index information.
360 Metadata is usually very compression friendly so this is
361 a good default.
362 always Compress all packets, including file data. This is recom‐
364 mended if the folders contents are mainly compressible
365 data such as documents or text files.
366 never Disable all compression.
368 introducer
370 Set to true if this device should be trusted as an introducer,
371 i.e. we should copy their list of devices per folder when con‐
372 necting.
373 SEE ALSO:
375 introducer
376 skipIntroductionRemovals
378 Set to true if you wish to follow only introductions and not
379 de-introductions. For example, if this is set, we would not
380 remove a device that we were introduced to even if the original
381 introducer is no longer listing the remote device as known.
382 introducedBy
384 Defines which device has introduced us to this device. Used only
385 for following de-introductions.
386 certName
388 The device certificate common name, if it is not the default
389 “syncthing”.
390 From following child elements at least one address child must exist.
392 address
394 Contains an address or host name to use when attempting to con‐
395 nect to this device. Entries other than dynamic must be pre‐
396 fixed with tcp:// (dual-stack), tcp4:// (IPv4 only) or tcp6://
397 (IPv6 only). Note that IP addresses need not use tcp4/tcp6;
398 these are optional. Accepted formats are:
399 IPv4 address (tcp://192.0.2.42)
401 The default port (22000) is used.
402 IPv4 address and port (tcp://192.0.2.42:12345)
404 The address and port is used as given.
405 IPv6 address (tcp://[2001:db8::23:42])
407 The default port (22000) is used. The address must be
408 enclosed in square brackets.
409 IPv6 address and port (tcp://[2001:db8::23:42]:12345)
411 The address and port is used as given. The address must
412 be enclosed in square brackets.
413 Host name (tcp6://fileserver)
415 The host name will be used on the default port (22000)
416 and connections will be attempted only via IPv6.
417 Host name and port (tcp://fileserver:12345)
419 The host name will be used on the given port and connec‐
420 tions will be attempted via both IPv4 and IPv6, depending
421 on name resolution.
422 dynamic
424 The word dynamic (without tcp:// prefix) means to use
425 local and global discovery to find the device.
426 You can set multiple addresses and combine it with the dynamic
428 keyword for example:
429 <device id="...">
431 <address>tcp://192.0.2.1:22001</address>
432 <address>tcp://192.0.1.254:22000</address>
433 <address>dynamic</address>
434 </device>
435 paused True if synchronization with this devices is (temporarily) sus‐
437 pended.
438 allowedNetwork
440 If given, this restricts connections to this device to only this
441 network (see allowed-networks).
442
444 <gui enabled="true" tls="false" debugging="false">
445 <address>127.0.0.1:8384</address>
446 <apikey>l7jSbCqPD95JYZ0g8vi4ZLAMg3ulnN1b</apikey>
447 <theme>default</theme>
448 </gui>
449 There must be exactly one gui element. The GUI configuration is also
451 used by the rest-api and the event-api. The following attributes may be
452 set on the gui element:
453 enabled
455 If not true, the GUI and API will not be started.
456 tls If set to true, TLS (HTTPS) will be enforced. Non-HTTPS requests
458 will be redirected to HTTPS. When this is set to false, TLS con‐
459 nections are still possible but it is not mandatory.
460 debugging
462 This enables profiling and additional debugging endpoints in the
463 rest-api.
464 The following child elements may be present:
466 address
468 Set the listen address. One address element must be present.
469 Allowed address formats are:
470 IPv4 address and port (127.0.0.1:8384)
472 The address and port is used as given.
473 IPv6 address and port ([::1]:8384)
475 The address and port is used as given. The address must
476 be enclosed in square brackets.
477 Wildcard and port (0.0.0.0:12345, [::]:12345, :12345)
479 These are equivalent and will result in Syncthing listen‐
480 ing on all interfaces via both IPv4 and IPv6.
481 UNIX socket location (/var/run/st.sock)
483 If the address is an absolute path it is interpreted as
484 the path to a UNIX socket. (Added in v0.14.52.)
485 user Set to require authentication.
487 password
489 Contains the bcrypt hash of the real password.
490 apikey If set, this is the API key that enables usage of the REST
492 interface.
493 insecureAdminAccess
495 If true, this allows access to the web GUI from outside (i.e.
496 not localhost) without authorization. A warning will displayed
497 about this setting on startup.
498 theme The name of the theme to use.
500 authMode
502 Authentication mode to use. If not present authentication mode
503 (static) is controlled by presence of user/passward fields for
504 backward compatibility.
505 static Authentication using user and password.
507 ldap LDAP authentication. Requires ldap top level config sec‐
509 tion to be present.
510
512 <ldap>
513 <address>localhost:389</address>
514 <bindDN>cn=%s,ou=users,dc=syncthing,dc=net</bindDN>
515 <transport>nontls</transport>
516 <insecureSkipVerify>false</insecureSkipVerify>
517 </ldap>
518 The ldap element contains LDAP configuration options.
520 address
522 LDAP server address (server:port).
523 bindDN BindDN for user authentication. Special %s variable shoild be
525 used to pass username to LDAP.
526 transport
528 nontls Non secure connection.
530 tls TLS secured connection.
532 starttls
534 StartTLS connection mode.
535 insecureSkipVerify
537 Skip verification (true or false).
538
540 <options>
541 <listenAddress>default</listenAddress>
542 <globalAnnounceServer>default</globalAnnounceServer>
543 <globalAnnounceEnabled>true</globalAnnounceEnabled>
544 <localAnnounceEnabled>true</localAnnounceEnabled>
545 <localAnnouncePort>21027</localAnnouncePort>
546 <localAnnounceMCAddr>[ff12::8384]:21027</localAnnounceMCAddr>
547 <maxSendKbps>0</maxSendKbps>
548 <maxRecvKbps>0</maxRecvKbps>
549 <reconnectionIntervalS>60</reconnectionIntervalS>
550 <relaysEnabled>true</relaysEnabled>
551 <relayReconnectIntervalM>10</relayReconnectIntervalM>
552 <startBrowser>true</startBrowser>
553 <natEnabled>true</natEnabled>
554 <natLeaseMinutes>60</natLeaseMinutes>
555 <natRenewalMinutes>30</natRenewalMinutes>
556 <natTimeoutSeconds>10</natTimeoutSeconds>
557 <urAccepted>0</urAccepted>
558 <urUniqueID></urUniqueID>
559 <urURL>https://data.syncthing.net/newdata</urURL>
560 <urPostInsecurely>false</urPostInsecurely>
561 <urInitialDelayS>1800</urInitialDelayS>
562 <restartOnWakeup>true</restartOnWakeup>
563 <autoUpgradeIntervalH>12</autoUpgradeIntervalH>
564 <keepTemporariesH>24</keepTemporariesH>
565 <cacheIgnoredFiles>false</cacheIgnoredFiles>
566 <progressUpdateIntervalS>5</progressUpdateIntervalS>
567 <limitBandwidthInLan>false</limitBandwidthInLan>
568 <minHomeDiskFree unit="%">1</minHomeDiskFree>
569 <releasesURL>https://api.github.com/repos/syncthing/syncthing/releases?per_page=30</releasesURL>
570 <overwriteRemoteDeviceNamesOnConnect>false</overwriteRemoteDeviceNamesOnConnect>
571 <tempIndexMinBlocks>10</tempIndexMinBlocks>
572 <defaultFolderPath>~</defaultFolderPath>
573 </options>
574 The options element contains all other global configuration options.
576 listenAddress
578 The listen address for incoming sync connections. See Listen
579 Addresses for allowed syntax.
580 globalAnnounceServer
582 A URI to a global announce (discovery) server, or the word
583 default to include the default servers. Any number of globalAn‐
584 nounceServer elements may be present. The syntax for non-default
585 entries is that of a HTTP or HTTPS URL. A number of options may
586 be added as query options to the URL: insecure to prevent cer‐
587 tificate validation (required for HTTP URLs) and id=<device ID>
588 to perform certificate pinning. The device ID to use is printed
589 by the discovery server on startup.
590 globalAnnounceEnabled
592 Whether to announce this device to the global announce (discov‐
593 ery) server, and also use it to look up other devices.
594 localAnnounceEnabled
596 Whether to send announcements to the local LAN, also use such
597 announcements to find other devices.
598 localAnnouncePort
600 The port on which to listen and send IPv4 broadcast announce‐
601 ments to.
602 localAnnounceMCAddr
604 The group address and port to join and send IPv6 multicast
605 announcements on.
606 maxSendKbps
608 Outgoing data rate limit, in kibibytes per second.
609 maxRecvKbps
611 Incoming data rate limits, in kibibytes per second.
612 reconnectionIntervalS
614 The number of seconds to wait between each attempt to connect to
615 currently unconnected devices.
616 relaysEnabled
618 When true, relays will be connected to and potentially used for
619 device to device connections.
620 relayReconnectIntervalM
622 Sets the interval, in minutes, between relay reconnect attempts.
623 startBrowser
625 Whether to attempt to start a browser to show the GUI when Sync‐
626 thing starts.
627 natEnabled
629 Whether to attempt to perform a UPnP and NAT-PMP port mapping
630 for incoming sync connections.
631 natLeaseMinutes
633 Request a lease for this many minutes; zero to request a perma‐
634 nent lease.
635 natRenewalMinutes
637 Attempt to renew the lease after this many minutes.
638 natTimeoutSeconds
640 When scanning for UPnP devices, wait this long for responses.
641 urAccepted
643 Whether the user has accepted to submit anonymous usage data.
644 The default, 0, mean the user has not made a choice, and Sync‐
645 thing will ask at some point in the future. -1 means no, a num‐
646 ber above zero means that that version of usage reporting has
647 been accepted.
648 urSeen The highest usage reporting version that has already been shown
650 in the web GUI.
651 urUniqueID
653 The unique ID sent together with the usage report. Generated
654 when usage reporting is enabled.
655 urURL The URL to post usage report data to, when enabled.
657 urPostInsecurely
659 When true, the UR URL can be http instead of https, or have a
660 self-signed certificate. The default is false.
661 urInitialDelayS
663 The time to wait from startup to the first usage report being
664 sent. Allows the system to stabilize before reporting statis‐
665 tics.
666 restartOnWakeup
668 Whether to perform a restart of Syncthing when it is detected
669 that we are waking from sleep mode (i.e. a folded up laptop).
670 autoUpgradeIntervalH
672 Check for a newer version after this many hours. Set to zero to
673 disable automatic upgrades.
674 upgradeToPreReleases
676 If true, automatic upgrades include release candidates (see
677 release-channels).
678 keepTemporariesH
680 Keep temporary failed transfers for this many hours. While the
681 temporaries are kept, the data they contain need not be trans‐
682 ferred again.
683 cacheIgnoredFiles
685 Whether to cache the results of ignore pattern evaluation. Per‐
686 formance at the price of memory. Defaults to false as the cost
687 for evaluating ignores is usually not significant.
688 progressUpdateIntervalS
690 How often in seconds the progress of ongoing downloads is made
691 available to the GUI.
692 limitBandwidthInLan
694 Whether to apply bandwidth limits to devices in the same broad‐
695 cast domain as the local device.
696 minHomeDiskFree
698 The minimum required free space that should be available on the
699 partition holding the configuration and index. Accepted units
700 are %, kB, MB, GB and TB.
701 releasesURL
703 The URL from which release information is loaded, for automatic
704 upgrades.
705 alwaysLocalNet
707 Network that should be considered as local given in CIDR nota‐
708 tion.
709 overwriteRemoteDeviceNamesOnConnect
711 If set, device names will always be overwritten with the name
712 given by remote on each connection. By default, the name that
713 the remote device announces will only be adopted when a name has
714 not already been set.
715 tempIndexMinBlocks
717 When exchanging index information for incomplete transfers, only
718 take into account files that have at least this many blocks.
719 unackedNotificationID
721 ID of a notification to be displayed in the web GUI. Will be
722 removed once the user acknowledged it (e.g. an transition notice
723 on an upgrade).
724 trafficClass
726 Specify a type of service (TOS)/traffic class of outgoing pack‐
727 ets.
728 weakHashSelectionMethod
730 Specify whether weak hashing is used, possible options are
731 WeakHashAlways, WeakHashNever and WeakHashAuto. Deciding auto‐
732 matically means running benchmarks at startup to decide whether
733 the performance impact is acceptable (this is the default).
734 stunServer
736 Server to be used for STUN, given as ip:port. The keyword
737 default gets expanded to stun.callwithus.com:3478, stun.counter‐
738 path.com:3478, stun.counterpath.net:3478, stun.ekiga.net:3478,
739 stun.ideasip.com:3478, stun.internetcalls.com:3478,
740 stun.schlund.de:3478, stun.sipgate.net:10000, stun.sip‐
741 gate.net:3478, stun.voip.aebc.com:3478,
742 stun.voiparound.com:3478, stun.voipbuster.com:3478, stun.voip‐
743 stunt.com:3478, stun.voxgratia.org:3478 and stun.xten.com:3478
744 (this is the default).
745 stunKeepaliveSeconds
747 Interval in seconds between contacting a STUN server to maintain
748 NAT mapping. Default is 24 and you can set it to 0 to disable
749 contacting STUN servers.
750 kcpNoDelay, kcpUpdateIntervalMs, kcpFastResend, kcpCongestionControl,
752 kcpSendWindowSize, kcpReceiveWindowSize
753 Various KCP tweaking parameters.
754 defaultFolderPath
756 The UI will propose to create new folders at this path. This can
757 be disabled by setting this to an empty string.
758 setLowPriority
760 Syncthing will attempt to lower its process priority at startup.
761 Specifically: on Linux, set itself to a separate process group,
762 set the niceness level of that process group to nine and the I/O
763 priority to best effort level five; on other Unixes, set the
764 process niceness level to nine; on Windows, set the process pri‐
765 ority class to below normal. To disable this behavior, for exam‐
766 ple to control process priority yourself as part of launching
767 Syncthing, set this option to false.
768 Listen Addresses
770 The following address types are accepted in sync protocol listen
771 addresses:
772 Default listen addresses (default)
774 This is equivalent to tcp://0.0.0.0:22000 and
775 dynamic+https://relays.syncthing.net/endpoint.
776 TCP wildcard and port (tcp://0.0.0.0:22000, tcp://:22000)
778 These are equivalent and will result in Syncthing listening on
779 all interfaces, IPv4 and IPv6, on the specified port.
780 TCP IPv4 wildcard and port (tcp4://0.0.0.0:22000, tcp4://:22000)
782 These are equivalent and will result in Syncthing listening on
783 all interfaces via IPv4 only.
784 TCP IPv4 address and port (tcp4://192.0.2.1:22000)
786 This results in Syncthing listening on the specified address and
787 port, IPv4 only.
788 TCP IPv6 wildcard and port (tcp6://[::]:22000, tcp6://:22000)
790 These are equivalent and will result in Syncthing listening on
791 all interfaces via IPv6 only.
792 TCP IPv6 address and port (tcp6://[2001:db8::42]:22000)
794 This results in Syncthing listening on the specified address and
795 port, IPv6 only.
796 Static relay address (relay://192.0.2.42:22067?id=abcd123...)
798 Syncthing will connect to and listen for incoming connections
799 via the specified relay address.
800 Todo
802 Document available URL parameters.
803 Dynamic relay pool (dynamic+https://192.0.2.42/relays)
805 Syncthing will fetch the specified HTTPS URL, parse it for a
806 JSON payload describing relays, select a relay from the avail‐
807 able ones and listen via that as if specified as a static relay
808 above.
809 Todo
811 Document available URL parameters.
812
814 Syncing configuration files between devices (such that multiple devices
815 are using the same configuration files) can cause issues. This is easy
816 to do accidentally if you sync your home folder between devices. A com‐
817 mon symptom of syncing configuration files is two devices ending up
818 with the same Device ID.
819 If you want to use Syncthing to backup your configuration files, it is
821 recommended that the files you are backing up are in a folder-sendonly
822 to prevent other devices from overwriting the per device configuration.
823 The folder on the remote device(s) should not be used as configuration
824 for the remote devices.
825 If you’d like to sync your home folder in non-send only mode, you may
827 add the folder that stores the configuration files to the ignore list.
828 If you’d also like to backup your configuration files, add another
829 folder in send only mode for just the configuration folder.
830
832 The Syncthing Authors
833
835 2014-2019, The Syncthing Authors
836v1 Apr 13, 2019 SYNCTHING-CONFIG(5)