2015-05-30 11:05:37 +00:00
|
|
|
|
.\" Man page generated from reStructuredText.
|
|
|
|
|
.
|
2019-04-17 05:45:24 +00:00
|
|
|
|
.TH "SYNCTHING-CONFIG" "5" "Apr 13, 2019" "v1" "Syncthing"
|
2015-05-30 11:05:37 +00:00
|
|
|
|
.SH NAME
|
|
|
|
|
syncthing-config \- Syncthing Configuration
|
|
|
|
|
.
|
|
|
|
|
.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
|
|
|
|
|
..
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.INDENT 0.0
|
|
|
|
|
.INDENT 3.5
|
|
|
|
|
.sp
|
|
|
|
|
.nf
|
|
|
|
|
.ft C
|
2015-06-21 09:45:54 +00:00
|
|
|
|
$HOME/.config/syncthing
|
2015-05-30 11:05:37 +00:00
|
|
|
|
$HOME/Library/Application Support/Syncthing
|
|
|
|
|
%AppData%/Syncthing
|
|
|
|
|
%localappdata%/Syncthing
|
|
|
|
|
.ft P
|
|
|
|
|
.fi
|
|
|
|
|
.UNINDENT
|
|
|
|
|
.UNINDENT
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
.sp
|
|
|
|
|
Syncthing uses a single directory to store configuration, crypto keys
|
|
|
|
|
and index caches. The location defaults to \fB$HOME/.config/syncthing\fP
|
|
|
|
|
(Unix\-like), \fB$HOME/Library/Application Support/Syncthing\fP (Mac),
|
2015-06-21 09:45:54 +00:00
|
|
|
|
\fB%AppData%/Syncthing\fP (Windows XP) or \fB%LocalAppData%/Syncthing\fP
|
|
|
|
|
(Windows 7+). It can be changed at runtime using the \fB\-home\fP flag. In this
|
2015-05-30 11:05:37 +00:00
|
|
|
|
directory the following files are located:
|
|
|
|
|
.INDENT 0.0
|
|
|
|
|
.TP
|
2015-06-21 09:45:54 +00:00
|
|
|
|
.B \fBconfig.xml\fP
|
2015-05-30 11:05:37 +00:00
|
|
|
|
The configuration file, in XML format.
|
|
|
|
|
.TP
|
2015-06-21 09:45:54 +00:00
|
|
|
|
.B \fBcert.pem\fP, \fBkey.pem\fP
|
2019-03-27 06:45:25 +00:00
|
|
|
|
The device’s RSA public and private key. These form the basis for the
|
2015-06-21 09:45:54 +00:00
|
|
|
|
device ID. The key must be kept private.
|
2015-05-30 11:05:37 +00:00
|
|
|
|
.TP
|
2015-06-21 09:45:54 +00:00
|
|
|
|
.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.
|
2015-05-30 11:05:37 +00:00
|
|
|
|
.TP
|
2016-04-01 07:33:42 +00:00
|
|
|
|
.B \fBindex\-\fP\fI*\fP\fB\&.db\fP
|
2015-05-30 11:05:37 +00:00
|
|
|
|
A directory holding the database with metadata and hashes of the files
|
|
|
|
|
currently on disk and available from peers.
|
|
|
|
|
.TP
|
2015-06-21 09:45:54 +00:00
|
|
|
|
.B \fBcsrftokens.txt\fP
|
2015-05-30 11:05:37 +00:00
|
|
|
|
A list of recently issued CSRF tokens (for protection against browser cross
|
|
|
|
|
site request forgery).
|
|
|
|
|
.UNINDENT
|
|
|
|
|
.SH CONFIG FILE FORMAT
|
|
|
|
|
.sp
|
2016-10-07 02:09:19 +00:00
|
|
|
|
The following shows an example of the default configuration file (IDs will differ):
|
2015-05-30 11:05:37 +00:00
|
|
|
|
.INDENT 0.0
|
|
|
|
|
.INDENT 3.5
|
|
|
|
|
.sp
|
|
|
|
|
.nf
|
|
|
|
|
.ft C
|
2017-11-29 06:45:17 +00:00
|
|
|
|
<configuration version="26">
|
2018-07-18 05:45:27 +00:00
|
|
|
|
<folder id="zj2AA\-q55a7" label="Default Folder" path="/Users/jb/Sync/" type="sendreceive" rescanIntervalS="60" fsWatcherEnabled="false" fsWatcherDelayS="10" ignorePerms="false" autoNormalize="true">
|
2015-11-05 15:47:06 +00:00
|
|
|
|
<device id="3LT2GA5\-CQI4XJM\-WTZ264P\-MLOGMHL\-MCRLDNT\-MZV4RD3\-KA745CL\-OGAERQZ"></device>
|
2017-11-29 06:45:17 +00:00
|
|
|
|
<filesystemType>basic</filesystemType>
|
2017-06-14 05:45:21 +00:00
|
|
|
|
<minDiskFree unit="%">1</minDiskFree>
|
2015-06-21 09:45:54 +00:00
|
|
|
|
<versioning></versioning>
|
|
|
|
|
<copiers>0</copiers>
|
|
|
|
|
<pullers>0</pullers>
|
|
|
|
|
<hashers>0</hashers>
|
|
|
|
|
<order>random</order>
|
2015-11-05 15:47:06 +00:00
|
|
|
|
<ignoreDelete>false</ignoreDelete>
|
|
|
|
|
<scanProgressIntervalS>0</scanProgressIntervalS>
|
|
|
|
|
<pullerPauseS>0</pullerPauseS>
|
2016-05-17 12:02:44 +00:00
|
|
|
|
<maxConflicts>\-1</maxConflicts>
|
|
|
|
|
<disableSparseFiles>false</disableSparseFiles>
|
|
|
|
|
<disableTempIndexes>false</disableTempIndexes>
|
2017-11-29 06:45:17 +00:00
|
|
|
|
<paused>false</paused>
|
|
|
|
|
<weakHashThresholdPct>25</weakHashThresholdPct>
|
|
|
|
|
<markerName>.stfolder</markerName>
|
2015-05-30 11:05:37 +00:00
|
|
|
|
</folder>
|
2017-11-29 06:45:17 +00:00
|
|
|
|
<device id="3LT2GA5\-CQI4XJM\-WTZ264P\-MLOGMHL\-MCRLDNT\-MZV4RD3\-KA745CL\-OGAERQZ" name="syno" compression="metadata" introducer="false" skipIntroductionRemovals="false" introducedBy="">
|
2015-05-30 11:05:37 +00:00
|
|
|
|
<address>dynamic</address>
|
2017-11-29 06:45:17 +00:00
|
|
|
|
<paused>false</paused>
|
2015-05-30 11:05:37 +00:00
|
|
|
|
</device>
|
2017-11-29 06:45:17 +00:00
|
|
|
|
<gui enabled="true" tls="false" debugging="false">
|
2016-05-17 12:02:44 +00:00
|
|
|
|
<address>127.0.0.1:8384</address>
|
2015-11-05 15:47:06 +00:00
|
|
|
|
<apikey>k1dnz1Dd0rzTBjjFFh7CXPnrF12C49B1</apikey>
|
2016-05-17 12:02:44 +00:00
|
|
|
|
<theme>default</theme>
|
2015-05-30 11:05:37 +00:00
|
|
|
|
</gui>
|
|
|
|
|
<options>
|
2016-05-17 12:02:44 +00:00
|
|
|
|
<listenAddress>default</listenAddress>
|
2015-11-05 15:47:06 +00:00
|
|
|
|
<globalAnnounceServer>default</globalAnnounceServer>
|
2015-05-30 11:05:37 +00:00
|
|
|
|
<globalAnnounceEnabled>true</globalAnnounceEnabled>
|
|
|
|
|
<localAnnounceEnabled>true</localAnnounceEnabled>
|
2015-11-05 15:47:06 +00:00
|
|
|
|
<localAnnouncePort>21027</localAnnouncePort>
|
|
|
|
|
<localAnnounceMCAddr>[ff12::8384]:21027</localAnnounceMCAddr>
|
2015-05-30 11:05:37 +00:00
|
|
|
|
<maxSendKbps>0</maxSendKbps>
|
2015-06-21 09:45:54 +00:00
|
|
|
|
<maxRecvKbps>0</maxRecvKbps>
|
2015-05-30 11:05:37 +00:00
|
|
|
|
<reconnectionIntervalS>60</reconnectionIntervalS>
|
2015-11-05 15:47:06 +00:00
|
|
|
|
<relaysEnabled>true</relaysEnabled>
|
|
|
|
|
<relayReconnectIntervalM>10</relayReconnectIntervalM>
|
2015-05-30 11:05:37 +00:00
|
|
|
|
<startBrowser>true</startBrowser>
|
2016-05-17 12:02:44 +00:00
|
|
|
|
<natEnabled>true</natEnabled>
|
|
|
|
|
<natLeaseMinutes>60</natLeaseMinutes>
|
|
|
|
|
<natRenewalMinutes>30</natRenewalMinutes>
|
|
|
|
|
<natTimeoutSeconds>10</natTimeoutSeconds>
|
2015-05-30 11:05:37 +00:00
|
|
|
|
<urAccepted>0</urAccepted>
|
2017-11-29 06:45:17 +00:00
|
|
|
|
<urSeen>0</urSeen>
|
|
|
|
|
<urUniqueID>LFWe2vn3</urUniqueID>
|
2015-11-05 15:47:06 +00:00
|
|
|
|
<urURL>https://data.syncthing.net/newdata</urURL>
|
|
|
|
|
<urPostInsecurely>false</urPostInsecurely>
|
|
|
|
|
<urInitialDelayS>1800</urInitialDelayS>
|
2015-06-21 09:45:54 +00:00
|
|
|
|
<restartOnWakeup>true</restartOnWakeup>
|
|
|
|
|
<autoUpgradeIntervalH>12</autoUpgradeIntervalH>
|
2017-11-29 06:45:17 +00:00
|
|
|
|
<upgradeToPreReleases>false</upgradeToPreReleases>
|
2015-06-21 09:45:54 +00:00
|
|
|
|
<keepTemporariesH>24</keepTemporariesH>
|
2016-05-17 12:02:44 +00:00
|
|
|
|
<cacheIgnoredFiles>false</cacheIgnoredFiles>
|
2015-06-21 09:45:54 +00:00
|
|
|
|
<progressUpdateIntervalS>5</progressUpdateIntervalS>
|
|
|
|
|
<limitBandwidthInLan>false</limitBandwidthInLan>
|
2017-06-14 05:45:21 +00:00
|
|
|
|
<minHomeDiskFree unit="%">1</minHomeDiskFree>
|
2017-11-29 06:45:17 +00:00
|
|
|
|
<releasesURL>https://upgrades.syncthing.net/meta.json</releasesURL>
|
2016-05-17 12:02:44 +00:00
|
|
|
|
<overwriteRemoteDeviceNamesOnConnect>false</overwriteRemoteDeviceNamesOnConnect>
|
|
|
|
|
<tempIndexMinBlocks>10</tempIndexMinBlocks>
|
2017-11-29 06:45:17 +00:00
|
|
|
|
<trafficClass>0</trafficClass>
|
|
|
|
|
<weakHashSelectionMethod>auto</weakHashSelectionMethod>
|
|
|
|
|
<stunServer>default</stunServer>
|
|
|
|
|
<stunKeepaliveSeconds>24</stunKeepaliveSeconds>
|
|
|
|
|
<kcpNoDelay>false</kcpNoDelay>
|
|
|
|
|
<kcpUpdateIntervalMs>25</kcpUpdateIntervalMs>
|
|
|
|
|
<kcpFastResend>false</kcpFastResend>
|
|
|
|
|
<kcpCongestionControl>true</kcpCongestionControl>
|
|
|
|
|
<kcpSendWindowSize>128</kcpSendWindowSize>
|
|
|
|
|
<kcpReceiveWindowSize>128</kcpReceiveWindowSize>
|
2017-09-06 05:45:19 +00:00
|
|
|
|
<defaultFolderPath>~</defaultFolderPath>
|
2017-11-29 06:45:17 +00:00
|
|
|
|
<minHomeDiskFreePct>0</minHomeDiskFreePct>
|
2018-01-17 06:45:19 +00:00
|
|
|
|
<setLowPriority>true</setLowPriority>
|
2015-05-30 11:05:37 +00:00
|
|
|
|
</options>
|
|
|
|
|
</configuration>
|
|
|
|
|
.ft P
|
|
|
|
|
.fi
|
|
|
|
|
.UNINDENT
|
|
|
|
|
.UNINDENT
|
2015-06-21 09:45:54 +00:00
|
|
|
|
.SH CONFIGURATION ELEMENT
|
2017-11-29 06:45:17 +00:00
|
|
|
|
.INDENT 0.0
|
|
|
|
|
.INDENT 3.5
|
|
|
|
|
.sp
|
|
|
|
|
.nf
|
|
|
|
|
.ft C
|
|
|
|
|
<configuration version="26">
|
|
|
|
|
<folder></folder>
|
|
|
|
|
<device></device>
|
|
|
|
|
<gui></gui>
|
|
|
|
|
<options></options>
|
|
|
|
|
<ignoredDevice>5SYI2FS\-LW6YAXI\-JJDYETS\-NDBBPIO\-256MWBO\-XDPXWVG\-24QPUM4\-PDW4UQU</ignoredDevice>
|
2019-01-23 06:45:23 +00:00
|
|
|
|
<ignoredFolder>bd7q3\-zskm5</ignoredFolder>
|
2017-11-29 06:45:17 +00:00
|
|
|
|
</configuration>
|
|
|
|
|
.ft P
|
|
|
|
|
.fi
|
|
|
|
|
.UNINDENT
|
|
|
|
|
.UNINDENT
|
2015-05-30 11:05:37 +00:00
|
|
|
|
.sp
|
2017-11-29 06:45:17 +00:00
|
|
|
|
This is the root element. It has one attribute:
|
2015-05-30 11:05:37 +00:00
|
|
|
|
.INDENT 0.0
|
|
|
|
|
.TP
|
|
|
|
|
.B version
|
2015-07-05 09:24:21 +00:00
|
|
|
|
The config version. Increments whenever a change is made that requires
|
|
|
|
|
migration from previous formats.
|
2015-05-30 11:05:37 +00:00
|
|
|
|
.UNINDENT
|
2017-11-29 06:45:17 +00:00
|
|
|
|
.sp
|
|
|
|
|
It contains the elements described in the following sections and these two
|
|
|
|
|
additional child elements:
|
|
|
|
|
.INDENT 0.0
|
|
|
|
|
.TP
|
|
|
|
|
.B ignoredDevice
|
|
|
|
|
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.
|
|
|
|
|
.TP
|
|
|
|
|
.B ignoredFolder
|
|
|
|
|
Contains the ID of the folder that should be ignored. This folder will
|
|
|
|
|
always be skipped when advertised from a remote device, i.e. this will be
|
|
|
|
|
logged, but there will be no dialog about it in the web GUI.
|
|
|
|
|
.UNINDENT
|
2015-06-21 09:45:54 +00:00
|
|
|
|
.SH FOLDER ELEMENT
|
|
|
|
|
.INDENT 0.0
|
|
|
|
|
.INDENT 3.5
|
2015-05-30 11:05:37 +00:00
|
|
|
|
.sp
|
2015-06-21 09:45:54 +00:00
|
|
|
|
.nf
|
|
|
|
|
.ft C
|
2018-07-18 05:45:27 +00:00
|
|
|
|
<folder id="zj2AA\-q55a7" label="Default Folder" path="/Users/jb/Sync/" type="sendreceive" rescanIntervalS="60" fsWatcherEnabled="false" fsWatcherDelayS="10" ignorePerms="false" autoNormalize="true">
|
2017-11-29 06:45:17 +00:00
|
|
|
|
<device id="3LT2GA5\-CQI4XJM\-WTZ264P\-MLOGMHL\-MCRLDNT\-MZV4RD3\-KA745CL\-OGAERQZ"></device>
|
|
|
|
|
<filesystemType>basic</filesystemType>
|
2017-06-14 05:45:21 +00:00
|
|
|
|
<minDiskFree unit="%">1</minDiskFree>
|
2015-06-21 09:45:54 +00:00
|
|
|
|
<versioning></versioning>
|
|
|
|
|
<copiers>0</copiers>
|
|
|
|
|
<pullers>0</pullers>
|
|
|
|
|
<hashers>0</hashers>
|
|
|
|
|
<order>random</order>
|
2015-11-05 15:47:06 +00:00
|
|
|
|
<ignoreDelete>false</ignoreDelete>
|
|
|
|
|
<scanProgressIntervalS>0</scanProgressIntervalS>
|
|
|
|
|
<pullerPauseS>0</pullerPauseS>
|
2016-05-17 12:02:44 +00:00
|
|
|
|
<maxConflicts>\-1</maxConflicts>
|
|
|
|
|
<disableSparseFiles>false</disableSparseFiles>
|
|
|
|
|
<disableTempIndexes>false</disableTempIndexes>
|
2017-11-29 06:45:17 +00:00
|
|
|
|
<paused>false</paused>
|
|
|
|
|
<weakHashThresholdPct>25</weakHashThresholdPct>
|
|
|
|
|
<markerName>.stfolder</markerName>
|
2015-06-21 09:45:54 +00:00
|
|
|
|
</folder>
|
|
|
|
|
.ft P
|
|
|
|
|
.fi
|
|
|
|
|
.UNINDENT
|
|
|
|
|
.UNINDENT
|
2015-05-30 11:05:37 +00:00
|
|
|
|
.sp
|
2015-06-21 09:45:54 +00:00
|
|
|
|
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:
|
2015-05-30 11:05:37 +00:00
|
|
|
|
.INDENT 0.0
|
|
|
|
|
.TP
|
|
|
|
|
.B id
|
|
|
|
|
The folder ID, must be unique. (mandatory)
|
|
|
|
|
.TP
|
2016-05-17 12:02:44 +00:00
|
|
|
|
.B label
|
2016-07-03 11:29:32 +00:00
|
|
|
|
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)
|
2016-05-17 12:02:44 +00:00
|
|
|
|
.TP
|
2015-06-21 09:45:54 +00:00
|
|
|
|
.B path
|
2015-10-20 07:59:50 +00:00
|
|
|
|
The path to the directory where the folder is stored on this
|
2015-05-30 11:05:37 +00:00
|
|
|
|
device; not sent to other devices. (mandatory)
|
|
|
|
|
.TP
|
2016-05-17 12:02:44 +00:00
|
|
|
|
.B type
|
|
|
|
|
Controls how the folder is handled by Syncthing. Possible values are:
|
|
|
|
|
.INDENT 7.0
|
|
|
|
|
.TP
|
2018-07-18 05:45:27 +00:00
|
|
|
|
.B sendreceive
|
2016-05-17 12:02:44 +00:00
|
|
|
|
The folder is in default mode. Sending local and accepting remote changes.
|
2019-03-27 06:45:25 +00:00
|
|
|
|
Note that this type was previously called “readwrite” which is deprecated
|
2018-07-18 05:45:27 +00:00
|
|
|
|
but still accepted in incoming configs.
|
2016-05-17 12:02:44 +00:00
|
|
|
|
.TP
|
2018-07-18 05:45:27 +00:00
|
|
|
|
.B sendonly
|
2019-03-27 06:45:25 +00:00
|
|
|
|
The folder is in “send only” mode – it will not be modified by
|
2016-10-07 02:09:19 +00:00
|
|
|
|
Syncthing on this device.
|
2019-03-27 06:45:25 +00:00
|
|
|
|
Note that this type was previously called “readonly” which is deprecated
|
2018-07-18 05:45:27 +00:00
|
|
|
|
but still accepted in incoming configs.
|
2018-07-25 05:45:29 +00:00
|
|
|
|
.TP
|
|
|
|
|
.B receiveonly
|
2019-03-27 06:45:25 +00:00
|
|
|
|
The folder is in “receive only” mode – it will not propagate
|
2018-07-25 05:45:29 +00:00
|
|
|
|
changes to other devices.
|
2016-05-17 12:02:44 +00:00
|
|
|
|
.UNINDENT
|
2015-06-21 09:45:54 +00:00
|
|
|
|
.TP
|
|
|
|
|
.B rescanIntervalS
|
2016-01-24 07:08:08 +00:00
|
|
|
|
The rescan interval, in seconds. Can be set to zero to disable when external
|
|
|
|
|
plugins are used to trigger rescans.
|
2015-05-30 11:05:37 +00:00
|
|
|
|
.TP
|
2017-11-29 06:45:17 +00:00
|
|
|
|
.B fsWatcherEnabled
|
|
|
|
|
If enabled this detects changes to files in the folder and scans them.
|
2018-04-25 05:45:13 +00:00
|
|
|
|
.UNINDENT
|
|
|
|
|
.INDENT 0.0
|
2017-11-29 06:45:17 +00:00
|
|
|
|
.TP
|
|
|
|
|
.B fsWatcherDelayS
|
|
|
|
|
The duration during which changes detected are accumulated, before a scan is
|
2018-04-25 05:45:13 +00:00
|
|
|
|
scheduled (only takes effect if \fBfsWatcherEnabled\fP is true).
|
2017-11-29 06:45:17 +00:00
|
|
|
|
.TP
|
2015-05-30 11:05:37 +00:00
|
|
|
|
.B ignorePerms
|
2015-06-21 09:45:54 +00:00
|
|
|
|
True if the folder should ignore permissions.
|
|
|
|
|
.TP
|
|
|
|
|
.B autoNormalize
|
|
|
|
|
Automatically correct UTF\-8 normalization errors found in file names.
|
|
|
|
|
.UNINDENT
|
|
|
|
|
.sp
|
|
|
|
|
The following child elements may exist:
|
|
|
|
|
.INDENT 0.0
|
|
|
|
|
.TP
|
|
|
|
|
.B device
|
2016-11-22 08:32:57 +00:00
|
|
|
|
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 skipIntroductionRemovals being false on the introducer device).
|
|
|
|
|
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.
|
2016-11-29 10:56:02 +00:00
|
|
|
|
It is customary that the local device ID is included in all folders.
|
2015-06-21 09:45:54 +00:00
|
|
|
|
Syncthing will currently add this automatically if it is not present in
|
|
|
|
|
the configuration file.
|
|
|
|
|
.TP
|
2017-06-14 05:45:21 +00:00
|
|
|
|
.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. Accepted units are
|
|
|
|
|
\fB%\fP, \fBkB\fP, \fBMB\fP, \fBGB\fP and \fBTB\fP\&. Set to zero to disable.
|
2015-11-05 15:47:06 +00:00
|
|
|
|
.TP
|
2015-06-21 09:45:54 +00:00
|
|
|
|
.B versioning
|
|
|
|
|
Specifies a versioning configuration.
|
2015-07-26 09:25:40 +00:00
|
|
|
|
.UNINDENT
|
2015-06-21 09:45:54 +00:00
|
|
|
|
.sp
|
2015-07-26 09:25:40 +00:00
|
|
|
|
\fBSEE ALSO:\fP
|
|
|
|
|
.INDENT 0.0
|
2015-06-21 09:45:54 +00:00
|
|
|
|
.INDENT 3.5
|
2015-07-26 09:25:40 +00:00
|
|
|
|
versioning
|
2015-06-21 09:45:54 +00:00
|
|
|
|
.UNINDENT
|
|
|
|
|
.UNINDENT
|
2015-07-26 09:25:40 +00:00
|
|
|
|
.INDENT 0.0
|
2015-06-21 09:45:54 +00:00
|
|
|
|
.TP
|
|
|
|
|
.B copiers, pullers, hashers
|
|
|
|
|
The number of copier, puller and hasher routines to use, or zero for the
|
|
|
|
|
system determined optimum. These are low level performance options for
|
2019-03-27 06:45:25 +00:00
|
|
|
|
advanced users only; do not change unless requested to or you’ve actually
|
2015-06-21 09:45:54 +00:00
|
|
|
|
read and understood the code yourself. :)
|
|
|
|
|
.TP
|
|
|
|
|
.B order
|
2015-07-05 09:24:21 +00:00
|
|
|
|
The order in which needed files should be pulled from the cluster.
|
|
|
|
|
The possibles values are:
|
2015-06-21 09:45:54 +00:00
|
|
|
|
.INDENT 7.0
|
|
|
|
|
.TP
|
|
|
|
|
.B random
|
2015-07-05 09:24:21 +00:00
|
|
|
|
Pull files in random order. This optimizes for balancing resources among
|
|
|
|
|
the devices in a cluster.
|
2015-06-21 09:45:54 +00:00
|
|
|
|
.TP
|
|
|
|
|
.B alphabetic
|
|
|
|
|
Pull files ordered by file name alphabetically.
|
|
|
|
|
.TP
|
|
|
|
|
.B smallestFirst, largestFirst
|
|
|
|
|
Pull files ordered by file size; smallest and largest first respectively.
|
|
|
|
|
.TP
|
|
|
|
|
.B oldestFirst, newestFirst
|
2015-07-05 09:24:21 +00:00
|
|
|
|
Pull files ordered by modification time; oldest and newest first
|
|
|
|
|
respectively.
|
2015-06-21 09:45:54 +00:00
|
|
|
|
.UNINDENT
|
2018-09-19 05:45:25 +00:00
|
|
|
|
.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.
|
2015-11-05 15:47:06 +00:00
|
|
|
|
.TP
|
|
|
|
|
.B ignoreDelete
|
|
|
|
|
When set to true, this device will pretend not to see instructions to
|
|
|
|
|
delete files from other devices.
|
|
|
|
|
.TP
|
|
|
|
|
.B scanProgressIntervalS
|
|
|
|
|
The interval with which scan progress information is sent to the GUI. Zero
|
|
|
|
|
means the default value (two seconds).
|
|
|
|
|
.TP
|
2017-11-29 06:45:17 +00:00
|
|
|
|
.B pullerPauseS
|
2019-03-27 06:45:25 +00:00
|
|
|
|
Tweak for rate limiting the puller when it retries pulling files. Don’t
|
|
|
|
|
change these unless you know what you’re doing.
|
2015-11-05 15:47:06 +00:00
|
|
|
|
.TP
|
|
|
|
|
.B maxConflicts
|
|
|
|
|
The maximum number of conflict copies to keep around for any given file.
|
|
|
|
|
The default, \-1, means an unlimited number. Setting this to zero disables
|
|
|
|
|
conflict copies altogether.
|
2016-05-17 12:02:44 +00:00
|
|
|
|
.TP
|
|
|
|
|
.B disableSparseFiles
|
|
|
|
|
By default, blocks containing all zeroes are not written, causing files
|
|
|
|
|
to be sparse on filesystems that support the concept. When set to true,
|
|
|
|
|
sparse files will not be created.
|
|
|
|
|
.TP
|
|
|
|
|
.B disableTempIndexes
|
|
|
|
|
By default, devices exchange information about blocks available in
|
|
|
|
|
transfers that are still in progress. When set to true, such information
|
|
|
|
|
is not exchanged for this folder.
|
2016-11-22 08:32:57 +00:00
|
|
|
|
.TP
|
2017-11-29 06:45:17 +00:00
|
|
|
|
.B paused
|
|
|
|
|
True if this folder is (temporarily) suspended.
|
|
|
|
|
.TP
|
|
|
|
|
.B weakHashThresholdPct
|
|
|
|
|
Use weak hash if more than the given percentage of the file has changed. Set
|
|
|
|
|
to \-1 to always use weak hash. Default value is 25.
|
|
|
|
|
.TP
|
|
|
|
|
.B markerName
|
|
|
|
|
Name of a directory or file in the folder root to be used as
|
2019-03-27 06:45:25 +00:00
|
|
|
|
marker\-faq\&. Default is “.stfolder”.
|
2017-11-29 06:45:17 +00:00
|
|
|
|
.TP
|
2016-11-22 08:32:57 +00:00
|
|
|
|
.B fsync
|
2017-11-29 06:45:17 +00:00
|
|
|
|
Deprecated since version v0.14.37.
|
|
|
|
|
|
|
|
|
|
.sp
|
2016-11-22 08:32:57 +00:00
|
|
|
|
Transfer updated (from other devices) files to permanent storage before
|
|
|
|
|
committing the changes to the internal database.
|
2017-11-29 06:45:17 +00:00
|
|
|
|
.TP
|
|
|
|
|
.B pullerSleepS
|
|
|
|
|
Deprecated since version v0.14.41.
|
|
|
|
|
|
|
|
|
|
.sp
|
2019-03-27 06:45:25 +00:00
|
|
|
|
Tweak for rate limiting the puller. Don’t change these unless you know
|
|
|
|
|
what you’re doing.
|
2016-11-22 08:32:57 +00:00
|
|
|
|
.UNINDENT
|
2015-06-21 09:45:54 +00:00
|
|
|
|
.SH DEVICE ELEMENT
|
|
|
|
|
.INDENT 0.0
|
|
|
|
|
.INDENT 3.5
|
|
|
|
|
.sp
|
|
|
|
|
.nf
|
|
|
|
|
.ft C
|
2017-11-29 06:45:17 +00:00
|
|
|
|
<device id="5SYI2FS\-LW6YAXI\-JJDYETS\-NDBBPIO\-256MWBO\-XDPXWVG\-24QPUM4\-PDW4UQU" name="syno" compression="metadata" introducer="false" skipIntroductionRemovals="false" introducedBy="2CYF2WQ\-AKZO2QZ\-JAKWLYD\-AGHMQUM\-BGXUOIS\-GYILW34\-HJG3DUK\-LRRYQAR">
|
2015-06-21 09:45:54 +00:00
|
|
|
|
<address>dynamic</address>
|
|
|
|
|
</device>
|
2016-04-01 07:33:42 +00:00
|
|
|
|
<device id="2CYF2WQ\-AKZO2QZ\-JAKWLYD\-AGHMQUM\-BGXUOIS\-GYILW34\-HJG3DUK\-LRRYQAR" name="syno local" compression="metadata" introducer="false">
|
|
|
|
|
<address>tcp://192.0.2.1:22001</address>
|
2017-11-29 06:45:17 +00:00
|
|
|
|
<paused>true<paused>
|
|
|
|
|
<allowedNetwork>192.168.0.0/16<allowedNetwork>
|
2016-04-01 07:33:42 +00:00
|
|
|
|
</device>
|
2015-06-21 09:45:54 +00:00
|
|
|
|
.ft P
|
|
|
|
|
.fi
|
|
|
|
|
.UNINDENT
|
2015-05-30 11:05:37 +00:00
|
|
|
|
.UNINDENT
|
|
|
|
|
.sp
|
2015-06-21 09:45:54 +00:00
|
|
|
|
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:
|
2015-05-30 11:05:37 +00:00
|
|
|
|
.INDENT 0.0
|
|
|
|
|
.TP
|
|
|
|
|
.B id
|
|
|
|
|
The device ID. This must be written in canonical form, that is without any
|
|
|
|
|
spaces or dashes. (mandatory)
|
|
|
|
|
.TP
|
|
|
|
|
.B name
|
|
|
|
|
A friendly name for the device. (optional)
|
|
|
|
|
.TP
|
2015-06-21 09:45:54 +00:00
|
|
|
|
.B compression
|
|
|
|
|
Whether to use protocol compression when sending messages to this device.
|
|
|
|
|
The possible values are:
|
2015-05-30 11:05:37 +00:00
|
|
|
|
.INDENT 7.0
|
2015-06-21 09:45:54 +00:00
|
|
|
|
.TP
|
|
|
|
|
.B metadata
|
|
|
|
|
Compress metadata packets, such as index information. Metadata is
|
|
|
|
|
usually very compression friendly so this is a good default.
|
|
|
|
|
.TP
|
|
|
|
|
.B always
|
|
|
|
|
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 never
|
|
|
|
|
Disable all compression.
|
|
|
|
|
.UNINDENT
|
|
|
|
|
.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.
|
2017-01-10 07:41:14 +00:00
|
|
|
|
.UNINDENT
|
|
|
|
|
.sp
|
|
|
|
|
\fBSEE ALSO:\fP
|
|
|
|
|
.INDENT 0.0
|
|
|
|
|
.INDENT 3.5
|
|
|
|
|
introducer
|
|
|
|
|
.UNINDENT
|
|
|
|
|
.UNINDENT
|
|
|
|
|
.INDENT 0.0
|
2016-11-22 08:32:57 +00:00
|
|
|
|
.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.
|
|
|
|
|
.TP
|
|
|
|
|
.B introducedBy
|
|
|
|
|
Defines which device has introduced us to this device. Used only for following de\-introductions.
|
2018-09-19 05:45:25 +00:00
|
|
|
|
.TP
|
|
|
|
|
.B certName
|
2019-03-27 06:45:25 +00:00
|
|
|
|
The device certificate common name, if it is not the default “syncthing”.
|
2015-06-21 09:45:54 +00:00
|
|
|
|
.UNINDENT
|
|
|
|
|
.sp
|
2017-11-29 06:45:17 +00:00
|
|
|
|
From following child elements at least one \fBaddress\fP child must exist.
|
2015-06-21 09:45:54 +00:00
|
|
|
|
.INDENT 0.0
|
|
|
|
|
.TP
|
2017-11-29 06:45:17 +00:00
|
|
|
|
.B address
|
|
|
|
|
Contains an address or host name to use when attempting to connect to this device.
|
|
|
|
|
Entries other than \fBdynamic\fP must be prefixed with \fBtcp://\fP (dual\-stack),
|
|
|
|
|
\fBtcp4://\fP (IPv4 only) or \fBtcp6://\fP (IPv6 only). Note that IP addresses need
|
|
|
|
|
not use tcp4/tcp6; these are optional. Accepted formats are:
|
|
|
|
|
.INDENT 7.0
|
|
|
|
|
.TP
|
2016-04-01 07:33:42 +00:00
|
|
|
|
.B IPv4 address (\fBtcp://192.0.2.42\fP)
|
2015-06-21 09:45:54 +00:00
|
|
|
|
The default port (22000) is used.
|
|
|
|
|
.TP
|
2016-04-01 07:33:42 +00:00
|
|
|
|
.B IPv4 address and port (\fBtcp://192.0.2.42:12345\fP)
|
2015-06-21 09:45:54 +00:00
|
|
|
|
The address and port is used as given.
|
|
|
|
|
.TP
|
2016-04-01 07:33:42 +00:00
|
|
|
|
.B IPv6 address (\fBtcp://[2001:db8::23:42]\fP)
|
|
|
|
|
The default port (22000) is used. The address must be enclosed in
|
|
|
|
|
square brackets.
|
2015-06-21 09:45:54 +00:00
|
|
|
|
.TP
|
2016-04-01 07:33:42 +00:00
|
|
|
|
.B IPv6 address and port (\fBtcp://[2001:db8::23:42]:12345\fP)
|
2015-07-05 09:24:21 +00:00
|
|
|
|
The address and port is used as given. The address must be enclosed in
|
2015-07-26 09:25:40 +00:00
|
|
|
|
square brackets.
|
2015-06-21 09:45:54 +00:00
|
|
|
|
.TP
|
2016-04-01 07:33:42 +00:00
|
|
|
|
.B Host name (\fBtcp6://fileserver\fP)
|
2017-11-29 06:45:17 +00:00
|
|
|
|
The host name will be used on the default port (22000) and connections
|
|
|
|
|
will be attempted only via IPv6.
|
2016-04-01 07:33:42 +00:00
|
|
|
|
.TP
|
|
|
|
|
.B Host name and port (\fBtcp://fileserver:12345\fP)
|
2017-11-29 06:45:17 +00:00
|
|
|
|
The host name will be used on the given port and connections will be
|
|
|
|
|
attempted via both IPv4 and IPv6, depending on name resolution.
|
2016-04-01 07:33:42 +00:00
|
|
|
|
.TP
|
2015-06-21 09:45:54 +00:00
|
|
|
|
.B \fBdynamic\fP
|
2017-11-29 06:45:17 +00:00
|
|
|
|
The word \fBdynamic\fP (without \fBtcp://\fP prefix) means to use local and
|
|
|
|
|
global discovery to find the device.
|
2016-01-24 07:08:08 +00:00
|
|
|
|
.UNINDENT
|
2018-08-22 05:45:24 +00:00
|
|
|
|
.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>tcp://192.0.1.254:22000</address>
|
|
|
|
|
<address>dynamic</address>
|
|
|
|
|
</device>
|
|
|
|
|
.ft P
|
|
|
|
|
.fi
|
|
|
|
|
.UNINDENT
|
|
|
|
|
.UNINDENT
|
2017-11-29 06:45:17 +00:00
|
|
|
|
.TP
|
|
|
|
|
.B paused
|
|
|
|
|
True if synchronization with this devices is (temporarily) suspended.
|
|
|
|
|
.TP
|
|
|
|
|
.B allowedNetwork
|
|
|
|
|
If given, this restricts connections to this device to only this network
|
|
|
|
|
(see allowed\-networks).
|
2016-01-24 07:08:08 +00:00
|
|
|
|
.UNINDENT
|
2015-06-21 09:45:54 +00:00
|
|
|
|
.SH GUI ELEMENT
|
|
|
|
|
.INDENT 0.0
|
|
|
|
|
.INDENT 3.5
|
|
|
|
|
.sp
|
|
|
|
|
.nf
|
|
|
|
|
.ft C
|
2017-11-29 06:45:17 +00:00
|
|
|
|
<gui enabled="true" tls="false" debugging="false">
|
2015-06-21 09:45:54 +00:00
|
|
|
|
<address>127.0.0.1:8384</address>
|
|
|
|
|
<apikey>l7jSbCqPD95JYZ0g8vi4ZLAMg3ulnN1b</apikey>
|
2016-05-17 12:02:44 +00:00
|
|
|
|
<theme>default</theme>
|
2015-06-21 09:45:54 +00:00
|
|
|
|
</gui>
|
|
|
|
|
.ft P
|
|
|
|
|
.fi
|
2015-05-30 11:05:37 +00:00
|
|
|
|
.UNINDENT
|
|
|
|
|
.UNINDENT
|
|
|
|
|
.sp
|
2015-06-21 09:45:54 +00:00
|
|
|
|
There must be exactly one \fBgui\fP element. The GUI configuration is also used
|
|
|
|
|
by the rest\-api and the event\-api\&. The following attributes may
|
|
|
|
|
be set on the \fBgui\fP element:
|
2015-05-30 11:05:37 +00:00
|
|
|
|
.INDENT 0.0
|
|
|
|
|
.TP
|
|
|
|
|
.B enabled
|
2015-06-21 09:45:54 +00:00
|
|
|
|
If not \fBtrue\fP, the GUI and API will not be started.
|
2015-05-30 11:05:37 +00:00
|
|
|
|
.TP
|
|
|
|
|
.B tls
|
2015-06-21 09:45:54 +00:00
|
|
|
|
If set to \fBtrue\fP, TLS (HTTPS) will be enforced. Non\-HTTPS requests will
|
|
|
|
|
be redirected to HTTPS. When this is set to \fBfalse\fP, TLS connections are
|
|
|
|
|
still possible but it is not mandatory.
|
2016-05-17 12:02:44 +00:00
|
|
|
|
.TP
|
2017-11-29 06:45:17 +00:00
|
|
|
|
.B debugging
|
|
|
|
|
This enables profiling and additional debugging endpoints in the rest\-api\&.
|
2015-06-21 09:45:54 +00:00
|
|
|
|
.UNINDENT
|
|
|
|
|
.sp
|
|
|
|
|
The following child elements may be present:
|
|
|
|
|
.INDENT 0.0
|
2015-05-30 11:05:37 +00:00
|
|
|
|
.TP
|
|
|
|
|
.B address
|
2016-11-15 06:23:48 +00:00
|
|
|
|
Set the listen address. One address element must be present. Allowed address formats are:
|
2015-06-21 09:45:54 +00:00
|
|
|
|
.INDENT 7.0
|
|
|
|
|
.TP
|
2016-11-15 06:23:48 +00:00
|
|
|
|
.B IPv4 address and port (\fB127.0.0.1:8384\fP)
|
2015-06-21 09:45:54 +00:00
|
|
|
|
The address and port is used as given.
|
|
|
|
|
.TP
|
2016-11-15 06:23:48 +00:00
|
|
|
|
.B IPv6 address and port (\fB[::1]:8384\fP)
|
2015-07-05 09:24:21 +00:00
|
|
|
|
The address and port is used as given. The address must be enclosed in
|
2015-07-26 09:25:40 +00:00
|
|
|
|
square brackets.
|
2015-06-21 09:45:54 +00:00
|
|
|
|
.TP
|
2016-11-15 06:23:48 +00:00
|
|
|
|
.B Wildcard and port (\fB0.0.0.0:12345\fP, \fB[::]:12345\fP, \fB:12345\fP)
|
2015-07-05 09:24:21 +00:00
|
|
|
|
These are equivalent and will result in Syncthing listening on all
|
2016-04-01 07:33:42 +00:00
|
|
|
|
interfaces via both IPv4 and IPv6.
|
2018-11-07 06:45:25 +00:00
|
|
|
|
.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.
|
|
|
|
|
(Added in v0.14.52.)
|
2015-06-21 09:45:54 +00:00
|
|
|
|
.UNINDENT
|
2015-05-30 11:05:37 +00:00
|
|
|
|
.TP
|
2016-07-17 21:45:22 +00:00
|
|
|
|
.B user
|
2015-05-30 11:05:37 +00:00
|
|
|
|
Set to require authentication.
|
|
|
|
|
.TP
|
|
|
|
|
.B password
|
|
|
|
|
Contains the bcrypt hash of the real password.
|
|
|
|
|
.TP
|
|
|
|
|
.B apikey
|
|
|
|
|
If set, this is the API key that enables usage of the REST interface.
|
2017-11-29 06:45:17 +00:00
|
|
|
|
.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.
|
|
|
|
|
.TP
|
|
|
|
|
.B theme
|
|
|
|
|
The name of the theme to use.
|
2019-01-02 06:45:22 +00:00
|
|
|
|
.TP
|
|
|
|
|
.B authMode
|
|
|
|
|
Authentication mode to use. If not present authentication mode (static)
|
|
|
|
|
is controlled by presence of user/passward fields for backward compatibility.
|
|
|
|
|
.INDENT 7.0
|
|
|
|
|
.TP
|
|
|
|
|
.B static
|
|
|
|
|
Authentication using user and password.
|
|
|
|
|
.TP
|
|
|
|
|
.B ldap
|
|
|
|
|
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.
|
|
|
|
|
.INDENT 0.0
|
|
|
|
|
.TP
|
|
|
|
|
.B address
|
|
|
|
|
LDAP server address (server:port).
|
|
|
|
|
.TP
|
|
|
|
|
.B bindDN
|
|
|
|
|
BindDN for user authentication.
|
|
|
|
|
Special %s variable shoild be used to pass username to LDAP.
|
|
|
|
|
.UNINDENT
|
|
|
|
|
.sp
|
|
|
|
|
transport
|
|
|
|
|
.INDENT 0.0
|
|
|
|
|
.INDENT 3.5
|
|
|
|
|
.INDENT 0.0
|
|
|
|
|
.TP
|
|
|
|
|
.B nontls
|
|
|
|
|
Non secure connection.
|
|
|
|
|
.TP
|
|
|
|
|
.B tls
|
|
|
|
|
TLS secured connection.
|
|
|
|
|
.TP
|
|
|
|
|
.B starttls
|
|
|
|
|
StartTLS connection mode.
|
|
|
|
|
.UNINDENT
|
|
|
|
|
.UNINDENT
|
|
|
|
|
.UNINDENT
|
|
|
|
|
.INDENT 0.0
|
|
|
|
|
.TP
|
|
|
|
|
.B insecureSkipVerify
|
|
|
|
|
Skip verification (true or false).
|
2015-05-30 11:05:37 +00:00
|
|
|
|
.UNINDENT
|
2015-06-21 09:45:54 +00:00
|
|
|
|
.SH OPTIONS ELEMENT
|
|
|
|
|
.INDENT 0.0
|
|
|
|
|
.INDENT 3.5
|
|
|
|
|
.sp
|
|
|
|
|
.nf
|
|
|
|
|
.ft C
|
|
|
|
|
<options>
|
2016-05-17 12:02:44 +00:00
|
|
|
|
<listenAddress>default</listenAddress>
|
2015-11-05 15:47:06 +00:00
|
|
|
|
<globalAnnounceServer>default</globalAnnounceServer>
|
2015-06-21 09:45:54 +00:00
|
|
|
|
<globalAnnounceEnabled>true</globalAnnounceEnabled>
|
|
|
|
|
<localAnnounceEnabled>true</localAnnounceEnabled>
|
2015-11-05 15:47:06 +00:00
|
|
|
|
<localAnnouncePort>21027</localAnnouncePort>
|
|
|
|
|
<localAnnounceMCAddr>[ff12::8384]:21027</localAnnounceMCAddr>
|
2015-06-21 09:45:54 +00:00
|
|
|
|
<maxSendKbps>0</maxSendKbps>
|
|
|
|
|
<maxRecvKbps>0</maxRecvKbps>
|
|
|
|
|
<reconnectionIntervalS>60</reconnectionIntervalS>
|
2015-11-05 15:47:06 +00:00
|
|
|
|
<relaysEnabled>true</relaysEnabled>
|
|
|
|
|
<relayReconnectIntervalM>10</relayReconnectIntervalM>
|
2015-06-21 09:45:54 +00:00
|
|
|
|
<startBrowser>true</startBrowser>
|
2016-05-17 12:02:44 +00:00
|
|
|
|
<natEnabled>true</natEnabled>
|
|
|
|
|
<natLeaseMinutes>60</natLeaseMinutes>
|
|
|
|
|
<natRenewalMinutes>30</natRenewalMinutes>
|
|
|
|
|
<natTimeoutSeconds>10</natTimeoutSeconds>
|
2015-06-21 09:45:54 +00:00
|
|
|
|
<urAccepted>0</urAccepted>
|
|
|
|
|
<urUniqueID></urUniqueID>
|
2015-11-05 15:47:06 +00:00
|
|
|
|
<urURL>https://data.syncthing.net/newdata</urURL>
|
|
|
|
|
<urPostInsecurely>false</urPostInsecurely>
|
|
|
|
|
<urInitialDelayS>1800</urInitialDelayS>
|
2015-06-21 09:45:54 +00:00
|
|
|
|
<restartOnWakeup>true</restartOnWakeup>
|
|
|
|
|
<autoUpgradeIntervalH>12</autoUpgradeIntervalH>
|
|
|
|
|
<keepTemporariesH>24</keepTemporariesH>
|
2016-05-17 12:02:44 +00:00
|
|
|
|
<cacheIgnoredFiles>false</cacheIgnoredFiles>
|
2015-06-21 09:45:54 +00:00
|
|
|
|
<progressUpdateIntervalS>5</progressUpdateIntervalS>
|
|
|
|
|
<limitBandwidthInLan>false</limitBandwidthInLan>
|
2017-06-14 05:45:21 +00:00
|
|
|
|
<minHomeDiskFree unit="%">1</minHomeDiskFree>
|
2015-11-05 15:47:06 +00:00
|
|
|
|
<releasesURL>https://api.github.com/repos/syncthing/syncthing/releases?per_page=30</releasesURL>
|
2016-05-17 12:02:44 +00:00
|
|
|
|
<overwriteRemoteDeviceNamesOnConnect>false</overwriteRemoteDeviceNamesOnConnect>
|
|
|
|
|
<tempIndexMinBlocks>10</tempIndexMinBlocks>
|
2017-09-06 05:45:19 +00:00
|
|
|
|
<defaultFolderPath>~</defaultFolderPath>
|
2015-06-21 09:45:54 +00:00
|
|
|
|
</options>
|
|
|
|
|
.ft P
|
|
|
|
|
.fi
|
|
|
|
|
.UNINDENT
|
|
|
|
|
.UNINDENT
|
2015-05-30 11:05:37 +00:00
|
|
|
|
.sp
|
2015-06-21 09:45:54 +00:00
|
|
|
|
The \fBoptions\fP element contains all other global configuration options.
|
2015-05-30 11:05:37 +00:00
|
|
|
|
.INDENT 0.0
|
|
|
|
|
.TP
|
|
|
|
|
.B listenAddress
|
2016-05-17 12:02:44 +00:00
|
|
|
|
The listen address for incoming sync connections. See
|
|
|
|
|
\fI\%Listen Addresses\fP for allowed syntax.
|
2015-05-30 11:05:37 +00:00
|
|
|
|
.TP
|
|
|
|
|
.B globalAnnounceServer
|
2015-11-05 15:47:06 +00:00
|
|
|
|
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 a 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.
|
2015-05-30 11:05:37 +00:00
|
|
|
|
.TP
|
|
|
|
|
.B globalAnnounceEnabled
|
2015-06-21 09:45:54 +00:00
|
|
|
|
Whether to announce this device to the global announce (discovery) server,
|
2015-10-20 07:59:50 +00:00
|
|
|
|
and also use it to look up other devices.
|
2015-05-30 11:05:37 +00:00
|
|
|
|
.TP
|
|
|
|
|
.B localAnnounceEnabled
|
2015-06-21 09:45:54 +00:00
|
|
|
|
Whether to send announcements to the local LAN, also use such
|
|
|
|
|
announcements to find other devices.
|
|
|
|
|
.TP
|
|
|
|
|
.B localAnnouncePort
|
|
|
|
|
The port on which to listen and send IPv4 broadcast announcements to.
|
2015-05-30 11:05:37 +00:00
|
|
|
|
.TP
|
2015-06-21 09:45:54 +00:00
|
|
|
|
.B localAnnounceMCAddr
|
|
|
|
|
The group address and port to join and send IPv6 multicast announcements on.
|
2015-05-30 11:05:37 +00:00
|
|
|
|
.TP
|
|
|
|
|
.B maxSendKbps
|
2016-04-01 07:33:42 +00:00
|
|
|
|
Outgoing data rate limit, in kibibytes per second.
|
2015-05-30 11:05:37 +00:00
|
|
|
|
.TP
|
2015-06-21 09:45:54 +00:00
|
|
|
|
.B maxRecvKbps
|
2016-04-01 07:33:42 +00:00
|
|
|
|
Incoming data rate limits, in kibibytes per second.
|
2015-05-30 11:05:37 +00:00
|
|
|
|
.TP
|
|
|
|
|
.B reconnectionIntervalS
|
|
|
|
|
The number of seconds to wait between each attempt to connect to currently
|
2015-06-21 09:45:54 +00:00
|
|
|
|
unconnected devices.
|
2015-05-30 11:05:37 +00:00
|
|
|
|
.TP
|
2015-11-05 15:47:06 +00:00
|
|
|
|
.B relaysEnabled
|
|
|
|
|
When true, relays will be connected to and potentially used for device to device connections.
|
|
|
|
|
.TP
|
|
|
|
|
.B relayReconnectIntervalM
|
|
|
|
|
Sets the interval, in minutes, between relay reconnect attempts.
|
|
|
|
|
.TP
|
2015-05-30 11:05:37 +00:00
|
|
|
|
.B startBrowser
|
2015-06-21 09:45:54 +00:00
|
|
|
|
Whether to attempt to start a browser to show the GUI when Syncthing starts.
|
2015-05-30 11:05:37 +00:00
|
|
|
|
.TP
|
2016-05-17 12:02:44 +00:00
|
|
|
|
.B natEnabled
|
2016-10-07 02:09:19 +00:00
|
|
|
|
Whether to attempt to perform a UPnP and NAT\-PMP port mapping for
|
2016-05-17 12:02:44 +00:00
|
|
|
|
incoming sync connections.
|
2015-06-21 09:45:54 +00:00
|
|
|
|
.TP
|
2016-05-17 12:02:44 +00:00
|
|
|
|
.B natLeaseMinutes
|
2015-06-21 09:45:54 +00:00
|
|
|
|
Request a lease for this many minutes; zero to request a permanent lease.
|
|
|
|
|
.TP
|
2016-05-17 12:02:44 +00:00
|
|
|
|
.B natRenewalMinutes
|
2015-06-21 09:45:54 +00:00
|
|
|
|
Attempt to renew the lease after this many minutes.
|
|
|
|
|
.TP
|
2016-05-17 12:02:44 +00:00
|
|
|
|
.B natTimeoutSeconds
|
2015-06-21 09:45:54 +00:00
|
|
|
|
When scanning for UPnP devices, wait this long for responses.
|
2015-05-30 11:05:37 +00:00
|
|
|
|
.TP
|
|
|
|
|
.B urAccepted
|
2016-01-24 07:08:08 +00:00
|
|
|
|
Whether the user has accepted to submit anonymous usage data. The default,
|
2015-05-30 11:05:37 +00:00
|
|
|
|
\fB0\fP, mean the user has not made a choice, and Syncthing will ask at some
|
2015-06-21 09:45:54 +00:00
|
|
|
|
point in the future. \fB\-1\fP means no, a number above zero means that that
|
|
|
|
|
version of usage reporting has been accepted.
|
|
|
|
|
.TP
|
2017-11-29 06:45:17 +00:00
|
|
|
|
.B urSeen
|
|
|
|
|
The highest usage reporting version that has already been shown in the web GUI.
|
|
|
|
|
.TP
|
2015-06-21 09:45:54 +00:00
|
|
|
|
.B urUniqueID
|
|
|
|
|
The unique ID sent together with the usage report. Generated when usage
|
|
|
|
|
reporting is enabled.
|
|
|
|
|
.TP
|
2015-11-05 15:47:06 +00:00
|
|
|
|
.B urURL
|
|
|
|
|
The URL to post usage report data to, when enabled.
|
|
|
|
|
.TP
|
|
|
|
|
.B urPostInsecurely
|
2016-01-24 07:08:08 +00:00
|
|
|
|
When true, the UR URL can be http instead of https, or have a self\-signed
|
2015-11-05 15:47:06 +00:00
|
|
|
|
certificate. The default is \fBfalse\fP\&.
|
|
|
|
|
.TP
|
|
|
|
|
.B urInitialDelayS
|
|
|
|
|
The time to wait from startup to the first usage report being sent. Allows
|
|
|
|
|
the system to stabilize before reporting statistics.
|
|
|
|
|
.TP
|
2015-06-21 09:45:54 +00:00
|
|
|
|
.B restartOnWakeup
|
|
|
|
|
Whether to perform a restart of Syncthing when it is detected that we are
|
|
|
|
|
waking from sleep mode (i.e. a folded up laptop).
|
|
|
|
|
.TP
|
|
|
|
|
.B autoUpgradeIntervalH
|
|
|
|
|
Check for a newer version after this many hours. Set to zero to disable
|
|
|
|
|
automatic upgrades.
|
|
|
|
|
.TP
|
2017-11-29 06:45:17 +00:00
|
|
|
|
.B upgradeToPreReleases
|
2018-05-23 05:45:25 +00:00
|
|
|
|
If true, automatic upgrades include release candidates (see
|
2017-11-29 06:45:17 +00:00
|
|
|
|
release\-channels).
|
|
|
|
|
.TP
|
2015-06-21 09:45:54 +00:00
|
|
|
|
.B keepTemporariesH
|
|
|
|
|
Keep temporary failed transfers for this many hours. While the temporaries
|
|
|
|
|
are kept, the data they contain need not be transferred again.
|
|
|
|
|
.TP
|
|
|
|
|
.B cacheIgnoredFiles
|
2016-05-17 12:02:44 +00:00
|
|
|
|
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.
|
2015-06-21 09:45:54 +00:00
|
|
|
|
.TP
|
|
|
|
|
.B progressUpdateIntervalS
|
2016-01-24 07:08:08 +00:00
|
|
|
|
How often in seconds the progress of ongoing downloads is made available to
|
|
|
|
|
the GUI.
|
2015-06-21 09:45:54 +00:00
|
|
|
|
.TP
|
|
|
|
|
.B limitBandwidthInLan
|
|
|
|
|
Whether to apply bandwidth limits to devices in the same broadcast domain
|
|
|
|
|
as the local device.
|
|
|
|
|
.TP
|
2017-06-14 05:45:21 +00:00
|
|
|
|
.B minHomeDiskFree
|
2017-08-22 09:00:52 +00:00
|
|
|
|
The minimum required free space that should be available on the
|
2017-06-14 05:45:21 +00:00
|
|
|
|
partition holding the configuration and index. Accepted units are \fB%\fP, \fBkB\fP,
|
|
|
|
|
\fBMB\fP, \fBGB\fP and \fBTB\fP\&.
|
2015-11-05 15:47:06 +00:00
|
|
|
|
.TP
|
|
|
|
|
.B releasesURL
|
|
|
|
|
The URL from which release information is loaded, for automatic upgrades.
|
2016-05-17 12:02:44 +00:00
|
|
|
|
.TP
|
2017-11-29 06:45:17 +00:00
|
|
|
|
.B alwaysLocalNet
|
|
|
|
|
Network that should be considered as local given in CIDR notation.
|
|
|
|
|
.TP
|
2016-05-17 12:02:44 +00:00
|
|
|
|
.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.
|
|
|
|
|
.TP
|
|
|
|
|
.B tempIndexMinBlocks
|
|
|
|
|
When exchanging index information for incomplete transfers, only take
|
|
|
|
|
into account files that have at least this many blocks.
|
2017-09-06 05:45:19 +00:00
|
|
|
|
.TP
|
2017-11-29 06:45:17 +00:00
|
|
|
|
.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).
|
|
|
|
|
.TP
|
|
|
|
|
.B trafficClass
|
|
|
|
|
Specify a type of service (TOS)/traffic class of outgoing packets.
|
|
|
|
|
.TP
|
|
|
|
|
.B weakHashSelectionMethod
|
|
|
|
|
Specify whether weak hashing is used, possible options are
|
|
|
|
|
\fBWeakHashAlways\fP, \fBWeakHashNever\fP and \fBWeakHashAuto\fP\&. Deciding
|
|
|
|
|
automatically means running benchmarks at startup to decide whether the
|
|
|
|
|
performance impact is acceptable (this is the default).
|
|
|
|
|
.TP
|
|
|
|
|
.B stunServer
|
2017-12-06 06:45:18 +00:00
|
|
|
|
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, \fBstun.voxgratia.org:3478\fP and
|
|
|
|
|
\fBstun.xten.com:3478\fP (this is the default).
|
2017-11-29 06:45:17 +00:00
|
|
|
|
.TP
|
|
|
|
|
.B stunKeepaliveSeconds
|
2017-12-06 06:45:18 +00:00
|
|
|
|
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.
|
2017-11-29 06:45:17 +00:00
|
|
|
|
.TP
|
|
|
|
|
.B kcpNoDelay, kcpUpdateIntervalMs, kcpFastResend, kcpCongestionControl, kcpSendWindowSize, kcpReceiveWindowSize
|
|
|
|
|
Various KCP tweaking parameters.
|
|
|
|
|
.TP
|
2017-09-06 05:45:19 +00:00
|
|
|
|
.B defaultFolderPath
|
|
|
|
|
The UI will propose to create new folders at this path. This can be disabled by
|
|
|
|
|
setting this to an empty string.
|
2018-01-17 06:45:19 +00:00
|
|
|
|
.UNINDENT
|
|
|
|
|
.INDENT 0.0
|
2017-11-29 06:45:17 +00:00
|
|
|
|
.TP
|
2018-01-17 06:45:19 +00:00
|
|
|
|
.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\&.
|
2016-05-17 12:02:44 +00:00
|
|
|
|
.UNINDENT
|
|
|
|
|
.SS Listen Addresses
|
|
|
|
|
.sp
|
|
|
|
|
The following address types are accepted in sync protocol listen addresses:
|
|
|
|
|
.INDENT 0.0
|
|
|
|
|
.TP
|
2017-06-21 05:45:20 +00:00
|
|
|
|
.B Default listen addresses (\fBdefault\fP)
|
|
|
|
|
This is equivalent to \fBtcp://0.0.0.0:22000\fP and
|
|
|
|
|
\fBdynamic+https://relays.syncthing.net/endpoint\fP\&.
|
|
|
|
|
.TP
|
2016-05-17 12:02:44 +00:00
|
|
|
|
.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)
|
2017-01-23 20:58:53 +00:00
|
|
|
|
This results in Syncthing listening on the specified address and port, IPv4
|
|
|
|
|
only.
|
2016-05-17 12:02:44 +00:00
|
|
|
|
.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)
|
2017-01-23 20:58:53 +00:00
|
|
|
|
This results in Syncthing listening on the specified address and port, IPv6
|
|
|
|
|
only.
|
2016-05-17 12:02:44 +00:00
|
|
|
|
.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
|
2015-05-30 11:05:37 +00:00
|
|
|
|
.UNINDENT
|
2015-11-09 13:00:10 +00:00
|
|
|
|
.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
|
2016-01-24 07:08:08 +00:00
|
|
|
|
If you want to use Syncthing to backup your configuration files, it is recommended
|
2017-01-10 07:41:14 +00:00
|
|
|
|
that the files you are backing up are in a folder\-sendonly to prevent other
|
2015-11-09 13:00:10 +00:00
|
|
|
|
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
|
2019-03-27 06:45:25 +00:00
|
|
|
|
If you’d like to sync your home folder in non\-send only mode, you may add the
|
2015-11-09 13:00:10 +00:00
|
|
|
|
folder that stores the configuration files to the ignore list\&.
|
2019-03-27 06:45:25 +00:00
|
|
|
|
If you’d also like to backup your configuration files, add another folder in
|
2018-07-25 05:45:29 +00:00
|
|
|
|
send only mode for just the configuration folder.
|
2015-05-30 11:05:37 +00:00
|
|
|
|
.SH AUTHOR
|
|
|
|
|
The Syncthing Authors
|
|
|
|
|
.SH COPYRIGHT
|
2019-02-13 06:45:23 +00:00
|
|
|
|
2014-2019, The Syncthing Authors
|
2015-05-30 11:05:37 +00:00
|
|
|
|
.\" Generated by docutils manpage writer.
|
|
|
|
|
.
|