|
|
@@ -1,6 +1,6 @@
|
|
|
.\" Man page generated from reStructuredText.
|
|
|
.
|
|
|
-.TH "SYNCTHING-CONFIG" "5" "October 20, 2015" "v0.11" "Syncthing"
|
|
|
+.TH "SYNCTHING-CONFIG" "5" "November 04, 2015" "v0.12" "Syncthing"
|
|
|
.SH NAME
|
|
|
syncthing-config \- Syncthing Configuration
|
|
|
.
|
|
|
@@ -81,33 +81,42 @@ The following shows the default configuration file:
|
|
|
.sp
|
|
|
.nf
|
|
|
.ft C
|
|
|
-<configuration version="10">
|
|
|
- <folder id="default" path="/Users/jb/Sync" ro="false" rescanIntervalS="60" ignorePerms="false" autoNormalize="false">
|
|
|
- <device id="5SYI2FS\-LW6YAXI\-JJDYETS\-NDBBPIO\-256MWBO\-XDPXWVG\-24QPUM4\-PDW4UQU"></device>
|
|
|
+<configuration version="12">
|
|
|
+ <folder id="default" path="/Users/jb/Sync/" ro="false" rescanIntervalS="60" ignorePerms="false" autoNormalize="true">
|
|
|
+ <device id="3LT2GA5\-CQI4XJM\-WTZ264P\-MLOGMHL\-MCRLDNT\-MZV4RD3\-KA745CL\-OGAERQZ"></device>
|
|
|
+ <minDiskFreePct>1</minDiskFreePct>
|
|
|
<versioning></versioning>
|
|
|
<copiers>0</copiers>
|
|
|
<pullers>0</pullers>
|
|
|
<hashers>0</hashers>
|
|
|
<order>random</order>
|
|
|
+ <ignoreDelete>false</ignoreDelete>
|
|
|
+ <scanProgressIntervalS>0</scanProgressIntervalS>
|
|
|
+ <pullerSleepS>0</pullerSleepS>
|
|
|
+ <pullerPauseS>0</pullerPauseS>
|
|
|
+ <maxConflicts>0</maxConflicts>
|
|
|
</folder>
|
|
|
- <device id="5SYI2FS\-LW6YAXI\-JJDYETS\-NDBBPIO\-256MWBO\-XDPXWVG\-24QPUM4\-PDW4UQU" name="syno" compression="metadata" introducer="false">
|
|
|
+ <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:8384</address>
|
|
|
- <apikey>l7jSbCqPD95JYZ0g8vi4ZLAMg3ulnN1b</apikey>
|
|
|
+ <address>127.0.0.1:52620</address>
|
|
|
+ <apikey>k1dnz1Dd0rzTBjjFFh7CXPnrF12C49B1</apikey>
|
|
|
</gui>
|
|
|
<options>
|
|
|
- <listenAddress>0.0.0.0:56847</listenAddress>
|
|
|
- <globalAnnounceServer>udp4://announce.syncthing.net:22026</globalAnnounceServer>
|
|
|
- <globalAnnounceServer>udp6://announce\-v6.syncthing.net:22026</globalAnnounceServer>
|
|
|
+ <listenAddress>tcp://0.0.0.0:22000</listenAddress>
|
|
|
+ <globalAnnounceServer>default</globalAnnounceServer>
|
|
|
<globalAnnounceEnabled>true</globalAnnounceEnabled>
|
|
|
<localAnnounceEnabled>true</localAnnounceEnabled>
|
|
|
- <localAnnouncePort>21025</localAnnouncePort>
|
|
|
- <localAnnounceMCAddr>[ff32::5222]:21026</localAnnounceMCAddr>
|
|
|
+ <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>
|
|
|
@@ -115,6 +124,9 @@ The following shows the default configuration file:
|
|
|
<upnpTimeoutSeconds>10</upnpTimeoutSeconds>
|
|
|
<urAccepted>0</urAccepted>
|
|
|
<urUniqueID></urUniqueID>
|
|
|
+ <urURL>https://data.syncthing.net/newdata</urURL>
|
|
|
+ <urPostInsecurely>false</urPostInsecurely>
|
|
|
+ <urInitialDelayS>1800</urInitialDelayS>
|
|
|
<restartOnWakeup>true</restartOnWakeup>
|
|
|
<autoUpgradeIntervalH>12</autoUpgradeIntervalH>
|
|
|
<keepTemporariesH>24</keepTemporariesH>
|
|
|
@@ -123,6 +135,8 @@ The following shows the default configuration file:
|
|
|
<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>
|
|
|
</options>
|
|
|
</configuration>
|
|
|
.ft P
|
|
|
@@ -144,13 +158,19 @@ migration from previous formats.
|
|
|
.sp
|
|
|
.nf
|
|
|
.ft C
|
|
|
-<folder id="default" path="/Users/jb/Sync" ro="false" rescanIntervalS="60" ignorePerms="false" autoNormalize="false">
|
|
|
- <device id="5SYI2FS\-LW6YAXI\-JJDYETS\-NDBBPIO\-256MWBO\-XDPXWVG\-24QPUM4\-PDW4UQU"></device>
|
|
|
+<folder id="default" path="/Users/jb/Sync/" ro="false" rescanIntervalS="60" ignorePerms="false" autoNormalize="true">
|
|
|
+ <device id="3LT2GA5\-CQI4XJM\-WTZ264P\-MLOGMHL\-MCRLDNT\-MZV4RD3\-KA745CL\-OGAERQZ"></device>
|
|
|
+ <minDiskFreePct>1</minDiskFreePct>
|
|
|
<versioning></versioning>
|
|
|
<copiers>0</copiers>
|
|
|
<pullers>0</pullers>
|
|
|
<hashers>0</hashers>
|
|
|
<order>random</order>
|
|
|
+ <ignoreDelete>false</ignoreDelete>
|
|
|
+ <scanProgressIntervalS>0</scanProgressIntervalS>
|
|
|
+ <pullerSleepS>0</pullerSleepS>
|
|
|
+ <pullerPauseS>0</pullerPauseS>
|
|
|
+ <maxConflicts>0</maxConflicts>
|
|
|
</folder>
|
|
|
.ft P
|
|
|
.fi
|
|
|
@@ -194,6 +214,11 @@ customary that the local device ID is included in all repositories.
|
|
|
Syncthing will currently add this automatically if it is not present in
|
|
|
the configuration file.
|
|
|
.TP
|
|
|
+.B minDiskFreePct
|
|
|
+The percentage of space that should be available on the disk this folder
|
|
|
+resides. The folder will be stopped when the percentage of free space goes
|
|
|
+below the threshold. Set to zero to disable.
|
|
|
+.TP
|
|
|
.B versioning
|
|
|
Specifies a versioning configuration.
|
|
|
.UNINDENT
|
|
|
@@ -231,6 +256,23 @@ Pull files ordered by file size; smallest and largest first respectively.
|
|
|
Pull files ordered by modification time; oldest and newest first
|
|
|
respectively.
|
|
|
.UNINDENT
|
|
|
+.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
|
|
|
+.B pullerSleepS, pullerPauseS
|
|
|
+Tweaks for rate limiting the puller. Don\(aqt change these unless you know
|
|
|
+what you\(aqre doing.
|
|
|
+.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.
|
|
|
.UNINDENT
|
|
|
.SH DEVICE ELEMENT
|
|
|
.INDENT 0.0
|
|
|
@@ -370,16 +412,19 @@ If set, this is the API key that enables usage of the REST interface.
|
|
|
.nf
|
|
|
.ft C
|
|
|
<options>
|
|
|
- <listenAddress>0.0.0.0:56847</listenAddress>
|
|
|
- <globalAnnounceServer>udp4://announce.syncthing.net:22026</globalAnnounceServer>
|
|
|
- <globalAnnounceServer>udp6://announce\-v6.syncthing.net:22026</globalAnnounceServer>
|
|
|
+ <listenAddress>tcp://0.0.0.0:22000</listenAddress>
|
|
|
+ <globalAnnounceServer>default</globalAnnounceServer>
|
|
|
<globalAnnounceEnabled>true</globalAnnounceEnabled>
|
|
|
<localAnnounceEnabled>true</localAnnounceEnabled>
|
|
|
- <localAnnouncePort>21025</localAnnouncePort>
|
|
|
- <localAnnounceMCAddr>[ff32::5222]:21026</localAnnounceMCAddr>
|
|
|
+ <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>
|
|
|
@@ -387,6 +432,9 @@ If set, this is the API key that enables usage of the REST interface.
|
|
|
<upnpTimeoutSeconds>10</upnpTimeoutSeconds>
|
|
|
<urAccepted>0</urAccepted>
|
|
|
<urUniqueID></urUniqueID>
|
|
|
+ <urURL>https://data.syncthing.net/newdata</urURL>
|
|
|
+ <urPostInsecurely>false</urPostInsecurely>
|
|
|
+ <urInitialDelayS>1800</urInitialDelayS>
|
|
|
<restartOnWakeup>true</restartOnWakeup>
|
|
|
<autoUpgradeIntervalH>12</autoUpgradeIntervalH>
|
|
|
<keepTemporariesH>24</keepTemporariesH>
|
|
|
@@ -395,8 +443,8 @@ If set, this is the API key that enables usage of the REST interface.
|
|
|
<symlinksEnabled>true</symlinksEnabled>
|
|
|
<limitBandwidthInLan>false</limitBandwidthInLan>
|
|
|
<databaseBlockCacheMiB>0</databaseBlockCacheMiB>
|
|
|
- <pingTimeoutS>60</pingTimeoutS>
|
|
|
- <pingIdleTimeS>120</pingIdleTimeS>
|
|
|
+ <minHomeDiskFreePct>1</minHomeDiskFreePct>
|
|
|
+ <releasesURL>https://api.github.com/repos/syncthing/syncthing/releases?per_page=30</releasesURL>
|
|
|
</options>
|
|
|
.ft P
|
|
|
.fi
|
|
|
@@ -408,12 +456,18 @@ The \fBoptions\fP element contains all other global configuration options.
|
|
|
.TP
|
|
|
.B listenAddress
|
|
|
The listen address for incoming sync connections. See the \fBaddress\fP
|
|
|
-element under the \fI\%GUI Element\fP for allowed syntax.
|
|
|
+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.
|
|
|
.TP
|
|
|
.B globalAnnounceServer
|
|
|
-A URI to a global announce (discovery) server. Allowed protocol prefixes
|
|
|
-are \fBudp4://\fP (UDP over IPv4), \fBudp6://\fP (UDP over IPv6) and
|
|
|
-\fBudp://\fP (UDP over any available protocol).
|
|
|
+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.
|
|
|
.TP
|
|
|
.B globalAnnounceEnabled
|
|
|
Whether to announce this device to the global announce (discovery) server,
|
|
|
@@ -429,6 +483,12 @@ The port on which to listen and send IPv4 broadcast announcements to.
|
|
|
.B localAnnounceMCAddr
|
|
|
The group address and port to join and send IPv6 multicast announcements on.
|
|
|
.TP
|
|
|
+.B relayServer
|
|
|
+Lists one or more relay servers, on the format \fBrelay://hostname:port\fP\&.
|
|
|
+Alternatively, a relay list can be loaded over https by using an URL like
|
|
|
+\fBdynamic+https://somehost/path\fP\&. The default loads the list of relays
|
|
|
+from the relay pool server, \fBrelays.syncthing.net\fP\&.
|
|
|
+.TP
|
|
|
.B maxSendKbps
|
|
|
Outgoing data rate limit, in kibibits per second.
|
|
|
.TP
|
|
|
@@ -439,6 +499,17 @@ Incoming data rate limits, in kibibits per second.
|
|
|
The number of seconds to wait between each attempt to connect to currently
|
|
|
unconnected devices.
|
|
|
.TP
|
|
|
+.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
|
|
|
+.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
|
|
|
@@ -465,6 +536,17 @@ version of usage reporting has been accepted.
|
|
|
The unique ID sent together with the usage report. Generated when usage
|
|
|
reporting is enabled.
|
|
|
.TP
|
|
|
+.B urURL
|
|
|
+The URL to post usage report data to, when enabled.
|
|
|
+.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\&.
|
|
|
+.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
|
|
|
.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).
|
|
|
@@ -508,6 +590,13 @@ slow response time (slow connection/cpu) and large index exchanges
|
|
|
.TP
|
|
|
.B pingIdleTimeS
|
|
|
ping interval in seconds. Don\(aqt change it unless you feel it\(aqs necessary.
|
|
|
+.TP
|
|
|
+.B minHomeDiskFreePct
|
|
|
+The percentage of space that should be available on the partition holding
|
|
|
+the configuration and index.
|
|
|
+.TP
|
|
|
+.B releasesURL
|
|
|
+The URL from which release information is loaded, for automatic upgrades.
|
|
|
.UNINDENT
|
|
|
.SH AUTHOR
|
|
|
The Syncthing Authors
|