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