felixfoertsch/syncthing
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 10 Wiki Activity

gui, man, authors: Update docs, translations, and contributors

Browse Source
This commit is contained in:
Syncthing Release Automation
2024-05-13 03:45:18 +00:00
parent f6df8b40b4
commit 06914b872b
20 changed files with 1082 additions and 881 deletions
Download Patch File Download Diff File Expand all files Collapse all files
man/stdiscosrv.1
+37 -63
View File
@@ -27,20 +27,18 @@ 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" "Apr 11, 2024" "v1.27.5" "Syncthing"
.TH "STDISCOSRV" "1" "May 08, 2024" "v1.27.7" "Syncthing"
.SH NAME
stdiscosrv \- Syncthing Discovery Server
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
stdiscosrv [\-cert=<file>] [\-db\-dir=<string>] [\-debug] [\-http] [\-key=<string>]
[\-listen=<address>] [\-metrics\-listen=<address>]
[\-replicate=<peers>] [\-replication\-listen=<address>]
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.SH DESCRIPTION
@@ -87,7 +85,7 @@ Prometheus compatible metrics endpoint listen address (default disabled).
.INDENT 0.0
.TP
.B \-replicate=<peers>
Replication peers, \fI\%id@address\fP <\fBid@address\fP>, comma separated
Replication peers, \X'tty: link mailto:id@address'\fI\%id@address\fP <\fBid@address\fP>\X'tty: link', comma separated
.UNINDENT
.INDENT 0.0
.TP
@@ -114,10 +112,10 @@ entry from the list.
.SS Description
.sp
This guide assumes that you have already set up Syncthing. If you
haven’t yet, head over to \fI\%Getting Started\fP first.
haven’t yet, head over to \X'tty: link #getting-started'\fI\%Getting Started\fP\X'tty: link' first.
.SS Installing
.sp
Go to \fI\%releases\fP <\fBhttps://github.com/syncthing/discosrv/releases\fP> and
Go to \X'tty: link https://github.com/syncthing/discosrv/releases'\fI\%releases\fP <\fBhttps://github.com/syncthing/discosrv/releases\fP>\X'tty: link' and
download the file appropriate for your operating system. Unpacking it will
yield a binary called \fBstdiscosrv\fP (or \fBstdiscosrv.exe\fP on Windows).
Start this in whatever way you are most comfortable with; double clicking
@@ -127,7 +125,7 @@ given flags to the contrary.
.sp
The discovery server can also be obtained through apt, the Debian/Ubuntu package
manager. Recent releases can be found at syncthing’s
\fI\%apt repository\fP <\fBhttps://apt.syncthing.net/\fP>\&. The name of the package is
\X'tty: link https://apt.syncthing.net/'\fI\%apt repository\fP <\fBhttps://apt.syncthing.net/\fP>\X'tty: link'\&. The name of the package is
syncthing\-discosrv.
.SS Configuring
.sp
@@ -164,12 +162,10 @@ the certificate and key at startup. This isn’t necessary with the \fBhttp\fP f
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
$ stdiscosrv \-cert=/path/to/cert.pem \-key=/path/to/key.pem
Server device ID is 7DDRT7J\-UICR4PM\-PBIZYL3\-MZOJ7X7\-EX56JP6\-IK6HHMW\-S7EK32W\-G3EUPQA
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
@@ -179,11 +175,9 @@ the clients in the discovery server URL:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
https://disco.example.com:8443/?id=7DDRT7J\-UICR4PM\-PBIZYL3\-MZOJ7X7\-EX56JP6\-IK6HHMW\-S7EK32W\-G3EUPQA
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
@@ -191,11 +185,9 @@ Otherwise, the URL will be:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
https://disco.example.com:8443/
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.SS Replication
@@ -210,8 +202,8 @@ shared with the main discovery API. If the \fB\-http\fP mode is used the
certificate is not used for client requests but only for replication
connections.
.sp
Authentication of replication connections is done using \fI\%Syncthing\-style
device IDs\fP <\fBhttps://docs.syncthing.net/dev/device-ids.html#id1\fP> only \- CA
Authentication of replication connections is done using \X'tty: link https://docs.syncthing.net/dev/device-ids.html#id1'\fI\%Syncthing\-style
device IDs\fP <\fBhttps://docs.syncthing.net/dev/device-ids.html#id1\fP>\X'tty: link' only \- CA
verification is not available. The device IDs in question are those printed
by the discovery server on startup.
.sp
@@ -235,11 +227,9 @@ On server one:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
$ stdiscosrv \-replicate=MRI...7OK@192.0.2.55:19200 <other options>
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
@@ -247,11 +237,9 @@ On server two:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
$ stdiscosrv \-replicate=I6K...H76@192.0.2.20:19200 <other options>
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
@@ -266,11 +254,9 @@ device ID without “@ip:port” address:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
$ stdiscosrv \-replicate=I6K...H76 <other options>
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
@@ -283,7 +269,7 @@ Syncthing towards this name. The same certificate must be used on both
discovery servers.
.SS Reverse Proxy Setup
.sp
New in version 1.8.0: A new “X\-Client\-Port” HTTP header was added.
Added in version 1.8.0: A new “X\-Client\-Port” HTTP header was added.
.sp
The discovery server can be run behind an SSL\-secured reverse proxy. This
@@ -331,25 +317,22 @@ listed above:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
proxy_set_header X\-Forwarded\-For $proxy_add_x_forwarded_for;
proxy_set_header X\-Client\-Port $remote_port;
proxy_set_header X\-SSL\-Cert $ssl_client_cert;
ssl_verify_client optional_no_ca;
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
The following is a complete example Nginx configuration file. With this setup,
clients can use \fI\%https://discovery.example.com\fP as the discovery server URL in
clients can use \X'tty: link https://discovery.example.com'\fI\%https://discovery.example.com\fP\X'tty: link' as the discovery server URL in
the Syncthing settings.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
# HTTP 1.1 support
proxy_http_version 1.1;
proxy_buffering off;
@@ -404,26 +387,23 @@ server {
proxy_pass http://discovery.example.com;
}
}
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
An example of automating the SSL certificates and reverse\-proxying the Discovery
Server and Syncthing using Nginx, \fI\%Let’s Encrypt\fP <\fBhttps://letsencrypt.org/\fP> and Docker can be found \fI\%here\fP <\fBhttps://forum.syncthing.net/t/docker-syncthing-and-syncthing-discovery-behind-nginx-reverse-proxy-with-lets-encrypt/6880\fP>\&.
Server and Syncthing using Nginx, \X'tty: link https://letsencrypt.org/'\fI\%Let’s Encrypt\fP <\fBhttps://letsencrypt.org/\fP>\X'tty: link' and Docker can be found \X'tty: link https://forum.syncthing.net/t/docker-syncthing-and-syncthing-discovery-behind-nginx-reverse-proxy-with-lets-encrypt/6880'\fI\%here\fP <\fBhttps://forum.syncthing.net/t/docker-syncthing-and-syncthing-discovery-behind-nginx-reverse-proxy-with-lets-encrypt/6880\fP>\X'tty: link'\&.
.SS Apache
.sp
The following lines must be added to the configuration:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
SSLProxyEngine On
SSLVerifyClient optional_no_ca
RequestHeader set X\-SSL\-Cert \(dq%{SSL_CLIENT_CERT}s\(dq
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
@@ -435,11 +415,9 @@ configuration:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
RemoteIPHeader X\-Forwarded\-For
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.SS Caddy
@@ -448,8 +426,7 @@ The following lines must be added to the Caddyfile:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
discovery.example.com {
reverse_proxy 192.0.2.1:8443 {
header_up X\-Forwarded\-For {http.request.remote.host}
@@ -463,23 +440,20 @@ The following lines must be added to the Caddyfile:
}
}
}
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
For more details, see also the recommendations in the
\fI\%Reverse Proxy Setup\fP <\fBhttps://docs.syncthing.net/users/reverseproxy.html\fP>
\X'tty: link https://docs.syncthing.net/users/reverseproxy.html'\fI\%Reverse Proxy Setup\fP <\fBhttps://docs.syncthing.net/users/reverseproxy.html\fP>\X'tty: link'
page. Note that that page is directed at setting up a proxy for the
Syncthing web UI. You should do the proper path and port adjustments to proxying
the discovery server and your particular setup.
man/strelaysrv.1
+24 -40
View File
@@ -27,22 +27,20 @@ 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" "Apr 11, 2024" "v1.27.5" "Syncthing"
.TH "STRELAYSRV" "1" "May 08, 2024" "v1.27.7" "Syncthing"
.SH NAME
strelaysrv \- Syncthing Relay Server
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
strelaysrv [\-debug] [\-ext\-address=<address>] [\-global\-rate=<bytes/s>] [\-keys=<dir>] [\-listen=<listen addr>]
[\-message\-timeout=<duration>] [\-nat] [\-nat\-lease=<duration>] [\-nat\-renewal=<duration>]
[\-nat\-timeout=<duration>] [\-network\-timeout=<duration>] [\-per\-session\-rate=<bytes/s>]
[\-ping\-interval=<duration>] [\-pools=<pool addresses>] [\-pprof] [\-protocol=<string>]
[\-provided\-by=<string>] [\-status\-srv=<listen addr>] [\-token=<string>] [\-version]
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.SH DESCRIPTION
@@ -50,7 +48,7 @@ strelaysrv [\-debug] [\-ext\-address=<address>] [\-global\-rate=<bytes/s>] [\-ke
Syncthing relies on a network of community\-contributed relay servers. Anyone
can run a relay server, and it will automatically join the relay pool and be
available to Syncthing users. The current list of relays can be found at
\fI\%https://relays.syncthing.net/\fP\&.
\X'tty: link https://relays.syncthing.net/'\fI\%https://relays.syncthing.net/\fP\X'tty: link'\&.
.SH OPTIONS
.INDENT 0.0
.TP
@@ -127,7 +125,7 @@ How often pings are sent (default 1m0s).
.TP
.B \-pools=<pool addresses>
Comma separated list of relay pool addresses to join (default
“\fI\%https://relays.syncthing.net/endpoint\fP”). Blank to disable announcement to
“\X'tty: link https://relays.syncthing.net/endpoint'\fI\%https://relays.syncthing.net/endpoint\fP\X'tty: link'”). Blank to disable announcement to
a pool, thereby remaining a private relay.
.UNINDENT
.INDENT 0.0
@@ -163,7 +161,7 @@ Show version
.UNINDENT
.SS Installing
.sp
Go to \fI\%releases\fP <\fBhttps://github.com/syncthing/relaysrv/releases\fP> and
Go to \X'tty: link https://github.com/syncthing/relaysrv/releases'\fI\%releases\fP <\fBhttps://github.com/syncthing/relaysrv/releases\fP>\X'tty: link' and
download the file appropriate for your operating system. Unpacking it will
yield a binary called \fBstrelaysrv\fP (or \fBstrelaysrv.exe\fP on Windows).
Start this in whatever way you are most comfortable with; double clicking
@@ -175,7 +173,7 @@ The startup message prints instructions on how to change this.
.sp
The relay server can also be obtained through apt, the Debian/Ubuntu package
manager. Recent releases can be found at syncthing’s
\fI\%apt repository\fP <\fBhttps://apt.syncthing.net/\fP>\&. The name of the package is
\X'tty: link https://apt.syncthing.net/'\fI\%apt repository\fP <\fBhttps://apt.syncthing.net/\fP>\X'tty: link'\&. The name of the package is
syncthing\-relaysrv.
.SH SETTING UP
.sp
@@ -189,14 +187,12 @@ system:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
$ sudo useradd strelaysrv
$ sudo mkdir /etc/strelaysrv
$ sudo chown strelaysrv /etc/strelaysrv
$ sudo \-u strelaysrv /usr/local/bin/strelaysrv \-keys /etc/strelaysrv
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
@@ -212,11 +208,9 @@ Syncthing can be configured to use specific relay servers (exclusively of the pu
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
relay://<host name|IP>[:port]/?id=<relay device ID>
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
@@ -224,11 +218,9 @@ For example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
relay://private\-relay\-1.example.com:443/?id=ITZRNXE\-YNROGBZ\-HXTH5P7\-VK5NYE5\-QHRQGE2\-7JQ6VNJ\-KZUEDIU\-5PPR5AM
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
@@ -246,11 +238,9 @@ to forward traffic from port 443 to port 22067, for example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
iptables \-t nat \-A PREROUTING \-p tcp \-\-dport 443 \-j REDIRECT \-\-to\-port 22067
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
@@ -258,8 +248,7 @@ Or, if you’re using \fBufw\fP, add the following to \fB/etc/ufw/before.rules\f
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
*nat
:PREROUTING ACCEPT [0:0]
:POSTROUTING ACCEPT [0:0]
@@ -267,8 +256,7 @@ Or, if you’re using \fBufw\fP, add the following to \fB/etc/ufw/before.rules\f
\-A PREROUTING \-p tcp \-\-dport 443 \-j REDIRECT \-\-to\-port 22067
COMMIT
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
@@ -277,12 +265,12 @@ You will need to start \fBstrelaysrv\fP with \fB\-ext\-address \(dq:443\(dq\fP\&
on port 22067. You will also need to let both port 443 and 22067 through your
firewall.
.sp
Another option is \fI\%described here\fP <\fBhttps://wiki.apache.org/httpd/NonRootPortBinding\fP>,
Another option is \X'tty: link https://wiki.apache.org/httpd/NonRootPortBinding'\fI\%described here\fP <\fBhttps://wiki.apache.org/httpd/NonRootPortBinding\fP>\X'tty: link',
although your mileage may vary.
.SH FIREWALL CONSIDERATIONS
.sp
The relay server listens on two ports by default. One for data connections and the other
for providing public statistics at \fI\%https://relays.syncthing.net/\fP\&. The firewall, such as
for providing public statistics at \X'tty: link https://relays.syncthing.net/'\fI\%https://relays.syncthing.net/\fP\X'tty: link'\&. The firewall, such as
\fBiptables\fP, must permit incoming TCP connections to the following ports:
.INDENT 0.0
.IP \(bu 2
@@ -295,19 +283,17 @@ Runtime \fBiptables\fP rules to allow access to the default ports:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
iptables \-I INPUT \-p tcp \-\-dport 22067 \-j ACCEPT
iptables \-I INPUT \-p tcp \-\-dport 22070 \-j ACCEPT
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
Please consult Linux distribution documentation to persist firewall rules.
.SH ACCESS CONTROL FOR PRIVATE RELAYS
.sp
New in version 1.22.1.
Added in version 1.22.1.
.sp
Private relays can be configured to only accept connections from peers in possession of a shared secret.
@@ -319,11 +305,9 @@ Then configure your Syncthing devices to send the token when joining the relay:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
relay://<host name|IP>[:port]/?id=<relay device ID>&token=mySecretToken
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.SH SEE ALSO
man/syncthing-bep.7
+42 -77
View File
@@ -1,3 +1,4 @@
'\" t
.\" Man page generated from reStructuredText.
.
.
@@ -27,7 +28,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" "Apr 11, 2024" "v1.27.5" "Syncthing"
.TH "SYNCTHING-BEP" "7" "May 08, 2024" "v1.27.7" "Syncthing"
.SH NAME
syncthing-bep \- Block Exchange Protocol v1
.SH INTRODUCTION AND DEFINITIONS
@@ -48,7 +49,7 @@ for the last block which may be smaller.
.sp
The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”,
“SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this
document are to be interpreted as described in \fI\%RFC 2119\fP <\fBhttps://datatracker.ietf.org/doc/html/rfc2119.html\fP>\&.
document are to be interpreted as described in \X'tty: link https://datatracker.ietf.org/doc/html/rfc2119.html'\fI\%RFC 2119\fP <\fBhttps://datatracker.ietf.org/doc/html/rfc2119.html\fP>\X'tty: link'\&.
.SH TRANSPORT AND AUTHENTICATION
.sp
BEP is deployed as the highest level in a protocol stack, with the lower
@@ -56,8 +57,7 @@ level protocols providing encryption and authentication.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+
| Block Exchange Protocol |
|\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-|
@@ -66,8 +66,7 @@ level protocols providing encryption and authentication.
| Reliable Transport |
|\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-|
v ... v
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
@@ -129,8 +128,7 @@ followed by the contents of the Hello message itself.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
0 1
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5
+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+
@@ -143,8 +141,7 @@ followed by the contents of the Hello message itself.
\e Hello \e
/ /
+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
@@ -152,15 +149,13 @@ The Hello message itself is in protocol buffer format with the following schema:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
message Hello {
string device_name = 1;
string client_name = 2;
string client_version = 3;
}
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.SS Fields (Hello message)
@@ -172,8 +167,8 @@ The \fBclient_name\fP and \fBclient_version\fP identifies the implementation. Th
values SHOULD be simple strings identifying the implementation name, as a
user would expect to see it, and the version string in the same manner. An
example client name is “syncthing” and an example client version is “v0.7.2”.
The client version field SHOULD follow the patterns laid out in the \fI\%Semantic
Versioning\fP <\fBhttps://semver.org/\fP> standard.
The client version field SHOULD follow the patterns laid out in the \X'tty: link https://semver.org/'\fI\%Semantic
Versioning\fP <\fBhttps://semver.org/\fP>\X'tty: link' standard.
.sp
Immediately after exchanging Hello messages, the connection MUST be dropped
if the remote device does not pass authentication.
@@ -193,8 +188,7 @@ A \fBMessage\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
0 1
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5
+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+
@@ -211,8 +205,7 @@ A \fBMessage\fP
\e Message \e
/ /
+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
@@ -228,8 +221,7 @@ As always, the length words are in network byte order (big endian).
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
message Header {
MessageType type = 1;
MessageCompression compression = 2;
@@ -250,8 +242,7 @@ enum MessageCompression {
NONE = 0;
LZ4 = 1;
}
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
@@ -274,8 +265,7 @@ initial exchange.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
message ClusterConfig {
repeated Folder folders = 1;
}
@@ -310,8 +300,7 @@ enum Compression {
NEVER = 1;
ALWAYS = 2;
}
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.SS Fields (Cluster Config Message)
@@ -389,7 +378,7 @@ The \fBencryption_password_token\fP field contains a token derived from the pass
used to encrypt data sent to this device. If the device is the same as the
device sending the message, it signifies that the device itself has encrypted
data that was encrypted with the given token. It is empty or missing if there is
no encryption. See \fI\%Untrusted Device Encryption\fP for details on the encryption scheme.
no encryption. See \X'tty: link #untrusted'\fI\%Untrusted Device Encryption\fP\X'tty: link' for details on the encryption scheme.
.SS Index and Index Update
.sp
The Index and Index Update messages define the contents of the senders
@@ -406,8 +395,7 @@ although this is not guaranteed to be the case in the future.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
message Index {
string folder = 1;
repeated FileInfo files = 2;
@@ -460,8 +448,7 @@ message Counter {
uint64 id = 1;
uint64 value = 2;
}
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.SS Fields (Index Message)
@@ -544,8 +531,7 @@ corresponding to a part of a certain file in the peer’s folder.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
message Request {
int32 id = 1;
string folder = 2;
@@ -555,8 +541,7 @@ message Request {
bytes hash = 6;
bool from_temporary = 7;
}
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.SS Fields
@@ -586,8 +571,7 @@ The Response message is sent in response to a Request message.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
message Response {
int32 id = 1;
bytes data = 2;
@@ -600,8 +584,7 @@ enum ErrorCode {
NO_SUCH_FILE = 2;
INVALID_FILE = 3;
}
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.SS Fields
@@ -642,8 +625,7 @@ contain zero or more FileDownloadProgressUpdate messages.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
message DownloadProgress {
string folder = 1;
repeated FileDownloadProgressUpdate updates = 2;
@@ -660,8 +642,7 @@ enum FileDownloadProgressUpdateType {
APPEND = 0;
FORGET = 1;
}
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.SS Fields (DownloadProgress Message)
@@ -721,12 +702,10 @@ other message has been sent in the preceding 90 seconds.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
message Ping {
}
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.SS Close
@@ -738,13 +717,11 @@ further messages.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
message Close {
string reason = 1;
}
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.SS Fields
@@ -759,15 +736,13 @@ directions.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
+\-\-\-\-\-\-\-\-\-\-\-\-+ Updates /\-\-\-\-\-\-\-\-\-\e
| | \-\-\-\-\-\-\-\-\-\-\-> / \e
| Device | | Cluster |
| | <\-\-\-\-\-\-\-\-\-\-\- \e /
+\-\-\-\-\-\-\-\-\-\-\-\-+ Updates \e\-\-\-\-\-\-\-\-\-/
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.SS Send Only
@@ -777,15 +752,13 @@ publishes changes of its local folder to the cluster as usual.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
+\-\-\-\-\-\-\-\-\-\-\-\-+ Updates /\-\-\-\-\-\-\-\-\-\e
| | \-\-\-\-\-\-\-\-\-\-\-> / \e
| Device | | Cluster |
| | \e /
+\-\-\-\-\-\-\-\-\-\-\-\-+ \e\-\-\-\-\-\-\-\-\-/
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.SS Receive Only
@@ -795,15 +768,13 @@ accepts changes to its local folder from the cluster as usual.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
+\-\-\-\-\-\-\-\-\-\-\-\-+ Updates /\-\-\-\-\-\-\-\-\-\e
| | <\-\-\-\-\-\-\-\-\-\-\- / \e
| Device | | Cluster |
| | \e /
+\-\-\-\-\-\-\-\-\-\-\-\-+ \e\-\-\-\-\-\-\-\-\-/
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.SH DELTA INDEX EXCHANGE
@@ -878,9 +849,8 @@ results in fewer than 2000 blocks, or the maximum block size for larger
files. This rule results in the following table of block sizes per file
size:
.TS
center;
|l|l|.
_
box center;
l|l.
T{
File Size
T} T{
@@ -934,7 +904,6 @@ T{
T} T{
16 MiB
T}
_
.TE
.sp
An implementation MAY deviate from the block size rule when there is good
@@ -950,9 +919,8 @@ allowed. The block size used MUST be exactly one of the power\-of\-two block
sizes listed in the table above.
.SH EXAMPLE EXCHANGE
.TS
center;
|l|l|l|.
_
box center;
l|l|l.
T{
#
T} T{
@@ -1074,7 +1042,6 @@ T} T{
Ping\->
T} T{
T}
_
.TE
.sp
The connection is established and at 1. both peers send ClusterConfiguration
@@ -1089,9 +1056,8 @@ the ping timer on device B expires and a Ping message is sent. The same
process occurs for device A at 15.
.SH EXAMPLES OF STRONG CIPHER SUITES
.TS
center;
|l|l|l|.
_
box center;
l|l|l.
T{
ID
T} T{
@@ -1163,7 +1129,6 @@ ECDHE\-RSA\-AES128\-SHA256
T} T{
TLSv1.2 ECDH RSA AES(128) SHA256
T}
_
.TE
.SH AUTHOR
The Syncthing Authors
man/syncthing-config.5
+31 -51
View File
@@ -27,21 +27,19 @@ 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" "Apr 11, 2024" "v1.27.5" "Syncthing"
.TH "SYNCTHING-CONFIG" "5" "May 08, 2024" "v1.27.7" "Syncthing"
.SH NAME
syncthing-config \- Syncthing Configuration
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
$XDG_STATE_HOME/syncthing
$HOME/.local/state/syncthing
$HOME/Library/Application Support/Syncthing
%LOCALAPPDATA%\eSyncthing
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.SH DESCRIPTION
@@ -56,7 +54,7 @@ installations may still use these directories instead of the newer
defaults.
.sp
New in version 1.5.0: Database and config can now be set separately. Previously the database was
Added in version 1.5.0: Database and config can now be set separately. Previously the database was
always located in the same directory as the config.
.sp
@@ -119,8 +117,7 @@ may no longer correspond to the defaults.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
<configuration version=\(dq37\(dq>
<folder id=\(dqdefault\(dq label=\(dqDefault Folder\(dq path=\(dq/Users/jb/Sync/\(dq type=\(dqsendreceive\(dq rescanIntervalS=\(dq3600\(dq fsWatcherEnabled=\(dqtrue\(dq fsWatcherDelayS=\(dq10\(dq ignorePerms=\(dqfalse\(dq autoNormalize=\(dqtrue\(dq>
<filesystemType>basic</filesystemType>
@@ -277,16 +274,14 @@ may no longer correspond to the defaults.
</device>
</defaults>
</configuration>
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.SH CONFIGURATION ELEMENT
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
<configuration version=\(dq37\(dq>
<folder></folder>
<device></device>
@@ -296,8 +291,7 @@ may no longer correspond to the defaults.
<remoteIgnoredDevice></remoteIgnoredDevice>
<defaults></defaults>
</configuration>
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
@@ -322,8 +316,7 @@ GUI.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
<folder id=\(dqdefault\(dq label=\(dqDefault Folder\(dq path=\(dq/Users/jb/Sync/\(dq type=\(dqsendreceive\(dq rescanIntervalS=\(dq3600\(dq fsWatcherEnabled=\(dqtrue\(dq fsWatcherDelayS=\(dq10\(dq ignorePerms=\(dqfalse\(dq autoNormalize=\(dqtrue\(dq>
<filesystemType>basic</filesystemType>
<device id=\(dqS7UKX27\-GI7ZTXS\-GC6RKUA\-7AJGZ44\-C6NAYEB\-HSKTJQK\-KJHU2NO\-CWV7EQW\(dq introducedBy=\(dq\(dq>
@@ -361,8 +354,7 @@ GUI.
<syncXattrs>false</syncXattrs>
<sendXattrs>false</sendXattrs>
</folder>
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
@@ -603,7 +595,7 @@ to \fB\-1\fP to always use weak hash. Default is \fB25\fP\&.
.TP
.B markerName
Name of a directory or file in the folder root to be used as
\fI\%How do I serve a folder from a read only filesystem?\fP\&. Default is \fB\&.stfolder\fP\&.
\X'tty: link #marker-faq'\fI\%How do I serve a folder from a read only filesystem?\fP\X'tty: link'\&. Default is \fB\&.stfolder\fP\&.
.UNINDENT
.INDENT 0.0
.TP
@@ -715,8 +707,7 @@ devices when this is set to \fBtrue\fP\&. See
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
<device id=\(dqS7UKX27\-GI7ZTXS\-GC6RKUA\-7AJGZ44\-C6NAYEB\-HSKTJQK\-KJHU2NO\-CWV7EQW\(dq name=\(dqsyno\(dq compression=\(dqmetadata\(dq introducer=\(dqfalse\(dq skipIntroductionRemovals=\(dqfalse\(dq introducedBy=\(dq2CYF2WQ\-AKZO2QZ\-JAKWLYD\-AGHMQUM\-BGXUOIS\-GYILW34\-HJG3DUK\-LRRYQAR\(dq>
<address>dynamic</address>
<paused>false</paused>
@@ -741,8 +732,7 @@ devices when this is set to \fBtrue\fP\&. See
<remoteGUIPort>8384</remoteGUIPort>
<numConnections>0</numConnections>
</device>
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
@@ -754,7 +744,7 @@ element:
.INDENT 0.0
.TP
.B id (mandatory)
The \fI\%device ID\fP\&.
The \X'tty: link #device-ids'\fI\%device ID\fP\X'tty: link'\&.
.UNINDENT
.INDENT 0.0
.TP
@@ -855,15 +845,13 @@ for example:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
<device id=\(dq...\(dq>
<address>tcp://192.0.2.1:22001</address>
<address>quic://192.0.1.254:22000</address>
<address>dynamic</address>
</device>
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.UNINDENT
@@ -942,15 +930,13 @@ The number of connections to this device. See
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
<gui enabled=\(dqtrue\(dq tls=\(dqfalse\(dq debugging=\(dqfalse\(dq>
<address>127.0.0.1:8384</address>
<apikey>k1dnz1Dd0rzTBjjFFh7CXPnrF12C49B1</apikey>
<theme>default</theme>
</gui>
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
@@ -1060,7 +1046,7 @@ LDAP authentication. Requires ldap top level config section to be present.
.INDENT 0.0
.TP
.B sendBasicAuthPrompt
New in version 1.26.0.
Added in version 1.26.0.
.sp
Prior to version 1.26.0 the GUI used HTTP Basic Authorization for login, but
@@ -1082,16 +1068,14 @@ won’t see browser popups prompting for username and password.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
<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
.EE
.UNINDENT
.UNINDENT
.sp
@@ -1150,8 +1134,7 @@ Search filter for user searches.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
<options>
<listenAddress>default</listenAddress>
<globalAnnounceServer>default</globalAnnounceServer>
@@ -1202,8 +1185,7 @@ Search filter for user searches.
<connectionLimitMax>0</connectionLimitMax>
<insecureAllowOldTLSVersions>false</insecureAllowOldTLSVersions>
</options>
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
@@ -1345,7 +1327,7 @@ automatic upgrades.
.TP
.B upgradeToPreReleases
If \fBtrue\fP, automatic upgrades include release candidates (see
\fI\%Versions & Releases\fP).
\X'tty: link #releases'\fI\%Versions & Releases\fP\X'tty: link').
.UNINDENT
.INDENT 0.0
.TP
@@ -1500,7 +1482,7 @@ addresses to global discovery.
.TP
.B sendFullIndexOnUpgrade
Controls whether all index data is resent when an upgrade has happened,
equivalent to starting Syncthing with \fI\%\-\-reset\-deltas\fP\&. This used
equivalent to starting Syncthing with \X'tty: link #cmdoption-reset-deltas'\fI\%\-\-reset\-deltas\fP\X'tty: link'\&. This used
to be the default behavior in older versions, but is mainly useful as a
troubleshooting step and causes high database churn. The default is now
\fBfalse\fP\&.
@@ -1538,8 +1520,7 @@ detailed in \fI\%insecureAllowOldTLSVersions\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
<defaults>
<folder id=\(dq\(dq label=\(dq\(dq path=\(dq~\(dq type=\(dqsendreceive\(dq rescanIntervalS=\(dq3600\(dq fsWatcherEnabled=\(dqtrue\(dq fsWatcherDelayS=\(dq10\(dq ignorePerms=\(dqfalse\(dq autoNormalize=\(dqtrue\(dq>
<filesystemType>basic</filesystemType>
@@ -1593,8 +1574,7 @@ detailed in \fI\%insecureAllowOldTLSVersions\fP\&.
<line>qu*</line>
</ignores>
</defaults>
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
@@ -1626,10 +1606,10 @@ including the appropriate \fI\%folder.device\fP element underneath.
.INDENT 0.0
.TP
.B ignores
New in version 1.19.0.
Added in version 1.19.0.
.sp
Template for the \fI\%ignore patterns\fP applied to new
Template for the \X'tty: link #ignoring-files'\fI\%ignore patterns\fP\X'tty: link' applied to new
folders. These are copied to the \fB\&.stignore\fP file when a folder is
automatically accepted from a remote device. The GUI uses them to pre\-fill
the respective field when adding a new folder as well. In XML, each pattern
@@ -1701,12 +1681,12 @@ accidentally if you sync your home folder between devices. A common symptom
of syncing configuration files is two devices ending up with the same Device ID.
.sp
If you want to use Syncthing to backup your configuration files, it is recommended
that the files you are backing up are in a \fI\%Send Only Folder\fP to prevent other
that the files you are backing up are in a \X'tty: link #folder-sendonly'\fI\%Send Only Folder\fP\X'tty: link' to prevent other
devices from overwriting the per device configuration. The folder on the remote
device(s) should not be used as configuration for the remote devices.
.sp
If you’d like to sync your home folder in non\-send only mode, you may add the
folder that stores the configuration files to the \fI\%ignore list\fP\&.
folder that stores the configuration files to the \X'tty: link #ignoring-files'\fI\%ignore list\fP\X'tty: link'\&.
If you’d also like to backup your configuration files, add another folder in
send only mode for just the configuration folder.
.SH AUTHOR
man/syncthing-device-ids.7
+11 -17
View File
@@ -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" "Apr 11, 2024" "v1.27.5" "Syncthing"
.TH "SYNCTHING-DEVICE-IDS" "7" "May 08, 2024" "v1.27.7" "Syncthing"
.SH NAME
syncthing-device-ids \- Understanding Device IDs
.sp
@@ -52,8 +52,7 @@ The typical certificate will look something like this, inspected with
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
Certificate:
Data:
Version: 3 (0x2)
@@ -87,8 +86,7 @@ Certificate:
...
88:7e:e2:61:aa:4c:02:e3:64:b0:da:70:3a:cd:1c:3d:86:db:
df:54:b9:4e:be:1b
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
@@ -113,27 +111,23 @@ bits) so the resulting ID looks something like:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
MFZWI3DBONSGYYLTMRWGC43ENRQXGZDMMFZWI3DBONSGYYLTMRWA====
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
The padding (\fB====\fP) is stripped away, the device ID split into four
groups, and \fI\%check
digits\fP <\fBhttps://forum.syncthing.net/t/v0-9-0-new-node-id-format/478\fP>
groups, and \X'tty: link https://forum.syncthing.net/t/v0-9-0-new-node-id-format/478'\fI\%check
digits\fP <\fBhttps://forum.syncthing.net/t/v0-9-0-new-node-id-format/478\fP>\X'tty: link'
are added for each group. For presentation purposes the device ID is
grouped with dashes, resulting in the final value:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
MFZWI3D\-BONSGYC\-YLTMRWG\-C43ENR5\-QXGZDMM\-FZWI3DP\-BONSGYY\-LTMRWAD
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.SS Connection Establishment
@@ -192,8 +186,8 @@ You can argue that of course there are collisions \- there’s an infinite
amount of inputs and a finite amount of outputs \- so by definition there
are infinitely many messages that result in the same hash.
.sp
I’m going to quote \fI\%stack
overflow\fP <\fBhttps://stackoverflow.com/questions/4014090/is-it-safe-to-ignore-the-possibility-of-sha-collisions-in-practice\fP>
I’m going to quote \X'tty: link https://stackoverflow.com/questions/4014090/is-it-safe-to-ignore-the-possibility-of-sha-collisions-in-practice'\fI\%stack
overflow\fP <\fBhttps://stackoverflow.com/questions/4014090/is-it-safe-to-ignore-the-possibility-of-sha-collisions-in-practice\fP>\X'tty: link'
here:
.INDENT 0.0
.INDENT 3.5
man/syncthing-event-api.7
+79 -147
View File
@@ -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" "Apr 11, 2024" "v1.27.5" "Syncthing"
.TH "SYNCTHING-EVENT-API" "7" "May 08, 2024" "v1.27.7" "Syncthing"
.SH NAME
syncthing-event-api \- Event API
.SH DESCRIPTION
@@ -40,8 +40,7 @@ Each event is represented by an object similar to the following:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
{
\(dqid\(dq: 2,
\(dqglobalID\(dq: 3,
@@ -52,8 +51,7 @@ Each event is represented by an object similar to the following:
\(dqid\(dq: \(dqNFGKEKE\-7Z6RTH7\-I3PRZXS\-DEJF3UJ\-FRWJBFO\-VBBTDND\-4SGNGVZ\-QUQHJAG\(dq
}
}
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
@@ -85,7 +83,7 @@ determined by the event type.
.SH EVENT TYPES
.SS ClusterConfigReceived
.sp
New in version 1.20.0.
Added in version 1.20.0.
.sp
The \fBClusterConfigReceived\fP event is emitted after processing such a protocol
@@ -93,8 +91,7 @@ message received from a remote device. It is mainly used for internal purposes.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
{
\(dqid\(dq: 84,
\(dqglobalID\(dq: 84,
@@ -104,8 +101,7 @@ message received from a remote device. It is mainly used for internal purposes.
\(dqdevice\(dq: \(dqI6KAH76\-66SLLLB\-5PFXSOA\-UFJCDZC\-YAOMLEK\-CP2GB32\-BV5RQST\-3PSROAU\(dq
}
}
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.SS ConfigSaved
@@ -115,8 +111,7 @@ itself.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
{
\(dqid\(dq: 50,
\(dqglobalID\(dq: 50,
@@ -133,8 +128,7 @@ itself.
\(dqdefaults\(dq: {\(dq...\(dq}
}
}
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.SS DeviceConnected
@@ -143,8 +137,7 @@ Generated each time a connection to a device has been established.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
{
\(dqid\(dq: 2,
\(dqglobalID\(dq: 2,
@@ -159,8 +152,7 @@ Generated each time a connection to a device has been established.
\(dqtype\(dq: \(dqTCP (Client)\(dq
}
}
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.SS DeviceDisconnected
@@ -169,8 +161,7 @@ Generated each time a connection to a device has been terminated.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
{
\(dqid\(dq: 48,
\(dqglobalID\(dq: 48,
@@ -181,8 +172,7 @@ Generated each time a connection to a device has been terminated.
\(dqid\(dq: \(dqNFGKEKE\-7Z6RTH7\-I3PRZXS\-DEJF3UJ\-FRWJBFO\-VBBTDND\-4SGNGVZ\-QUQHJAG\(dq
}
}
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
@@ -201,8 +191,7 @@ Emitted when a new device is discovered using local discovery.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
{
\(dqid\(dq: 13,
\(dqglobalID\(dq: 13,
@@ -215,8 +204,7 @@ Emitted when a new device is discovered using local discovery.
\(dqdevice\(dq: \(dqNFGKEKE\-7Z6RTH7\-I3PRZXS\-DEJF3UJ\-FRWJBFO\-VBBTDND\-4SGNGVZ\-QUQHJAG\(dq
}
}
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.SS DevicePaused
@@ -225,8 +213,7 @@ Emitted when a device was paused.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
{
\(dqid\(dq: 13,
\(dqglobalID\(dq: 13,
@@ -236,8 +223,7 @@ Emitted when a device was paused.
\(dqdevice\(dq: \(dqNFGKEKE\-7Z6RTH7\-I3PRZXS\-DEJF3UJ\-FRWJBFO\-VBBTDND\-4SGNGVZ\-QUQHJAG\(dq
}
}
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.SS DeviceRejected (DEPRECATED)
@@ -251,8 +237,7 @@ to talk to.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
{
\(dqid\(dq: 24,
\(dqglobalID\(dq: 24,
@@ -264,8 +249,7 @@ to talk to.
\(dqdevice\(dq: \(dqEJHMPAQ\-OGCVORE\-ISB4IS3\-SYYVJXF\-TKJGLTU\-66DIQPF\-GJ5D2GX\-GQ3OWQK\(dq
}
}
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.SS DeviceResumed
@@ -274,8 +258,7 @@ Generated each time a device was resumed.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
{
\(dqid\(dq: 2,
\(dqglobalID\(dq: 2,
@@ -285,8 +268,7 @@ Generated each time a device was resumed.
\(dqdevice\(dq: \(dqNFGKEKE\-7Z6RTH7\-I3PRZXS\-DEJF3UJ\-FRWJBFO\-VBBTDND\-4SGNGVZ\-QUQHJAG\(dq
}
}
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.SS DownloadProgress
@@ -297,8 +279,7 @@ configuration can cause multiple files to be shown.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
{
\(dqid\(dq: 221,
\(dqglobalID\(dq: 221,
@@ -351,8 +332,7 @@ configuration can cause multiple files to be shown.
}
}
}
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.INDENT 0.0
@@ -393,8 +373,7 @@ The \fBdata\fP field contains a textual error message.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
{
\(dqid\(dq: 93,
\(dqglobalID\(dq: 93,
@@ -402,8 +381,7 @@ The \fBdata\fP field contains a textual error message.
\(dqtime\(dq: \(dq2021\-06\-07T21:22:03.414609034+02:00\(dq,
\(dqdata\(dq: \(dqindex handler got paused while already paused\(dq
}
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.SS FolderCompletion
@@ -413,7 +391,7 @@ contents for a folder changes. It contains the completion percentage for
a given remote device and is emitted once per currently connected remote
device.
.sp
New in version 1.20.0: Indication whether the remote device has accepted the folder (shares it with
Added in version 1.20.0: Indication whether the remote device has accepted the folder (shares it with
us) as well, and whether it is paused. The \fBremoteState\fP field is
\fBunknown\fP when the remote device is not connected. Otherwise it can be
either \fBpaused\fP, \fBnotSharing\fP, or \fBvalid\fP if the remote is sharing back.
@@ -421,8 +399,7 @@ either \fBpaused\fP, \fBnotSharing\fP, or \fBvalid\fP if the remote is sharing b
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
{
\(dqid\(dq: 84,
\(dqglobalID\(dq: 84,
@@ -441,8 +418,7 @@ either \fBpaused\fP, \fBnotSharing\fP, or \fBvalid\fP if the remote is sharing b
\(dqsequence\(dq: 12
}
}
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.SS FolderErrors
@@ -455,8 +431,7 @@ synchronization attempt, a new \fBFolderErrors\fP event is emitted.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
{
\(dqid\(dq: 132,
\(dqtype\(dq: \(dqFolderErrors\(dq,
@@ -471,18 +446,17 @@ synchronization attempt, a new \fBFolderErrors\fP event is emitted.
\(dqfolder\(dq: \(dqdefault\(dq
}
}
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
New in version 0.11.12.
Added in version 0.11.12.
.sp
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
The \fI\%StateChanged\fP event.
The \X'tty: link #statechanged'\fI\%StateChanged\fP\X'tty: link' event.
.UNINDENT
.UNINDENT
.SS FolderPaused
@@ -492,8 +466,7 @@ of a folder. Sent repeatedly for each changed folder.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
{
\(dqid\(dq: 93,
\(dqglobalID\(dq: 93,
@@ -504,8 +477,7 @@ of a folder. Sent repeatedly for each changed folder.
\(dqlabel\(dq: \(dqMy folder\(dq
}
}
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.SS FolderRejected (DEPRECATED)
@@ -519,8 +491,7 @@ have, or have but do not share with the device in question.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
{
\(dqid\(dq: 27,
\(dqglobalID\(dq: 27,
@@ -532,8 +503,7 @@ have, or have but do not share with the device in question.
\(dqfolderLabel\(dq: \(dqMy Pictures\(dq
}
}
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.SS FolderResumed
@@ -543,8 +513,7 @@ of a folder. Sent repeatedly for each changed folder.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
{
\(dqid\(dq: 93,
\(dqglobalID\(dq: 93,
@@ -555,8 +524,7 @@ of a folder. Sent repeatedly for each changed folder.
\(dqlabel\(dq: \(dqMy folder\(dq
}
}
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.SS FolderScanProgress
@@ -567,8 +535,7 @@ total , as well as the current scanning rates in bytes per second.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
{
\(dqdata\(dq : {
\(dqtotal\(dq : 1,
@@ -581,8 +548,7 @@ total , as well as the current scanning rates in bytes per second.
\(dqtime\(dq : \(dq2017\-03\-06T15:00:58.072004209+01:00\(dq,
\(dqid\(dq : 29
}
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.SS FolderSummary
@@ -593,8 +559,7 @@ state.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
{
\(dqid\(dq: 16,
\(dqtype\(dq: \(dqFolderSummary\(dq,
@@ -644,8 +609,7 @@ state.
}
}
}
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.SS FolderWatchStateChanged
@@ -658,8 +622,7 @@ If there was no error in either of these, the respective field is omitted.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
{
\(dqid\(dq: 123,
\(dqtype\(dq: \(dqFolderWatchStateChanged\(dq,
@@ -670,8 +633,7 @@ If there was no error in either of these, the respective field is omitted.
\(dqto\(dq: \(dqSomething worse happened.\(dq
}
}
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.SS ItemFinished
@@ -681,8 +643,7 @@ successful operation:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
{
\(dqid\(dq: 93,
\(dqglobalID\(dq: 93,
@@ -696,8 +657,7 @@ successful operation:
\(dqaction\(dq: \(dqupdate\(dq
}
}
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
@@ -705,8 +665,7 @@ An unsuccessful operation:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
{
\(dqid\(dq: 44,
\(dqglobalID\(dq: 44,
@@ -720,14 +679,13 @@ An unsuccessful operation:
\(dqtype\(dq: \(dqfile\(dq
}
}
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
The \fBaction\fP field is either \fBupdate\fP (contents changed), \fBmetadata\fP (file metadata changed but not contents), or \fBdelete\fP\&.
.sp
New in version 0.11.10: The \fBmetadata\fP action.
Added in version 0.11.10: The \fBmetadata\fP action.
.SS ItemStarted
.sp
@@ -735,8 +693,7 @@ Generated when Syncthing begins synchronizing a file to a newer version.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
{
\(dqid\(dq: 93,
\(dqglobalID\(dq: 93,
@@ -749,23 +706,21 @@ Generated when Syncthing begins synchronizing a file to a newer version.
\(dqaction\(dq: \(dqupdate\(dq
}
}
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
The \fBaction\fP field is either \fBupdate\fP (contents changed), \fBmetadata\fP (file metadata changed but not contents), or \fBdelete\fP\&.
.sp
New in version 0.11.10: The \fBmetadata\fP action.
Added in version 0.11.10: The \fBmetadata\fP action.
.SS ListenAddressesChanged
.sp
This event is emitted when a \fI\%listen address\fP changes.
This event is emitted when a \X'tty: link #listen-addresses'\fI\%listen address\fP\X'tty: link' changes.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
{
\(dqtype\(dq : \(dqListenAddressesChanged\(dq,
\(dqid\(dq : 70,
@@ -811,8 +766,7 @@ This event is emitted when a \fI\%listen address\fP changes.
]
}
}
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.SS LocalChangeDetected
@@ -832,8 +786,7 @@ a mask specified, but needs to be selected explicitly.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
{
\(dqid\(dq: 7,
\(dqglobalID\(dq: 59,
@@ -848,8 +801,7 @@ a mask specified, but needs to be selected explicitly.
\(dqtype\(dq: \(dqfile\(dq
}
}
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
@@ -864,8 +816,7 @@ changes during a scan.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
{
\(dqid\(dq: 59,
\(dqglobalID\(dq: 59,
@@ -883,8 +834,7 @@ changes during a scan.
\(dqversion\(dq: 12345
}
}
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
@@ -901,8 +851,7 @@ origin of the request, but e.g. a reverse proxy.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
{
\(dqid\(dq : 187,
\(dqtime\(dq : \(dq2017\-03\-07T00:19:24.420386143+01:00\(dq,
@@ -914,13 +863,12 @@ origin of the request, but e.g. a reverse proxy.
\(dqtype\(dq : \(dqLoginAttempt\(dq,
\(dqglobalID\(dq : 195
}
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.SS PendingDevicesChanged
.sp
New in version 1.14.0.
Added in version 1.14.0.
.sp
Emitted when pending devices were added / updated (connection from
@@ -928,8 +876,7 @@ unknown ID) or removed (device is ignored, dismissed or added).
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
{
\(dqid\(dq: 87,
\(dqtype\(dq: \(dqPendingDevicesChanged\(dq,
@@ -949,13 +896,12 @@ unknown ID) or removed (device is ignored, dismissed or added).
]
}
}
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.SS PendingFoldersChanged
.sp
New in version 1.14.0.
Added in version 1.14.0.
.sp
Emitted when pending folders were added / updated (offered by some
@@ -966,8 +912,7 @@ longer pending for any device.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
{
\(dqid\(dq: 101,
\(dqtype\(dq: \(dqPendingFoldersChanged\(dq,
@@ -993,8 +938,7 @@ longer pending for any device.
]
}
}
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.SS RemoteChangeDetected
@@ -1012,8 +956,7 @@ a mask specified, but needs to be selected explicitly.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
{
\(dqtime\(dq : \(dq2017\-03\-06T23:58:21.844739891+01:00\(dq,
\(dqglobalID\(dq : 123,
@@ -1029,8 +972,7 @@ a mask specified, but needs to be selected explicitly.
\(dqtype\(dq : \(dqRemoteChangeDetected\(dq,
\(dqid\(dq : 2
}
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
@@ -1039,15 +981,14 @@ Deprecated since version v1.1.2: The \fBfolderID\fP field is a legacy name kept
.SS RemoteDownloadProgress
.sp
This event is emitted when a \fI\%DownloadProgress\fP message is
This event is emitted when a \X'tty: link #download-progress'\fI\%DownloadProgress\fP\X'tty: link' message is
received. It returns a map \fBdata\fP of filenames with a count of
downloaded blocks. The files in questions are currently being
downloaded on the remote \fBdevice\fP and belong to \fBfolder\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
{
\(dqtime\(dq : \(dq2017\-03\-07T00:11:37.65838955+01:00\(dq,
\(dqglobalID\(dq : 170,
@@ -1061,8 +1002,7 @@ downloaded on the remote \fBdevice\fP and belong to \fBfolder\fP\&.
\(dqtype\(dq : \(dqRemoteDownloadProgress\(dq,
\(dqid\(dq : 163
}
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.SS RemoteIndexUpdated
@@ -1071,8 +1011,7 @@ Generated each time new index information is received from a device.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
{
\(dqid\(dq: 44,
\(dqglobalID\(dq: 44,
@@ -1084,8 +1023,7 @@ Generated each time new index information is received from a device.
\(dqitems\(dq: 1000
}
}
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.SS Starting
@@ -1095,8 +1033,7 @@ configuration etc.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
{
\(dqid\(dq: 1,
\(dqglobalID\(dq: 1,
@@ -1106,8 +1043,7 @@ configuration etc.
\(dqhome\(dq: \(dq/home/jb/.config/syncthing\(dq
}
}
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.SS StartupComplete
@@ -1117,8 +1053,7 @@ ready to start exchanging data with other devices.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
{
\(dqid\(dq: 1,
\(dqglobalID\(dq: 1,
@@ -1126,8 +1061,7 @@ ready to start exchanging data with other devices.
\(dqtime\(dq: \(dq2014\-07\-13T21:03:18.383239179+02:00\(dq,
\(dqdata\(dq: null
}
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.SS StateChanged
@@ -1140,8 +1074,7 @@ seconds and is now in state \fBidle\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
{
\(dqid\(dq: 8,
\(dqglobalID\(dq: 8,
@@ -1154,8 +1087,7 @@ seconds and is now in state \fBidle\fP\&.
\(dqto\(dq: \(dqidle\(dq
}
}
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.SH AUTHOR
man/syncthing-faq.7
+44 -60
View File
@@ -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" "Apr 11, 2024" "v1.27.5" "Syncthing"
.TH "SYNCTHING-FAQ" "7" "May 08, 2024" "v1.27.7" "Syncthing"
.SH NAME
syncthing-faq \- Frequently Asked Questions
.INDENT 0.0
@@ -164,7 +164,7 @@ Directory modification times (not preserved)
Hard links (followed, not preserved)
.IP \(bu 2
Windows junctions (synced as ordinary directories; require enabling in
\fI\%the configuration\fP on a per\-folder
\X'tty: link #config-option-folder.junctionsasdirs'\fI\%the configuration\fP\X'tty: link' on a per\-folder
basis)
.IP \(bu 2
Resource forks (not preserved)
@@ -176,7 +176,7 @@ Devices, FIFOs, and other specials (ignored)
Sparse file sparseness (will become sparse, when supported by the OS & filesystem)
.IP \(bu 2
Syncthing internal files and folders (e.g. \fB\&.stfolder\fP, \fB\&.stignore\fP,
\fB\&.stversions\fP, \fI\%temporary files\fP, etc.)
\fB\&.stversions\fP, \X'tty: link #temporary-files'\fI\%temporary files\fP\X'tty: link', etc.)
.UNINDENT
.SS Is synchronization fast?
.sp
@@ -191,7 +191,7 @@ 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
\fI\%Temporary files\fP are used to store partial data
\X'tty: link #temporary-files'\fI\%Temporary files\fP\X'tty: link' are used to store partial data
downloaded from other devices. They are automatically removed whenever a file
transfer has been completed or after the configured amount of time which is set
in the configuration file (24 hours by default).
@@ -209,7 +209,7 @@ Syncthing uses an open and documented protocol, and likewise the security
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
\X'tty: link https://en.wikipedia.org/wiki/Resilio_Sync'\fI\%https://en.wikipedia.org/wiki/Resilio_Sync\fP\X'tty: link'
.SS Is there an iOS client?
.sp
There are no plans by the current Syncthing team to officially support iOS in the foreseeable future.
@@ -219,7 +219,7 @@ 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
\X'tty: link https://www.mobiussync.com'\fI\%https://www.mobiussync.com\fP\X'tty: link'
.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
@@ -236,7 +236,7 @@ oyster!)
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
\fI\%Understanding Device IDs\fP
\X'tty: link #device-ids'\fI\%Understanding Device IDs\fP\X'tty: link'
.UNINDENT
.UNINDENT
.SH TROUBLESHOOTING
@@ -262,7 +262,7 @@ Devices” list on the right side of the GUI, double check that you see
.sp
If you are connected via a relay, this is because a direct connection could
not be established. Double check and follow the suggestions in
\fI\%Firewall Setup\fP to enable direct connections.
\X'tty: link #firewall-setup'\fI\%Firewall Setup\fP\X'tty: link' to enable direct connections.
.sp
Second, if one of the devices is a very low powered machine (a Raspberry Pi,
or a phone, or a NAS, or similar) you are likely constrained by the CPU on
@@ -295,8 +295,8 @@ causes a certain amount of extra CPU usage to calculate the summary data it
presents. Note however that once things are \fIin sync\fP CPU usage should be
negligible.
.sp
To minimize the impact of this, Syncthing attempts to \fI\%lower the
process priority\fP when starting up.
To minimize the impact of this, Syncthing attempts to \X'tty: link #config-option-options.setlowpriority'\fI\%lower the
process priority\fP\X'tty: link' when starting up.
.sp
To further limit the amount of CPU used when syncing and scanning, set the
environment variable \fBGOMAXPROCS\fP to the maximum number of CPU cores
@@ -315,7 +315,7 @@ This is an area that we are working to improve in the long term.
.sp
Since version 0.14.6 Syncthing does an extra security check when the GUI/API
is bound to localhost \- namely that the browser is talking to localhost.
This protects against most forms of \fI\%DNS rebinding attack\fP <\fBhttps://en.wikipedia.org/wiki/DNS_rebinding\fP> against the GUI.
This protects against most forms of \X'tty: link https://en.wikipedia.org/wiki/DNS_rebinding'\fI\%DNS rebinding attack\fP <\fBhttps://en.wikipedia.org/wiki/DNS_rebinding\fP>\X'tty: link' against the GUI.
.sp
To pass this test, ensure that you are accessing the GUI using an URL that
begins with \fBhttp://localhost\fP, \fBhttp://127.0.0.1\fP or \fBhttp://[::1]\fP\&. HTTPS
@@ -328,7 +328,7 @@ protect against unauthorized access. Either:
.IP \(bu 2
Make sure the proxy sets a \fBHost\fP header containing \fBlocalhost\fP, or
.IP \(bu 2
Set \fI\%gui.insecureSkipHostcheck\fP in the advanced settings, or
Set \X'tty: link #config-option-gui.insecureskiphostcheck'\fI\%gui.insecureSkipHostcheck\fP\X'tty: link' in the advanced settings, or
.IP \(bu 2
Bind the GUI/API to a non\-localhost listen port.
.UNINDENT
@@ -338,8 +338,8 @@ In all cases, username/password authentication and HTTPS should be used.
.sp
This is almost always a result of bad RAM, storage device or other hardware.
When the index database is found to be corrupt Syncthing cannot operate and will
note this in the logs and exit. To overcome this delete the \fI\%database
folder\fP inside Syncthing’s data directory and re\-start
note this in the logs and exit. To overcome this delete the \X'tty: link #config-locations'\fI\%database
folder\fP\X'tty: link' inside Syncthing’s data directory and re\-start
Syncthing. It will then need to perform a full re\-hashing of all shared
folders. You should check your system in case the underlying cause is indeed
faulty hardware which may put the system at risk of further data loss.
@@ -374,10 +374,10 @@ up\-to\-date state with all the neighbours.
.SS Why does Syncthing connect to this unknown/suspicious address?
.sp
If you see outgoing connections to odd and unexpected addresses these are
most likely connections to \fI\%relay servers\fP\&. Relay servers
most likely connections to \X'tty: link #relaying'\fI\%relay servers\fP\X'tty: link'\&. Relay servers
are run by volunteers all over the world. They usually listen on ports 443 or
22067, though this is controlled by the user running it. You can compare the
address you are concerned about with \fI\%the current list of active relays\fP <\fBhttps://relays.syncthing.net\fP>\&. Relays do not and can not see the data
address you are concerned about with \X'tty: link https://relays.syncthing.net'\fI\%the current list of active relays\fP <\fBhttps://relays.syncthing.net\fP>\X'tty: link'\&. Relays do not and can not see the data
transmitted via them.
.SS I am seeing the error message “folder marker missing”. What do I do?
.sp
@@ -420,7 +420,7 @@ Also see the \fI\%marker FAQ\fP for more information about the folder marker.
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
\fI\%Conflicting Changes\fP
\X'tty: link #conflict-handling'\fI\%Conflicting Changes\fP\X'tty: link'
.UNINDENT
.UNINDENT
.SS How do I serve a folder from a read only filesystem?
@@ -468,8 +468,8 @@ to configure listening ports such that they do not overlap (see \fI\%Syncthing C
.sp
No. Syncthing is not designed to sync locally and the overhead involved in
doing so using Syncthing’s method would be wasteful. There are better
programs to achieve this such as \fI\%rsync\fP <\fBhttps://rsync.samba.org/\fP> or
\fI\%Unison\fP <\fBhttps://www.cis.upenn.edu/~bcpierce/unison\fP>\&.
programs to achieve this such as \X'tty: link https://rsync.samba.org/'\fI\%rsync\fP <\fBhttps://rsync.samba.org/\fP>\X'tty: link' or
\X'tty: link https://www.cis.upenn.edu/~bcpierce/unison'\fI\%Unison\fP <\fBhttps://www.cis.upenn.edu/~bcpierce/unison\fP>\X'tty: link'\&.
.SS When I do have two distinct Syncthing\-managed folders on two hosts, how does Syncthing handle moving files between them?
.sp
Syncthing does not specially handle this case, and most files will most likely get
@@ -526,12 +526,10 @@ computer, change the \fBGUI listen address\fP option in the web GUI from
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
<gui enabled=\(dqtrue\(dq tls=\(dqfalse\(dq>
<address>127.0.0.1:8384</address>
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
@@ -539,12 +537,10 @@ to
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
<gui enabled=\(dqtrue\(dq tls=\(dqtrue\(dq>
<address>0.0.0.0:8384</address>
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
@@ -557,33 +553,29 @@ GUI settings at default and use an SSH port forward to access it. For example,
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
$ ssh \-L 9090:127.0.0.1:8384 user@othercomputer.example.com
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
will log you into \fBothercomputer.example.com\fP, and present the \fIremote\fP
Syncthing GUI on \fI\%http://localhost:9090\fP on your \fIlocal\fP computer.
Syncthing GUI on \X'tty: link http://localhost:9090'\fI\%http://localhost:9090\fP\X'tty: link' on your \fIlocal\fP computer.
.sp
If you only want to access the remote GUI and don’t want the terminal session,
use this example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
$ ssh \-N \-L 9090:127.0.0.1:8384 user@othercomputer.example.com
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
If only your remote computer is Unix\-like, you can still access it with SSH from
Windows. Under Windows 10 or later you can use the same \fBssh\fP command if you
\fI\%install the OpenSSH Client\fP <\fBhttps://learn.microsoft.com/windows-server/administration/openssh/openssh_install_firstuse\fP>\&.
\X'tty: link https://learn.microsoft.com/windows-server/administration/openssh/openssh_install_firstuse'\fI\%install the OpenSSH Client\fP <\fBhttps://learn.microsoft.com/windows-server/administration/openssh/openssh_install_firstuse\fP>\X'tty: link'\&.
.SS I don’t like the GUI or the theme. Can it be changed?
.sp
You can change the theme in the settings. Syncthing ships with other themes
@@ -601,7 +593,7 @@ To add e.g. a red theme, you can create the file \fBred/assets/css/theme.css\fP
inside the GUI override directory to override the default CSS styles.
.sp
To create a whole new GUI, you should checkout the files at
\fI\%https://github.com/syncthing/syncthing/tree/main/gui/default\fP
\X'tty: link https://github.com/syncthing/syncthing/tree/main/gui/default'\fI\%https://github.com/syncthing/syncthing/tree/main/gui/default\fP\X'tty: link'
to get an idea how to do that.
.SS How do I upgrade Syncthing?
.sp
@@ -626,13 +618,13 @@ so should Syncthing.
.SS Where do I find the latest release?
.sp
We release new versions through GitHub. The latest release is always found
\fI\%on the release page\fP <\fBhttps://github.com/syncthing/syncthing/releases/latest\fP>\&. Unfortunately
\X'tty: link https://github.com/syncthing/syncthing/releases/latest'\fI\%on the release page\fP <\fBhttps://github.com/syncthing/syncthing/releases/latest\fP>\X'tty: link'\&. Unfortunately
GitHub does not provide a single URL to automatically download the latest
version. We suggest to use the \fI\%GitHub API\fP <\fBhttps://api.github.com/repos/syncthing/syncthing/releases/latest\fP> and parsing
version. We suggest to use the \X'tty: link https://api.github.com/repos/syncthing/syncthing/releases/latest'\fI\%GitHub API\fP <\fBhttps://api.github.com/repos/syncthing/syncthing/releases/latest\fP>\X'tty: link' and parsing
the JSON response.
.SS How do I run Syncthing as a daemon process on Linux?
.sp
If you’re using systemd, runit, or upstart, we ship \fI\%example configurations\fP <\fBhttps://github.com/syncthing/syncthing/tree/main/etc\fP>\&.
If you’re using systemd, runit, or upstart, we ship \X'tty: link https://github.com/syncthing/syncthing/tree/main/etc'\fI\%example configurations\fP <\fBhttps://github.com/syncthing/syncthing/tree/main/etc\fP>\X'tty: link'\&.
.sp
If however you’re not using one of these tools, you have a couple of options.
If your system has a tool called \fBstart\-stop\-daemon\fP installed (that’s the name
@@ -650,7 +642,7 @@ the filesystem watcher on linux:
.INDENT 0.0
.INDENT 3.5
Failed to start filesystem watcher for folder yourLabel (yourID): failed to
setup inotify handler. Please increase inotify limits, see \fI\%https://docs.syncthing.net/users/faq.html#inotify\-limits\fP
setup inotify handler. Please increase inotify limits, see \X'tty: link https://docs.syncthing.net/users/faq.html#inotify-limits'\fI\%https://docs.syncthing.net/users/faq.html#inotify\-limits\fP\X'tty: link'
.UNINDENT
.UNINDENT
.sp
@@ -661,11 +653,9 @@ On many Linux distributions you can run the following to fix it:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
echo \(dqfs.inotify.max_user_watches=204800\(dq | sudo tee \-a /etc/sysctl.conf
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
@@ -674,11 +664,9 @@ separate file, i.e. you should run:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
echo \(dqfs.inotify.max_user_watches=204800\(dq | sudo tee \-a /etc/sysctl.d/90\-override.conf
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
@@ -686,17 +674,15 @@ This only takes effect after a reboot. To adjust the limit immediately, run:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
echo 204800 | sudo tee /proc/sys/fs/inotify/max_user_watches
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.SS How do I reset the GUI password?
.sp
If you’ve forgotten / lost the GUI password, you can reset it using the
\fI\%\-\-gui\-password\fP (and possibly \fI\%\-\-gui\-user\fP) options to the
\X'tty: link #cmdoption-gui-password'\fI\%\-\-gui\-password\fP\X'tty: link' (and possibly \X'tty: link #cmdoption-gui-user'\fI\%\-\-gui\-user\fP\X'tty: link') options to the
\fBsyncthing generate\fP subcommand. This should be done while Syncthing is not
running.
.INDENT 0.0
@@ -708,7 +694,7 @@ Stop Syncthing: \fBsyncthing cli operations shutdown\fP
Restart Syncthing as usual.
.UNINDENT
.sp
\fIAlternatively, in step 2\fP, you can manually delete the \fI\%<user>\fP and \fI\%<password>\fP XML tags from the
\fIAlternatively, in step 2\fP, you can manually delete the \X'tty: link #config-option-gui.user'\fI\%<user>\fP\X'tty: link' and \X'tty: link #config-option-gui.password'\fI\%<password>\fP\X'tty: link' XML tags from the
\fB<gui>\fP block in file \fBconfig.xml\fP\&. The location of the file depends on the
OS and is described in the \fI\%configuration documentation\fP\&.
.sp
@@ -716,8 +702,7 @@ For example, the two emphasized lines below would be removed from the file.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
<gui enabled=\(dqtrue\(dq tls=\(dqfalse\(dq debugging=\(dqfalse\(dq>
<address>127.0.0.1:8384</address>
<user>syncguy</user>
@@ -725,8 +710,7 @@ For example, the two emphasized lines below would be removed from the file.
<apikey>9RCKohqCAyrj5RjpyZdR2wXmQ9PyQFeN</apikey>
<theme>default</theme>
</gui>
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.SH AUTHOR
man/syncthing-globaldisco.7
+3 -5
View File
@@ -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" "Apr 11, 2024" "v1.27.5" "Syncthing"
.TH "SYNCTHING-GLOBALDISCO" "7" "May 08, 2024" "v1.27.7" "Syncthing"
.SH NAME
syncthing-globaldisco \- Global Discovery Protocol v3
.SH ANNOUNCEMENTS
@@ -39,13 +39,11 @@ listing connection addresses (if any):
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
{
addresses: [\(dqtcp://192.0.2.45:22000\(dq, \(dqtcp://:22202\(dq, \(dqrelay://192.0.2.99:22028\(dq],
}
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
man/syncthing-localdisco.7
+6 -10
View File
@@ -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" "Apr 11, 2024" "v1.27.5" "Syncthing"
.TH "SYNCTHING-LOCALDISCO" "7" "May 08, 2024" "v1.27.7" "Syncthing"
.SH NAME
syncthing-localdisco \- Local Discovery Protocol v4
.SH MODE OF OPERATION
@@ -55,15 +55,14 @@ previously unknown device is discovered or a device has restarted (see the
.SH DEVICE ID
.sp
The device ID is the SHA\-256 (32 bytes) of the device X.509 certificate. See
\fI\%Understanding Device IDs\fP in the Syncthing documentation.
\X'tty: link #device-ids'\fI\%Understanding Device IDs\fP\X'tty: link' in the Syncthing documentation.
.SH ANNOUNCEMENT PACKET
.sp
The Announcement packet has the following structure:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
0 1 2 3
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+
@@ -73,8 +72,7 @@ The Announcement packet has the following structure:
\e Announce Message \e
/ /
+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
@@ -90,15 +88,13 @@ following schema:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
message Announce {
bytes id = 1;
repeated string addresses = 2;
int64 instance_id = 3;
}
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
man/syncthing-networking.7
+18 -30
View File
@@ -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" "Apr 11, 2024" "v1.27.5" "Syncthing"
.TH "SYNCTHING-NETWORKING" "7" "May 08, 2024" "v1.27.7" "Syncthing"
.SH NAME
syncthing-networking \- Firewall Setup
.SH ROUTER SETUP
@@ -40,11 +40,9 @@ message in the console saying:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
Created UPnP port mapping for external port XXXXX on UPnP device YYYYY.
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
@@ -57,7 +55,7 @@ Communication in Syncthing works both ways. Therefore if you set up port
forwards for one device, other devices will be able to connect to it even when
they are behind a NAT network or firewall.
.sp
In the absence of port forwarding, \fI\%Relaying\fP may work well enough to get
In the absence of port forwarding, \X'tty: link #relaying'\fI\%Relaying\fP\X'tty: link' may work well enough to get
devices connected and synced, but will perform poorly in comparison to a
direct connection.
.SS Local Discovery
@@ -87,15 +85,13 @@ If you configured a custom port in the \fISync Protocol Listen Address\fP settin
you have to adapt the firewall rules accordingly.
.SS Uncomplicated Firewall (ufw)
.sp
If you’re using \fBufw\fP on Linux and have installed the \fI\%Syncthing package\fP <\fBhttps://apt.syncthing.net/\fP>, you can allow the necessary ports by running:
If you’re using \fBufw\fP on Linux and have installed the \X'tty: link https://apt.syncthing.net/'\fI\%Syncthing package\fP <\fBhttps://apt.syncthing.net/\fP>\X'tty: link', you can allow the necessary ports by running:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
sudo ufw allow syncthing
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
@@ -103,11 +99,9 @@ If you also want to allow external access to the Syncthing web GUI, run:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
sudo ufw allow syncthing\-gui
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
@@ -117,29 +111,25 @@ You can then verify that the ports mentioned above are allowed:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
sudo ufw status verbose
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
In case you installed Syncthing manually you can follow the \fI\%instructions to manually add the syncthing preset\fP <\fBhttps://github.com/syncthing/syncthing/tree/main/etc/firewall-ufw\fP> to ufw.
In case you installed Syncthing manually you can follow the \X'tty: link https://github.com/syncthing/syncthing/tree/main/etc/firewall-ufw'\fI\%instructions to manually add the syncthing preset\fP <\fBhttps://github.com/syncthing/syncthing/tree/main/etc/firewall-ufw\fP>\X'tty: link' to ufw.
.SS Firewalld
.sp
If you are using \fI\%Firewalld\fP <\fBhttps://firewalld.org/\fP> it has included
If you are using \X'tty: link https://firewalld.org/'\fI\%Firewalld\fP <\fBhttps://firewalld.org/\fP>\X'tty: link' it has included
support for syncthing (since version 0.5.0, January 2018), and you can enable
it with:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
sudo firewall\-cmd \-\-zone=public \-\-add\-service=syncthing \-\-permanent
sudo firewall\-cmd \-\-reload
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
@@ -158,11 +148,9 @@ tunnel instead. You can start a tunnel with a command like the following:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
ssh \-L 9999:localhost:8384 machine
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
@@ -171,7 +159,7 @@ port 8384 on the target machine. This still works even if Syncthing is bound to
listen on localhost only.
.SH VIA A PROXY
.sp
Syncthing can use a SOCKS5 proxy for outbound connections. Please see \fI\%Using Proxies\fP\&.
Syncthing can use a SOCKS5 proxy for outbound connections. Please see \X'tty: link #proxying'\fI\%Using Proxies\fP\X'tty: link'\&.
.SH AUTHOR
The Syncthing Authors
.SH COPYRIGHT
man/syncthing-relay.7
+24 -45
View File
@@ -1,3 +1,4 @@
'\" t
.\" Man page generated from reStructuredText.
.
.
@@ -27,7 +28,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" "Apr 11, 2024" "v1.27.5" "Syncthing"
.TH "SYNCTHING-RELAY" "7" "May 08, 2024" "v1.27.7" "Syncthing"
.SH NAME
syncthing-relay \- Relay Protocol v1
.SH WHAT IS A RELAY?
@@ -114,9 +115,8 @@ The connection is terminated immediately after that.
Client A \- Permanent protocol submode
Client B \- Temporary protocol submode
.TS
center;
|l|l|l|l|.
_
box center;
l|l|l|l.
T{
#
T} T{
@@ -222,7 +222,6 @@ T} T{
<\-Pong
T} T{
T}
_
.TE
.SH SESSION MODE
.sp
@@ -246,9 +245,8 @@ relayed between the two devices in the session directly.
Client A \- Permanent protocol mode
Client B \- Temporary protocol mode
.TS
center;
|l|l|l|l|.
_
box center;
l|l|l|l.
T{
#
T} T{
@@ -333,7 +331,6 @@ T} T{
T} T{
<\-Data
T}
_
.TE
.SH MESSAGES
.sp
@@ -351,8 +348,7 @@ us to identify what type of message it is.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
0 1 2 3
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+
@@ -369,16 +365,14 @@ struct Header {
int MessageType;
int MessageLength;
}
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.SS Ping message (Type = 0)
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
0 1 2 3
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+
@@ -386,16 +380,14 @@ struct Header {
struct Ping {
}
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.SS Pong message (Type = 1)
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
0 1 2 3
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+
@@ -403,16 +395,14 @@ struct Ping {
struct Pong {
}
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.SS JoinRelayRequest message (Type = 2)
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
0 1 2 3
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+
@@ -420,16 +410,14 @@ struct Pong {
struct JoinRelayRequest {
}
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.SS JoinSessionRequest message (Type = 3)
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
0 1 2 3
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+
@@ -444,8 +432,7 @@ struct JoinRelayRequest {
struct JoinSessionRequest {
opaque Key<32>;
}
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.INDENT 0.0
@@ -458,8 +445,7 @@ used to identify which session you are trying to connect to.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
0 1 2 3
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+
@@ -477,8 +463,7 @@ struct Response {
int Code;
string Message<>;
}
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.INDENT 0.0
@@ -493,8 +478,7 @@ Message associated with the code.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
0 1 2 3
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+
@@ -509,8 +493,7 @@ Message associated with the code.
struct ConnectRequest {
opaque ID<32>;
}
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.INDENT 0.0
@@ -522,8 +505,7 @@ Device ID to which the client would like to connect.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
0 1 2 3
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+\-+
@@ -558,8 +540,7 @@ struct SessionInvitation {
unsigned int Port;
bool ServerSocket;
}
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.INDENT 0.0
@@ -615,9 +596,8 @@ performing device ID validation, and full TLS encryption, and provides the same
security properties as it would provide when connecting over the internet.
.SH EXAMPLES OF STRONG CIPHER SUITES
.TS
center;
|l|l|l|.
_
box center;
l|l|l.
T{
ID
T} T{
@@ -689,7 +669,6 @@ ECDHE\-RSA\-AES128\-SHA256
T} T{
TLSv1.2 ECDH RSA AES(128) SHA256
T}
_
.TE
.SH AUTHOR
The Syncthing Authors
man/syncthing-rest-api.7
+132 -230
View File
File diff suppressed because it is too large Load Diff
man/syncthing-security.7
+6 -6
View File
@@ -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" "Apr 11, 2024" "v1.27.5" "Syncthing"
.TH "SYNCTHING-SECURITY" "7" "May 08, 2024" "v1.27.7" "Syncthing"
.SH NAME
syncthing-security \- Security Principles
.sp
@@ -46,7 +46,7 @@ Incoming requests for file data are verified to the extent that the requested
file name must exist in the local index and the global model.
.sp
For information about ensuring you are running the code you think you are and
for reporting security vulnerabilities, please see the official \fI\%security page\fP <\fBhttps://syncthing.net/security\fP>\&.
for reporting security vulnerabilities, please see the official \X'tty: link https://syncthing.net/security'\fI\%security page\fP <\fBhttps://syncthing.net/security\fP>\X'tty: link'\&.
.SH INFORMATION LEAKAGE
.SS Global Discovery
.sp
@@ -59,7 +59,7 @@ servers containing the device ID of the requested device. The connection to
the discovery server is encrypted using TLS and the discovery server
certificate is verified, so the contents of the query should be considered
private between the device and the discovery server. The discovery servers
are currently hosted by \fI\%@calmh\fP <\fBhttps://github.com/calmh\fP>\&. Global discovery defaults to \fBon\fP\&.
are currently hosted by \X'tty: link https://github.com/calmh'\fI\%@calmh\fP <\fBhttps://github.com/calmh\fP>\X'tty: link'\&. Global discovery defaults to \fBon\fP\&.
.sp
When turned off, devices with dynamic addresses not on the local network cannot
be found and connected to.
@@ -87,7 +87,7 @@ found and connected to.
.sp
When automatic upgrades are enabled, Syncthing checks for a new version at
startup and then once every twelve hours. This is by an HTTPS request to the
download site for releases, currently hosted by \fI\%@calmh\fP <\fBhttps://github.com/calmh\fP>\&.
download site for releases, currently hosted by \X'tty: link https://github.com/calmh'\fI\%@calmh\fP <\fBhttps://github.com/calmh\fP>\X'tty: link'\&.
Automatic upgrades default to \fBon\fP (unless Syncthing was compiled with
upgrades disabled).
.sp
@@ -105,7 +105,7 @@ information about the user or device.
.sp
When usage reporting is enabled, Syncthing reports usage data at startup and
then every 24 hours. The report is sent as an HTTPS POST to the usage reporting
server, currently hosted by \fI\%@calmh\fP <\fBhttps://github.com/calmh\fP>\&. The contents of the usage report can
server, currently hosted by \X'tty: link https://github.com/calmh'\fI\%@calmh\fP <\fBhttps://github.com/calmh\fP>\X'tty: link'\&. The contents of the usage report can
be seen behind the “Preview” link in settings. Usage reporting defaults to
\fBoff\fP but the GUI will ask once about enabling it, shortly after the first
install.
@@ -147,7 +147,7 @@ web GUI defaults to being reachable from the \fBlocal host only\fP\&.
.sp
Parties doing surveillance on your network (whether that be corporate IT, the
NSA or someone else) will be able to see that you use Syncthing, and your device
IDs \fI\%are OK to share anyway\fP <\fBhttps://docs.syncthing.net/users/faq.html#should-i-keep-my-device-ids-secret\fP>,
IDs \X'tty: link https://docs.syncthing.net/users/faq.html#should-i-keep-my-device-ids-secret'\fI\%are OK to share anyway\fP <\fBhttps://docs.syncthing.net/users/faq.html#should-i-keep-my-device-ids-secret\fP>\X'tty: link',
but the actual transmitted data is protected as well as we can. Knowing your
device ID can expose your IP address, using global discovery.
.SH PROTECTING YOUR SYNCTHING KEYS AND IDENTITY
man/syncthing-stignore.5
+15 -27
View File
@@ -27,18 +27,16 @@ 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" "Apr 11, 2024" "v1.27.5" "Syncthing"
.TH "SYNCTHING-STIGNORE" "5" "May 08, 2024" "v1.27.7" "Syncthing"
.SH NAME
syncthing-stignore \- Prevent files from being synchronized to other nodes
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
\&.stignore
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.SH DESCRIPTION
@@ -126,21 +124,19 @@ more general patterns that follow.
.INDENT 3.5
Negated patterns that can match items below the folder root will cause
Syncthing to traverse otherwise ignored directories. If the
\fI\%watcher\fP is enabled, those directories will also be
\X'tty: link #scanning'\fI\%watcher\fP\X'tty: link' is enabled, those directories will also be
watched. Directories ignored before the first negated pattern can
however be safely skipped, since the first matching pattern wins. For
example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
/foo
/bar
!baz
*
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
@@ -152,12 +148,10 @@ not cause this behaviour:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
!/baz
*
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
@@ -194,8 +188,7 @@ Given a directory layout starting at the synced folder’s root:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
\&.DS_Store
\&.stignore
foo
@@ -209,8 +202,7 @@ bar2/
frobble
My Pictures/
Img15.PNG
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
@@ -218,8 +210,7 @@ and an \fB\&.stignore\fP file with the contents:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
(?d).DS_Store
!frobble
!quuz
@@ -227,8 +218,7 @@ foo
*2
qu*
(?i)my pictures
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
@@ -237,8 +227,7 @@ all files and directories called “foo”, ending in a “2” or starting with
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
\&.DS_Store # ignored, will be deleted if gets in the way of parent directory removal
foo # ignored, matches \(dqfoo\(dq
foofoo # synced, does not match \(dqfoo\(dq but would match \(dqfoo*\(dq or \(dq*foo\(dq
@@ -251,8 +240,7 @@ bar2/ # synced, despite matching \(dq*2\(dq due to child frobble
frobble # synced, due to \(dq!frobble\(dq
My Pictures/ # ignored, matched case insensitive \(dq(?i)my pictures\(dq pattern
Img15.PNG # ignored, due to parent being ignored
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
@@ -266,7 +254,7 @@ content, make sure it does not have a \fB/\fP at the end of the pattern.
.UNINDENT
.UNINDENT
.sp
New in version 1.19.0: Default patterns can be configured which will take effect when automatically
Added in version 1.19.0: Default patterns can be configured which will take effect when automatically
accepting a folder from a remote device. The GUI suggests same the patterns
when adding a folder manually. In either case, the \fB\&.stignore\fP file is
created with these defaults if none is present yet.
man/syncthing-versioning.7
+16 -28
View File
@@ -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" "Apr 11, 2024" "v1.27.5" "Syncthing"
.TH "SYNCTHING-VERSIONING" "7" "May 08, 2024" "v1.27.7" "Syncthing"
.SH NAME
syncthing-versioning \- Keep automatic backups of deleted files by other nodes
.sp
@@ -113,7 +113,7 @@ will be deleted unless when the interval they are entering is empty. By keeping
the oldest versions this versioning scheme preserves the file if it is
overwritten.
.sp
For more info, check the \fI\%unit test file\fP <\fBhttps://github.com/syncthing/syncthing/blob/main/lib/versioner/staggered_test.go#L32\fP>
For more info, check the \X'tty: link https://github.com/syncthing/syncthing/blob/main/lib/versioner/staggered_test.go#L32'\fI\%unit test file\fP <\fBhttps://github.com/syncthing/syncthing/blob/main/lib/versioner/staggered_test.go#L32\fP>\X'tty: link'
that shows which versions are deleted for a specific run.
.SH EXTERNAL FILE VERSIONING
.sp
@@ -147,8 +147,7 @@ the following script and store it as \fB/Users/jb/bin/onlylatest.sh\fP (i.e. the
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
#!/bin/sh
set \-eu
@@ -164,8 +163,7 @@ outpath=$(dirname \(dq$versionspath/$filepath\(dq)
mkdir \-p \(dq$outpath\(dq
# Then move the file there
mv \-f \(dq$folderpath/$filepath\(dq \(dq$versionspath/$filepath\(dq
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
@@ -178,11 +176,9 @@ script will be called as if I ran this from the command line:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
$ /Users/jb/bin/onlylatest.sh /Users/jb/Sync docs/letter.txt
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
@@ -198,8 +194,7 @@ behavior as mentioned above. I created the following script and saved it as
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
@echo off
rem Enable UTF\-8 encoding to deal with multilingual folder and file names
@@ -221,8 +216,7 @@ if not exist \(dq%output_path%\(dq md \(dq%output_path%\(dq || exit /b
rem Finally move the file, overwrite existing file if any
move /y \(dq%folder_path%\e%file_path%\(dq \(dq%versions_path%\e%file_path%\(dq
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
@@ -237,8 +231,7 @@ location, e.g. \fBC:\eUsers\eUser\eScripts\eSendToRecycleBin.ps1\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
# PowerShell has no native method to recycle files, so we use Visual
# Basic to perform the operation. If succeeded, we also include the
# recycled file in the Syncthing\(aqs DEBUG output.
@@ -247,8 +240,7 @@ Add\-Type \-AssemblyName Microsoft.VisualBasic
if ($?) {
Write\-Output (\(dqRecycled \(dq + $args + \(dq.\(dq)
}
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
@@ -258,8 +250,7 @@ more consistent with how the Explorer works.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
# PowerShell has no native method to recycle files, so we use Visual
# Basic to perform the operation.
Add\-Type \-AssemblyName Microsoft.VisualBasic
@@ -279,8 +270,7 @@ if (Test\-Path \-LiteralPath ((Split\-Path \-Path $args) + \(dq\e~syncthing~\(dq
Write\-Output (\(dqRecycled \(dq + $args + \(dq.\(dq)
}
}
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.sp
@@ -295,13 +285,12 @@ files permanently.
.SH CONFIGURATION PARAMETER REFERENCE
.sp
The versioning settings are grouped into their own section of each folder in the
\fI\%configuration file\fP\&. The following shows an
\X'tty: link #config-option-folder.versioning'\fI\%configuration file\fP\X'tty: link'\&. The following shows an
example of such a section in the XML:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
<folder id=\(dq...\(dq>
<versioning type=\(dqsimple\(dq>
<cleanupIntervalS>3600</cleanupIntervalS>
@@ -311,8 +300,7 @@ example of such a section in the XML:
<param key=\(dqkeep\(dq val=\(dq5\(dq></param>
</versioning>
</folder>
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.INDENT 0.0
@@ -338,7 +326,7 @@ in the \fI\%params\fP element.
.B versioning.fsType
The internal file system implementation used to access this versions folder.
Only applies if \fI\%fsPath\fP is also set non\-empty,
otherwise the \fI\%filesystemType\fP from the folder element is used
otherwise the \X'tty: link #config-option-folder.filesystemtype'\fI\%filesystemType\fP\X'tty: link' from the folder element is used
instead. Refer to that option description for possible values. Ignored for
the \fBexternal\fP versioning strategy.
.sp
man/syncthing.1
+7 -11
View File
@@ -27,15 +27,14 @@ 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" "Apr 11, 2024" "v1.27.5" "Syncthing"
.TH "SYNCTHING" "1" "May 08, 2024" "v1.27.7" "Syncthing"
.SH NAME
syncthing \- Syncthing
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
syncthing [serve]
[\-\-audit] [\-\-auditfile=<file|\-|\-\->] [\-\-browser\-only] [\-\-device\-id]
[\-\-generate=<dir>] [\-\-gui\-address=<address>] [\-\-gui\-apikey=<key>]
@@ -64,8 +63,7 @@ syncthing cli
[\-\-gui\-address=<address>] [\-\-gui\-apikey=<key>]
[\-\-help]
<command> [command options...] [arguments...]
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.SH DESCRIPTION
@@ -369,7 +367,7 @@ 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 \fI\%decryption\fP for
devices, see the relevant section on \X'tty: link #untrusted-decrypt'\fI\%decryption\fP\X'tty: link' for
details. It does not depend on Syncthing to be running, but works on offline
data.
.sp
@@ -423,11 +421,9 @@ example:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
.EX
$ export all_proxy=socks://192.0.2.42:8081
.ft P
.fi
.EE
.UNINDENT
.UNINDENT
.SH DEVELOPMENT SETTINGS
@@ -582,7 +578,7 @@ Disable automatic upgrades. Equivalent to the \fI\%\-\-no\-upgrade\fP flag.
.B STPROFILER
Set to a listen address such as “127.0.0.1:9090” to start the profiler with
HTTP access, which then can be reached at
\fI\%http://localhost:9090/debug/pprof\fP\&. See \fBgo tool pprof\fP for more
\X'tty: link http://localhost:9090/debug/pprof'\fI\%http://localhost:9090/debug/pprof\fP\X'tty: link'\&. See \fBgo tool pprof\fP for more
information.
.TP
.B STPERFSTATS