gui, man, authors: Update docs, translations, and contributors
This commit is contained in:
+1
-1
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "STDISCOSRV" "1" "Oct 17, 2021" "v1" "Syncthing"
|
||||
.TH "STDISCOSRV" "1" "Jan 10, 2022" "v1" "Syncthing"
|
||||
.SH NAME
|
||||
stdiscosrv \- Syncthing Discovery Server
|
||||
.SH SYNOPSIS
|
||||
|
||||
+1
-1
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "STRELAYSRV" "1" "Oct 17, 2021" "v1" "Syncthing"
|
||||
.TH "STRELAYSRV" "1" "Jan 10, 2022" "v1" "Syncthing"
|
||||
.SH NAME
|
||||
strelaysrv \- Syncthing Relay Server
|
||||
.SH SYNOPSIS
|
||||
|
||||
+1
-1
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "SYNCTHING-BEP" "7" "Oct 17, 2021" "v1" "Syncthing"
|
||||
.TH "SYNCTHING-BEP" "7" "Jan 10, 2022" "v1" "Syncthing"
|
||||
.SH NAME
|
||||
syncthing-bep \- Block Exchange Protocol v1
|
||||
.SH INTRODUCTION AND DEFINITIONS
|
||||
|
||||
+180
-28
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "SYNCTHING-CONFIG" "5" "Oct 17, 2021" "v1" "Syncthing"
|
||||
.TH "SYNCTHING-CONFIG" "5" "Jan 10, 2022" "v1" "Syncthing"
|
||||
.SH NAME
|
||||
syncthing-config \- Syncthing Configuration
|
||||
.SH SYNOPSIS
|
||||
@@ -115,12 +115,18 @@ may no longer correspond to the defaults.
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
<configuration version="30">
|
||||
<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="3LT2GA5\-CQI4XJM\-WTZ264P\-MLOGMHL\-MCRLDNT\-MZV4RD3\-KA745CL\-OGAERQZ"></device>
|
||||
<device id="S7UKX27\-GI7ZTXS\-GC6RKUA\-7AJGZ44\-C6NAYEB\-HSKTJQK\-KJHU2NO\-CWV7EQW" introducedBy="">
|
||||
<encryptionPassword></encryptionPassword>
|
||||
</device>
|
||||
<minDiskFree unit="%">1</minDiskFree>
|
||||
<versioning></versioning>
|
||||
<versioning>
|
||||
<cleanupIntervalS>3600</cleanupIntervalS>
|
||||
<fsPath></fsPath>
|
||||
<fsType>basic</fsType>
|
||||
</versioning>
|
||||
<copiers>0</copiers>
|
||||
<pullerMaxPendingKiB>0</pullerMaxPendingKiB>
|
||||
<hashers>0</hashers>
|
||||
@@ -140,14 +146,18 @@ may no longer correspond to the defaults.
|
||||
<disableFsync>false</disableFsync>
|
||||
<blockPullOrder>standard</blockPullOrder>
|
||||
<copyRangeMethod>standard</copyRangeMethod>
|
||||
<caseSensitiveFS>false</caseSensitiveFS>
|
||||
<junctionsAsDirs>false</junctionsAsDirs>
|
||||
</folder>
|
||||
<device id="3LT2GA5\-CQI4XJM\-WTZ264P\-MLOGMHL\-MCRLDNT\-MZV4RD3\-KA745CL\-OGAERQZ" name="syno" compression="metadata" introducer="false" skipIntroductionRemovals="false" introducedBy="">
|
||||
<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">
|
||||
@@ -190,8 +200,8 @@ may no longer correspond to the defaults.
|
||||
<releasesURL>https://upgrades.syncthing.net/meta.json</releasesURL>
|
||||
<overwriteRemoteDeviceNamesOnConnect>false</overwriteRemoteDeviceNamesOnConnect>
|
||||
<tempIndexMinBlocks>10</tempIndexMinBlocks>
|
||||
<unackedNotificationID>authenticationUserAndPassword</unackedNotificationID>
|
||||
<trafficClass>0</trafficClass>
|
||||
<defaultFolderPath>~</defaultFolderPath>
|
||||
<setLowPriority>true</setLowPriority>
|
||||
<maxFolderConcurrency>0</maxFolderConcurrency>
|
||||
<crashReportingURL>https://crash.syncthing.net/newcrash</crashReportingURL>
|
||||
@@ -201,7 +211,58 @@ may no longer correspond to the defaults.
|
||||
<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
|
||||
@@ -213,14 +274,14 @@ may no longer correspond to the defaults.
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
<configuration version="30">
|
||||
<configuration version="35">
|
||||
<folder></folder>
|
||||
<device></device>
|
||||
<gui></gui>
|
||||
<ldap></ldap>
|
||||
<options></options>
|
||||
<ignoredDevice>5SYI2FS\-LW6YAXI\-JJDYETS\-NDBBPIO\-256MWBO\-XDPXWVG\-24QPUM4\-PDW4UQU</ignoredDevice>
|
||||
<ignoredFolder>bd7q3\-zskm5</ignoredFolder>
|
||||
<remoteIgnoredDevice></remoteIgnoredDevice>
|
||||
<defaults></defaults>
|
||||
</configuration>
|
||||
.ft P
|
||||
.fi
|
||||
@@ -235,19 +296,14 @@ 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 these two
|
||||
additional child elements:
|
||||
It contains the elements described in the following sections and any number of
|
||||
this additional child element:
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B ignoredDevice
|
||||
.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.
|
||||
.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 shown in the web GUI.
|
||||
.UNINDENT
|
||||
.SH FOLDER ELEMENT
|
||||
.INDENT 0.0
|
||||
@@ -257,9 +313,15 @@ logged, but there will be no dialog shown in the web GUI.
|
||||
.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="3LT2GA5\-CQI4XJM\-WTZ264P\-MLOGMHL\-MCRLDNT\-MZV4RD3\-KA745CL\-OGAERQZ"></device>
|
||||
<device id="S7UKX27\-GI7ZTXS\-GC6RKUA\-7AJGZ44\-C6NAYEB\-HSKTJQK\-KJHU2NO\-CWV7EQW" introducedBy="">
|
||||
<encryptionPassword></encryptionPassword>
|
||||
</device>
|
||||
<minDiskFree unit="%">1</minDiskFree>
|
||||
<versioning></versioning>
|
||||
<versioning>
|
||||
<cleanupIntervalS>3600</cleanupIntervalS>
|
||||
<fsPath></fsPath>
|
||||
<fsType>basic</fsType>
|
||||
</versioning>
|
||||
<copiers>0</copiers>
|
||||
<pullerMaxPendingKiB>0</pullerMaxPendingKiB>
|
||||
<hashers>0</hashers>
|
||||
@@ -279,6 +341,8 @@ logged, but there will be no dialog shown in the web GUI.
|
||||
<disableFsync>false</disableFsync>
|
||||
<blockPullOrder>standard</blockPullOrder>
|
||||
<copyRangeMethod>standard</copyRangeMethod>
|
||||
<caseSensitiveFS>false</caseSensitiveFS>
|
||||
<junctionsAsDirs>false</junctionsAsDirs>
|
||||
</folder>
|
||||
.ft P
|
||||
.fi
|
||||
@@ -519,16 +583,18 @@ See folder\-copyRangeMethod for details.
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
<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">
|
||||
<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="false" skipIntroductionRemovals="false" introducedBy="">
|
||||
<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>
|
||||
@@ -536,6 +602,7 @@ See folder\-copyRangeMethod for details.
|
||||
<maxSendKbps>100</maxSendKbps>
|
||||
<maxRecvKbps>100</maxRecvKbps>
|
||||
<maxRequestKiB>65536</maxRequestKiB>
|
||||
<untrusted>false</untrusted>
|
||||
<remoteGUIPort>8384</remoteGUIPort>
|
||||
</device>
|
||||
.ft P
|
||||
@@ -669,6 +736,11 @@ the config name looking like kilobits/second.
|
||||
Maximum receive rate to use for this device. Unit is kibibytes/second,
|
||||
despite the config name looking like kilobits/second.
|
||||
.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.
|
||||
.TP
|
||||
.B maxRequestKiB
|
||||
Maximum amount of data to have outstanding in requests towards this device.
|
||||
Unit is kibibytes.
|
||||
@@ -688,7 +760,7 @@ work for link\-local IPv6 addresses because of modern browser limitations.
|
||||
.ft C
|
||||
<gui enabled="true" tls="false" debugging="false">
|
||||
<address>127.0.0.1:8384</address>
|
||||
<apikey>l7jSbCqPD95JYZ0g8vi4ZLAMg3ulnN1b</apikey>
|
||||
<apikey>k1dnz1Dd0rzTBjjFFh7CXPnrF12C49B1</apikey>
|
||||
<theme>default</theme>
|
||||
</gui>
|
||||
.ft P
|
||||
@@ -717,7 +789,7 @@ The following child elements may be present:
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B address
|
||||
Set the listen address. One address element must be present. Allowed address formats are:
|
||||
Set the listen address. Exactly one address element must be present. Allowed address formats are:
|
||||
.INDENT 7.0
|
||||
.TP
|
||||
.B IPv4 address and port (\fB127.0.0.1:8384\fP)
|
||||
@@ -856,8 +928,8 @@ Skip verification (\fBtrue\fP or \fBfalse\fP).
|
||||
<releasesURL>https://upgrades.syncthing.net/meta.json</releasesURL>
|
||||
<overwriteRemoteDeviceNamesOnConnect>false</overwriteRemoteDeviceNamesOnConnect>
|
||||
<tempIndexMinBlocks>10</tempIndexMinBlocks>
|
||||
<unackedNotificationID>authenticationUserAndPassword</unackedNotificationID>
|
||||
<trafficClass>0</trafficClass>
|
||||
<defaultFolderPath>~</defaultFolderPath>
|
||||
<setLowPriority>true</setLowPriority>
|
||||
<maxFolderConcurrency>0</maxFolderConcurrency>
|
||||
<crashReportingURL>https://crash.syncthing.net/newcrash</crashReportingURL>
|
||||
@@ -867,6 +939,11 @@ Skip verification (\fBtrue\fP or \fBfalse\fP).
|
||||
<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
|
||||
@@ -1030,10 +1107,6 @@ expanded to
|
||||
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.
|
||||
.TP
|
||||
.B defaultFolderPath
|
||||
The UI will propose to create new folders at this path. This can be disabled by
|
||||
setting this to an empty string.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
@@ -1046,6 +1119,85 @@ 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
|
||||
.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>
|
||||
</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.
|
||||
.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 \fBdevice\fP element underneath.
|
||||
.UNINDENT
|
||||
.SS Listen Addresses
|
||||
.sp
|
||||
The following address types are accepted in sync protocol listen addresses.
|
||||
|
||||
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "SYNCTHING-DEVICE-IDS" "7" "Oct 17, 2021" "v1" "Syncthing"
|
||||
.TH "SYNCTHING-DEVICE-IDS" "7" "Jan 10, 2022" "v1" "Syncthing"
|
||||
.SH NAME
|
||||
syncthing-device-ids \- Understanding Device IDs
|
||||
.sp
|
||||
|
||||
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "SYNCTHING-EVENT-API" "7" "Oct 17, 2021" "v1" "Syncthing"
|
||||
.TH "SYNCTHING-EVENT-API" "7" "Jan 10, 2022" "v1" "Syncthing"
|
||||
.SH NAME
|
||||
syncthing-event-api \- Event API
|
||||
.SH DESCRIPTION
|
||||
|
||||
+34
-15
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "SYNCTHING-FAQ" "7" "Oct 17, 2021" "v1" "Syncthing"
|
||||
.TH "SYNCTHING-FAQ" "7" "Jan 10, 2022" "v1" "Syncthing"
|
||||
.SH NAME
|
||||
syncthing-faq \- Frequently Asked Questions
|
||||
.INDENT 0.0
|
||||
@@ -45,7 +45,7 @@ syncthing-faq \- Frequently Asked Questions
|
||||
.IP \(bu 2
|
||||
\fI\%How does Syncthing differ from BitTorrent/Resilio Sync?\fP
|
||||
.IP \(bu 2
|
||||
\fI\%Why is there no iOS client?\fP
|
||||
\fI\%Is there an iOS client?\fP
|
||||
.IP \(bu 2
|
||||
\fI\%Should I keep my device IDs secret?\fP
|
||||
.UNINDENT
|
||||
@@ -93,6 +93,8 @@ syncthing-faq \- Frequently Asked Questions
|
||||
.IP \(bu 2
|
||||
\fI\%When I do have two distinct Syncthing\-managed folders on two hosts, how does Syncthing handle moving files between them?\fP
|
||||
.IP \(bu 2
|
||||
\fI\%Can I help initial sync by copying files manually?\fP
|
||||
.IP \(bu 2
|
||||
\fI\%Is Syncthing my ideal backup application?\fP
|
||||
.IP \(bu 2
|
||||
\fI\%How can I exclude files with brackets ([]) in the name?\fP
|
||||
@@ -172,9 +174,9 @@ the faster an additional device will receive the data
|
||||
because small blocks will be fetched from all devices in parallel.
|
||||
.sp
|
||||
Syncthing handles renaming files and updating their metadata in an efficient
|
||||
manner. This means that renaming a large file will not cause a retransmission of
|
||||
that file. Additionally, appending data to existing large files should be
|
||||
handled efficiently as well.
|
||||
manner. This means that renaming a file will not cause a retransmission of
|
||||
that file. Additionally, appending data to existing files should be handled
|
||||
efficiently as well.
|
||||
.sp
|
||||
Temporary files are used to store partial data
|
||||
downloaded from other devices. They are automatically removed whenever a file
|
||||
@@ -195,12 +197,16 @@ mechanisms in use are well defined and visible in the source code. Resilio
|
||||
Sync uses an undocumented, closed protocol with unknown security properties.
|
||||
.IP [1] 5
|
||||
\fI\%https://en.wikipedia.org/wiki/Resilio_Sync\fP
|
||||
.SS Why is there no iOS client?
|
||||
.SS Is there an iOS client?
|
||||
.sp
|
||||
There is an alternative implementation of Syncthing (using the same network
|
||||
protocol) called \fBfsync()\fP\&. There are no plans by the current Syncthing
|
||||
team to support iOS in the foreseeable future, as the code required to do so
|
||||
would be quite different from what Syncthing is today.
|
||||
There are no plans by the current Syncthing team to officially support iOS in the foreseeable future.
|
||||
.sp
|
||||
iOS has significant restrictions on background processing that make it very hard to
|
||||
run Syncthing reliably and integrate it into the system.
|
||||
.sp
|
||||
However, there is a commercial packaging of Syncthing for iOS that attempts to work within these limitations. [2]
|
||||
.IP [2] 5
|
||||
\fI\%https://www.mobiussync.com\fP
|
||||
.SS Should I keep my device IDs secret?
|
||||
.sp
|
||||
No. The IDs are not sensitive. Given a device ID it’s possible to find the IP
|
||||
@@ -225,7 +231,7 @@ device\-ids
|
||||
.sp
|
||||
Syncthing logs to stdout by default. On Windows Syncthing by default also
|
||||
creates \fBsyncthing.log\fP in Syncthing’s home directory (run \fBsyncthing
|
||||
\-paths\fP to see where that is). The command line option \fB\-logfile\fP can be
|
||||
\-\-paths\fP to see where that is). The command line option \fB\-\-logfile\fP can be
|
||||
used to specify a user\-defined logfile.
|
||||
.sp
|
||||
If you’re running a process manager like systemd, check there. If you’re
|
||||
@@ -332,7 +338,7 @@ crashes and other bugs.
|
||||
.SS How can I view the history of changes?
|
||||
.sp
|
||||
The web GUI contains a \fBRecent Changes\fP button under the device list which
|
||||
displays changes since the last (re)start of Syncthing. With the \fB\-audit\fP
|
||||
displays changes since the last (re)start of Syncthing. With the \fB\-\-audit\fP
|
||||
option you can enable a persistent, detailed log of changes and most
|
||||
activities, which contains a \fBJSON\fP formatted sequence of events in the
|
||||
\fB~/.config/syncthing/audit\-_date_\-_time_.log\fP file.
|
||||
@@ -397,7 +403,7 @@ The easy way to rename or move a synced folder on the local system is to
|
||||
remove the folder in the Syncthing UI, move it on disk, then re\-add it using
|
||||
the new path.
|
||||
.sp
|
||||
It’s best to do this when the folder is already in sync between your
|
||||
It’s important to do this when the folder is already in sync between your
|
||||
devices, as it is otherwise unpredictable which changes will “win” after the
|
||||
move. Changes made on other devices may be overwritten, or changes made
|
||||
locally may be overwritten by those on other devices.
|
||||
@@ -432,6 +438,19 @@ block) from A, and then as A gets rescanned, it will remove the files from A.
|
||||
.sp
|
||||
A workaround would be to copy first from A to B, rescan B, wait for B to
|
||||
copy the files on the remote side, and then delete from A.
|
||||
.SS Can I help initial sync by copying files manually?
|
||||
.sp
|
||||
If you have a large folder that you want to keep in sync over a not\-so\-fast network, and you have the possibility to move all files to the remote device in a faster manner, here is a procedure to follow:
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
Create the folder on the local device, but don’t share it with the remote device yet.
|
||||
.IP \(bu 2
|
||||
Copy the files from the local device to the remote device using regular file copy. If this takes a long time (perhaps requiring travelling there physically), it may be a good idea to make sure that the files on the local device are not updated while you are doing this.
|
||||
.IP \(bu 2
|
||||
Create the folder on the remote device, and copy the Folder ID from the folder on the local device, as we want the folders to be considered the same. Then wait until scanning the folder is done.
|
||||
.IP \(bu 2
|
||||
Now share the folder with the other device, on both sides. Syncthing will exchange file information, updating the database, but existing files will not be transferred. This may still take a while initially, be patient and wait until it settled.
|
||||
.UNINDENT
|
||||
.SS Is Syncthing my ideal backup application?
|
||||
.sp
|
||||
No. Syncthing is not a great backup application because all changes to your
|
||||
@@ -531,7 +550,7 @@ own.
|
||||
By default, Syncthing will look for a directory \fBgui\fP inside the Syncthing
|
||||
home folder. To change the directory to look for themes, you need to set the
|
||||
STGUIASSETS environment variable. To get the concrete directory, run
|
||||
syncthing with the \fB\-paths\fP parameter. It will print all the relevant paths,
|
||||
syncthing with the \fB\-\-paths\fP parameter. It will print all the relevant paths,
|
||||
including the “GUI override directory”.
|
||||
.sp
|
||||
To add e.g. a red theme, you can create the file \fBred/assets/css/theme.css\fP
|
||||
@@ -553,7 +572,7 @@ upgrade itself automatically within 24 hours of a new release.
|
||||
The upgrade button appears in the web GUI when a new version has been
|
||||
released. Pressing it will perform an upgrade.
|
||||
.IP \(bu 2
|
||||
To force an upgrade from the command line, run \fBsyncthing \-upgrade\fP\&.
|
||||
To force an upgrade from the command line, run \fBsyncthing \-\-upgrade\fP\&.
|
||||
.UNINDENT
|
||||
.sp
|
||||
Note that your system should have CA certificates installed which allows a
|
||||
|
||||
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "SYNCTHING-GLOBALDISCO" "7" "Oct 17, 2021" "v1" "Syncthing"
|
||||
.TH "SYNCTHING-GLOBALDISCO" "7" "Jan 10, 2022" "v1" "Syncthing"
|
||||
.SH NAME
|
||||
syncthing-globaldisco \- Global Discovery Protocol v3
|
||||
.SH ANNOUNCEMENTS
|
||||
|
||||
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "SYNCTHING-LOCALDISCO" "7" "Oct 17, 2021" "v1" "Syncthing"
|
||||
.TH "SYNCTHING-LOCALDISCO" "7" "Jan 10, 2022" "v1" "Syncthing"
|
||||
.SH NAME
|
||||
syncthing-localdisco \- Local Discovery Protocol v4
|
||||
.SH MODE OF OPERATION
|
||||
|
||||
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "SYNCTHING-NETWORKING" "7" "Oct 17, 2021" "v1" "Syncthing"
|
||||
.TH "SYNCTHING-NETWORKING" "7" "Jan 10, 2022" "v1" "Syncthing"
|
||||
.SH NAME
|
||||
syncthing-networking \- Firewall Setup
|
||||
.SH ROUTER SETUP
|
||||
|
||||
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "SYNCTHING-RELAY" "7" "Oct 17, 2021" "v1" "Syncthing"
|
||||
.TH "SYNCTHING-RELAY" "7" "Jan 10, 2022" "v1" "Syncthing"
|
||||
.SH NAME
|
||||
syncthing-relay \- Relay Protocol v1
|
||||
.SH WHAT IS A RELAY?
|
||||
|
||||
+137
-32
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "SYNCTHING-REST-API" "7" "Oct 17, 2021" "v1" "Syncthing"
|
||||
.TH "SYNCTHING-REST-API" "7" "Jan 10, 2022" "v1" "Syncthing"
|
||||
.SH NAME
|
||||
syncthing-rest-api \- REST API
|
||||
.sp
|
||||
@@ -100,22 +100,23 @@ Returns the current configuration.
|
||||
.nf
|
||||
.ft C
|
||||
{
|
||||
"version": 30,
|
||||
"version": 35,
|
||||
"folders": [
|
||||
{
|
||||
"id": "GXWxf\-3zgnU",
|
||||
"label": "MyFolder",
|
||||
"id": "default",
|
||||
"label": "Default Folder",
|
||||
"filesystemType": "basic",
|
||||
"path": "...",
|
||||
"type": "sendreceive",
|
||||
"devices": [
|
||||
{
|
||||
"deviceID": "...",
|
||||
"introducedBy": ""
|
||||
"introducedBy": "",
|
||||
"encryptionPassword": ""
|
||||
}
|
||||
],
|
||||
"rescanIntervalS": 60,
|
||||
"fsWatcherEnabled": false,
|
||||
"rescanIntervalS": 3600,
|
||||
"fsWatcherEnabled": true,
|
||||
"fsWatcherDelayS": 10,
|
||||
"ignorePerms": false,
|
||||
"autoNormalize": true,
|
||||
@@ -124,10 +125,11 @@ Returns the current configuration.
|
||||
"unit": "%"
|
||||
},
|
||||
"versioning": {
|
||||
"type": "simple",
|
||||
"params": {
|
||||
"keep": "5"
|
||||
}
|
||||
"type": "",
|
||||
"params": {},
|
||||
"cleanupIntervalS": 3600,
|
||||
"fsPath": "",
|
||||
"fsType": "basic"
|
||||
},
|
||||
"copiers": 0,
|
||||
"pullerMaxPendingKiB": 0,
|
||||
@@ -136,14 +138,20 @@ Returns the current configuration.
|
||||
"ignoreDelete": false,
|
||||
"scanProgressIntervalS": 0,
|
||||
"pullerPauseS": 0,
|
||||
"maxConflicts": 10,
|
||||
"maxConflicts": \-1,
|
||||
"disableSparseFiles": false,
|
||||
"disableTempIndexes": false,
|
||||
"paused": false,
|
||||
"weakHashThresholdPct": 25,
|
||||
"markerName": ".stfolder",
|
||||
"copyOwnershipFromParent": false,
|
||||
"modTimeWindowS": 0
|
||||
"modTimeWindowS": 0,
|
||||
"maxConcurrentWrites": 2,
|
||||
"disableFsync": false,
|
||||
"blockPullOrder": "standard",
|
||||
"copyRangeMethod": "standard",
|
||||
"caseSensitiveFS": false,
|
||||
"junctionsAsDirs": true
|
||||
}
|
||||
],
|
||||
"devices": [
|
||||
@@ -164,18 +172,27 @@ Returns the current configuration.
|
||||
"autoAcceptFolders": false,
|
||||
"maxSendKbps": 0,
|
||||
"maxRecvKbps": 0,
|
||||
"ignoredFolders": [],
|
||||
"maxRequestKiB": 0
|
||||
"ignoredFolders": [
|
||||
{
|
||||
"time": "2022\-01\-09T19:09:52Z",
|
||||
"id": "br63e\-wyhb7",
|
||||
"label": "Foo"
|
||||
}
|
||||
],
|
||||
"maxRequestKiB": 0,
|
||||
"untrusted": false,
|
||||
"remoteGUIPort": 0
|
||||
}
|
||||
],
|
||||
"gui": {
|
||||
"enabled": true,
|
||||
"address": "127.0.0.1:8384",
|
||||
"unixSocketPermissions": "",
|
||||
"user": "Username",
|
||||
"password": "$2a$10$ZFws69T4FlvWwsqeIwL.TOo5zOYqsa/.TxlUnsGYS.j3JvjFTmxo6",
|
||||
"authMode": "static",
|
||||
"useTLS": false,
|
||||
"apiKey": "pGahcht56664QU5eoFQW6szbEG6Ec2Cr",
|
||||
"apiKey": "k1dnz1Dd0rzTBjjFFh7CXPnrF12C49B1",
|
||||
"insecureAdminAccess": false,
|
||||
"theme": "default",
|
||||
"debugging": false,
|
||||
@@ -186,7 +203,9 @@ Returns the current configuration.
|
||||
"address": "",
|
||||
"bindDN": "",
|
||||
"transport": "plain",
|
||||
"insecureSkipVerify": false
|
||||
"insecureSkipVerify": false,
|
||||
"searchBaseDN": "",
|
||||
"searchFilter": ""
|
||||
},
|
||||
"options": {
|
||||
"listenAddresses": [
|
||||
@@ -204,14 +223,14 @@ Returns the current configuration.
|
||||
"reconnectionIntervalS": 60,
|
||||
"relaysEnabled": true,
|
||||
"relayReconnectIntervalM": 10,
|
||||
"startBrowser": false,
|
||||
"startBrowser": true,
|
||||
"natEnabled": true,
|
||||
"natLeaseMinutes": 60,
|
||||
"natRenewalMinutes": 30,
|
||||
"natTimeoutSeconds": 10,
|
||||
"urAccepted": \-1,
|
||||
"urSeen": 2,
|
||||
"urUniqueId": "",
|
||||
"urAccepted": 0,
|
||||
"urSeen": 0,
|
||||
"urUniqueId": "...",
|
||||
"urURL": "https://data.syncthing.net/newdata",
|
||||
"urPostInsecurely": false,
|
||||
"urInitialDelayS": 1800,
|
||||
@@ -230,9 +249,10 @@ Returns the current configuration.
|
||||
"alwaysLocalNets": [],
|
||||
"overwriteRemoteDeviceNamesOnConnect": false,
|
||||
"tempIndexMinBlocks": 10,
|
||||
"unackedNotificationIDs": [],
|
||||
"unackedNotificationIDs": [
|
||||
"authenticationUserAndPassword"
|
||||
],
|
||||
"trafficClass": 0,
|
||||
"defaultFolderPath": "~",
|
||||
"setLowPriority": true,
|
||||
"maxFolderConcurrency": 0,
|
||||
"crURL": "https://crash.syncthing.net/newcrash",
|
||||
@@ -243,9 +263,96 @@ Returns the current configuration.
|
||||
"default"
|
||||
],
|
||||
"databaseTuning": "auto",
|
||||
"maxConcurrentIncomingRequestKiB": 0
|
||||
"maxConcurrentIncomingRequestKiB": 0,
|
||||
"announceLANAddresses": true,
|
||||
"sendFullIndexOnUpgrade": false,
|
||||
"featureFlags": [],
|
||||
"connectionLimitEnough": 0,
|
||||
"connectionLimitMax": 0,
|
||||
"insecureAllowOldTLSVersions": false
|
||||
},
|
||||
"remoteIgnoredDevices": []
|
||||
"remoteIgnoredDevices": [
|
||||
{
|
||||
"time": "2022\-01\-09T20:02:01Z",
|
||||
"deviceID": "...",
|
||||
"name": "...",
|
||||
"address": "192.168.0.20:22000"
|
||||
}
|
||||
],
|
||||
"defaults": {
|
||||
"folder": {
|
||||
"id": "",
|
||||
"label": "",
|
||||
"filesystemType": "basic",
|
||||
"path": "~",
|
||||
"type": "sendreceive",
|
||||
"devices": [
|
||||
{
|
||||
"deviceID": "...",
|
||||
"introducedBy": "",
|
||||
"encryptionPassword": ""
|
||||
}
|
||||
],
|
||||
"rescanIntervalS": 3600,
|
||||
"fsWatcherEnabled": true,
|
||||
"fsWatcherDelayS": 10,
|
||||
"ignorePerms": false,
|
||||
"autoNormalize": true,
|
||||
"minDiskFree": {
|
||||
"value": 1,
|
||||
"unit": "%"
|
||||
},
|
||||
"versioning": {
|
||||
"type": "",
|
||||
"params": {},
|
||||
"cleanupIntervalS": 3600,
|
||||
"fsPath": "",
|
||||
"fsType": "basic"
|
||||
},
|
||||
"copiers": 0,
|
||||
"pullerMaxPendingKiB": 0,
|
||||
"hashers": 0,
|
||||
"order": "random",
|
||||
"ignoreDelete": false,
|
||||
"scanProgressIntervalS": 0,
|
||||
"pullerPauseS": 0,
|
||||
"maxConflicts": 10,
|
||||
"disableSparseFiles": false,
|
||||
"disableTempIndexes": false,
|
||||
"paused": false,
|
||||
"weakHashThresholdPct": 25,
|
||||
"markerName": ".stfolder",
|
||||
"copyOwnershipFromParent": false,
|
||||
"modTimeWindowS": 0,
|
||||
"maxConcurrentWrites": 2,
|
||||
"disableFsync": false,
|
||||
"blockPullOrder": "standard",
|
||||
"copyRangeMethod": "standard",
|
||||
"caseSensitiveFS": false,
|
||||
"junctionsAsDirs": false
|
||||
},
|
||||
"device": {
|
||||
"deviceID": "",
|
||||
"name": "",
|
||||
"addresses": [
|
||||
"dynamic"
|
||||
],
|
||||
"compression": "metadata",
|
||||
"certName": "",
|
||||
"introducer": false,
|
||||
"skipIntroductionRemovals": false,
|
||||
"introducedBy": "",
|
||||
"paused": false,
|
||||
"allowedNetworks": [],
|
||||
"autoAcceptFolders": false,
|
||||
"maxSendKbps": 0,
|
||||
"maxRecvKbps": 0,
|
||||
"ignoredFolders": [],
|
||||
"maxRequestKiB": 0,
|
||||
"untrusted": false,
|
||||
"remoteGUIPort": 0
|
||||
}
|
||||
}
|
||||
}
|
||||
.ft P
|
||||
.fi
|
||||
@@ -290,7 +397,7 @@ config, modify the needed parts and post it again.
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
Return format changed in 0.13.0.
|
||||
Return format changed in versions 0.13.0 and 1.19.0.
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
@@ -305,14 +412,9 @@ The connection types are \fBTCP (Client)\fP, \fBTCP (Server)\fP, \fBRelay (Clien
|
||||
.ft C
|
||||
{
|
||||
"total" : {
|
||||
"paused" : false,
|
||||
"clientVersion" : "",
|
||||
"at" : "2015\-11\-07T17:29:47.691637262+01:00",
|
||||
"connected" : false,
|
||||
"inBytesTotal" : 1479,
|
||||
"type" : "",
|
||||
"outBytesTotal" : 1318,
|
||||
"address" : ""
|
||||
},
|
||||
"connections" : {
|
||||
"YZJBJFX\-RDBL7WY\-6ZGKJ2D\-4MJB4E7\-ZATSDUY\-LD6Y3L3\-MLFUYWE\-AEMXJAC" : {
|
||||
@@ -320,6 +422,7 @@ The connection types are \fBTCP (Client)\fP, \fBTCP (Server)\fP, \fBRelay (Clien
|
||||
"inBytesTotal" : 556,
|
||||
"paused" : false,
|
||||
"at" : "2015\-11\-07T17:29:47.691548971+01:00",
|
||||
"startedAt" : "2015\-11\-07T00:09:47Z",
|
||||
"clientVersion" : "v0.12.1",
|
||||
"address" : "127.0.0.1:22002",
|
||||
"type" : "TCP (Client)",
|
||||
@@ -330,6 +433,7 @@ The connection types are \fBTCP (Client)\fP, \fBTCP (Server)\fP, \fBRelay (Clien
|
||||
"type" : "",
|
||||
"address" : "",
|
||||
"at" : "0001\-01\-01T00:00:00Z",
|
||||
"startedAt" : "0001\-01\-01T00:00:00Z",
|
||||
"clientVersion" : "",
|
||||
"paused" : false,
|
||||
"inBytesTotal" : 0,
|
||||
@@ -343,6 +447,7 @@ The connection types are \fBTCP (Client)\fP, \fBTCP (Server)\fP, \fBRelay (Clien
|
||||
"inBytesTotal" : 0,
|
||||
"paused" : false,
|
||||
"at" : "0001\-01\-01T00:00:00Z",
|
||||
"startedAt" : "0001\-01\-01T00:00:00Z",
|
||||
"clientVersion" : ""
|
||||
}
|
||||
}
|
||||
@@ -549,7 +654,7 @@ $ curl \-X POST \-H "X\-API\-Key: abc123" http://localhost:8384/rest/system/rese
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBCaution\fP: See \fB\-reset\-database\fP for \fB\&.stfolder\fP creation side\-effect and caution regarding mountpoints.
|
||||
\fBCaution\fP: See \fB\-\-reset\-database\fP for \fB\&.stfolder\fP creation side\-effect and caution regarding mountpoints.
|
||||
.SS POST /rest/system/restart
|
||||
.sp
|
||||
Post with empty body to immediately restart Syncthing.
|
||||
|
||||
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "SYNCTHING-SECURITY" "7" "Oct 17, 2021" "v1" "Syncthing"
|
||||
.TH "SYNCTHING-SECURITY" "7" "Jan 10, 2022" "v1" "Syncthing"
|
||||
.SH NAME
|
||||
syncthing-security \- Security Principles
|
||||
.sp
|
||||
|
||||
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "SYNCTHING-STIGNORE" "5" "Oct 17, 2021" "v1" "Syncthing"
|
||||
.TH "SYNCTHING-STIGNORE" "5" "Jan 10, 2022" "v1" "Syncthing"
|
||||
.SH NAME
|
||||
syncthing-stignore \- Prevent files from being synchronized to other nodes
|
||||
.SH SYNOPSIS
|
||||
|
||||
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "SYNCTHING-VERSIONING" "7" "Oct 17, 2021" "v1" "Syncthing"
|
||||
.TH "SYNCTHING-VERSIONING" "7" "Jan 10, 2022" "v1" "Syncthing"
|
||||
.SH NAME
|
||||
syncthing-versioning \- Keep automatic backups of deleted files by other nodes
|
||||
.sp
|
||||
|
||||
+211
-42
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "SYNCTHING" "1" "Oct 17, 2021" "v1" "Syncthing"
|
||||
.TH "SYNCTHING" "1" "Jan 10, 2022" "v1" "Syncthing"
|
||||
.SH NAME
|
||||
syncthing \- Syncthing
|
||||
.SH SYNOPSIS
|
||||
@@ -36,13 +36,34 @@ syncthing \- Syncthing
|
||||
.sp
|
||||
.nf
|
||||
.ft C
|
||||
syncthing [\-audit] [\-auditfile=<file|\-|\-\->] [\-browser\-only] [device\-id]
|
||||
[\-generate=<dir>] [\-gui\-address=<address>] [\-gui\-apikey=<key>]
|
||||
[\-home=<dir> | \-config=<dir> \-data=<dir>]
|
||||
[\-logfile=<filename>] [\-logflags=<flags>]
|
||||
[\-no\-browser] [\-no\-console] [\-no\-restart] [\-paths] [\-paused]
|
||||
[\-reset\-database] [\-reset\-deltas] [\-unpaused] [\-upgrade]
|
||||
[\-upgrade\-check] [\-upgrade\-to=<url>] [\-verbose] [\-version]
|
||||
syncthing [serve]
|
||||
[\-\-audit] [\-\-auditfile=<file|\-|\-\->] [\-\-browser\-only] [\-\-device\-id]
|
||||
[\-\-generate=<dir>] [\-\-gui\-address=<address>] [\-\-gui\-apikey=<key>]
|
||||
[\-\-home=<dir> | \-\-config=<dir> \-\-data=<dir>]
|
||||
[\-\-logfile=<filename>] [\-\-logflags=<flags>]
|
||||
[\-\-log\-max\-old\-files=<num>] [\-\-log\-max\-size=<num>]
|
||||
[\-\-no\-browser] [\-\-no\-console] [\-\-no\-restart] [\-\-paths] [\-\-paused]
|
||||
[\-\-no\-default\-folder] [\-\-skip\-port\-probing]
|
||||
[\-\-reset\-database] [\-\-reset\-deltas] [\-\-unpaused] [\-\-allow\-newer\-config]
|
||||
[\-\-upgrade] [\-\-no\-upgrade] [\-\-upgrade\-check] [\-\-upgrade\-to=<url>]
|
||||
[\-\-verbose] [\-\-version] [\-\-help] [\-\-debug\-*]
|
||||
|
||||
syncthing generate
|
||||
[\-\-home=<dir> | \-\-config=<dir>]
|
||||
[\-\-gui\-user=<username>] [\-\-gui\-password=<password|\->]
|
||||
[\-\-no\-default\-folder] [\-\-skip\-port\-probing] [\-\-no\-console]
|
||||
[\-\-help]
|
||||
|
||||
syncthing decrypt (\-\-to=<dir> | \-\-verify\-only)
|
||||
[\-\-password=<pw>] [\-\-folder\-id=<id>] [\-\-token\-path=<file>]
|
||||
[\-\-continue] [\-\-verbose] [\-\-version] [\-\-help]
|
||||
<path>
|
||||
|
||||
syncthing cli
|
||||
[\-\-home=<dir> | \-\-config=<dir> \-\-data=<dir>]
|
||||
[\-\-gui\-address=<address>] [\-\-gui\-apikey=<key>]
|
||||
[\-\-help]
|
||||
<command> [command options...] [arguments...]
|
||||
.ft P
|
||||
.fi
|
||||
.UNINDENT
|
||||
@@ -66,39 +87,69 @@ few log messages.
|
||||
.SH OPTIONS
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-audit
|
||||
.B \-\-allow\-newer\-config
|
||||
Try loading a config file written by a newer program version, instead of
|
||||
failing immediately.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-audit
|
||||
Write events to timestamped file \fBaudit\-YYYYMMDD\-HHMMSS.log\fP\&.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-auditfile=<file|\-|\-\->
|
||||
.B \-\-auditfile=<file|\-|\-\->
|
||||
Use specified file or stream (\fB"\-"\fP for stdout, \fB"\-\-"\fP for stderr) for
|
||||
audit events, rather than the timestamped default file name.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-browser\-only
|
||||
.B \-\-browser\-only
|
||||
Open the web UI in a browser for an already running Syncthing instance.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-device\-id
|
||||
.B \-\-device\-id
|
||||
Print device ID to command line.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-generate=<dir>
|
||||
.B \-\-generate=<dir>
|
||||
Generate key and config in specified dir, then exit.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-gui\-address=<address>
|
||||
.B \-\-gui\-address=<address>
|
||||
Override GUI listen address. Set this to an address (\fB0.0.0.0:8384\fP)
|
||||
or file path (\fB/var/run/st.sock\fP, for UNIX sockets).
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-home=<dir>
|
||||
.B \-\-gui\-apikey=<string>
|
||||
Override the API key needed to access the GUI / REST API.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-gui\-password=<password|\->
|
||||
Specify new GUI authentication password, to update the config file. Read
|
||||
from the standard input stream if only a single dash (\fB\-\fP) is given. The
|
||||
password is hashed before writing to the config file. As a special case,
|
||||
giving the existing password hash as password will leave it untouched.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-gui\-user=<username>
|
||||
Specify new GUI authentication user name, to update the config file.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-help, \-h
|
||||
Show help text about command line usage. Context\-sensitive depending on the
|
||||
given subcommand.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-home=<dir>
|
||||
Set common configuration and data directory. The default configuration
|
||||
directory is \fB$HOME/.config/syncthing\fP (Unix\-like),
|
||||
\fB$HOME/Library/Application Support/Syncthing\fP (Mac) and
|
||||
@@ -106,26 +157,26 @@ directory is \fB$HOME/.config/syncthing\fP (Unix\-like),
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-config=<dir>
|
||||
Set configuration directory. Alternative to \fB\-home\fP and must be used
|
||||
together with \fB\-data\fP\&.
|
||||
.B \-\-config=<dir>
|
||||
Set configuration directory. Alternative to \fB\-\-home\fP and must be used
|
||||
together with \fB\-\-data\fP\&.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-data=<dir>
|
||||
Set data (e.g. database) directory. Alternative to \fB\-home\fP and must be used
|
||||
together with \fB\-config\fP\&.
|
||||
.B \-\-data=<dir>
|
||||
Set data (e.g. database) directory. Alternative to \fB\-\-home\fP and must be used
|
||||
together with \fB\-\-config\fP\&.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-logfile=<filename>
|
||||
.B \-\-logfile=<filename>
|
||||
Set destination filename for logging (use \fB"\-"\fP for stdout, which is the
|
||||
default option).
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-logflags=<flags>
|
||||
Select information in log line prefix. The \fB\-logflags\fP value is a sum of
|
||||
.B \-\-logflags=<flags>
|
||||
Select information in log line prefix. The \fB\-\-logflags\fP value is a sum of
|
||||
the following:
|
||||
.INDENT 7.0
|
||||
.IP \(bu 2
|
||||
@@ -140,40 +191,63 @@ the following:
|
||||
16: Short filename
|
||||
.UNINDENT
|
||||
.sp
|
||||
To prefix each log line with date and time, set \fB\-logflags=3\fP (1 + 2 from
|
||||
To prefix each log line with date and time, set \fB\-\-logflags=3\fP (1 + 2 from
|
||||
above). The value 0 is used to disable all of the above. The default is to
|
||||
show time only (2).
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-no\-browser
|
||||
.B \-\-log\-max\-old\-files=<num>
|
||||
Number of old files to keep (zero to keep only current). Applies only when
|
||||
log rotation is enabled through \fB\-\-log\-max\-size\fP\&.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-log\-max\-size=<num>
|
||||
Maximum size of any log file (zero to disable log rotation).
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-no\-browser
|
||||
Do not start a browser.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-no\-console
|
||||
.B \-\-no\-console
|
||||
Hide the console window. (On Windows only)
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-no\-restart
|
||||
.B \-\-no\-default\-folder
|
||||
Don’t create a default folder when generating an initial configuration /
|
||||
starting for the first time.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-no\-restart
|
||||
Do not restart Syncthing when it exits. The monitor process will still run
|
||||
to handle crashes and writing to logfiles (if configured to).
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-paths
|
||||
.B \-\-no\-upgrade
|
||||
Disable automatic upgrades. Equivalent to the \fBSTNOUPGRADE\fP environment
|
||||
variable, see below.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-paths
|
||||
Print the paths used for configuration, keys, database, GUI overrides,
|
||||
default sync folder and the log file.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-paused
|
||||
.B \-\-paused
|
||||
Start with all devices and folders paused.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-reset\-database
|
||||
.B \-\-reset\-database
|
||||
Reset the database, forcing a full rescan and resync. Create \fI\&.stfolder\fP
|
||||
folders in each sync folder if they do not already exist. \fBCaution\fP:
|
||||
Ensure that all sync folders which are mountpoints are already mounted.
|
||||
@@ -182,39 +256,77 @@ contains older versions.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-reset\-deltas
|
||||
.B \-\-reset\-deltas
|
||||
Reset delta index IDs, forcing a full index exchange.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-unpaused
|
||||
.B \-\-skip\-port\-probing
|
||||
Don’t try to find unused random ports for the GUI and listen address when
|
||||
generating an initial configuration / starting for the first time.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-unpaused
|
||||
Start with all devices and folders unpaused.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-upgrade
|
||||
.B \-\-upgrade
|
||||
Perform upgrade.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-upgrade\-check
|
||||
.B \-\-upgrade\-check
|
||||
Check for available upgrade.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-upgrade\-to=<url>
|
||||
.B \-\-upgrade\-to=<url>
|
||||
Force upgrade directly from specified URL.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-verbose
|
||||
.B \-\-verbose
|
||||
Print verbose log output.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-version
|
||||
.B \-\-version
|
||||
Show version.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-to=<dir>
|
||||
Destination directory where files should be stored after decryption.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-verify\-only
|
||||
Don’t write decrypted files to disk (but verify plaintext hashes).
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-password=<pw>
|
||||
Folder password for decryption / verification. Can be passed through the
|
||||
\fBFOLDER_PASSWORD\fP environment variable instead to avoid recording in a
|
||||
shell’s history buffer or sniffing from the running processes list.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-folder\-id=<id>
|
||||
Folder ID of the encrypted folder, if it cannot be determined automatically.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-token\-path=<file>
|
||||
Path to the token file within the folder (used to determine folder ID).
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-\-continue
|
||||
Continue processing next file in case of error, instead of aborting.
|
||||
.UNINDENT
|
||||
.SH EXIT CODES
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
@@ -237,6 +349,62 @@ Upgrading
|
||||
Exit codes over 125 are usually returned by the shell/binary loader/default
|
||||
signal handler. Exit codes over 128+N on Unix usually represent the signal which
|
||||
caused the process to exit. For example, \fB128 + 9 (SIGKILL) = 137\fP\&.
|
||||
.SH SUBCOMMANDS
|
||||
.sp
|
||||
The command line syntax actually supports different modes of operation through
|
||||
several subcommands, specified as the first argument. If omitted, the default
|
||||
\fBserve\fP is assumed.
|
||||
.sp
|
||||
The initial setup of a device ID and default configuration can be called
|
||||
explicitly with the \fBgenerate\fP subcommand. It can also update the configured
|
||||
GUI authentication credentials, without going through the REST API. An existing
|
||||
device certificate is left untouched. If the configuration file already exists,
|
||||
it is validated and updated to the latest configuration schema, including adding
|
||||
default values for any new options.
|
||||
.sp
|
||||
The \fBdecrypt\fP subcommand is used in conjunction with untrusted (encrypted)
|
||||
devices, see the relevant section on decryption for
|
||||
details. It does not depend on Syncthing to be running, but works on offline
|
||||
data.
|
||||
.sp
|
||||
To work with the REST API for debugging or automating things in Syncthing, the
|
||||
\fBcli\fP subcommand provides easy access to individual features. It basically
|
||||
saves the hassle of handling HTTP connections and API authentication.
|
||||
.sp
|
||||
The available subcommands are grouped into several nested hierarchies and some
|
||||
parts dynamically generated from the running Syncthing instance. On every
|
||||
level, the \fB\-\-help\fP option lists the available properties, actions and
|
||||
commands for the user to discover interactively. The top\-level groups are:
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B config
|
||||
Access the live configuration in a running instance over the REST API to
|
||||
retrieve (get) or update (set) values in a fine\-grained way. The hierarchy
|
||||
is based on the same structure as used in the JSON / XML representations.
|
||||
.TP
|
||||
.B show
|
||||
Show system properties and status of a running instance. The output is
|
||||
passed on directly from the REST API response and therefore requires parsing
|
||||
JSON format.
|
||||
.TP
|
||||
.B operations
|
||||
Control the overall program operation such as restarting or handling
|
||||
upgrades, as well as triggering some actions on a per\-folder basis.
|
||||
.TP
|
||||
.B errors
|
||||
Examine pending error conditions that need attention from the user, or
|
||||
acknowledge (clear) them.
|
||||
.TP
|
||||
.B debug
|
||||
Various tools to aid in diagnosing problems or collection information for
|
||||
bug reports. Some of these commands access the database directly and can
|
||||
therefore only work when Syncthing is not running.
|
||||
.TP
|
||||
.B \fB\-\fP (a single dash)
|
||||
Reads subsequent commands from the standard input stream, without needing to
|
||||
call the \fBsyncthing cli\fP command over and over. Exits on any invalid
|
||||
command or when EOF (end\-of\-file) is received.
|
||||
.UNINDENT
|
||||
.SH PROXIES
|
||||
.sp
|
||||
Syncthing can use a SOCKS, HTTP, or HTTPS proxy to talk to the outside
|
||||
@@ -267,7 +435,7 @@ path expansion may not be supported.
|
||||
Used to increase the debugging verbosity in specific or all facilities,
|
||||
generally mapping to a Go package. Enabling any of these also enables
|
||||
microsecond timestamps, file names plus line numbers. Enter a
|
||||
comma\-separated string of facilities to trace. \fBsyncthing \-help\fP always
|
||||
comma\-separated string of facilities to trace. \fBsyncthing \-\-help\fP always
|
||||
outputs an up\-to\-date list. The valid facility strings are:
|
||||
.INDENT 7.0
|
||||
.TP
|
||||
@@ -388,13 +556,14 @@ increases.
|
||||
.TP
|
||||
.B STNODEFAULTFOLDER
|
||||
Don’t create a default folder when starting for the first time. This
|
||||
variable will be ignored anytime after the first run.
|
||||
variable will be ignored anytime after the first run. Equivalent to the
|
||||
\fB\-\-no\-default\-folder\fP flag.
|
||||
.TP
|
||||
.B STNORESTART
|
||||
Equivalent to the \fB\-no\-restart\fP flag
|
||||
Equivalent to the \fB\-\-no\-restart\fP flag.
|
||||
.TP
|
||||
.B STNOUPGRADE
|
||||
Disable automatic upgrades.
|
||||
Disable automatic upgrades. Equivalent to the \fB\-\-no\-upgrade\fP flag.
|
||||
.TP
|
||||
.B STPROFILER
|
||||
Set to a listen address such as “127.0.0.1:9090” to start the profiler with
|
||||
|
||||
Reference in New Issue
Block a user