syncthing-config.5 45 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280
  1. .\" Man page generated from reStructuredText.
  2. .
  3. .
  4. .nr rst2man-indent-level 0
  5. .
  6. .de1 rstReportMargin
  7. \\$1 \\n[an-margin]
  8. level \\n[rst2man-indent-level]
  9. level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
  10. -
  11. \\n[rst2man-indent0]
  12. \\n[rst2man-indent1]
  13. \\n[rst2man-indent2]
  14. ..
  15. .de1 INDENT
  16. .\" .rstReportMargin pre:
  17. . RS \\$1
  18. . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
  19. . nr rst2man-indent-level +1
  20. .\" .rstReportMargin post:
  21. ..
  22. .de UNINDENT
  23. . RE
  24. .\" indent \\n[an-margin]
  25. .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
  26. .nr rst2man-indent-level -1
  27. .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
  28. .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
  29. ..
  30. .TH "SYNCTHING-CONFIG" "5" "Jan 22, 2022" "v1" "Syncthing"
  31. .SH NAME
  32. syncthing-config \- Syncthing Configuration
  33. .SH SYNOPSIS
  34. .INDENT 0.0
  35. .INDENT 3.5
  36. .sp
  37. .nf
  38. .ft C
  39. $HOME/.config/syncthing
  40. $HOME/Library/Application Support/Syncthing
  41. %LOCALAPPDATA%\eSyncthing
  42. .ft P
  43. .fi
  44. .UNINDENT
  45. .UNINDENT
  46. .SH DESCRIPTION
  47. .sp
  48. New in version 1.5.0: Database and config can now be set separately. Previously the database was
  49. always located in the same directory as the config.
  50. .sp
  51. Syncthing uses a single directory to store configuration and crypto keys.
  52. Syncthing also has a database, which is often stored in this directory too.
  53. The config location defaults to \fB$HOME/.config/syncthing\fP
  54. (Unix\-like), \fB$HOME/Library/Application Support/Syncthing\fP (Mac),
  55. or \fB%LOCALAPPDATA%\eSyncthing\fP (Windows). It can be changed at runtime
  56. using the \fB\-\-config\fP flag. In this directory the following files are
  57. located:
  58. .INDENT 0.0
  59. .TP
  60. .B \fBconfig.xml\fP
  61. The configuration file, in XML format.
  62. .TP
  63. .B \fBcert.pem\fP, \fBkey.pem\fP
  64. The device’s ECDSA public and private key. These form the basis for the
  65. device ID. The key must be kept private.
  66. .TP
  67. .B \fBhttps\-cert.pem\fP, \fBhttps\-key.pem\fP
  68. The certificate and key for HTTPS GUI connections. These may be replaced
  69. with a custom certificate for HTTPS as desired.
  70. .TP
  71. .B \fBcsrftokens.txt\fP
  72. A list of recently issued CSRF tokens (for protection against browser cross
  73. site request forgery).
  74. .UNINDENT
  75. .sp
  76. The database is stored either in the same directory as the config (usually the
  77. default), but may also be located in one of the following directories (Unix\-like
  78. platforms only):
  79. .INDENT 0.0
  80. .IP \(bu 2
  81. If a database exists in the old default location, that location is
  82. still used.
  83. .IP \(bu 2
  84. If \fB$XDG_DATA_HOME\fP is set, use \fB$XDG_DATA_HOME/syncthing\fP\&.
  85. .IP \(bu 2
  86. If \fB~/.local/share/syncthing\fP exists, use that location.
  87. .IP \(bu 2
  88. Use the old default location (same as config).
  89. .UNINDENT
  90. .sp
  91. The location of the database can be changed using the \fB\-\-data\fP flag. The
  92. \fB\-\-home\fP flag sets both config and database locations at the same time.
  93. The database contains the following files:
  94. .INDENT 0.0
  95. .TP
  96. .B \fBindex\-\fP\fI*\fP\fB\&.db\fP
  97. A directory holding the database with metadata and hashes of the files
  98. currently on disk and available from peers.
  99. .UNINDENT
  100. .SH CONFIG FILE FORMAT
  101. .sp
  102. The following shows an example of a default configuration file (IDs will differ):
  103. .sp
  104. \fBNOTE:\fP
  105. .INDENT 0.0
  106. .INDENT 3.5
  107. The config examples are present for illustration. Do \fBnot\fP copy them
  108. entirely to use as your config. They are likely out\-of\-date and the values
  109. may no longer correspond to the defaults.
  110. .UNINDENT
  111. .UNINDENT
  112. .INDENT 0.0
  113. .INDENT 3.5
  114. .sp
  115. .nf
  116. .ft C
  117. <configuration version="35">
  118. <folder id="default" label="Default Folder" path="/Users/jb/Sync/" type="sendreceive" rescanIntervalS="3600" fsWatcherEnabled="true" fsWatcherDelayS="10" ignorePerms="false" autoNormalize="true">
  119. <filesystemType>basic</filesystemType>
  120. <device id="S7UKX27\-GI7ZTXS\-GC6RKUA\-7AJGZ44\-C6NAYEB\-HSKTJQK\-KJHU2NO\-CWV7EQW" introducedBy="">
  121. <encryptionPassword></encryptionPassword>
  122. </device>
  123. <minDiskFree unit="%">1</minDiskFree>
  124. <versioning>
  125. <cleanupIntervalS>3600</cleanupIntervalS>
  126. <fsPath></fsPath>
  127. <fsType>basic</fsType>
  128. </versioning>
  129. <copiers>0</copiers>
  130. <pullerMaxPendingKiB>0</pullerMaxPendingKiB>
  131. <hashers>0</hashers>
  132. <order>random</order>
  133. <ignoreDelete>false</ignoreDelete>
  134. <scanProgressIntervalS>0</scanProgressIntervalS>
  135. <pullerPauseS>0</pullerPauseS>
  136. <maxConflicts>\-1</maxConflicts>
  137. <disableSparseFiles>false</disableSparseFiles>
  138. <disableTempIndexes>false</disableTempIndexes>
  139. <paused>false</paused>
  140. <weakHashThresholdPct>25</weakHashThresholdPct>
  141. <markerName>.stfolder</markerName>
  142. <copyOwnershipFromParent>false</copyOwnershipFromParent>
  143. <modTimeWindowS>0</modTimeWindowS>
  144. <maxConcurrentWrites>2</maxConcurrentWrites>
  145. <disableFsync>false</disableFsync>
  146. <blockPullOrder>standard</blockPullOrder>
  147. <copyRangeMethod>standard</copyRangeMethod>
  148. <caseSensitiveFS>false</caseSensitiveFS>
  149. <junctionsAsDirs>false</junctionsAsDirs>
  150. </folder>
  151. <device id="S7UKX27\-GI7ZTXS\-GC6RKUA\-7AJGZ44\-C6NAYEB\-HSKTJQK\-KJHU2NO\-CWV7EQW" name="syno" compression="metadata" introducer="false" skipIntroductionRemovals="false" introducedBy="">
  152. <address>dynamic</address>
  153. <paused>false</paused>
  154. <autoAcceptFolders>false</autoAcceptFolders>
  155. <maxSendKbps>0</maxSendKbps>
  156. <maxRecvKbps>0</maxRecvKbps>
  157. <ignoredFolder time="2022\-01\-09T19:09:52Z" id="br63e\-wyhb7" label="Foo"></ignoredFolder>
  158. <maxRequestKiB>0</maxRequestKiB>
  159. <untrusted>false</untrusted>
  160. <remoteGUIPort>0</remoteGUIPort>
  161. </device>
  162. <gui enabled="true" tls="false" debugging="false">
  163. <address>127.0.0.1:8384</address>
  164. <apikey>k1dnz1Dd0rzTBjjFFh7CXPnrF12C49B1</apikey>
  165. <theme>default</theme>
  166. </gui>
  167. <ldap></ldap>
  168. <options>
  169. <listenAddress>default</listenAddress>
  170. <globalAnnounceServer>default</globalAnnounceServer>
  171. <globalAnnounceEnabled>true</globalAnnounceEnabled>
  172. <localAnnounceEnabled>true</localAnnounceEnabled>
  173. <localAnnouncePort>21027</localAnnouncePort>
  174. <localAnnounceMCAddr>[ff12::8384]:21027</localAnnounceMCAddr>
  175. <maxSendKbps>0</maxSendKbps>
  176. <maxRecvKbps>0</maxRecvKbps>
  177. <reconnectionIntervalS>60</reconnectionIntervalS>
  178. <relaysEnabled>true</relaysEnabled>
  179. <relayReconnectIntervalM>10</relayReconnectIntervalM>
  180. <startBrowser>true</startBrowser>
  181. <natEnabled>true</natEnabled>
  182. <natLeaseMinutes>60</natLeaseMinutes>
  183. <natRenewalMinutes>30</natRenewalMinutes>
  184. <natTimeoutSeconds>10</natTimeoutSeconds>
  185. <urAccepted>0</urAccepted>
  186. <urSeen>0</urSeen>
  187. <urUniqueID></urUniqueID>
  188. <urURL>https://data.syncthing.net/newdata</urURL>
  189. <urPostInsecurely>false</urPostInsecurely>
  190. <urInitialDelayS>1800</urInitialDelayS>
  191. <restartOnWakeup>true</restartOnWakeup>
  192. <autoUpgradeIntervalH>12</autoUpgradeIntervalH>
  193. <upgradeToPreReleases>false</upgradeToPreReleases>
  194. <keepTemporariesH>24</keepTemporariesH>
  195. <cacheIgnoredFiles>false</cacheIgnoredFiles>
  196. <progressUpdateIntervalS>5</progressUpdateIntervalS>
  197. <limitBandwidthInLan>false</limitBandwidthInLan>
  198. <minHomeDiskFree unit="%">1</minHomeDiskFree>
  199. <releasesURL>https://upgrades.syncthing.net/meta.json</releasesURL>
  200. <overwriteRemoteDeviceNamesOnConnect>false</overwriteRemoteDeviceNamesOnConnect>
  201. <tempIndexMinBlocks>10</tempIndexMinBlocks>
  202. <unackedNotificationID>authenticationUserAndPassword</unackedNotificationID>
  203. <trafficClass>0</trafficClass>
  204. <setLowPriority>true</setLowPriority>
  205. <maxFolderConcurrency>0</maxFolderConcurrency>
  206. <crashReportingURL>https://crash.syncthing.net/newcrash</crashReportingURL>
  207. <crashReportingEnabled>true</crashReportingEnabled>
  208. <stunKeepaliveStartS>180</stunKeepaliveStartS>
  209. <stunKeepaliveMinS>20</stunKeepaliveMinS>
  210. <stunServer>default</stunServer>
  211. <databaseTuning>auto</databaseTuning>
  212. <maxConcurrentIncomingRequestKiB>0</maxConcurrentIncomingRequestKiB>
  213. <announceLANAddresses>true</announceLANAddresses>
  214. <sendFullIndexOnUpgrade>false</sendFullIndexOnUpgrade>
  215. <connectionLimitEnough>0</connectionLimitEnough>
  216. <connectionLimitMax>0</connectionLimitMax>
  217. <insecureAllowOldTLSVersions>false</insecureAllowOldTLSVersions>
  218. </options>
  219. <remoteIgnoredDevice time="2022\-01\-09T20:02:01Z" id="5SYI2FS\-LW6YAXI\-JJDYETS\-NDBBPIO\-256MWBO\-XDPXWVG\-24QPUM4\-PDW4UQU" name="bugger" address="192.168.0.20:22000"></remoteIgnoredDevice>
  220. <defaults>
  221. <folder id="" label="" path="~" type="sendreceive" rescanIntervalS="3600" fsWatcherEnabled="true" fsWatcherDelayS="10" ignorePerms="false" autoNormalize="true">
  222. <filesystemType>basic</filesystemType>
  223. <device id="S7UKX27\-GI7ZTXS\-GC6RKUA\-7AJGZ44\-C6NAYEB\-HSKTJQK\-KJHU2NO\-CWV7EQW" introducedBy="">
  224. <encryptionPassword></encryptionPassword>
  225. </device>
  226. <minDiskFree unit="%">1</minDiskFree>
  227. <versioning>
  228. <cleanupIntervalS>3600</cleanupIntervalS>
  229. <fsPath></fsPath>
  230. <fsType>basic</fsType>
  231. </versioning>
  232. <copiers>0</copiers>
  233. <pullerMaxPendingKiB>0</pullerMaxPendingKiB>
  234. <hashers>0</hashers>
  235. <order>random</order>
  236. <ignoreDelete>false</ignoreDelete>
  237. <scanProgressIntervalS>0</scanProgressIntervalS>
  238. <pullerPauseS>0</pullerPauseS>
  239. <maxConflicts>10</maxConflicts>
  240. <disableSparseFiles>false</disableSparseFiles>
  241. <disableTempIndexes>false</disableTempIndexes>
  242. <paused>false</paused>
  243. <weakHashThresholdPct>25</weakHashThresholdPct>
  244. <markerName>.stfolder</markerName>
  245. <copyOwnershipFromParent>false</copyOwnershipFromParent>
  246. <modTimeWindowS>0</modTimeWindowS>
  247. <maxConcurrentWrites>2</maxConcurrentWrites>
  248. <disableFsync>false</disableFsync>
  249. <blockPullOrder>standard</blockPullOrder>
  250. <copyRangeMethod>standard</copyRangeMethod>
  251. <caseSensitiveFS>false</caseSensitiveFS>
  252. <junctionsAsDirs>false</junctionsAsDirs>
  253. </folder>
  254. <device id="" compression="metadata" introducer="false" skipIntroductionRemovals="false" introducedBy="">
  255. <address>dynamic</address>
  256. <paused>false</paused>
  257. <autoAcceptFolders>false</autoAcceptFolders>
  258. <maxSendKbps>0</maxSendKbps>
  259. <maxRecvKbps>0</maxRecvKbps>
  260. <maxRequestKiB>0</maxRequestKiB>
  261. <untrusted>false</untrusted>
  262. <remoteGUIPort>0</remoteGUIPort>
  263. </device>
  264. </defaults>
  265. </configuration>
  266. .ft P
  267. .fi
  268. .UNINDENT
  269. .UNINDENT
  270. .SH CONFIGURATION ELEMENT
  271. .INDENT 0.0
  272. .INDENT 3.5
  273. .sp
  274. .nf
  275. .ft C
  276. <configuration version="35">
  277. <folder></folder>
  278. <device></device>
  279. <gui></gui>
  280. <ldap></ldap>
  281. <options></options>
  282. <remoteIgnoredDevice></remoteIgnoredDevice>
  283. <defaults></defaults>
  284. </configuration>
  285. .ft P
  286. .fi
  287. .UNINDENT
  288. .UNINDENT
  289. .sp
  290. This is the root element. It has one attribute:
  291. .INDENT 0.0
  292. .TP
  293. .B version
  294. The config version. Increments whenever a change is made that requires
  295. migration from previous formats.
  296. .UNINDENT
  297. .sp
  298. It contains the elements described in the following sections and any number of
  299. this additional child element:
  300. .INDENT 0.0
  301. .TP
  302. .B remoteIgnoredDevice
  303. Contains the ID of the device that should be ignored. Connection attempts
  304. from this device are logged to the console but never displayed in the web
  305. GUI.
  306. .UNINDENT
  307. .SH FOLDER ELEMENT
  308. .INDENT 0.0
  309. .INDENT 3.5
  310. .sp
  311. .nf
  312. .ft C
  313. <folder id="default" label="Default Folder" path="/Users/jb/Sync/" type="sendreceive" rescanIntervalS="3600" fsWatcherEnabled="true" fsWatcherDelayS="10" ignorePerms="false" autoNormalize="true">
  314. <filesystemType>basic</filesystemType>
  315. <device id="S7UKX27\-GI7ZTXS\-GC6RKUA\-7AJGZ44\-C6NAYEB\-HSKTJQK\-KJHU2NO\-CWV7EQW" introducedBy="">
  316. <encryptionPassword></encryptionPassword>
  317. </device>
  318. <minDiskFree unit="%">1</minDiskFree>
  319. <versioning>
  320. <cleanupIntervalS>3600</cleanupIntervalS>
  321. <fsPath></fsPath>
  322. <fsType>basic</fsType>
  323. </versioning>
  324. <copiers>0</copiers>
  325. <pullerMaxPendingKiB>0</pullerMaxPendingKiB>
  326. <hashers>0</hashers>
  327. <order>random</order>
  328. <ignoreDelete>false</ignoreDelete>
  329. <scanProgressIntervalS>0</scanProgressIntervalS>
  330. <pullerPauseS>0</pullerPauseS>
  331. <maxConflicts>\-1</maxConflicts>
  332. <disableSparseFiles>false</disableSparseFiles>
  333. <disableTempIndexes>false</disableTempIndexes>
  334. <paused>false</paused>
  335. <weakHashThresholdPct>25</weakHashThresholdPct>
  336. <markerName>.stfolder</markerName>
  337. <copyOwnershipFromParent>false</copyOwnershipFromParent>
  338. <modTimeWindowS>0</modTimeWindowS>
  339. <maxConcurrentWrites>2</maxConcurrentWrites>
  340. <disableFsync>false</disableFsync>
  341. <blockPullOrder>standard</blockPullOrder>
  342. <copyRangeMethod>standard</copyRangeMethod>
  343. <caseSensitiveFS>false</caseSensitiveFS>
  344. <junctionsAsDirs>false</junctionsAsDirs>
  345. </folder>
  346. .ft P
  347. .fi
  348. .UNINDENT
  349. .UNINDENT
  350. .sp
  351. One or more \fBfolder\fP elements must be present in the file. Each element
  352. describes one folder. The following attributes may be set on the \fBfolder\fP
  353. element:
  354. .INDENT 0.0
  355. .TP
  356. .B id
  357. The folder ID, which must be unique. (mandatory)
  358. .TP
  359. .B label
  360. The label of a folder is a human readable and descriptive local name. May
  361. be different on each device, empty, and/or identical to other folder
  362. labels. (optional)
  363. .TP
  364. .B path
  365. The path to the directory where the folder is stored on this
  366. device; not sent to other devices. (mandatory)
  367. .TP
  368. .B type
  369. Controls how the folder is handled by Syncthing. Possible values are:
  370. .INDENT 7.0
  371. .TP
  372. .B sendreceive
  373. The folder is in default mode. Sending local and accepting remote changes.
  374. Note that this type was previously called “readwrite” which is deprecated
  375. but still accepted in incoming configs.
  376. .TP
  377. .B sendonly
  378. The folder is in “send only” mode – it will not be modified by
  379. Syncthing on this device.
  380. Note that this type was previously called “readonly” which is deprecated
  381. but still accepted in incoming configs.
  382. .TP
  383. .B receiveonly
  384. The folder is in “receive only” mode – it will not propagate
  385. changes to other devices.
  386. .UNINDENT
  387. .TP
  388. .B rescanIntervalS
  389. The rescan interval, in seconds. Can be set to \fB0\fP to disable when external
  390. plugins are used to trigger rescans.
  391. .TP
  392. .B fsWatcherEnabled
  393. If set to \fBtrue\fP, this detects changes to files in the folder and scans them.
  394. .UNINDENT
  395. .INDENT 0.0
  396. .TP
  397. .B fsWatcherDelayS
  398. The duration during which changes detected are accumulated, before a scan is
  399. scheduled (only takes effect if \fBfsWatcherEnabled\fP is set to \fBtrue\fP).
  400. .TP
  401. .B ignorePerms
  402. True if the folder should ignore permissions.
  403. .TP
  404. .B autoNormalize
  405. Automatically correct UTF\-8 normalization errors found in file names.
  406. .UNINDENT
  407. .sp
  408. The following child elements may exist:
  409. .INDENT 0.0
  410. .TP
  411. .B device
  412. These must have the \fBid\fP attribute and can have an \fBintroducedBy\fP attribute,
  413. identifying the device that introduced us to share this folder with the given device.
  414. If the original introducer unshares this folder with this device, our device will follow
  415. and unshare the folder (subject to skipIntroductionRemovals being false on the introducer device).
  416. All mentioned devices are those that will be sharing the folder in question.
  417. Each mentioned device must have a separate \fBdevice\fP element later in the file.
  418. It is customary that the local device ID is included in all folders.
  419. Syncthing will currently add this automatically if it is not present in
  420. the configuration file.
  421. .TP
  422. .B minDiskFree
  423. The minimum required free space that should be available on the disk this folder
  424. resides. The folder will be stopped when the value drops below the threshold. Accepted units are
  425. \fB%\fP, \fBkB\fP, \fBMB\fP, \fBGB\fP and \fBTB\fP\&. Set to zero to disable.
  426. .TP
  427. .B versioning
  428. Specifies a versioning configuration.
  429. .UNINDENT
  430. .sp
  431. \fBSEE ALSO:\fP
  432. .INDENT 0.0
  433. .INDENT 3.5
  434. versioning
  435. .UNINDENT
  436. .UNINDENT
  437. .INDENT 0.0
  438. .TP
  439. .B copiers, pullers, hashers
  440. The number of copier, puller and hasher routines to use, or \fB0\fP for the
  441. system determined optimums. These are low level performance options for
  442. advanced users only; do not change unless requested to or you’ve actually
  443. read and understood the code yourself. :)
  444. .TP
  445. .B order
  446. The order in which needed files should be pulled from the cluster.
  447. The possibles values are:
  448. .INDENT 7.0
  449. .TP
  450. .B random
  451. Pull files in random order. This optimizes for balancing resources among
  452. the devices in a cluster.
  453. .TP
  454. .B alphabetic
  455. Pull files ordered by file name alphabetically.
  456. .TP
  457. .B smallestFirst, largestFirst
  458. Pull files ordered by file size; smallest and largest first respectively.
  459. .TP
  460. .B oldestFirst, newestFirst
  461. Pull files ordered by modification time; oldest and newest first
  462. respectively.
  463. .UNINDENT
  464. .sp
  465. Note that the scanned files are sent in batches and the sorting is applied
  466. only to the already discovered files. This means the sync might start with
  467. a 1 GB file even if there is 1 KB file available on the source device until
  468. the 1 KB becomes known to the pulling device.
  469. .TP
  470. .B ignoreDelete
  471. .
  472. \fBWARNING:\fP
  473. .INDENT 7.0
  474. .INDENT 3.5
  475. Enabling this is highly discouraged \- use at your own risk. You have been warned.
  476. .UNINDENT
  477. .UNINDENT
  478. .sp
  479. When set to \fBtrue\fP, this device will pretend not to see instructions to
  480. delete files from other devices.
  481. .TP
  482. .B scanProgressIntervalS
  483. The interval in seconds with which scan progress information is sent to the GUI. Setting to \fB0\fP
  484. will cause Syncthing to use the default value of two.
  485. .TP
  486. .B pullerPauseS
  487. Tweak for rate limiting the puller when it retries pulling files. Don’t
  488. change this unless you know what you’re doing.
  489. .TP
  490. .B maxConflicts
  491. The maximum number of conflict copies to keep around for any given file.
  492. The default, \fB\-1\fP, means an unlimited number. Setting this to \fB0\fP disables
  493. conflict copies altogether.
  494. .TP
  495. .B disableSparseFiles
  496. By default, blocks containing all zeros are not written, causing files
  497. to be sparse on filesystems that support this feature. When set to \fBtrue\fP,
  498. sparse files will not be created.
  499. .TP
  500. .B disableTempIndexes
  501. By default, devices exchange information about blocks available in
  502. transfers that are still in progress, which allows other devices to
  503. download parts of files that are not yet fully downloaded on your own
  504. device, essentially making transfers more torrent like. When set to
  505. \fBtrue\fP, such information is not exchanged for this folder.
  506. .TP
  507. .B paused
  508. True if this folder is (temporarily) suspended.
  509. .TP
  510. .B weakHashThresholdPct
  511. Use weak hash if more than the given percentage of the file has changed. Set
  512. to \fB\-1\fP to always use weak hash. Default is \fB25\fP\&.
  513. .TP
  514. .B markerName
  515. Name of a directory or file in the folder root to be used as
  516. marker\-faq\&. Default is \fB\&.stfolder\fP\&.
  517. .TP
  518. .B copyOwnershipFromParent
  519. On Unix systems, tries to copy file/folder ownership from the parent directory (the directory it’s located in).
  520. Requires running Syncthing as a privileged user, or granting it additional capabilities (e.g. CAP_CHOWN on Linux).
  521. .TP
  522. .B modTimeWindowS
  523. Allowed modification timestamp difference when comparing files for
  524. equivalence. To be used on file systems which have unstable
  525. modification timestamps that might change after being recorded
  526. during the last write operation. Default is \fB2\fP on Android when the
  527. folder is located on a FAT partition, and \fB0\fP otherwise.
  528. .TP
  529. .B maxConcurrentWrites
  530. Maximum number of concurrent write operations while syncing. Increasing this might increase or
  531. decrease disk performance, depending on the underlying storage. Default is \fB2\fP\&.
  532. .UNINDENT
  533. .sp
  534. disableFsync
  535. .INDENT 0.0
  536. .INDENT 3.5
  537. .sp
  538. \fBWARNING:\fP
  539. .INDENT 0.0
  540. .INDENT 3.5
  541. This is a known insecure option \- use at your own risk.
  542. .UNINDENT
  543. .UNINDENT
  544. .sp
  545. Disables committing file operations to disk before recording them in the database.
  546. Disabling fsync can lead to data corruption.
  547. .UNINDENT
  548. .UNINDENT
  549. .INDENT 0.0
  550. .TP
  551. .B blockPullOrder
  552. Order in which the blocks of a file are downloaded. This option controls how quickly different parts of the
  553. file spread between the connected devices, at the cost of causing strain on the storage.
  554. .sp
  555. Available options:
  556. .INDENT 7.0
  557. .TP
  558. .B standard (default):
  559. The blocks of a file are split into N equal continuous sequences, where N is the number of connected
  560. devices. Each device starts downloading its own sequence, after which it picks other devices
  561. sequences at random. Provides acceptable data distribution and minimal spinning disk strain.
  562. .TP
  563. .B random:
  564. The blocks of a file are downloaded in a random order. Provides great data distribution, but very taxing on
  565. spinning disk drives.
  566. .TP
  567. .B inOrder:
  568. The blocks of a file are downloaded sequentially, from start to finish. Spinning disk drive friendly, but provides
  569. no improvements to data distribution.
  570. .UNINDENT
  571. .TP
  572. .B copyRangeMethod
  573. Provides a choice of method for copying data between files. This can be used to optimise copies on network
  574. filesystems, improve speed of large copies or clone the data using copy\-on\-write functionality if the underlying
  575. filesystem supports it.
  576. .sp
  577. See folder\-copyRangeMethod for details.
  578. .UNINDENT
  579. .SH DEVICE ELEMENT
  580. .INDENT 0.0
  581. .INDENT 3.5
  582. .sp
  583. .nf
  584. .ft C
  585. <device id="S7UKX27\-GI7ZTXS\-GC6RKUA\-7AJGZ44\-C6NAYEB\-HSKTJQK\-KJHU2NO\-CWV7EQW" name="syno" compression="metadata" introducer="false" skipIntroductionRemovals="false" introducedBy="2CYF2WQ\-AKZO2QZ\-JAKWLYD\-AGHMQUM\-BGXUOIS\-GYILW34\-HJG3DUK\-LRRYQAR">
  586. <address>dynamic</address>
  587. <paused>false</paused>
  588. <autoAcceptFolders>false</autoAcceptFolders>
  589. <maxSendKbps>0</maxSendKbps>
  590. <maxRecvKbps>0</maxRecvKbps>
  591. <ignoredFolder time="2022\-01\-09T19:09:52Z" id="br63e\-wyhb7" label="Foo"></ignoredFolder>
  592. <maxRequestKiB>0</maxRequestKiB>
  593. <untrusted>false</untrusted>
  594. <remoteGUIPort>0</remoteGUIPort>
  595. </device>
  596. <device id="2CYF2WQ\-AKZO2QZ\-JAKWLYD\-AGHMQUM\-BGXUOIS\-GYILW34\-HJG3DUK\-LRRYQAR" name="syno local" compression="metadata" introducer="true" skipIntroductionRemovals="false" introducedBy="">
  597. <address>tcp://192.0.2.1:22001</address>
  598. <paused>true</paused>
  599. <allowedNetwork>192.168.0.0/16</allowedNetwork>
  600. <autoAcceptFolders>false</autoAcceptFolders>
  601. <maxSendKbps>100</maxSendKbps>
  602. <maxRecvKbps>100</maxRecvKbps>
  603. <maxRequestKiB>65536</maxRequestKiB>
  604. <untrusted>false</untrusted>
  605. <remoteGUIPort>8384</remoteGUIPort>
  606. </device>
  607. .ft P
  608. .fi
  609. .UNINDENT
  610. .UNINDENT
  611. .sp
  612. One or more \fBdevice\fP elements must be present in the file. Each element
  613. describes a device participating in the cluster. It is customary to include a
  614. \fBdevice\fP element for the local device; Syncthing will currently add one if
  615. it is not present. The following attributes may be set on the \fBdevice\fP
  616. element:
  617. .INDENT 0.0
  618. .TP
  619. .B id
  620. The device ID\&. (mandatory)
  621. .TP
  622. .B name
  623. A friendly name for the device. (optional)
  624. .TP
  625. .B compression
  626. Whether to use protocol compression when sending messages to this device.
  627. The possible values are:
  628. .INDENT 7.0
  629. .TP
  630. .B metadata
  631. Compress metadata packets, such as index information. Metadata is
  632. usually very compression friendly so this is a good default.
  633. .TP
  634. .B always
  635. Compress all packets, including file data. This is recommended if the
  636. folders contents are mainly compressible data such as documents or
  637. text files.
  638. .TP
  639. .B never
  640. Disable all compression.
  641. .UNINDENT
  642. .TP
  643. .B introducer
  644. Set to true if this device should be trusted as an introducer, i.e. we
  645. should copy their list of devices per folder when connecting.
  646. .UNINDENT
  647. .sp
  648. \fBSEE ALSO:\fP
  649. .INDENT 0.0
  650. .INDENT 3.5
  651. introducer
  652. .UNINDENT
  653. .UNINDENT
  654. .INDENT 0.0
  655. .TP
  656. .B skipIntroductionRemovals
  657. Set to true if you wish to follow only introductions and not de\-introductions.
  658. For example, if this is set, we would not remove a device that we were introduced
  659. to even if the original introducer is no longer listing the remote device as known.
  660. .TP
  661. .B introducedBy
  662. Defines which device has introduced us to this device. Used only for following de\-introductions.
  663. .TP
  664. .B certName
  665. The device certificate’s common name, if it is not the default “syncthing”.
  666. .UNINDENT
  667. .sp
  668. From the following child elements at least one \fBaddress\fP child must exist.
  669. .INDENT 0.0
  670. .TP
  671. .B address
  672. Contains an address or host name to use when attempting to connect to this device.
  673. Entries other than \fBdynamic\fP need a protocol specific prefix. For the TCP protocol
  674. the prefixes \fBtcp://\fP (dual\-stack), \fBtcp4://\fP (IPv4 only) or \fBtcp6://\fP (IPv6 only) can be used.
  675. The prefixes for the QUIC protocol are analogous: \fBquic://\fP, \fBquic4://\fP and \fBquic6://\fP
  676. Note that IP addresses need not use IPv4 or IPv6 prefixes; these are optional. Accepted formats are:
  677. .INDENT 7.0
  678. .TP
  679. .B IPv4 address (\fBtcp://192.0.2.42\fP)
  680. The default port (22000) is used.
  681. .TP
  682. .B IPv4 address and port (\fBtcp://192.0.2.42:12345\fP)
  683. The address and port is used as given.
  684. .TP
  685. .B IPv6 address (\fBtcp://[2001:db8::23:42]\fP)
  686. The default port (22000) is used. The address must be enclosed in
  687. square brackets.
  688. .TP
  689. .B IPv6 address and port (\fBtcp://[2001:db8::23:42]:12345\fP)
  690. The address and port is used as given. The address must be enclosed in
  691. square brackets.
  692. .TP
  693. .B Host name (\fBtcp6://fileserver\fP)
  694. The host name will be used on the default port (22000) and connections
  695. will be attempted only via IPv6.
  696. .TP
  697. .B Host name and port (\fBtcp://fileserver:12345\fP)
  698. The host name will be used on the given port and connections will be
  699. attempted via both IPv4 and IPv6, depending on name resolution.
  700. .TP
  701. .B \fBdynamic\fP
  702. The word \fBdynamic\fP (without any prefix) means to use local and
  703. global discovery to find the device.
  704. .UNINDENT
  705. .sp
  706. You can set multiple addresses \fIand\fP combine it with the \fBdynamic\fP keyword
  707. for example:
  708. .INDENT 7.0
  709. .INDENT 3.5
  710. .sp
  711. .nf
  712. .ft C
  713. <device id="...">
  714. <address>tcp://192.0.2.1:22001</address>
  715. <address>quic://192.0.1.254:22000</address>
  716. <address>dynamic</address>
  717. </device>
  718. .ft P
  719. .fi
  720. .UNINDENT
  721. .UNINDENT
  722. .TP
  723. .B paused
  724. True if synchronization with this devices is (temporarily) suspended.
  725. .TP
  726. .B allowedNetwork
  727. If given, this restricts connections to this device to only this network
  728. (see allowed\-networks).
  729. .TP
  730. .B maxSendKbps
  731. Maximum send rate to use for this device. Unit is kibibytes/second, despite
  732. the config name looking like kilobits/second.
  733. .TP
  734. .B maxRecvKbps
  735. Maximum receive rate to use for this device. Unit is kibibytes/second,
  736. despite the config name looking like kilobits/second.
  737. .TP
  738. .B ignoredFolder
  739. Contains the ID of the folder that should be ignored. This folder will
  740. always be skipped when advertised from the containing remote device,
  741. i.e. this will be logged, but there will be no dialog shown in the web GUI.
  742. .TP
  743. .B maxRequestKiB
  744. Maximum amount of data to have outstanding in requests towards this device.
  745. Unit is kibibytes.
  746. .TP
  747. .B remoteGUIPort
  748. If set to a positive integer, the GUI will display an HTTP link to the IP
  749. address which is currently used for synchronization. Only the TCP port is
  750. exchanged for the value specified here. Note that any port forwarding or
  751. firewall settings need to be done manually and the link will probably not
  752. work for link\-local IPv6 addresses because of modern browser limitations.
  753. .UNINDENT
  754. .SH GUI ELEMENT
  755. .INDENT 0.0
  756. .INDENT 3.5
  757. .sp
  758. .nf
  759. .ft C
  760. <gui enabled="true" tls="false" debugging="false">
  761. <address>127.0.0.1:8384</address>
  762. <apikey>k1dnz1Dd0rzTBjjFFh7CXPnrF12C49B1</apikey>
  763. <theme>default</theme>
  764. </gui>
  765. .ft P
  766. .fi
  767. .UNINDENT
  768. .UNINDENT
  769. .sp
  770. There must be exactly one \fBgui\fP element. The GUI configuration is also used
  771. by the rest\-api and the event\-api\&. The following attributes may
  772. be set on the \fBgui\fP element:
  773. .INDENT 0.0
  774. .TP
  775. .B enabled
  776. If not \fBtrue\fP, the GUI and API will not be started.
  777. .TP
  778. .B tls
  779. If set to \fBtrue\fP, TLS (HTTPS) will be enforced. Non\-HTTPS requests will
  780. be redirected to HTTPS. When set to \fBfalse\fP, TLS connections are
  781. still possible but not required.
  782. .TP
  783. .B debugging
  784. This enables profiling and additional debugging endpoints in the rest\-api\&.
  785. .UNINDENT
  786. .sp
  787. The following child elements may be present:
  788. .INDENT 0.0
  789. .TP
  790. .B address
  791. Set the listen address. Exactly one address element must be present. Allowed address formats are:
  792. .INDENT 7.0
  793. .TP
  794. .B IPv4 address and port (\fB127.0.0.1:8384\fP)
  795. The address and port are used as given.
  796. .TP
  797. .B IPv6 address and port (\fB[::1]:8384\fP)
  798. The address and port are used as given. The address must be enclosed in
  799. square brackets.
  800. .TP
  801. .B Wildcard and port (\fB0.0.0.0:12345\fP, \fB[::]:12345\fP, \fB:12345\fP)
  802. These are equivalent and will result in Syncthing listening on all
  803. interfaces via both IPv4 and IPv6.
  804. .TP
  805. .B UNIX socket location (\fB/var/run/st.sock\fP)
  806. If the address is an absolute path it is interpreted as the path to a UNIX socket.
  807. .UNINDENT
  808. .TP
  809. .B unixSocketPermissions
  810. When \fBaddress\fP is set to a UNIX socket location, set this to an octal value
  811. to override the default permissions of the socket.
  812. .TP
  813. .B user
  814. Set to require authentication.
  815. .TP
  816. .B password
  817. Contains the bcrypt hash of the real password.
  818. .TP
  819. .B apikey
  820. If set, this is the API key that enables usage of the REST interface.
  821. .TP
  822. .B insecureAdminAccess
  823. If true, this allows access to the web GUI from outside (i.e. not localhost)
  824. without authorization. A warning will displayed about this setting on startup.
  825. .TP
  826. .B theme
  827. The name of the theme to use.
  828. .TP
  829. .B authMode
  830. Authentication mode to use. If not present, the authentication mode (static)
  831. is controlled by the presence of user/password fields for backward compatibility.
  832. .INDENT 7.0
  833. .TP
  834. .B static
  835. Authentication using user and password.
  836. .TP
  837. .B ldap
  838. LDAP authentication. Requires ldap top level config section to be present.
  839. .UNINDENT
  840. .UNINDENT
  841. .SH LDAP ELEMENT
  842. .INDENT 0.0
  843. .INDENT 3.5
  844. .sp
  845. .nf
  846. .ft C
  847. <ldap>
  848. <address>localhost:389</address>
  849. <bindDN>cn=%s,ou=users,dc=syncthing,dc=net</bindDN>
  850. <transport>nontls</transport>
  851. <insecureSkipVerify>false</insecureSkipVerify>
  852. </ldap>
  853. .ft P
  854. .fi
  855. .UNINDENT
  856. .UNINDENT
  857. .sp
  858. The \fBldap\fP element contains LDAP configuration options.
  859. .INDENT 0.0
  860. .TP
  861. .B address
  862. LDAP server address (server:port).
  863. .TP
  864. .B bindDN
  865. BindDN for user authentication.
  866. Special \fB%s\fP variable should be used to pass username to LDAP.
  867. .UNINDENT
  868. .sp
  869. transport
  870. .INDENT 0.0
  871. .INDENT 3.5
  872. .INDENT 0.0
  873. .TP
  874. .B nontls
  875. Non secure connection.
  876. .TP
  877. .B tls
  878. TLS secured connection.
  879. .TP
  880. .B starttls
  881. StartTLS connection mode.
  882. .UNINDENT
  883. .UNINDENT
  884. .UNINDENT
  885. .INDENT 0.0
  886. .TP
  887. .B insecureSkipVerify
  888. Skip verification (\fBtrue\fP or \fBfalse\fP).
  889. .UNINDENT
  890. .SH OPTIONS ELEMENT
  891. .INDENT 0.0
  892. .INDENT 3.5
  893. .sp
  894. .nf
  895. .ft C
  896. <options>
  897. <listenAddress>default</listenAddress>
  898. <globalAnnounceServer>default</globalAnnounceServer>
  899. <globalAnnounceEnabled>true</globalAnnounceEnabled>
  900. <localAnnounceEnabled>true</localAnnounceEnabled>
  901. <localAnnouncePort>21027</localAnnouncePort>
  902. <localAnnounceMCAddr>[ff12::8384]:21027</localAnnounceMCAddr>
  903. <maxSendKbps>0</maxSendKbps>
  904. <maxRecvKbps>0</maxRecvKbps>
  905. <reconnectionIntervalS>60</reconnectionIntervalS>
  906. <relaysEnabled>true</relaysEnabled>
  907. <relayReconnectIntervalM>10</relayReconnectIntervalM>
  908. <startBrowser>true</startBrowser>
  909. <natEnabled>true</natEnabled>
  910. <natLeaseMinutes>60</natLeaseMinutes>
  911. <natRenewalMinutes>30</natRenewalMinutes>
  912. <natTimeoutSeconds>10</natTimeoutSeconds>
  913. <urAccepted>0</urAccepted>
  914. <urSeen>0</urSeen>
  915. <urUniqueID></urUniqueID>
  916. <urURL>https://data.syncthing.net/newdata</urURL>
  917. <urPostInsecurely>false</urPostInsecurely>
  918. <urInitialDelayS>1800</urInitialDelayS>
  919. <restartOnWakeup>true</restartOnWakeup>
  920. <autoUpgradeIntervalH>12</autoUpgradeIntervalH>
  921. <upgradeToPreReleases>false</upgradeToPreReleases>
  922. <keepTemporariesH>24</keepTemporariesH>
  923. <cacheIgnoredFiles>false</cacheIgnoredFiles>
  924. <progressUpdateIntervalS>5</progressUpdateIntervalS>
  925. <limitBandwidthInLan>false</limitBandwidthInLan>
  926. <minHomeDiskFree unit="%">1</minHomeDiskFree>
  927. <releasesURL>https://upgrades.syncthing.net/meta.json</releasesURL>
  928. <overwriteRemoteDeviceNamesOnConnect>false</overwriteRemoteDeviceNamesOnConnect>
  929. <tempIndexMinBlocks>10</tempIndexMinBlocks>
  930. <unackedNotificationID>authenticationUserAndPassword</unackedNotificationID>
  931. <trafficClass>0</trafficClass>
  932. <setLowPriority>true</setLowPriority>
  933. <maxFolderConcurrency>0</maxFolderConcurrency>
  934. <crashReportingURL>https://crash.syncthing.net/newcrash</crashReportingURL>
  935. <crashReportingEnabled>true</crashReportingEnabled>
  936. <stunKeepaliveStartS>180</stunKeepaliveStartS>
  937. <stunKeepaliveMinS>20</stunKeepaliveMinS>
  938. <stunServer>default</stunServer>
  939. <databaseTuning>auto</databaseTuning>
  940. <maxConcurrentIncomingRequestKiB>0</maxConcurrentIncomingRequestKiB>
  941. <announceLANAddresses>true</announceLANAddresses>
  942. <sendFullIndexOnUpgrade>false</sendFullIndexOnUpgrade>
  943. <connectionLimitEnough>0</connectionLimitEnough>
  944. <connectionLimitMax>0</connectionLimitMax>
  945. <insecureAllowOldTLSVersions>false</insecureAllowOldTLSVersions>
  946. </options>
  947. .ft P
  948. .fi
  949. .UNINDENT
  950. .UNINDENT
  951. .sp
  952. The \fBoptions\fP element contains all other global configuration options.
  953. .INDENT 0.0
  954. .TP
  955. .B listenAddress
  956. The listen address for incoming sync connections. See
  957. \fI\%Listen Addresses\fP for the allowed syntax.
  958. .TP
  959. .B globalAnnounceServer
  960. A URI to a global announce (discovery) server, or the word \fBdefault\fP to
  961. include the default servers. Any number of globalAnnounceServer elements
  962. may be present. The syntax for non\-default entries is that of an HTTP or
  963. HTTPS URL. A number of options may be added as query options to the URL:
  964. \fBinsecure\fP to prevent certificate validation (required for HTTP URLs)
  965. and \fBid=<device ID>\fP to perform certificate pinning. The device ID to
  966. use is printed by the discovery server on startup.
  967. .TP
  968. .B globalAnnounceEnabled
  969. Whether to announce this device to the global announce (discovery) server,
  970. and also use it to look up other devices.
  971. .TP
  972. .B localAnnounceEnabled
  973. Whether to send announcements to the local LAN, also use such
  974. announcements to find other devices.
  975. .TP
  976. .B localAnnouncePort
  977. The port on which to listen and send IPv4 broadcast announcements to.
  978. .TP
  979. .B localAnnounceMCAddr
  980. The group address and port to join and send IPv6 multicast announcements on.
  981. .TP
  982. .B maxSendKbps
  983. Outgoing data rate limit, in kibibytes per second.
  984. .TP
  985. .B maxRecvKbps
  986. Incoming data rate limits, in kibibytes per second.
  987. .TP
  988. .B reconnectionIntervalS
  989. The number of seconds to wait between each attempt to connect to currently
  990. unconnected devices.
  991. .TP
  992. .B relaysEnabled
  993. When \fBtrue\fP, relays will be connected to and potentially used for device to device connections.
  994. .TP
  995. .B relayReconnectIntervalM
  996. Sets the interval, in minutes, between relay reconnect attempts.
  997. .TP
  998. .B startBrowser
  999. Whether to attempt to start a browser to show the GUI when Syncthing starts.
  1000. .TP
  1001. .B natEnabled
  1002. Whether to attempt to perform a UPnP and NAT\-PMP port mapping for
  1003. incoming sync connections.
  1004. .TP
  1005. .B natLeaseMinutes
  1006. Request a lease for this many minutes; zero to request a permanent lease.
  1007. .TP
  1008. .B natRenewalMinutes
  1009. Attempt to renew the lease after this many minutes.
  1010. .TP
  1011. .B natTimeoutSeconds
  1012. When scanning for UPnP devices, wait this long for responses.
  1013. .TP
  1014. .B urAccepted
  1015. Whether the user has accepted to submit anonymous usage data. The default,
  1016. \fB0\fP, mean the user has not made a choice, and Syncthing will ask at some
  1017. point in the future. \fB\-1\fP means no, a number above zero means that that
  1018. version of usage reporting has been accepted.
  1019. .TP
  1020. .B urSeen
  1021. The highest usage reporting version that has already been shown in the web GUI.
  1022. .TP
  1023. .B urUniqueID
  1024. The unique ID sent together with the usage report. Generated when usage
  1025. reporting is enabled.
  1026. .TP
  1027. .B urURL
  1028. The URL to post usage report data to, when enabled.
  1029. .TP
  1030. .B urPostInsecurely
  1031. When true, the UR URL can be http instead of https, or have a self\-signed
  1032. certificate. The default is \fBfalse\fP\&.
  1033. .TP
  1034. .B urInitialDelayS
  1035. The time to wait from startup for the first usage report to be sent. Allows
  1036. the system to stabilize before reporting statistics.
  1037. .TP
  1038. .B restartOnWakeup
  1039. Whether to perform a restart of Syncthing when it is detected that we are
  1040. waking from sleep mode (i.e. an unfolding laptop).
  1041. .TP
  1042. .B autoUpgradeIntervalH
  1043. Check for a newer version after this many hours. Set to \fB0\fP to disable
  1044. automatic upgrades.
  1045. .TP
  1046. .B upgradeToPreReleases
  1047. If \fBtrue\fP, automatic upgrades include release candidates (see
  1048. releases).
  1049. .TP
  1050. .B keepTemporariesH
  1051. Keep temporary failed transfers for this many hours. While the temporaries
  1052. are kept, the data they contain need not be transferred again.
  1053. .TP
  1054. .B cacheIgnoredFiles
  1055. Whether to cache the results of ignore pattern evaluation. Performance
  1056. at the price of memory. Defaults to \fBfalse\fP as the cost for evaluating
  1057. ignores is usually not significant.
  1058. .TP
  1059. .B progressUpdateIntervalS
  1060. How often in seconds the progress of ongoing downloads is made available to
  1061. the GUI.
  1062. .TP
  1063. .B limitBandwidthInLan
  1064. Whether to apply bandwidth limits to devices in the same broadcast domain
  1065. as the local device.
  1066. .TP
  1067. .B minHomeDiskFree
  1068. The minimum required free space that should be available on the
  1069. partition holding the configuration and index. Accepted units are \fB%\fP, \fBkB\fP,
  1070. \fBMB\fP, \fBGB\fP and \fBTB\fP\&.
  1071. .TP
  1072. .B releasesURL
  1073. The URL from which release information is loaded, for automatic upgrades.
  1074. .TP
  1075. .B alwaysLocalNet
  1076. Network that should be considered as local given in CIDR notation.
  1077. .TP
  1078. .B overwriteRemoteDeviceNamesOnConnect
  1079. If set, device names will always be overwritten with the name given by
  1080. remote on each connection. By default, the name that the remote device
  1081. announces will only be adopted when a name has not already been set.
  1082. .TP
  1083. .B tempIndexMinBlocks
  1084. When exchanging index information for incomplete transfers, only take
  1085. into account files that have at least this many blocks.
  1086. .TP
  1087. .B unackedNotificationID
  1088. ID of a notification to be displayed in the web GUI. Will be removed once
  1089. the user acknowledged it (e.g. an transition notice on an upgrade).
  1090. .TP
  1091. .B trafficClass
  1092. Specify a type of service (TOS)/traffic class of outgoing packets.
  1093. .TP
  1094. .B stunServer
  1095. Server to be used for STUN, given as ip:port. The keyword \fBdefault\fP gets
  1096. expanded to
  1097. \fBstun.callwithus.com:3478\fP, \fBstun.counterpath.com:3478\fP,
  1098. \fBstun.counterpath.net:3478\fP, \fBstun.ekiga.net:3478\fP,
  1099. \fBstun.ideasip.com:3478\fP, \fBstun.internetcalls.com:3478\fP,
  1100. \fBstun.schlund.de:3478\fP, \fBstun.sipgate.net:10000\fP,
  1101. \fBstun.sipgate.net:3478\fP, \fBstun.voip.aebc.com:3478\fP,
  1102. \fBstun.voiparound.com:3478\fP, \fBstun.voipbuster.com:3478\fP,
  1103. \fBstun.voipstunt.com:3478\fP and \fBstun.xten.com:3478\fP (this is the default).
  1104. .TP
  1105. .B stunKeepaliveSeconds
  1106. Interval in seconds between contacting a STUN server to
  1107. maintain NAT mapping. Default is \fB24\fP and you can set it to \fB0\fP to
  1108. disable contacting STUN servers.
  1109. .UNINDENT
  1110. .INDENT 0.0
  1111. .TP
  1112. .B setLowPriority
  1113. Syncthing will attempt to lower its process priority at startup.
  1114. Specifically: on Linux, set itself to a separate process group, set the
  1115. niceness level of that process group to nine and the I/O priority to
  1116. best effort level five; on other Unixes, set the process niceness level
  1117. to nine; on Windows, set the process priority class to below normal. To
  1118. disable this behavior, for example to control process priority yourself
  1119. as part of launching Syncthing, set this option to \fBfalse\fP\&.
  1120. .UNINDENT
  1121. .SH DEFAULTS ELEMENT
  1122. .INDENT 0.0
  1123. .INDENT 3.5
  1124. .sp
  1125. .nf
  1126. .ft C
  1127. <defaults>
  1128. <folder id="" label="" path="~" type="sendreceive" rescanIntervalS="3600" fsWatcherEnabled="true" fsWatcherDelayS="10" ignorePerms="false" autoNormalize="true">
  1129. <filesystemType>basic</filesystemType>
  1130. <device id="S7UKX27\-GI7ZTXS\-GC6RKUA\-7AJGZ44\-C6NAYEB\-HSKTJQK\-KJHU2NO\-CWV7EQW" introducedBy="">
  1131. <encryptionPassword></encryptionPassword>
  1132. </device>
  1133. <minDiskFree unit="%">1</minDiskFree>
  1134. <versioning>
  1135. <cleanupIntervalS>3600</cleanupIntervalS>
  1136. <fsPath></fsPath>
  1137. <fsType>basic</fsType>
  1138. </versioning>
  1139. <copiers>0</copiers>
  1140. <pullerMaxPendingKiB>0</pullerMaxPendingKiB>
  1141. <hashers>0</hashers>
  1142. <order>random</order>
  1143. <ignoreDelete>false</ignoreDelete>
  1144. <scanProgressIntervalS>0</scanProgressIntervalS>
  1145. <pullerPauseS>0</pullerPauseS>
  1146. <maxConflicts>10</maxConflicts>
  1147. <disableSparseFiles>false</disableSparseFiles>
  1148. <disableTempIndexes>false</disableTempIndexes>
  1149. <paused>false</paused>
  1150. <weakHashThresholdPct>25</weakHashThresholdPct>
  1151. <markerName>.stfolder</markerName>
  1152. <copyOwnershipFromParent>false</copyOwnershipFromParent>
  1153. <modTimeWindowS>0</modTimeWindowS>
  1154. <maxConcurrentWrites>2</maxConcurrentWrites>
  1155. <disableFsync>false</disableFsync>
  1156. <blockPullOrder>standard</blockPullOrder>
  1157. <copyRangeMethod>standard</copyRangeMethod>
  1158. <caseSensitiveFS>false</caseSensitiveFS>
  1159. <junctionsAsDirs>false</junctionsAsDirs>
  1160. </folder>
  1161. <device id="" compression="metadata" introducer="false" skipIntroductionRemovals="false" introducedBy="">
  1162. <address>dynamic</address>
  1163. <paused>false</paused>
  1164. <autoAcceptFolders>false</autoAcceptFolders>
  1165. <maxSendKbps>0</maxSendKbps>
  1166. <maxRecvKbps>0</maxRecvKbps>
  1167. <maxRequestKiB>0</maxRequestKiB>
  1168. <untrusted>false</untrusted>
  1169. <remoteGUIPort>0</remoteGUIPort>
  1170. </device>
  1171. </defaults>
  1172. .ft P
  1173. .fi
  1174. .UNINDENT
  1175. .UNINDENT
  1176. .sp
  1177. The \fBdefaults\fP element describes a template for newly added device and folder
  1178. options. These will be used when adding a new remote device or folder, either
  1179. through the GUI or the command line interface. The following child elements can
  1180. be present in the \fBdefaults\fP element:
  1181. .INDENT 0.0
  1182. .TP
  1183. .B device
  1184. Template for a \fBdevice\fP element, with the same internal structure. Any
  1185. fields here will be used for a newly added remote device. The \fBid\fP
  1186. attribute is meaningless in this context.
  1187. .TP
  1188. .B folder
  1189. Template for a \fBfolder\fP element, with the same internal structure. Any
  1190. fields here will be used for a newly added shared folder. The \fBid\fP
  1191. attribute is meaningless in this context.
  1192. .sp
  1193. The UI will propose to create new folders at the path given in the \fBpath\fP
  1194. attribute (used to be \fBdefaultFolderPath\fP under \fBoptions\fP). It also
  1195. applies to folders automatically accepted from a remote device.
  1196. .sp
  1197. Even sharing with other remote devices can be done in the template by
  1198. including the appropriate \fBdevice\fP element underneath.
  1199. .UNINDENT
  1200. .SS Listen Addresses
  1201. .sp
  1202. The following address types are accepted in sync protocol listen addresses.
  1203. If you want Syncthing to listen on multiple addresses, you can either: add
  1204. multiple \fB<listenAddress>\fP tags in the configuration file or enter several
  1205. addresses separated by commas in the GUI.
  1206. .INDENT 0.0
  1207. .TP
  1208. .B Default listen addresses (\fBdefault\fP)
  1209. This is equivalent to \fBtcp://0.0.0.0:22000\fP, \fBquic://0.0.0.0:22000\fP
  1210. and \fBdynamic+https://relays.syncthing.net/endpoint\fP\&.
  1211. .TP
  1212. .B TCP wildcard and port (\fBtcp://0.0.0.0:22000\fP, \fBtcp://:22000\fP)
  1213. These are equivalent and will result in Syncthing listening on all
  1214. interfaces, IPv4 and IPv6, on the specified port.
  1215. .TP
  1216. .B TCP IPv4 wildcard and port (\fBtcp4://0.0.0.0:22000\fP, \fBtcp4://:22000\fP)
  1217. These are equivalent and will result in Syncthing listening on all
  1218. interfaces via IPv4 only.
  1219. .TP
  1220. .B TCP IPv4 address and port (\fBtcp4://192.0.2.1:22000\fP)
  1221. This results in Syncthing listening on the specified address and port, IPv4
  1222. only.
  1223. .TP
  1224. .B TCP IPv6 wildcard and port (\fBtcp6://[::]:22000\fP, \fBtcp6://:22000\fP)
  1225. These are equivalent and will result in Syncthing listening on all
  1226. interfaces via IPv6 only.
  1227. .TP
  1228. .B TCP IPv6 address and port (\fBtcp6://[2001:db8::42]:22000\fP)
  1229. This results in Syncthing listening on the specified address and port, IPv6
  1230. only.
  1231. .TP
  1232. .B QUIC address and port (e.g. \fBquic://0.0.0.0:22000\fP)
  1233. Syntax is the same as for TCP, also \fBquic4\fP and \fBquic6\fP can be used.
  1234. .TP
  1235. .B Static relay address (\fBrelay://192.0.2.42:22067?id=abcd123...\fP)
  1236. Syncthing will connect to and listen for incoming connections via the
  1237. specified relay address.
  1238. .INDENT 7.0
  1239. .INDENT 3.5
  1240. .SS Todo
  1241. .sp
  1242. Document available URL parameters.
  1243. .UNINDENT
  1244. .UNINDENT
  1245. .TP
  1246. .B Dynamic relay pool (\fBdynamic+https://192.0.2.42/relays\fP)
  1247. Syncthing will fetch the specified HTTPS URL, parse it for a JSON payload
  1248. describing relays, select a relay from the available ones and listen via
  1249. that as if specified as a static relay above.
  1250. .INDENT 7.0
  1251. .INDENT 3.5
  1252. .SS Todo
  1253. .sp
  1254. Document available URL parameters.
  1255. .UNINDENT
  1256. .UNINDENT
  1257. .UNINDENT
  1258. .SH SYNCING CONFIGURATION FILES
  1259. .sp
  1260. Syncing configuration files between devices (such that multiple devices are
  1261. using the same configuration files) can cause issues. This is easy to do
  1262. accidentally if you sync your home folder between devices. A common symptom
  1263. of syncing configuration files is two devices ending up with the same Device ID.
  1264. .sp
  1265. If you want to use Syncthing to backup your configuration files, it is recommended
  1266. that the files you are backing up are in a folder\-sendonly to prevent other
  1267. devices from overwriting the per device configuration. The folder on the remote
  1268. device(s) should not be used as configuration for the remote devices.
  1269. .sp
  1270. If you’d like to sync your home folder in non\-send only mode, you may add the
  1271. folder that stores the configuration files to the ignore list\&.
  1272. If you’d also like to backup your configuration files, add another folder in
  1273. send only mode for just the configuration folder.
  1274. .SH AUTHOR
  1275. The Syncthing Authors
  1276. .SH COPYRIGHT
  1277. 2014-2019, The Syncthing Authors
  1278. .\" Generated by docutils manpage writer.
  1279. .