mirror of
https://github.com/octoleo/syncthing.git
synced 2024-12-22 10:58:57 +00:00
gui, man, authors: Update docs, translations, and contributors
This commit is contained in:
Jakob Borg
parent
43a5be1c4b
commit
d23e8be39f
@ -61,7 +61,7 @@
|
||||
"Danger!": "Fara!",
|
||||
"Debugging Facilities": "Felsökningsanläggningar",
|
||||
"Default Folder Path": "Standard mappsökväg",
|
||||
"Deleted": "Tog bort",
|
||||
"Deleted": "Raderade",
|
||||
"Deselect All": "Avmarkera alla",
|
||||
"Device": "Enhet",
|
||||
"Device \"{%name%}\" ({%device%} at {%address%}) wants to connect. Add new device?": "Enhet \"{{name}}\" ({{device}} på {{address}}) vill ansluta. Lägg till ny enhet?",
|
||||
@ -109,10 +109,10 @@
|
||||
"File Pull Order": "Filhämtningsprioritering",
|
||||
"File Versioning": "Filversionshantering",
|
||||
"File permission bits are ignored when looking for changes. Use on FAT file systems.": "Filrättigheter ignoreras under sökning efter förändringar. Används på FAT-filsystem.",
|
||||
"Files are moved to .stversions directory when replaced or deleted by Syncthing.": "Filer flyttas till .stversions-mappen vid byte eller tas bort av Syncthing.",
|
||||
"Files are moved to .stversions folder when replaced or deleted by Syncthing.": "Filer flyttas till .stversions-mappen när de ersätts eller tas bort av Syncthing.",
|
||||
"Files are moved to date stamped versions in a .stversions directory when replaced or deleted by Syncthing.": "Filer flyttas till datumstämplade versioner i en .stversions-mapp när de ersätts eller tas bort av Syncthing.",
|
||||
"Files are moved to date stamped versions in a .stversions folder when replaced or deleted by Syncthing.": "Filer flyttas till datummärkta versioner i en .stversions mapp när de ersätts eller tas bort av Syncthing.",
|
||||
"Files are moved to .stversions directory when replaced or deleted by Syncthing.": "Filer flyttas till .stversions-mappen vid byte eller raderas av Syncthing.",
|
||||
"Files are moved to .stversions folder when replaced or deleted by Syncthing.": "Filer flyttas till .stversions-mappen när de ersätts eller raderas av Syncthing.",
|
||||
"Files are moved to date stamped versions in a .stversions directory when replaced or deleted by Syncthing.": "Filer flyttas till datumstämplade versioner i en .stversions-mapp när de ersätts eller raderas av Syncthing.",
|
||||
"Files are moved to date stamped versions in a .stversions folder when replaced or deleted by Syncthing.": "Filer flyttas till datummärkta versioner i en .stversions-mapp när de ersätts eller raderas av Syncthing.",
|
||||
"Files are protected from changes made on other devices, but changes made on this device will be sent to the rest of the cluster.": "Filer skyddas från ändringar gjorda på andra enheter, men ändringar som görs på den här noden skickas till de andra klustermedlemmarna.",
|
||||
"Files are synchronized from the cluster, but any changes made locally will not be sent to other devices.": "Filer synkroniseras från klustret, men alla ändringar som görs lokalt skickas inte till andra enheter.",
|
||||
"Filesystem Notifications": "filsystemsnotifieringar",
|
||||
@ -188,7 +188,7 @@
|
||||
"Newest First": "Nyast först",
|
||||
"No": "Nej",
|
||||
"No File Versioning": "Ingen filversionshantering",
|
||||
"No files will be deleted as a result of this operation.": "Inga filer kommer att tas bort till följd av denna operation.",
|
||||
"No files will be deleted as a result of this operation.": "Inga filer kommer att raderas till följd av denna operation.",
|
||||
"No upgrades": "Inga uppgraderingar",
|
||||
"Normal": "Normal",
|
||||
"Notice": "Observera",
|
||||
@ -204,7 +204,7 @@
|
||||
"Path": "Sökväg",
|
||||
"Path to the folder on the local computer. Will be created if it does not exist. The tilde character (~) can be used as a shortcut for": "Sökväg till mappen på din dator. Kommer att skapas om det inte finns. Tecknet tilde (~) kan användas som en genväg för",
|
||||
"Path where new auto accepted folders will be created, as well as the default suggested path when adding new folders via the UI. Tilde character (~) expands to {%tilde%}.": "Sökvägen där nya automatiskt accepterade mappar kommer att skapas, liksom den föreslagna sökvägen när du lägger till nya mappar via gränssnittet. Tecknet tilde (~) expanderar till {{tilde}}.",
|
||||
"Path where versions should be stored (leave empty for the default .stversions directory in the shared folder).": "Sökväg där versioner ska lagras (lämna tomt för standard .stversions-katalogen i den delade katalogen).",
|
||||
"Path where versions should be stored (leave empty for the default .stversions directory in the shared folder).": "Sökväg där versioner ska lagras (lämna tomt för standard .stversions-mappen i den delade katalogen).",
|
||||
"Path where versions should be stored (leave empty for the default .stversions folder in the folder).": "Sökväg där versioner sparas (lämna tomt för att använda standard .stversions-mappen i mappen).",
|
||||
"Pause": "Paus",
|
||||
"Pause All": "Pausa alla",
|
||||
@ -217,7 +217,7 @@
|
||||
"Please consult the release notes before performing a major upgrade.": "Läs igenom versionsnyheterna innan den stora uppgraderingen.",
|
||||
"Please set a GUI Authentication User and Password in the Settings dialog.": "Ställ in ett grafiska gränssnittets användarautentisering och lösenord i inställningsdialogrutan.",
|
||||
"Please wait": "Var god vänta",
|
||||
"Prefix indicating that the file can be deleted if preventing directory removal": "Prefix som indikerar att filen kan raderas om det förhindrar borttagning av katalog",
|
||||
"Prefix indicating that the file can be deleted if preventing directory removal": "Prefix som indikerar att filen kan raderas om det förhindrar radering av katalog",
|
||||
"Prefix indicating that the pattern should be matched without case sensitivity": "Prefix som indikerar att mönstret ska matchas utan skiftlägeskänslighet",
|
||||
"Preview": "Förhandsgranska",
|
||||
"Preview Usage Report": "Förhandsgranska statistik",
|
||||
@ -356,7 +356,7 @@
|
||||
"Version": "Version",
|
||||
"Versions": "Versioner",
|
||||
"Versions Path": "Sökväg för versioner",
|
||||
"Versions are automatically deleted if they are older than the maximum age or exceed the number of files allowed in an interval.": "Versioner tas bort automatiskt när de är äldre än den maximala åldersgränsen eller överstiger frekvensen i intervallet.",
|
||||
"Versions are automatically deleted if they are older than the maximum age or exceed the number of files allowed in an interval.": "Versioner raderas automatiskt när de är äldre än den maximala åldersgränsen eller överstiger frekvensen i intervallet.",
|
||||
"Waiting to scan": "Väntar på uppdatering",
|
||||
"Warning, this path is a parent directory of an existing folder \"{%otherFolder%}\".": "Varning, denna sökväg är en överordnad mapp av en befintlig mapp \"{{otherFolder}}\".",
|
||||
"Warning, this path is a parent directory of an existing folder \"{%otherFolderLabel%}\" ({%otherFolder%}).": "Varning, denna sökväg är en överordnad mapp av en befintlig mapp \"{{otherFolderLabel}}\" ({{otherFolder}}).",
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
.\" Man page generated from reStructuredText.
|
||||
.
|
||||
.TH "STDISCOSRV" "1" "Mar 05, 2019" "v1" "Syncthing"
|
||||
.TH "STDISCOSRV" "1" "Mar 22, 2019" "v1" "Syncthing"
|
||||
.SH NAME
|
||||
stdiscosrv \- Syncthing Discovery Server
|
||||
.
|
||||
@ -52,12 +52,12 @@ Syncthing project also maintains a global cluster for public use.
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-cert=<file>
|
||||
Certificate file (default "./cert.pem").
|
||||
Certificate file (default “./cert.pem”).
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-db\-dir=<string>
|
||||
Database directory, where data is stored (default "./discovery.db").
|
||||
Database directory, where data is stored (default “./discovery.db”).
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
@ -72,12 +72,12 @@ Listen on HTTP (behind an HTTPS proxy).
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-key=<file>
|
||||
Key file (default "./key.pem").
|
||||
Key file (default “./key.pem”).
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-listen=<address>
|
||||
Listen address (default ":8443").
|
||||
Listen address (default “:8443”).
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
@ -92,14 +92,14 @@ Replication peers, \fI\%id@address\fP <\fBid@address\fP>, comma separated
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-replication\-listen=<address>
|
||||
Listen address for incoming replication connections (default ":19200").
|
||||
Listen address for incoming replication connections (default “:19200”).
|
||||
.UNINDENT
|
||||
.SH POINTING SYNCTHING AT YOUR DISCOVERY SERVER
|
||||
.sp
|
||||
By default, Syncthing uses a number of global discovery servers, signified by
|
||||
the entry \fBdefault\fP in the list of discovery servers. To make Syncthing use
|
||||
your own instance of stdiscosrv, open up Syncthing\(aqs web GUI. Go to settings,
|
||||
Global Discovery Server and add stdiscosrv\(aqs host address to the comma\-separated
|
||||
your own instance of stdiscosrv, open up Syncthing’s web GUI. Go to settings,
|
||||
Global Discovery Server and add stdiscosrv’s host address to the comma\-separated
|
||||
list, e.g. \fBhttps://disco.example.com:8443/\fP\&. Note that stdiscosrv uses port
|
||||
8443 by default. For stdiscosrv to be available over the internet with a dynamic
|
||||
IP address, you will need a dynamic DNS service.
|
||||
@ -114,7 +114,7 @@ entry from the list.
|
||||
.SS Description
|
||||
.sp
|
||||
This guide assumes that you have already set up Syncthing. If you
|
||||
haven\(aqt yet, head over to getting\-started first.
|
||||
haven’t yet, head over to getting\-started first.
|
||||
.SS Installing
|
||||
.sp
|
||||
Go to \fI\%releases\fP <\fBhttps://github.com/syncthing/discosrv/releases\fP> and
|
||||
@ -146,7 +146,7 @@ discovery server. This is like any other HTTPS website; clients will
|
||||
authenticate the server based on its certificate and domain name.
|
||||
.IP \(bu 2
|
||||
Use any certificate pair and let clients authenticate the server based on
|
||||
its "device ID" (similar to Syncthing\-to\-Syncthing authentication). This
|
||||
its “device ID” (similar to Syncthing\-to\-Syncthing authentication). This
|
||||
option can be used with the certificate automatically generated by the
|
||||
discovery server.
|
||||
.IP \(bu 2
|
||||
@ -155,7 +155,7 @@ reverse proxy. See below for configuration.
|
||||
.UNINDENT
|
||||
.sp
|
||||
For the first two options, the discovery server must be given the paths to
|
||||
the certificate and key at startup. This isn\(aqt necessary with the \fBhttp\fP flag:
|
||||
the certificate and key at startup. This isn’t necessary with the \fBhttp\fP flag:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
@ -218,9 +218,9 @@ sender and listener.
|
||||
As an example, lets assume two discovery servers:
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
Server one is on 192.0.2.20 and has certificate ID I6K...H76
|
||||
Server one is on 192.0.2.20 and has certificate ID I6K…H76
|
||||
.IP \(bu 2
|
||||
Server two is on 192.0.2.55 and has certificate ID MRI...7OK
|
||||
Server two is on 192.0.2.55 and has certificate ID MRI…7OK
|
||||
.UNINDENT
|
||||
.sp
|
||||
In order for both to replicate to the other and thus form a redundant pair,
|
||||
@ -257,7 +257,7 @@ port must be specified in peer addresses.
|
||||
.sp
|
||||
It is possible to only allow incoming connections from a peer without
|
||||
establishing an outgoing replication connection. To do so, give only the
|
||||
device ID without "@ip:port" address:
|
||||
device ID without “@ip:port” address:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
@ -270,7 +270,7 @@ $ stdiscosrv \-replicate=I6K...H76 <other options>
|
||||
.UNINDENT
|
||||
.sp
|
||||
Discosrv will listen on the replication port only when \fB\-replicate\fP is
|
||||
given. The default replication listen address is ":19200".
|
||||
given. The default replication listen address is “:19200”.
|
||||
.sp
|
||||
To achieve load balancing over two mutually replicating discovery server
|
||||
instances, add multiple A / AAAA DNS records for a given name and point
|
||||
@ -293,10 +293,10 @@ Run the discovery server using the \-http flag \fBstdiscosrv \-http\fP\&.
|
||||
.IP \(bu 2
|
||||
SSL certificate/key configured for the reverse proxy
|
||||
.IP \(bu 2
|
||||
The "X\-Forwarded\-For" http header must be passed through with the client\(aqs
|
||||
The “X\-Forwarded\-For” http header must be passed through with the client’s
|
||||
real IP address
|
||||
.IP \(bu 2
|
||||
The "X\-SSL\-Cert" must be passed through with the PEM\-encoded client SSL
|
||||
The “X\-SSL\-Cert” must be passed through with the PEM\-encoded client SSL
|
||||
certificate
|
||||
.IP \(bu 2
|
||||
The proxy must request the client SSL certificate but not require it to be
|
||||
@ -371,7 +371,7 @@ server {
|
||||
.UNINDENT
|
||||
.sp
|
||||
An example of automating the SSL certificates and reverse\-proxying the Discovery
|
||||
Server and Syncthing using Nginx, \fI\%Let\(aqs 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, \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>\&.
|
||||
.SH SEE ALSO
|
||||
.sp
|
||||
\fBsyncthing\-networking(7)\fP, \fBsyncthing\-faq(7)\fP
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
.\" Man page generated from reStructuredText.
|
||||
.
|
||||
.TH "STRELAYSRV" "1" "Mar 05, 2019" "v1" "Syncthing"
|
||||
.TH "STRELAYSRV" "1" "Mar 22, 2019" "v1" "Syncthing"
|
||||
.SH NAME
|
||||
strelaysrv \- Syncthing Relay Server
|
||||
.
|
||||
@ -72,12 +72,12 @@ Global rate limit, in bytes/s.
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-keys=<dir>
|
||||
Directory where cert.pem and key.pem is stored (default ".").
|
||||
Directory where cert.pem and key.pem is stored (default “.”).
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-listen=<listen addr>
|
||||
Protocol listen address (default ":22067").
|
||||
Protocol listen address (default “:22067”).
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
@ -127,13 +127,13 @@ How often pings are sent (default 1m0s).
|
||||
.TP
|
||||
.B \-pools=<pool addresses>
|
||||
Comma separated list of relay pool addresses to join (default
|
||||
"\fI\%http://relays.syncthing.net/endpoint\fP"). Blank to disable announcement to
|
||||
“\fI\%http://relays.syncthing.net/endpoint\fP”). Blank to disable announcement to
|
||||
a pool, thereby remaining a private relay.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-protocol=<string>
|
||||
Protocol used for listening. \(aqtcp\(aq for IPv4 and IPv6, \(aqtcp4\(aq for IPv4, \(aqtcp6\(aq for IPv6 (default "tcp").
|
||||
Protocol used for listening. ‘tcp’ for IPv4 and IPv6, ‘tcp4’ for IPv4, ‘tcp6’ for IPv6 (default “tcp”).
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
@ -143,7 +143,7 @@ An optional description about who provides the relay.
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B \-status\-srv=<listen addr>
|
||||
Listen address for status service (blank to disable) (default ":22070").
|
||||
Listen address for status service (blank to disable) (default “:22070”).
|
||||
Status service is used by the relay pool server UI for displaying stats (data transfered, number of clients, etc.)
|
||||
.UNINDENT
|
||||
.SH SETTING UP
|
||||
@ -191,7 +191,7 @@ relay://private\-relay\-1.example.com:443/?id=ITZRNXE\-YNROGBZ\-HXTH5P7\-VK5NYE5
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
The relay\(aqs device ID is output on start\-up.
|
||||
The relay’s device ID is output on start\-up.
|
||||
.SS Running on port 443 as an unprivileged user
|
||||
.sp
|
||||
It is recommended that you run the relay on port 443 (or another port which is
|
||||
@ -213,7 +213,7 @@ iptables \-t nat \-A PREROUTING \-i eth0 \-p tcp \-\-dport 443 \-j REDIRECT \-\-
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
Or, if you\(aqre using \fBufw\fP, add the following to \fB/etc/ufw/before.rules\fP:
|
||||
Or, if you’re using \fBufw\fP, add the following to \fB/etc/ufw/before.rules\fP:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
.\" Man page generated from reStructuredText.
|
||||
.
|
||||
.TH "SYNCTHING-BEP" "7" "Mar 05, 2019" "v1" "Syncthing"
|
||||
.TH "SYNCTHING-BEP" "7" "Mar 22, 2019" "v1" "Syncthing"
|
||||
.SH NAME
|
||||
syncthing-bep \- Block Exchange Protocol v1
|
||||
.
|
||||
@ -46,8 +46,8 @@ File data is described and transferred in units of \fIblocks\fP, each being from
|
||||
block size may vary between files but is constant in any given file, except
|
||||
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
|
||||
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 RFC 2119.
|
||||
.SH TRANSPORT AND AUTHENTICATION
|
||||
.sp
|
||||
@ -72,8 +72,8 @@ v ... v
|
||||
.UNINDENT
|
||||
.sp
|
||||
The encryption and authentication layer SHALL use TLS 1.2 or a higher
|
||||
revision. A strong cipher suite SHALL be used, with "strong cipher
|
||||
suite" being defined as being without known weaknesses and providing
|
||||
revision. A strong cipher suite SHALL be used, with “strong cipher
|
||||
suite” being defined as being without known weaknesses and providing
|
||||
Perfect Forward Secrecy (PFS). Examples of strong cipher suites are
|
||||
given at the end of this document. This is not to be taken as an
|
||||
exhaustive list of allowed cipher suites but represents best practices
|
||||
@ -85,7 +85,7 @@ connection. Possibilities include certificates signed by a common
|
||||
trusted CA, preshared certificates, preshared certificate fingerprints
|
||||
or certificate pinning combined with some out of band first
|
||||
verification. The reference implementation uses preshared certificate
|
||||
fingerprints (SHA\-256) referred to as "Device IDs".
|
||||
fingerprints (SHA\-256) referred to as “Device IDs”.
|
||||
.sp
|
||||
There is no required order or synchronization among BEP messages except
|
||||
as noted per message type \- any message type may be sent at any time and
|
||||
@ -94,9 +94,9 @@ another.
|
||||
.sp
|
||||
The underlying transport protocol MUST guarantee reliable packet delivery.
|
||||
.sp
|
||||
In this document, in diagrams and text, "bit 0" refers to the \fImost
|
||||
significant\fP bit of a word; "bit 15" is thus the least significant bit of a
|
||||
16 bit word (int16) and "bit 31" is the least significant bit of a 32 bit
|
||||
In this document, in diagrams and text, “bit 0” refers to the \fImost
|
||||
significant\fP bit of a word; “bit 15” is thus the least significant bit of a
|
||||
16 bit word (int16) and “bit 31” is the least significant bit of a 32 bit
|
||||
word (int32). Non protocol buffer integers are always represented in network
|
||||
byte order (i.e., big endian) and are signed unless stated otherwise, but
|
||||
when describing message lengths negative values do not make sense and the
|
||||
@ -109,7 +109,7 @@ message is \fIvalid\fP with all fields empty \- for example, an index entry for
|
||||
file that does not have a name is not useful and MAY be rejected by the
|
||||
implementation. However the folder label is for human consumption only so an
|
||||
empty label should be accepted \- the implementation will have to choose some
|
||||
way to represent the folder, perhaps by using the ID in it\(aqs place or
|
||||
way to represent the folder, perhaps by using the ID in it’s place or
|
||||
automatically generating a label.
|
||||
.SH PRE-AUTHENTICATION MESSAGES
|
||||
.sp
|
||||
@ -171,7 +171,7 @@ name or host name, for the remote device.
|
||||
The \fBclient_name\fP and \fBclient_version\fP identifies the implementation. The
|
||||
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".
|
||||
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 <\fBhttp://semver.org/\fP> standard.
|
||||
.sp
|
||||
@ -467,7 +467,7 @@ The \fBfiles\fP field is a list of files making up the index information.
|
||||
The \fBname\fP is the file name path relative to the folder root. Like all
|
||||
strings in BEP, the Name is always in UTF\-8 NFC regardless of operating
|
||||
system or file system specific conventions. The name field uses the slash
|
||||
character ("/") as path separator, regardless of the implementation\(aqs
|
||||
character (“/”) as path separator, regardless of the implementation’s
|
||||
operating system conventions. The combination of folder and name uniquely
|
||||
identifies each file in a cluster.
|
||||
.sp
|
||||
@ -532,7 +532,7 @@ symlink type. It is empty for all other entry types.
|
||||
.SS Request
|
||||
.sp
|
||||
The Request message expresses the desire to receive a data block
|
||||
corresponding to a part of a certain file in the peer\(aqs folder.
|
||||
corresponding to a part of a certain file in the peer’s folder.
|
||||
.SS Protocol Buffer Schema
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
@ -569,7 +569,7 @@ requested hash. The other device MAY reuse a block from a different file and
|
||||
offset having the same size and hash, if one exists.
|
||||
.sp
|
||||
The \fBfrom temporary\fP field is set to indicate that the read should be
|
||||
performed from the temporary file (converting name to it\(aqs temporary form)
|
||||
performed from the temporary file (converting name to it’s temporary form)
|
||||
and falling back to the non temporary file if any error occurs. Knowledge of
|
||||
contents of temporary files comes from DownloadProgress messages.
|
||||
.SS Response
|
||||
@ -812,7 +812,7 @@ index data.
|
||||
For situations with large indexes or frequent reconnects this can be quite
|
||||
inefficient. A mechanism can then be used to retain index data between
|
||||
connections and only transmit any changes since that data on connection
|
||||
start. This is called "delta indexes". To enable this mechanism the
|
||||
start. This is called “delta indexes”. To enable this mechanism the
|
||||
\fBsequence\fP and \fBindex ID\fP fields are used.
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
@ -861,7 +861,7 @@ Update messages rather than sending a very large Index message.
|
||||
The Syncthing implementation imposes a hard limit of 500,000,000 bytes on
|
||||
all messages. Attempting to send or receive a larger message will result in
|
||||
a connection close. This size was chosen to accommodate Index messages
|
||||
containing a large block list. It\(aqs intended that the limit may be further
|
||||
containing a large block list. It’s intended that the limit may be further
|
||||
reduced in a future protocol update supporting variable block sizes (and
|
||||
thus shorter block lists for large files).
|
||||
.SH SELECTION OF BLOCK SIZE
|
||||
@ -1049,7 +1049,7 @@ T} T{
|
||||
T}
|
||||
_
|
||||
T{
|
||||
\&...
|
||||
…
|
||||
T} T{
|
||||
T} T{
|
||||
T}
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
.\" Man page generated from reStructuredText.
|
||||
.
|
||||
.TH "SYNCTHING-CONFIG" "5" "Mar 05, 2019" "v1" "Syncthing"
|
||||
.TH "SYNCTHING-CONFIG" "5" "Mar 22, 2019" "v1" "Syncthing"
|
||||
.SH NAME
|
||||
syncthing-config \- Syncthing Configuration
|
||||
.
|
||||
@ -58,7 +58,7 @@ directory the following files are located:
|
||||
The configuration file, in XML format.
|
||||
.TP
|
||||
.B \fBcert.pem\fP, \fBkey.pem\fP
|
||||
The device\(aqs RSA public and private key. These form the basis for the
|
||||
The device’s RSA public and private key. These form the basis for the
|
||||
device ID. The key must be kept private.
|
||||
.TP
|
||||
.B \fBhttps\-cert.pem\fP, \fBhttps\-key.pem\fP
|
||||
@ -257,17 +257,17 @@ Controls how the folder is handled by Syncthing. Possible values are:
|
||||
.TP
|
||||
.B sendreceive
|
||||
The folder is in default mode. Sending local and accepting remote changes.
|
||||
Note that this type was previously called "readwrite" which is deprecated
|
||||
Note that this type was previously called “readwrite” which is deprecated
|
||||
but still accepted in incoming configs.
|
||||
.TP
|
||||
.B sendonly
|
||||
The folder is in "send only" mode \-\- it will not be modified by
|
||||
The folder is in “send only” mode – it will not be modified by
|
||||
Syncthing on this device.
|
||||
Note that this type was previously called "readonly" which is deprecated
|
||||
Note that this type was previously called “readonly” which is deprecated
|
||||
but still accepted in incoming configs.
|
||||
.TP
|
||||
.B receiveonly
|
||||
The folder is in "receive only" mode \-\- it will not propagate
|
||||
The folder is in “receive only” mode – it will not propagate
|
||||
changes to other devices.
|
||||
.UNINDENT
|
||||
.TP
|
||||
@ -325,7 +325,7 @@ versioning
|
||||
.B copiers, pullers, hashers
|
||||
The number of copier, puller and hasher routines to use, or zero for the
|
||||
system determined optimum. These are low level performance options for
|
||||
advanced users only; do not change unless requested to or you\(aqve actually
|
||||
advanced users only; do not change unless requested to or you’ve actually
|
||||
read and understood the code yourself. :)
|
||||
.TP
|
||||
.B order
|
||||
@ -362,8 +362,8 @@ The interval with which scan progress information is sent to the GUI. Zero
|
||||
means the default value (two seconds).
|
||||
.TP
|
||||
.B pullerPauseS
|
||||
Tweak for rate limiting the puller when it retries pulling files. Don\(aqt
|
||||
change these unless you know what you\(aqre doing.
|
||||
Tweak for rate limiting the puller when it retries pulling files. Don’t
|
||||
change these unless you know what you’re doing.
|
||||
.TP
|
||||
.B maxConflicts
|
||||
The maximum number of conflict copies to keep around for any given file.
|
||||
@ -389,7 +389,7 @@ to \-1 to always use weak hash. Default value is 25.
|
||||
.TP
|
||||
.B markerName
|
||||
Name of a directory or file in the folder root to be used as
|
||||
marker\-faq\&. Default is ".stfolder".
|
||||
marker\-faq\&. Default is “.stfolder”.
|
||||
.TP
|
||||
.B fsync
|
||||
Deprecated since version v0.14.37.
|
||||
@ -402,8 +402,8 @@ committing the changes to the internal database.
|
||||
Deprecated since version v0.14.41.
|
||||
|
||||
.sp
|
||||
Tweak for rate limiting the puller. Don\(aqt change these unless you know
|
||||
what you\(aqre doing.
|
||||
Tweak for rate limiting the puller. Don’t change these unless you know
|
||||
what you’re doing.
|
||||
.UNINDENT
|
||||
.SH DEVICE ELEMENT
|
||||
.INDENT 0.0
|
||||
@ -478,7 +478,7 @@ to even if the original introducer is no longer listing the remote device as kno
|
||||
Defines which device has introduced us to this device. Used only for following de\-introductions.
|
||||
.TP
|
||||
.B certName
|
||||
The device certificate common name, if it is not the default "syncthing".
|
||||
The device certificate common name, if it is not the default “syncthing”.
|
||||
.UNINDENT
|
||||
.sp
|
||||
From following child elements at least one \fBaddress\fP child must exist.
|
||||
@ -967,9 +967,9 @@ that the files you are backing up are in a folder\-sendonly 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\(aqd like to sync your home folder in non\-send only mode, you may add the
|
||||
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 ignore list\&.
|
||||
If you\(aqd also like to backup your configuration files, add another folder in
|
||||
If you’d also like to backup your configuration files, add another folder in
|
||||
send only mode for just the configuration folder.
|
||||
.SH AUTHOR
|
||||
The Syncthing Authors
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
.\" Man page generated from reStructuredText.
|
||||
.
|
||||
.TH "SYNCTHING-DEVICE-IDS" "7" "Mar 05, 2019" "v1" "Syncthing"
|
||||
.TH "SYNCTHING-DEVICE-IDS" "7" "Mar 22, 2019" "v1" "Syncthing"
|
||||
.SH NAME
|
||||
syncthing-device-ids \- Understanding Device IDs
|
||||
.
|
||||
@ -32,8 +32,8 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
..
|
||||
.sp
|
||||
Every device is identified by a device ID. The device ID is used for address
|
||||
resolution, authentication and authorization. The term "device ID" could
|
||||
interchangeably have been "key ID" since the device ID is a direct property of
|
||||
resolution, authentication and authorization. The term “device ID” could
|
||||
interchangeably have been “key ID” since the device ID is a direct property of
|
||||
the public key in use.
|
||||
.SH KEYS
|
||||
.sp
|
||||
@ -43,7 +43,7 @@ startup, Syncthing will create a public/private keypair.
|
||||
Currently this is a 384 bit ECDSA key (3072 bit RSA prior to v0.12.5,
|
||||
which is what is used as an example in this article). The keys are saved in
|
||||
the form of the private key (\fBkey.pem\fP) and a self signed certificate
|
||||
(\fBcert.pem\fP). The self signing part doesn\(aqt actually add any security or
|
||||
(\fBcert.pem\fP). The self signing part doesn’t actually add any security or
|
||||
functionality as far as Syncthing is concerned but it enables the use of the
|
||||
keys in a standard TLS exchange.
|
||||
.sp
|
||||
@ -94,7 +94,7 @@ Certificate:
|
||||
.sp
|
||||
We can see here that the certificate is little more than a container for the
|
||||
public key; the serial number is zero and the Issuer and Subject are both
|
||||
"syncthing" where a qualified name might otherwise be expected.
|
||||
“syncthing” where a qualified name might otherwise be expected.
|
||||
.sp
|
||||
An advanced user could replace the \fBkey.pem\fP and \fBcert.pem\fP files with a
|
||||
keypair generated directly by the \fBopenssl\fP utility or other mechanism.
|
||||
@ -138,7 +138,7 @@ MFZWI3D\-BONSGYC\-YLTMRWG\-C43ENR5\-QXGZDMM\-FZWI3DP\-BONSGYY\-LTMRWAD
|
||||
.UNINDENT
|
||||
.SS Connection Establishment
|
||||
.sp
|
||||
Now we know what device IDs are, here\(aqs how they are used in Syncthing. When
|
||||
Now we know what device IDs are, here’s how they are used in Syncthing. When
|
||||
you add a device ID to the configuration, Syncthing will attempt to
|
||||
connect to that device. The first thing we need to do is figure out the IP and
|
||||
port to connect to. There are three possibilities here:
|
||||
@ -150,13 +150,13 @@ dynamic DNS setup this might be a good option.
|
||||
.IP \(bu 2
|
||||
Using local discovery, if enabled. Every Syncthing instance on a LAN
|
||||
periodically broadcasts information about itself (device ID, address,
|
||||
port number). If we\(aqve seen one of these broadcasts for a given
|
||||
device ID that\(aqs where we try to connect.
|
||||
port number). If we’ve seen one of these broadcasts for a given
|
||||
device ID that’s where we try to connect.
|
||||
.IP \(bu 2
|
||||
Using global discovery, if enabled. Every Syncthing instance
|
||||
announces itself to the global discovery service (device ID and
|
||||
external port number \- the internal address is not announced to the
|
||||
global server). If we don\(aqt have a static address and haven\(aqt seen
|
||||
global server). If we don’t have a static address and haven’t seen
|
||||
any local announcements the global discovery server will be queried
|
||||
for an address.
|
||||
.UNINDENT
|
||||
@ -188,11 +188,11 @@ The SHA\-256 hash is cryptographically collision resistant. This means
|
||||
that there is no way that we know of to create two different messages
|
||||
with the same hash.
|
||||
.sp
|
||||
You can argue that of course there are collisions \- there\(aqs an infinite
|
||||
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\(aqm going to quote \fI\%stack
|
||||
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>
|
||||
here:
|
||||
.INDENT 0.0
|
||||
@ -203,28 +203,28 @@ civilization\-as\-we\- know\-it, and killing off a few billion people ?
|
||||
It can be argued that any unlucky event with a probability lower
|
||||
than that is not actually very important.
|
||||
.sp
|
||||
If we have a "perfect" hash function with output size n, and we have
|
||||
If we have a “perfect” hash function with output size n, and we have
|
||||
p messages to hash (individual message length is not important),
|
||||
then probability of collision is about p2/2n+1 (this is an
|
||||
approximation which is valid for "small" p, i.e. substantially
|
||||
approximation which is valid for “small” p, i.e. substantially
|
||||
smaller than 2n/2). For instance, with SHA\-256 (n=256) and one
|
||||
billion messages (p=10^9) then the probability is about 4.3*10^\-60.
|
||||
.sp
|
||||
A mass\-murderer space rock happens about once every 30 million years
|
||||
on average. This leads to a probability of such an event occurring
|
||||
in the next second to about 10^\-15. That\(aqs 45 orders of magnitude
|
||||
in the next second to about 10^\-15. That’s 45 orders of magnitude
|
||||
more probable than the SHA\-256 collision. Briefly stated, if you
|
||||
find SHA\-256 collisions scary then your priorities are wrong.
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
It\(aqs also worth noting that the property of SHA\-256 that we are using is not
|
||||
It’s also worth noting that the property of SHA\-256 that we are using is not
|
||||
simply collision resistance but resistance to a preimage attack, i.e. even if
|
||||
you can find two messages that result in a hash collision that doesn\(aqt help you
|
||||
you can find two messages that result in a hash collision that doesn’t help you
|
||||
attack Syncthing (or TLS in general). You need to create a message that hashes
|
||||
to exactly the hash that my certificate already has or you won\(aqt get in.
|
||||
to exactly the hash that my certificate already has or you won’t get in.
|
||||
.sp
|
||||
Note also that it\(aqs not good enough to find a random blob of bits that happen to
|
||||
Note also that it’s not good enough to find a random blob of bits that happen to
|
||||
have the same hash as my certificate. You need to create a valid DER\-encoded,
|
||||
signed certificate that has the same hash as mine. The difficulty of this is
|
||||
staggeringly far beyond the already staggering difficulty of finding a SHA\-256
|
||||
@ -235,22 +235,22 @@ As far as I know, these are the issues or potential issues with the
|
||||
above mechanism.
|
||||
.SS Discovery Spoofing
|
||||
.sp
|
||||
Currently, the local discovery mechanism isn\(aqt protected by crypto. This
|
||||
Currently, the local discovery mechanism isn’t protected by crypto. This
|
||||
means that any device can in theory announce itself for any device ID and
|
||||
potentially receive connections for that device from the local network.
|
||||
.SS Long Device IDs are Painful
|
||||
.sp
|
||||
It\(aqs a mouthful to read over the phone, annoying to type into an SMS or even
|
||||
It’s a mouthful to read over the phone, annoying to type into an SMS or even
|
||||
into a computer. And it needs to be done twice, once for each side.
|
||||
.sp
|
||||
This isn\(aqt a vulnerability as such, but a user experience problem. There are
|
||||
This isn’t a vulnerability as such, but a user experience problem. There are
|
||||
various possible solutions:
|
||||
.INDENT 0.0
|
||||
.IP \(bu 2
|
||||
Use shorter device IDs with verification based on the full ID ("You
|
||||
Use shorter device IDs with verification based on the full ID (“You
|
||||
entered MFZWI3; I found and connected to a device with the ID
|
||||
MFZWI3\-DBONSG\-YYLTMR\-WGC43E\-NRQXGZ\-DMMFZW\-I3DBON\-SGYYLT\-MRWA, please
|
||||
confirm that this is correct").
|
||||
confirm that this is correct”).
|
||||
.IP \(bu 2
|
||||
Use shorter device IDs with an out of band authentication, a la
|
||||
Bluetooth pairing. You enter a one time PIN into Syncthing and give
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
.\" Man page generated from reStructuredText.
|
||||
.
|
||||
.TH "SYNCTHING-EVENT-API" "7" "Mar 05, 2019" "v1" "Syncthing"
|
||||
.TH "SYNCTHING-EVENT-API" "7" "Mar 22, 2019" "v1" "Syncthing"
|
||||
.SH NAME
|
||||
syncthing-event-api \- Event API
|
||||
.
|
||||
@ -162,8 +162,8 @@ Generated each time a connection to a device has been terminated.
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
The error key contains the cause for disconnection, which might not
|
||||
necessarily be an error as such. Specifically, "EOF" and "unexpected
|
||||
EOF" both signify TCP connection termination, either due to the other
|
||||
necessarily be an error as such. Specifically, “EOF” and “unexpected
|
||||
EOF” both signify TCP connection termination, either due to the other
|
||||
device restarting or going offline or due to a network change.
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
.\" Man page generated from reStructuredText.
|
||||
.
|
||||
.TH "SYNCTHING-FAQ" "7" "Mar 05, 2019" "v1" "Syncthing"
|
||||
.TH "SYNCTHING-FAQ" "7" "Mar 22, 2019" "v1" "Syncthing"
|
||||
.SH NAME
|
||||
syncthing-faq \- Frequently Asked Questions
|
||||
.
|
||||
@ -38,10 +38,10 @@ machine will automatically be replicated to your other devices. We believe your
|
||||
data is your data alone and you deserve to choose where it is stored. Therefore
|
||||
Syncthing does not upload your data to the cloud but exchanges your data across
|
||||
your machines as soon as they are online at the same time.
|
||||
.SH IS IT "SYNCTHING", "SYNCTHING" OR "SYNCTHING"?
|
||||
.SH IS IT “SYNCTHING”, “SYNCTHING” OR “SYNCTHING”?
|
||||
.sp
|
||||
It\(aqs \fBSyncthing\fP, although the command and source repository is spelled
|
||||
\fBsyncthing\fP so it may be referred to in that way as well. It\(aqs definitely not
|
||||
It’s \fBSyncthing\fP, although the command and source repository is spelled
|
||||
\fBsyncthing\fP so it may be referred to in that way as well. It’s definitely not
|
||||
SyncThing, even though the abbreviation \fBst\fP is used in some
|
||||
circumstances and file names.
|
||||
.SH HOW DOES SYNCTHING DIFFER FROM BITTORRENT/RESILIO SYNC?
|
||||
@ -116,9 +116,9 @@ in the configuration file (24 hours by default).
|
||||
.sp
|
||||
When troubleshooting a slow sync, there are a number of things to check.
|
||||
.sp
|
||||
First of all, verify that you are not connected via a relay. In the "Remote
|
||||
Devices" list on the right side of the GUI, double check that you see
|
||||
"Address: <some address>" and \fInot\fP "Relay: <some address>".
|
||||
First of all, verify that you are not connected via a relay. In the “Remote
|
||||
Devices” list on the right side of the GUI, double check that you see
|
||||
“Address: <some address>” and \fInot\fP “Relay: <some address>”.
|
||||
[image]
|
||||
.sp
|
||||
If you are connected via a relay, this is because a direct connection could
|
||||
@ -151,8 +151,8 @@ There is a certain amount of housekeeping that must be done to track the
|
||||
current and available versions of each file in the index database.
|
||||
.IP 4. 3
|
||||
By default Syncthing uses periodic scanning every hour when watching for
|
||||
changes or every minute if that\(aqs disabled to detect
|
||||
file changes. This means checking every file\(aqs modification time and
|
||||
changes or every minute if that’s disabled to detect
|
||||
file changes. This means checking every file’s modification time and
|
||||
comparing it to the database. This can cause spikes of CPU usage for large
|
||||
folders.
|
||||
.UNINDENT
|
||||
@ -169,16 +169,16 @@ 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
|
||||
Syncthing should use at any given moment. For example, \fBGOMAXPROCS=2\fP on a
|
||||
machine with four cores will limit Syncthing to no more than half the
|
||||
system\(aqs CPU power.
|
||||
system’s CPU power.
|
||||
.SH SHOULD I KEEP MY DEVICE IDS SECRET?
|
||||
.sp
|
||||
No. The IDs are not sensitive. Given a device ID it\(aqs possible to find the IP
|
||||
No. The IDs are not sensitive. Given a device ID it’s possible to find the IP
|
||||
address for that device, if global discovery is enabled on it. Knowing the device
|
||||
ID doesn\(aqt help you actually establish a connection to that device or get a list
|
||||
ID doesn’t help you actually establish a connection to that device or get a list
|
||||
of files, etc.
|
||||
.sp
|
||||
For a connection to be established, both devices need to know about the other\(aqs
|
||||
device ID. It\(aqs not possible (in practice) to forge a device ID. (To forge a
|
||||
For a connection to be established, both devices need to know about the other’s
|
||||
device ID. It’s not possible (in practice) to forge a device ID. (To forge a
|
||||
device ID you need to create a TLS certificate with that specific SHA\-256 hash.
|
||||
If you can do that, you can spoof any TLS certificate. The world is your
|
||||
oyster!)
|
||||
@ -205,14 +205,14 @@ device where it was deleted.
|
||||
Beware that the \fB<filename>.sync\-conflict\-<date>\-<time>\-<modifiedBy>.<ext>\fP files are
|
||||
treated as normal files after they are created, so they are propagated between
|
||||
devices. We do this because the conflict is detected and resolved on one device,
|
||||
creating the \fBsync\-conflict\fP file, but it\(aqs just as much of a conflict
|
||||
everywhere else and we don\(aqt know which of the conflicting files is the "best"
|
||||
creating the \fBsync\-conflict\fP file, but it’s just as much of a conflict
|
||||
everywhere else and we don’t know which of the conflicting files is the “best”
|
||||
from the user point of view.
|
||||
.SH HOW DO I SERVE A FOLDER FROM A READ ONLY FILESYSTEM?
|
||||
.sp
|
||||
Syncthing requires a "folder marker" to indicate that the folder is present
|
||||
Syncthing requires a “folder marker” to indicate that the folder is present
|
||||
and healthy. By default this is a directory called \fB\&.stfolder\fP that is
|
||||
created by Syncthing when the folder is added. If this folder can\(aqt be
|
||||
created by Syncthing when the folder is added. If this folder can’t be
|
||||
created (you are serving files from a CD or something) you can instead set
|
||||
the advanced config \fBMarker Name\fP to the name of some file or folder that
|
||||
you know will always exist in the folder.
|
||||
@ -225,11 +225,11 @@ Sharing a folder that is within an already shared folder is possible, but it has
|
||||
its caveats. What you must absolutely avoid are circular shares. This is just
|
||||
one example, there may be other undesired effects. Nesting shared folders is not
|
||||
supported, recommended or coded for, but it can be done successfully when you
|
||||
know what you\(aqre doing \- you have been warned.
|
||||
know what you’re doing \- you have been warned.
|
||||
.SH HOW DO I RENAME/MOVE A SYNCED FOLDER?
|
||||
.sp
|
||||
Syncthing doesn\(aqt have a direct way to do this, as it\(aqs potentially
|
||||
dangerous to do so if you\(aqre not careful \- it may result in data loss if
|
||||
Syncthing doesn’t have a direct way to do this, as it’s potentially
|
||||
dangerous to do so if you’re not careful \- it may result in data loss if
|
||||
something goes wrong during the move and is synchronized to your other
|
||||
devices.
|
||||
.sp
|
||||
@ -237,8 +237,8 @@ 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\(aqs best to do this when the folder is already in sync between your
|
||||
devices, as it is otherwise unpredictable which changes will "win" after the
|
||||
It’s best 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.
|
||||
.sp
|
||||
@ -252,7 +252,7 @@ to configure listening ports such that they do not overlap (see config).
|
||||
.SH DOES SYNCTHING SUPPORT SYNCING BETWEEN FOLDERS ON THE SAME SYSTEM?
|
||||
.sp
|
||||
No. Syncthing is not designed to sync locally and the overhead involved in
|
||||
doing so using Syncthing\(aqs method would be wasteful. There are better
|
||||
doing so using Syncthing’s method would be wasteful. There are better
|
||||
programs to achieve this such as rsync or Unison.
|
||||
.SH WHEN I DO HAVE TWO DISTINCT SYNCTHING-MANAGED FOLDERS ON TWO HOSTS, HOW DOES SYNCTHING HANDLE MOVING FILES BETWEEN THEM?
|
||||
.sp
|
||||
@ -289,7 +289,7 @@ The patterns in .stignore are glob patterns, where brackets are used to
|
||||
denote character ranges. That is, the pattern \fBq[abc]x\fP will match the
|
||||
files \fBqax\fP, \fBqbx\fP and \fBqcx\fP\&.
|
||||
.sp
|
||||
To match an actual file \fIcalled\fP \fBq[abc]x\fP the pattern needs to "escape"
|
||||
To match an actual file \fIcalled\fP \fBq[abc]x\fP the pattern needs to “escape”
|
||||
the brackets, like so: \fBq\e[abc\e]x\fP\&.
|
||||
.sp
|
||||
On Windows, escaping special characters is not supported as the \fB\e\fP
|
||||
@ -298,7 +298,7 @@ such as \fB[\fP and \fB?\fP are not allowed in file names on Windows.
|
||||
.SH WHY IS THE SETUP MORE COMPLICATED THAN BITTORRENT/RESILIO SYNC?
|
||||
.sp
|
||||
Security over convenience. In Syncthing you have to setup both sides to
|
||||
connect two devices. An attacker can\(aqt do much with a stolen device ID, because
|
||||
connect two devices. An attacker can’t do much with a stolen device ID, because
|
||||
you have to add the device on the other side too. You have better control
|
||||
where your files are transferred.
|
||||
.sp
|
||||
@ -354,7 +354,7 @@ $ ssh \-L 9090:127.0.0.1:8384 user@othercomputer.example.com
|
||||
will log you into othercomputer.example.com, and present the \fIremote\fP
|
||||
Syncthing GUI on \fI\%http://localhost:9090\fP on your \fIlocal\fP computer.
|
||||
.sp
|
||||
If you only want to access the remote gui and don\(aqt want the terminal
|
||||
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
|
||||
@ -379,7 +379,7 @@ Another Windows way to run ssh is to install gow.
|
||||
.sp
|
||||
The easiest way to install gow is with chocolatey.
|
||||
\fI\%https://chocolatey.org/\fP
|
||||
.SH WHY DO I GET "HOST CHECK ERROR" IN THE GUI/API?
|
||||
.SH WHY DO I GET “HOST CHECK ERROR” IN THE GUI/API?
|
||||
.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.
|
||||
@ -404,8 +404,8 @@ Bind the GUI/API to a non\-localhost listen port.
|
||||
In all cases, username/password authentication and HTTPS should be used.
|
||||
.SH MY SYNCTHING DATABASE IS CORRUPT
|
||||
.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 <\fBhttps://docs.syncthing.net/users/config.html#description\fP> inside Syncthing\(aqs home 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.
|
||||
.SH I DON'T LIKE THE GUI OR THE THEME. CAN IT BE CHANGED?
|
||||
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 <\fBhttps://docs.syncthing.net/users/config.html#description\fP> inside Syncthing’s home 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.
|
||||
.SH 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
|
||||
than the default.
|
||||
@ -416,7 +416,7 @@ 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,
|
||||
including the "GUI override directory".
|
||||
including the “GUI override directory”.
|
||||
.sp
|
||||
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.
|
||||
@ -433,7 +433,7 @@ crashes and other bugs.
|
||||
.SH WHERE DO SYNCTHING LOGS GO TO?
|
||||
.sp
|
||||
Syncthing logs to stdout by default. On Windows Syncthing by default also
|
||||
creates \fBsyncthing.log\fP in Syncthing\(aqs home directory (run \fBsyncthing
|
||||
creates \fBsyncthing.log\fP in Syncthing’s home directory (run \fBsyncthing
|
||||
\-paths\fP to see where that is). Command line option \fB\-logfile\fP can be used
|
||||
to specify a user\-defined logfile.
|
||||
.SH HOW CAN I VIEW THE HISTORY OF CHANGES?
|
||||
@ -460,7 +460,7 @@ it initiates the conflict resolution procedure, which in the end results in a co
|
||||
up\-to\-date state with all the neighbours.
|
||||
.SH HOW DO I UPGRADE SYNCTHING?
|
||||
.sp
|
||||
If you use a package manager such as Debian\(aqs apt\-get, you should upgrade
|
||||
If you use a package manager such as Debian’s apt\-get, you should upgrade
|
||||
using the package manager. If you use the binary packages linked from
|
||||
Syncthing.net, you can use Syncthing built in automatic upgrades.
|
||||
.INDENT 0.0
|
||||
@ -488,14 +488,14 @@ version. We suggest to use the GitHub API at
|
||||
the JSON response.
|
||||
.SH HOW DO I RUN SYNCTHING AS A DAEMON PROCESS ON LINUX?
|
||||
.sp
|
||||
If you\(aqre using systemd, runit, or upstart, we already ship examples, check
|
||||
If you’re using systemd, runit, or upstart, we already ship examples, check
|
||||
\fI\%https://github.com/syncthing/syncthing/tree/master/etc\fP for example
|
||||
configurations.
|
||||
.sp
|
||||
If however you\(aqre 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\(aqs the name
|
||||
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
|
||||
of the command, not the package), look into the local documentation for that, it
|
||||
will almost certainly cover 100% of what you want to do. If you don\(aqt have
|
||||
will almost certainly cover 100% of what you want to do. If you don’t have
|
||||
\fBstart\-stop\-daemon\fP, there are a bunch of other software packages you could use
|
||||
to do this. The most well known is called daemontools, and can be found in the
|
||||
standard package repositories for almost every modern Linux distribution.
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
.\" Man page generated from reStructuredText.
|
||||
.
|
||||
.TH "SYNCTHING-GLOBALDISCO" "7" "Mar 05, 2019" "v1" "Syncthing"
|
||||
.TH "SYNCTHING-GLOBALDISCO" "7" "Mar 22, 2019" "v1" "Syncthing"
|
||||
.SH NAME
|
||||
syncthing-globaldisco \- Global Discovery Protocol v3
|
||||
.
|
||||
@ -34,7 +34,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.sp
|
||||
A device should announce itself at startup. It does this by an HTTPS POST to
|
||||
the announce server URL. Standard discovery currently requires the path to be
|
||||
"/v2/", yet this can be up to the discovery server. The POST has a JSON payload
|
||||
“/v2/”, yet this can be up to the discovery server. The POST has a JSON payload
|
||||
listing connection addresses (if any):
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
@ -49,9 +49,9 @@ listing connection addresses (if any):
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
It\(aqs OK for the "addresses" field to be either the empty list (\fB[]\fP),
|
||||
It’s OK for the “addresses” field to be either the empty list (\fB[]\fP),
|
||||
\fBnull\fP, or missing entirely. An announcement with the field missing
|
||||
or empty is however not useful...
|
||||
or empty is however not useful…
|
||||
.sp
|
||||
Any empty or unspecified IP addresses (i.e. addresses like \fBtcp://:22000\fP,
|
||||
\fBtcp://0.0.0.0:22000\fP, \fBtcp://[::]:22000\fP) are interpreted as referring to
|
||||
@ -63,7 +63,7 @@ authentication. The device ID is deduced from the presented certificate.
|
||||
.sp
|
||||
The server response is empty, with code \fB204\fP (No Content) on success. If no
|
||||
certificate was presented, status \fB403\fP (Forbidden) is returned. If the
|
||||
posted data doesn\(aqt conform to the expected format, \fB400\fP (Bad Request) is
|
||||
posted data doesn’t conform to the expected format, \fB400\fP (Bad Request) is
|
||||
returned.
|
||||
.sp
|
||||
In successful responses, the server may return a \fBReannounce\-After\fP header
|
||||
@ -80,14 +80,14 @@ Many Requests).
|
||||
.SH QUERIES
|
||||
.sp
|
||||
Queries are performed as HTTPS GET requests to the announce server URL. The
|
||||
requested device ID is passed as the query parameter "device", in canonical
|
||||
requested device ID is passed as the query parameter “device”, in canonical
|
||||
string form, i.e. \fBhttps://discovery.syncthing.net/?device=ABC12345\-....\fP
|
||||
.sp
|
||||
Successful responses will have status code \fB200\fP (OK) and carry a JSON payload
|
||||
of the same format as the announcement above. The response will not contain
|
||||
empty or unspecified addresses.
|
||||
.sp
|
||||
If the "device" query parameter is missing or malformed, the status code 400
|
||||
If the “device” query parameter is missing or malformed, the status code 400
|
||||
(Bad Request) is returned.
|
||||
.sp
|
||||
If the device ID is of a valid format but not found in the registry, 404 (Not
|
||||
@ -109,9 +109,9 @@ signed certificate, Syncthing often runs in environments with outdated or
|
||||
simply nonexistent root CA bundles. Instead, Syncthing can verify the
|
||||
discovery server certificate fingerprint using the device ID mechanism. This
|
||||
is certificate pinning and conveyed in the Syncthing configuration as a
|
||||
synthetic "id" parameter on the discovery server URL:
|
||||
\fBhttps://discovery.syncthing.net/?id=...\fP\&. The "id" parameter is not, in
|
||||
fact, sent to the discovery server \- it\(aqs used by Syncthing itself to know
|
||||
synthetic “id” parameter on the discovery server URL:
|
||||
\fBhttps://discovery.syncthing.net/?id=...\fP\&. The “id” parameter is not, in
|
||||
fact, sent to the discovery server \- it’s used by Syncthing itself to know
|
||||
which certificate to expect on the server side.
|
||||
.sp
|
||||
The public discovery network uses this authentication mechanism instead of
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
.\" Man page generated from reStructuredText.
|
||||
.
|
||||
.TH "SYNCTHING-LOCALDISCO" "7" "Mar 05, 2019" "v1" "Syncthing"
|
||||
.TH "SYNCTHING-LOCALDISCO" "7" "Mar 22, 2019" "v1" "Syncthing"
|
||||
.SH NAME
|
||||
syncthing-localdisco \- Local Discovery Protocol v4
|
||||
.
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
.\" Man page generated from reStructuredText.
|
||||
.
|
||||
.TH "SYNCTHING-NETWORKING" "7" "Mar 05, 2019" "v1" "Syncthing"
|
||||
.TH "SYNCTHING-NETWORKING" "7" "Mar 22, 2019" "v1" "Syncthing"
|
||||
.SH NAME
|
||||
syncthing-networking \- Firewall Setup
|
||||
.
|
||||
@ -72,7 +72,7 @@ Port \fB21027/UDP\fP (for discovery broadcasts on IPv4 and multicasts on IPv6)
|
||||
.UNINDENT
|
||||
.SS Uncomplicated Firewall (ufw)
|
||||
.sp
|
||||
If you\(aqre 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 \fI\%Syncthing package\fP <\fBhttps://apt.syncthing.net/\fP>, you can allow the necessary ports by running:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
.\" Man page generated from reStructuredText.
|
||||
.
|
||||
.TH "SYNCTHING-RELAY" "7" "Mar 05, 2019" "v1" "Syncthing"
|
||||
.TH "SYNCTHING-RELAY" "7" "Mar 22, 2019" "v1" "Syncthing"
|
||||
.SH NAME
|
||||
syncthing-relay \- Relay Protocol v1
|
||||
.
|
||||
@ -37,7 +37,7 @@ connect to each other directly otherwise. This is usually due to both devices
|
||||
being behind a NAT and neither side being able to open a port which would
|
||||
be directly accessible from the internet.
|
||||
.sp
|
||||
A relay was designed to relay BEP protocol, hence the reliance on device ID\(aqs
|
||||
A relay was designed to relay BEP protocol, hence the reliance on device ID’s
|
||||
in the protocol spec, but at the same time it is general enough that could be
|
||||
reused by other protocols or applications, as the data transferred between two
|
||||
devices which use a relay is completely obscure and does not affect the
|
||||
@ -92,14 +92,14 @@ exists.
|
||||
After the client has joined, no more messages are exchanged apart from
|
||||
Ping/Pong messages for general connection keep alive checking.
|
||||
.sp
|
||||
From this point onwards, the client stand\-by\(aqs and waits for SessionInvitation
|
||||
From this point onwards, the client stand\-by’s and waits for SessionInvitation
|
||||
messages from the relay, which implies that some other device is trying to
|
||||
connect with you. SessionInvitation message contains the unique session key
|
||||
which then can be used to establish a connection in session mode.
|
||||
.sp
|
||||
If the client fails to send a JoinRelayRequest message within the first ping
|
||||
interval, the connection is terminated.
|
||||
If the client fails to send a message (even if it\(aqs a ping message) every minute
|
||||
If the client fails to send a message (even if it’s a ping message) every minute
|
||||
(by default), the connection is terminated.
|
||||
.SS Temporary protocol submode
|
||||
.sp
|
||||
@ -574,7 +574,7 @@ identify which session you are trying to connect to.
|
||||
.B : Address
|
||||
An optional IP address on which the relay server is expecting you to
|
||||
connect, in order to start a connection in session mode.
|
||||
Empty/all zero IP should be replaced with the relay\(aqs public IP address that
|
||||
Empty/all zero IP should be replaced with the relay’s public IP address that
|
||||
was used when establishing the protocol mode connection.
|
||||
.TP
|
||||
.B : Port
|
||||
@ -585,14 +585,14 @@ in order to start a connection in session mode.
|
||||
Because both sides connecting to the relay use the client side of the socket,
|
||||
and some protocols behave differently depending if the connection starts on
|
||||
the server side or the client side, this boolean indicates which side of the
|
||||
connection this client should assume it\(aqs getting. The value is inverted in
|
||||
connection this client should assume it’s getting. The value is inverted in
|
||||
the invitation which is sent to the other device, so that there is always
|
||||
one client socket, and one server socket.
|
||||
.UNINDENT
|
||||
.SH HOW SYNCTHING USES RELAYS, AND GENERAL SECURITY
|
||||
.sp
|
||||
In the case of Syncthing and BEP, when two devices connect via relay, they
|
||||
start their standard TLS connection encapsulated within the relay\(aqs plain\-text
|
||||
start their standard TLS connection encapsulated within the relay’s plain\-text
|
||||
session connection, effectively upgrading the plain\-text connection to a TLS
|
||||
connection.
|
||||
.sp
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
.\" Man page generated from reStructuredText.
|
||||
.
|
||||
.TH "SYNCTHING-REST-API" "7" "Mar 05, 2019" "v1" "Syncthing"
|
||||
.TH "SYNCTHING-REST-API" "7" "Mar 22, 2019" "v1" "Syncthing"
|
||||
.SH NAME
|
||||
syncthing-rest-api \- REST API
|
||||
.
|
||||
@ -47,7 +47,7 @@ with \fBcurl\fP\&.
|
||||
.SS GET /rest/system/browse
|
||||
.sp
|
||||
Returns a list of directories matching the path given by the optional parameter
|
||||
\fBcurrent\fP\&. The path can use \fI\%patterns as described in Go\(aqs filepath package\fP <\fBhttps://golang.org/pkg/path/filepath/#Match\fP>\&. A \(aq*\(aq will always be appended
|
||||
\fBcurrent\fP\&. The path can use \fI\%patterns as described in Go’s filepath package\fP <\fBhttps://golang.org/pkg/path/filepath/#Match\fP>\&. A ‘*’ will always be appended
|
||||
to the given path (e.g. \fB/tmp/\fP matches all its subdirectories). If the option
|
||||
\fBcurrent\fP is not given, filesystem root paths are returned.
|
||||
.INDENT 0.0
|
||||
@ -904,8 +904,8 @@ curl \-X POST \-H X\-API\-Key:... http://127.0.0.1:8384/rest/db/revert?folder=de
|
||||
Request immediate scan. Takes the optional parameters \fBfolder\fP (folder ID),
|
||||
\fBsub\fP (path relative to the folder root) and \fBnext\fP (time in seconds). If
|
||||
\fBfolder\fP is omitted or empty all folders are scanned. If \fBsub\fP is given,
|
||||
only this path (and children, in case it\(aqs a directory) is scanned. The \fBnext\fP
|
||||
argument delays Syncthing\(aqs automated rescan interval for a given amount of
|
||||
only this path (and children, in case it’s a directory) is scanned. The \fBnext\fP
|
||||
argument delays Syncthing’s automated rescan interval for a given amount of
|
||||
seconds.
|
||||
.sp
|
||||
Requesting scan of a path that no longer exists, but previously did, is
|
||||
@ -980,7 +980,7 @@ Data in the cluster latest version.
|
||||
Data that is locally the same as the cluster latest version.
|
||||
.TP
|
||||
.B local*:
|
||||
Data that is locally present, regardless of whether it\(aqs the same or different version as the cluster latest version.
|
||||
Data that is locally present, regardless of whether it’s the same or different version as the cluster latest version.
|
||||
.TP
|
||||
.B need*:
|
||||
Data that is needed to become up to date with the cluster latest version (i.e., data that is out of sync).
|
||||
@ -1023,7 +1023,7 @@ only the desired event types, add a parameter
|
||||
\fBevents=EventTypeA,EventTypeB,...\fP where the event types are any of the event\-types\&.
|
||||
.sp
|
||||
The optional parameter \fBsince=<lastSeenID>\fP sets the ID of the last event
|
||||
you\(aqve already seen. Syncthing returns a JSON encoded array of event objects,
|
||||
you’ve already seen. Syncthing returns a JSON encoded array of event objects,
|
||||
starting at the event just after the one with this last seen ID. The default
|
||||
value is 0, which returns all events. There is a limit to the number of events
|
||||
buffered, so if the rate of events is high or the time between polling calls is
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
.\" Man page generated from reStructuredText.
|
||||
.
|
||||
.TH "SYNCTHING-SECURITY" "7" "Mar 05, 2019" "v1" "Syncthing"
|
||||
.TH "SYNCTHING-SECURITY" "7" "Mar 22, 2019" "v1" "Syncthing"
|
||||
.SH NAME
|
||||
syncthing-security \- Security Principles
|
||||
.
|
||||
@ -92,7 +92,7 @@ Automatic upgrades default to \fBon\fP (unless Syncthing was compiled with
|
||||
upgrades disabled).
|
||||
.sp
|
||||
Even when automatic upgrades are disabled in the configuration, an upgrade check
|
||||
as above is done when the GUI is loaded, in order to show the "Upgrade to ..."
|
||||
as above is done when the GUI is loaded, in order to show the “Upgrade to …”
|
||||
button when necessary. This can be disabled only by compiling Syncthing with
|
||||
upgrades disabled.
|
||||
.sp
|
||||
@ -106,7 +106,7 @@ information about the user or device.
|
||||
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
|
||||
be seen behind the "Preview" link in settings. Usage reporting defaults to
|
||||
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.
|
||||
.sp
|
||||
@ -130,13 +130,13 @@ case.
|
||||
.sp
|
||||
When relaying is enabled, Syncthing will look up the pool of public relays
|
||||
and establish a connection to one of them (the best, based on an internal
|
||||
heuristic). The selected relay server will learn the connecting device\(aqs
|
||||
heuristic). The selected relay server will learn the connecting device’s
|
||||
device ID. Relay servers can be run by \fBanyone in the general public\fP\&.
|
||||
Relaying defaults to \fBon\fP\&. Syncthing can be configured to disable
|
||||
relaying, or only use specific relays.
|
||||
.sp
|
||||
If a relay connections is required between two devices, the relay will learn
|
||||
the other device\(aqs device ID as well.
|
||||
the other device’s device ID as well.
|
||||
.sp
|
||||
Any data exchanged between the two devices is encrypted as usual and not
|
||||
subject to inspection by the relay.
|
||||
@ -161,7 +161,7 @@ synced files. Here are some general principles to protect your files:
|
||||
If a device of yours is lost, make sure to revoke its access from your other
|
||||
devices.
|
||||
.IP 2. 3
|
||||
If you\(aqre syncing confidential data on an encrypted disk to guard against
|
||||
If you’re syncing confidential data on an encrypted disk to guard against
|
||||
device theft, put the Syncthing config folder on the same encrypted disk to
|
||||
avoid leaking keys and metadata. Or, use whole disk encryption.
|
||||
.UNINDENT
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
.\" Man page generated from reStructuredText.
|
||||
.
|
||||
.TH "SYNCTHING-STIGNORE" "5" "Mar 05, 2019" "v1" "Syncthing"
|
||||
.TH "SYNCTHING-STIGNORE" "5" "Mar 22, 2019" "v1" "Syncthing"
|
||||
.SH NAME
|
||||
syncthing-stignore \- Prevent files from being synchronized to other nodes
|
||||
.
|
||||
@ -113,8 +113,8 @@ Windows does not support escaping \fB\e[foo \- bar\e]\fP\&.
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
Prefixes can be specified in any order (e.g. "(?d)(?i)"), but cannot be in a
|
||||
single pair of parentheses (not "(?di)").
|
||||
Prefixes can be specified in any order (e.g. “(?d)(?i)”), but cannot be in a
|
||||
single pair of parentheses (not “(?di)”).
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH EXAMPLE
|
||||
@ -160,8 +160,8 @@ qu*
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
all files and directories called "foo", ending in a "2" or starting with
|
||||
"qu" will be ignored. The end result becomes:
|
||||
all files and directories called “foo”, ending in a “2” or starting with
|
||||
“qu” will be ignored. The end result becomes:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
@ -193,24 +193,24 @@ directory itself. If you want the pattern to match the directory and its
|
||||
content, make sure it does not have a \fB/\fP at the end of the pattern.
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SH EFFECTS ON "IN SYNC" STATUS
|
||||
.SH EFFECTS ON “IN SYNC” STATUS
|
||||
.sp
|
||||
Currently the effects on who is in sync with what can be a bit confusing
|
||||
when using ignore patterns. This should be cleared up in a future
|
||||
version...
|
||||
version…
|
||||
.sp
|
||||
Assume two devices, Alice and Bob, where Alice has 100 files to share, but
|
||||
Bob ignores 25 of these. From Alice\(aqs point of view Bob will become
|
||||
Bob ignores 25 of these. From Alice’s point of view Bob will become
|
||||
about 75% in sync (the actual number depends on the sizes of the
|
||||
individual files) and remain in "Syncing" state even though it is in
|
||||
fact not syncing anything (\fI\%issue #623\fP <\fBhttps://github.com/syncthing/syncthing/issues/623\fP>). From Bob\(aqs point of view, it\(aqs
|
||||
individual files) and remain in “Syncing” state even though it is in
|
||||
fact not syncing anything (\fI\%issue #623\fP <\fBhttps://github.com/syncthing/syncthing/issues/623\fP>). From Bob’s point of view, it’s
|
||||
100% up to date but will show fewer files in both the local and global
|
||||
view.
|
||||
.sp
|
||||
If Bob adds files that have already been synced to the ignore list, they
|
||||
will remain in the "global" view but disappear from the "local" view.
|
||||
will remain in the “global” view but disappear from the “local” view.
|
||||
The end result is more files in the global folder than in the local,
|
||||
but still 100% in sync (\fI\%issue #624\fP <\fBhttps://github.com/syncthing/syncthing/issues/624\fP>). From Alice\(aqs point of view, Bob
|
||||
but still 100% in sync (\fI\%issue #624\fP <\fBhttps://github.com/syncthing/syncthing/issues/624\fP>). From Alice’s point of view, Bob
|
||||
will remain 100% in sync until the next reconnect, because Bob has
|
||||
already announced that he has the files that are now suddenly ignored.
|
||||
.SH AUTHOR
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
.\" Man page generated from reStructuredText.
|
||||
.
|
||||
.TH "SYNCTHING-VERSIONING" "7" "Mar 05, 2019" "v1" "Syncthing"
|
||||
.TH "SYNCTHING-VERSIONING" "7" "Mar 22, 2019" "v1" "Syncthing"
|
||||
.SH NAME
|
||||
syncthing-versioning \- Keep automatic backups of deleted files by other nodes
|
||||
.
|
||||
@ -32,13 +32,13 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
..
|
||||
.sp
|
||||
Syncthing supports archiving the old version of a file when it is deleted or
|
||||
replaced with a newer version from the cluster. This is called "file
|
||||
versioning" and uses one of the available \fIversioning strategies\fP described
|
||||
replaced with a newer version from the cluster. This is called “file
|
||||
versioning” and uses one of the available \fIversioning strategies\fP described
|
||||
below. File versioning is configured per folder, on a per\-device basis, and
|
||||
defaults to "no file versioning", i.e. no old copies of files are kept.
|
||||
defaults to “no file versioning”, i.e. no old copies of files are kept.
|
||||
.SH TRASH CAN FILE VERSIONING
|
||||
.sp
|
||||
This versioning strategy emulates the common "trash can" approach. When a file
|
||||
This versioning strategy emulates the common “trash can” approach. When a file
|
||||
is deleted or replaced due to a change on a remote device, it is a moved to
|
||||
the trash can in the \fB\&.stversions\fP folder. If a file with the same name was
|
||||
already in the trash can it is replaced.
|
||||
@ -50,26 +50,26 @@ this to zero prevents any files from being removed from the trash can
|
||||
automatically.
|
||||
.SH SIMPLE FILE VERSIONING
|
||||
.sp
|
||||
With "Simple File Versioning" files are moved to the \fB\&.stversions\fP folder
|
||||
With “Simple File Versioning” files are moved to the \fB\&.stversions\fP folder
|
||||
(inside your shared folder) when replaced or deleted on a remote device. This
|
||||
option also takes a value in an input titled "Keep Versions" which tells
|
||||
option also takes a value in an input titled “Keep Versions” which tells
|
||||
Syncthing how many old versions of the file it should keep. For example, if
|
||||
you set this value to 5, if a file is replaced 5 times on a remote device, you
|
||||
will see 5 time\-stamped versions on that file in the ".stversions" folder on
|
||||
will see 5 time\-stamped versions on that file in the “.stversions” folder on
|
||||
the other devices sharing the same folder.
|
||||
.SH STAGGERED FILE VERSIONING
|
||||
.sp
|
||||
With "Staggered File Versioning" files are also moved to a different folder
|
||||
when replaced or deleted on a remote device (just like "Simple File
|
||||
Versioning"), however, versions are automatically deleted if they are older
|
||||
With “Staggered File Versioning” files are also moved to a different folder
|
||||
when replaced or deleted on a remote device (just like “Simple File
|
||||
Versioning”), however, versions are automatically deleted if they are older
|
||||
than the maximum age or exceed the number of files allowed in an interval.
|
||||
.sp
|
||||
With this versioning method it\(aqs possible to specify where the versions are
|
||||
With this versioning method it’s possible to specify where the versions are
|
||||
stored, with the default being the \fB\&.stversions\fP folder inside the normal
|
||||
folder path. If you set a custom version path, please ensure that it\(aqs on the
|
||||
folder path. If you set a custom version path, please ensure that it’s on the
|
||||
same partition or filesystem as the regular folder path, as moving files there
|
||||
may otherwise fail. You can use an absolute path (this is recommended) or a
|
||||
relative path. Relative paths are interpreted relative to Syncthing\(aqs current
|
||||
relative path. Relative paths are interpreted relative to Syncthing’s current
|
||||
or startup directory.
|
||||
.sp
|
||||
The following intervals are used and they each have a maximum number of files
|
||||
@ -90,7 +90,7 @@ Until maximum age, the most recent version is kept every week.
|
||||
.TP
|
||||
.B Maximum Age
|
||||
The maximum time to keep a version in days. For example, to keep replaced or
|
||||
deleted files in the ".stversions" folder for an entire year, use 365. If
|
||||
deleted files in the “.stversions” folder for an entire year, use 365. If
|
||||
only for 10 days, use 10.
|
||||
\fBNote: Set to 0 to keep versions forever.\fP
|
||||
.UNINDENT
|
||||
@ -111,7 +111,7 @@ Path to the file within the folder
|
||||
.SS Example for Unixes
|
||||
.sp
|
||||
Lets say I want to keep the latest version of each file as they are replaced
|
||||
or removed; essentially I want a "trash can"\-like behavior. For this, I create
|
||||
or removed; essentially I want a “trash can”\-like behavior. For this, I create
|
||||
the following script and store it as \fB/Users/jb/bin/onlylatest.sh\fP (i.e. the
|
||||
\fBbin\fP directory in my home directory):
|
||||
.INDENT 0.0
|
||||
@ -142,7 +142,7 @@ mv \-f "$folderpath/$filepath" "$versionspath/$filepath"
|
||||
I must ensure that the script has execute permissions (\fBchmod 755
|
||||
onlylatest.sh\fP), then configure Syncthing with command \fB/Users/jb/bin/onlylatest.sh %FOLDER_PATH% %FILE_PATH%\fP
|
||||
.sp
|
||||
Lets assume I have a folder "default" in ~/Sync, and that within that folder
|
||||
Lets assume I have a folder “default” in ~/Sync, and that within that folder
|
||||
there is a file \fBdocs/letter.txt\fP that is being replaced or deleted. The
|
||||
script will be called as if I ran this from the command line:
|
||||
.INDENT 0.0
|
||||
@ -161,7 +161,7 @@ The script will then move the file in question to
|
||||
that may already have been there.
|
||||
.SS Example for Windows
|
||||
.sp
|
||||
On Windows we can use a batch script to perform the same "trash can"\-like
|
||||
On Windows we can use a batch script to perform the same “trash can”\-like
|
||||
behavior as mentioned above. I created the following script and saved it as
|
||||
\fBC:\eUsers\emfrnd\eScripts\eonlylatest.bat\fP\&.
|
||||
.INDENT 0.0
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
.\" Man page generated from reStructuredText.
|
||||
.
|
||||
.TH "SYNCTHING" "1" "Mar 05, 2019" "v1" "Syncthing"
|
||||
.TH "SYNCTHING" "1" "Mar 22, 2019" "v1" "Syncthing"
|
||||
.SH NAME
|
||||
syncthing \- Syncthing
|
||||
.
|
||||
@ -218,7 +218,7 @@ Syncthing can use a SOCKS, HTTP, or HTTPS proxy to talk to the outside
|
||||
world. The proxy is used for outgoing connections only \- it is not possible
|
||||
to accept incoming connections through the proxy. The proxy is configured
|
||||
through the environment variable \fBall_proxy\fP\&. Somewhat unusually, this
|
||||
variable must be named in lower case \- it is not "ALL_PROXY". For
|
||||
variable must be named in lower case \- it is not “ALL_PROXY”. For
|
||||
example:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
@ -232,7 +232,7 @@ $ export all_proxy=socks://192.0.2.42:8081
|
||||
.UNINDENT
|
||||
.SH DEVELOPMENT SETTINGS
|
||||
.sp
|
||||
The following environment variables modify Syncthing\(aqs behavior in ways that
|
||||
The following environment variables modify Syncthing’s behavior in ways that
|
||||
are mostly useful for developers. Use with care.
|
||||
If you start Syncthing from within service managers like systemd or supervisor,
|
||||
path expansion may not be supported.
|
||||
@ -354,7 +354,7 @@ developing webgui, commonly use \fBSTGUIASSETS=gui bin/syncthing\fP\&.
|
||||
.TP
|
||||
.B STHASHING
|
||||
Specify which hashing package to use. Defaults to automatic based on
|
||||
performance. Specify "minio" (compatibility) or "standard" for the default
|
||||
performance. Specify “minio” (compatibility) or “standard” for the default
|
||||
Go implementation.
|
||||
.TP
|
||||
.B STHEAPPROFILE
|
||||
@ -362,7 +362,7 @@ Write heap profiles to \fBheap\-$pid\-$timestamp.pprof\fP each time heap usage
|
||||
increases.
|
||||
.TP
|
||||
.B STNODEFAULTFOLDER
|
||||
Don\(aqt create a default folder when starting for the first time. This
|
||||
Don’t create a default folder when starting for the first time. This
|
||||
variable will be ignored anytime after the first run.
|
||||
.TP
|
||||
.B STNORESTART
|
||||
@ -374,7 +374,7 @@ crashes and also log file writing (stdout is still written).
|
||||
Disable automatic upgrades.
|
||||
.TP
|
||||
.B STPROFILER
|
||||
Set to a listen address such as "127.0.0.1:9090" to start the profiler with
|
||||
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
|
||||
information.
|
||||
@ -384,8 +384,8 @@ Write running performance statistics to \fBperf\-$pid.csv\fP\&. Not supported on
|
||||
Windows.
|
||||
.TP
|
||||
.B STRECHECKDBEVERY
|
||||
Time before folder statistics (file, dir, ... counts) are recalculated from
|
||||
scratch. The given duration must be parseable by GO\(aqs time.ParseDuration. If
|
||||
Time before folder statistics (file, dir, … counts) are recalculated from
|
||||
scratch. The given duration must be parseable by GO’s time.ParseDuration. If
|
||||
missing or not parseable, the default value of 1 month is used. To force
|
||||
recalculation on every startup, set it to \fB0\fP\&.
|
||||
.TP
|
||||
|
||||
Loading…
Reference in New Issue
Block a user