|
|
@@ -1,6 +1,6 @@
|
|
|
.\" Man page generated from reStructuredText.
|
|
|
.
|
|
|
-.TH "SYNCTHING-CONFIG" "5" "May 01, 2016" "v0.12" "Syncthing"
|
|
|
+.TH "SYNCTHING-CONFIG" "5" "May 17, 2016" "v0.12" "Syncthing"
|
|
|
.SH NAME
|
|
|
syncthing-config \- Syncthing Configuration
|
|
|
.
|
|
|
@@ -81,8 +81,8 @@ The following shows the default configuration file:
|
|
|
.sp
|
|
|
.nf
|
|
|
.ft C
|
|
|
-<configuration version="12">
|
|
|
- <folder id="default" path="/Users/jb/Sync/" ro="false" rescanIntervalS="60" ignorePerms="false" autoNormalize="true">
|
|
|
+<configuration version="14">
|
|
|
+ <folder id="zj2AA\-q55a7" label="Default Folder (zj2AA\-q55a7)" path="/Users/jb/Sync/" type="readwrite" rescanIntervalS="60" ignorePerms="false" autoNormalize="true">
|
|
|
<device id="3LT2GA5\-CQI4XJM\-WTZ264P\-MLOGMHL\-MCRLDNT\-MZV4RD3\-KA745CL\-OGAERQZ"></device>
|
|
|
<minDiskFreePct>1</minDiskFreePct>
|
|
|
<versioning></versioning>
|
|
|
@@ -94,34 +94,35 @@ The following shows the default configuration file:
|
|
|
<scanProgressIntervalS>0</scanProgressIntervalS>
|
|
|
<pullerSleepS>0</pullerSleepS>
|
|
|
<pullerPauseS>0</pullerPauseS>
|
|
|
- <maxConflicts>0</maxConflicts>
|
|
|
+ <maxConflicts>\-1</maxConflicts>
|
|
|
+ <disableSparseFiles>false</disableSparseFiles>
|
|
|
+ <disableTempIndexes>false</disableTempIndexes>
|
|
|
</folder>
|
|
|
<device id="3LT2GA5\-CQI4XJM\-WTZ264P\-MLOGMHL\-MCRLDNT\-MZV4RD3\-KA745CL\-OGAERQZ" name="syno" compression="metadata" introducer="false">
|
|
|
<address>dynamic</address>
|
|
|
</device>
|
|
|
<gui enabled="true" tls="false">
|
|
|
- <address>127.0.0.1:52620</address>
|
|
|
+ <address>127.0.0.1:8384</address>
|
|
|
<apikey>k1dnz1Dd0rzTBjjFFh7CXPnrF12C49B1</apikey>
|
|
|
+ <theme>default</theme>
|
|
|
</gui>
|
|
|
<options>
|
|
|
- <listenAddress>tcp://0.0.0.0:22000</listenAddress>
|
|
|
+ <listenAddress>default</listenAddress>
|
|
|
<globalAnnounceServer>default</globalAnnounceServer>
|
|
|
<globalAnnounceEnabled>true</globalAnnounceEnabled>
|
|
|
<localAnnounceEnabled>true</localAnnounceEnabled>
|
|
|
<localAnnouncePort>21027</localAnnouncePort>
|
|
|
<localAnnounceMCAddr>[ff12::8384]:21027</localAnnounceMCAddr>
|
|
|
- <relayServer>dynamic+https://relays.syncthing.net/endpoint</relayServer>
|
|
|
<maxSendKbps>0</maxSendKbps>
|
|
|
<maxRecvKbps>0</maxRecvKbps>
|
|
|
<reconnectionIntervalS>60</reconnectionIntervalS>
|
|
|
<relaysEnabled>true</relaysEnabled>
|
|
|
<relayReconnectIntervalM>10</relayReconnectIntervalM>
|
|
|
- <relayWithoutGlobalAnn>false</relayWithoutGlobalAnn>
|
|
|
<startBrowser>true</startBrowser>
|
|
|
- <upnpEnabled>true</upnpEnabled>
|
|
|
- <upnpLeaseMinutes>60</upnpLeaseMinutes>
|
|
|
- <upnpRenewalMinutes>30</upnpRenewalMinutes>
|
|
|
- <upnpTimeoutSeconds>10</upnpTimeoutSeconds>
|
|
|
+ <natEnabled>true</natEnabled>
|
|
|
+ <natLeaseMinutes>60</natLeaseMinutes>
|
|
|
+ <natRenewalMinutes>30</natRenewalMinutes>
|
|
|
+ <natTimeoutSeconds>10</natTimeoutSeconds>
|
|
|
<urAccepted>0</urAccepted>
|
|
|
<urUniqueID></urUniqueID>
|
|
|
<urURL>https://data.syncthing.net/newdata</urURL>
|
|
|
@@ -130,13 +131,14 @@ The following shows the default configuration file:
|
|
|
<restartOnWakeup>true</restartOnWakeup>
|
|
|
<autoUpgradeIntervalH>12</autoUpgradeIntervalH>
|
|
|
<keepTemporariesH>24</keepTemporariesH>
|
|
|
- <cacheIgnoredFiles>true</cacheIgnoredFiles>
|
|
|
+ <cacheIgnoredFiles>false</cacheIgnoredFiles>
|
|
|
<progressUpdateIntervalS>5</progressUpdateIntervalS>
|
|
|
<symlinksEnabled>true</symlinksEnabled>
|
|
|
<limitBandwidthInLan>false</limitBandwidthInLan>
|
|
|
- <databaseBlockCacheMiB>0</databaseBlockCacheMiB>
|
|
|
<minHomeDiskFreePct>1</minHomeDiskFreePct>
|
|
|
<releasesURL>https://api.github.com/repos/syncthing/syncthing/releases?per_page=30</releasesURL>
|
|
|
+ <overwriteRemoteDeviceNamesOnConnect>false</overwriteRemoteDeviceNamesOnConnect>
|
|
|
+ <tempIndexMinBlocks>10</tempIndexMinBlocks>
|
|
|
</options>
|
|
|
</configuration>
|
|
|
.ft P
|
|
|
@@ -158,7 +160,7 @@ migration from previous formats.
|
|
|
.sp
|
|
|
.nf
|
|
|
.ft C
|
|
|
-<folder id="default" path="/Users/jb/Sync/" ro="false" rescanIntervalS="60" ignorePerms="false" autoNormalize="true">
|
|
|
+<folder id="zj2AA\-q55a7" label="Default Folder (zj2AA\-q55a7)" path="/Users/jb/Sync/" type="readwrite" rescanIntervalS="60" ignorePerms="false" autoNormalize="true" ro="false">
|
|
|
<device id="3LT2GA5\-CQI4XJM\-WTZ264P\-MLOGMHL\-MCRLDNT\-MZV4RD3\-KA745CL\-OGAERQZ"></device>
|
|
|
<minDiskFreePct>1</minDiskFreePct>
|
|
|
<versioning></versioning>
|
|
|
@@ -170,7 +172,9 @@ migration from previous formats.
|
|
|
<scanProgressIntervalS>0</scanProgressIntervalS>
|
|
|
<pullerSleepS>0</pullerSleepS>
|
|
|
<pullerPauseS>0</pullerPauseS>
|
|
|
- <maxConflicts>0</maxConflicts>
|
|
|
+ <maxConflicts>\-1</maxConflicts>
|
|
|
+ <disableSparseFiles>false</disableSparseFiles>
|
|
|
+ <disableTempIndexes>false</disableTempIndexes>
|
|
|
</folder>
|
|
|
.ft P
|
|
|
.fi
|
|
|
@@ -185,13 +189,25 @@ element:
|
|
|
.B id
|
|
|
The folder ID, must be unique. (mandatory)
|
|
|
.TP
|
|
|
+.B label
|
|
|
+The label of a folder is a human readable and descriptive local name.
|
|
|
+Can be different on each device. (optional)
|
|
|
+.TP
|
|
|
.B path
|
|
|
The path to the directory where the folder is stored on this
|
|
|
device; not sent to other devices. (mandatory)
|
|
|
.TP
|
|
|
-.B ro
|
|
|
-True if the folder is read only (Master mode; will not be modified by
|
|
|
-Syncthing) on this device.
|
|
|
+.B type
|
|
|
+Controls how the folder is handled by Syncthing. Possible values are:
|
|
|
+.INDENT 7.0
|
|
|
+.TP
|
|
|
+.B readwrite
|
|
|
+The folder is in default mode. Sending local and accepting remote changes.
|
|
|
+.TP
|
|
|
+.B readonly
|
|
|
+The folder is in "master" mode \-\- it will not be modified by
|
|
|
+syncthing on this device.
|
|
|
+.UNINDENT
|
|
|
.TP
|
|
|
.B rescanIntervalS
|
|
|
The rescan interval, in seconds. Can be set to zero to disable when external
|
|
|
@@ -274,6 +290,16 @@ what you\(aqre doing.
|
|
|
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.
|
|
|
+.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.
|
|
|
.UNINDENT
|
|
|
.SH DEVICE ELEMENT
|
|
|
.INDENT 0.0
|
|
|
@@ -384,6 +410,7 @@ This optional element lists device IDs that have been specifically ignored. One
|
|
|
<gui enabled="true" tls="false">
|
|
|
<address>127.0.0.1:8384</address>
|
|
|
<apikey>l7jSbCqPD95JYZ0g8vi4ZLAMg3ulnN1b</apikey>
|
|
|
+ <theme>default</theme>
|
|
|
</gui>
|
|
|
.ft P
|
|
|
.fi
|
|
|
@@ -402,6 +429,9 @@ If not \fBtrue\fP, the GUI and API will not be started.
|
|
|
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.
|
|
|
+.TP
|
|
|
+.B theme
|
|
|
+The name of the theme to use.
|
|
|
.UNINDENT
|
|
|
.sp
|
|
|
The following child elements may be present:
|
|
|
@@ -415,16 +445,10 @@ Allowed address formats are:
|
|
|
.B IPv4 address and port (\fB127.0.0.1:8384\fP)
|
|
|
The address and port is used as given.
|
|
|
.TP
|
|
|
-.B IPv4 wildcard and port (\fBtcp4://0.0.0.0\fP, \fBtcp4://:8384\fP)
|
|
|
-These are equivalent and will result in Syncthing listening on all interfaces via IPv4 only.
|
|
|
-.TP
|
|
|
.B IPv6 address and port (\fB[::1]:8384\fP)
|
|
|
The address and port is used as given. The address must be enclosed in
|
|
|
square brackets.
|
|
|
.TP
|
|
|
-.B IPv6 wildcard and port (\fBtcp6://[::]:8384\fP, \fBtcp6://:8384\fP)
|
|
|
-These are equivalent and will result in Syncthing listening on all interfaces via IPv6 only.
|
|
|
-.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.
|
|
|
@@ -446,24 +470,22 @@ If set, this is the API key that enables usage of the REST interface.
|
|
|
.nf
|
|
|
.ft C
|
|
|
<options>
|
|
|
- <listenAddress>tcp://0.0.0.0:22000</listenAddress>
|
|
|
+ <listenAddress>default</listenAddress>
|
|
|
<globalAnnounceServer>default</globalAnnounceServer>
|
|
|
<globalAnnounceEnabled>true</globalAnnounceEnabled>
|
|
|
<localAnnounceEnabled>true</localAnnounceEnabled>
|
|
|
<localAnnouncePort>21027</localAnnouncePort>
|
|
|
<localAnnounceMCAddr>[ff12::8384]:21027</localAnnounceMCAddr>
|
|
|
- <relayServer>dynamic+https://relays.syncthing.net/endpoint</relayServer>
|
|
|
<maxSendKbps>0</maxSendKbps>
|
|
|
<maxRecvKbps>0</maxRecvKbps>
|
|
|
<reconnectionIntervalS>60</reconnectionIntervalS>
|
|
|
<relaysEnabled>true</relaysEnabled>
|
|
|
<relayReconnectIntervalM>10</relayReconnectIntervalM>
|
|
|
- <relayWithoutGlobalAnn>false</relayWithoutGlobalAnn>
|
|
|
<startBrowser>true</startBrowser>
|
|
|
- <upnpEnabled>true</upnpEnabled>
|
|
|
- <upnpLeaseMinutes>60</upnpLeaseMinutes>
|
|
|
- <upnpRenewalMinutes>30</upnpRenewalMinutes>
|
|
|
- <upnpTimeoutSeconds>10</upnpTimeoutSeconds>
|
|
|
+ <natEnabled>true</natEnabled>
|
|
|
+ <natLeaseMinutes>60</natLeaseMinutes>
|
|
|
+ <natRenewalMinutes>30</natRenewalMinutes>
|
|
|
+ <natTimeoutSeconds>10</natTimeoutSeconds>
|
|
|
<urAccepted>0</urAccepted>
|
|
|
<urUniqueID></urUniqueID>
|
|
|
<urURL>https://data.syncthing.net/newdata</urURL>
|
|
|
@@ -472,13 +494,14 @@ If set, this is the API key that enables usage of the REST interface.
|
|
|
<restartOnWakeup>true</restartOnWakeup>
|
|
|
<autoUpgradeIntervalH>12</autoUpgradeIntervalH>
|
|
|
<keepTemporariesH>24</keepTemporariesH>
|
|
|
- <cacheIgnoredFiles>true</cacheIgnoredFiles>
|
|
|
+ <cacheIgnoredFiles>false</cacheIgnoredFiles>
|
|
|
<progressUpdateIntervalS>5</progressUpdateIntervalS>
|
|
|
<symlinksEnabled>true</symlinksEnabled>
|
|
|
<limitBandwidthInLan>false</limitBandwidthInLan>
|
|
|
- <databaseBlockCacheMiB>0</databaseBlockCacheMiB>
|
|
|
<minHomeDiskFreePct>1</minHomeDiskFreePct>
|
|
|
<releasesURL>https://api.github.com/repos/syncthing/syncthing/releases?per_page=30</releasesURL>
|
|
|
+ <overwriteRemoteDeviceNamesOnConnect>false</overwriteRemoteDeviceNamesOnConnect>
|
|
|
+ <tempIndexMinBlocks>10</tempIndexMinBlocks>
|
|
|
</options>
|
|
|
.ft P
|
|
|
.fi
|
|
|
@@ -489,10 +512,8 @@ The \fBoptions\fP element contains all other global configuration options.
|
|
|
.INDENT 0.0
|
|
|
.TP
|
|
|
.B listenAddress
|
|
|
-The listen address for incoming sync connections. See the \fBaddress\fP
|
|
|
-element under the \fI\%GUI Element\fP for allowed syntax, with the addition
|
|
|
-that the address must have a protocol scheme prefix. Currently \fBtcp://\fP
|
|
|
-is the only supported protocol scheme.
|
|
|
+The listen address for incoming sync connections. See
|
|
|
+\fI\%Listen Addresses\fP for allowed syntax.
|
|
|
.TP
|
|
|
.B globalAnnounceServer
|
|
|
A URI to a global announce (discovery) server, or the word \fBdefault\fP to
|
|
|
@@ -539,25 +560,20 @@ When true, relays will be connected to and potentially used for device to device
|
|
|
.B relayReconnectIntervalM
|
|
|
Sets the interval, in minutes, between relay reconnect attempts.
|
|
|
.TP
|
|
|
-.B relayWithoutGlobalAnn
|
|
|
-When set to true, relay connections will be attempted even when global
|
|
|
-discovery is disabled. This is useful only in the case where devices are
|
|
|
-known to be connected to the same relays. The default is \fBfalse\fP\&.
|
|
|
-.TP
|
|
|
.B startBrowser
|
|
|
Whether to attempt to start a browser to show the GUI when Syncthing starts.
|
|
|
.TP
|
|
|
-.B upnpEnabled
|
|
|
-Whether to attempt to perform an UPnP port mapping for incoming sync
|
|
|
-connections.
|
|
|
+.B natEnabled
|
|
|
+Whether to attempt to perform an UPnP and NAT\-PMP port mapping for
|
|
|
+incoming sync connections.
|
|
|
.TP
|
|
|
-.B upnpLeaseMinutes
|
|
|
+.B natLeaseMinutes
|
|
|
Request a lease for this many minutes; zero to request a permanent lease.
|
|
|
.TP
|
|
|
-.B upnpRenewalMinutes
|
|
|
+.B natRenewalMinutes
|
|
|
Attempt to renew the lease after this many minutes.
|
|
|
.TP
|
|
|
-.B upnpTimeoutSeconds
|
|
|
+.B natTimeoutSeconds
|
|
|
When scanning for UPnP devices, wait this long for responses.
|
|
|
.TP
|
|
|
.B urAccepted
|
|
|
@@ -594,8 +610,9 @@ 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
|
|
|
-Whether to cache the results of ignore pattern evaluation. Performance at
|
|
|
-the price of memory.
|
|
|
+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.
|
|
|
.TP
|
|
|
.B progressUpdateIntervalS
|
|
|
How often in seconds the progress of ongoing downloads is made available to
|
|
|
@@ -626,6 +643,63 @@ the configuration and index.
|
|
|
.TP
|
|
|
.B releasesURL
|
|
|
The URL from which release information is loaded, for automatic upgrades.
|
|
|
+.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.
|
|
|
+.TP
|
|
|
+.B tempIndexMinBlocks
|
|
|
+When exchanging index information for incomplete transfers, only take
|
|
|
+into account files that have at least this many blocks.
|
|
|
+.UNINDENT
|
|
|
+.SS Listen Addresses
|
|
|
+.sp
|
|
|
+The following address types are accepted in sync protocol listen addresses:
|
|
|
+.INDENT 0.0
|
|
|
+.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)
|
|
|
+These are equivalent and will result in Syncthing listening on the
|
|
|
+specified address and port 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)
|
|
|
+These are equivalent and will result in Syncthing listening on the
|
|
|
+specified address and port only.
|
|
|
+.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
|
Jakob Borg