271 lines
7.7 KiB
Groff
271 lines
7.7 KiB
Groff
.\" Man page generated from reStructuredText.
|
|
.
|
|
.TH "SYNCTHING-CONFIG" "5" "May 30, 2015" "v0.11" "Syncthing"
|
|
.SH NAME
|
|
syncthing-config \- Syncthing Configuration
|
|
.
|
|
.nr rst2man-indent-level 0
|
|
.
|
|
.de1 rstReportMargin
|
|
\\$1 \\n[an-margin]
|
|
level \\n[rst2man-indent-level]
|
|
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
-
|
|
\\n[rst2man-indent0]
|
|
\\n[rst2man-indent1]
|
|
\\n[rst2man-indent2]
|
|
..
|
|
.de1 INDENT
|
|
.\" .rstReportMargin pre:
|
|
. RS \\$1
|
|
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
|
|
. nr rst2man-indent-level +1
|
|
.\" .rstReportMargin post:
|
|
..
|
|
.de UNINDENT
|
|
. RE
|
|
.\" indent \\n[an-margin]
|
|
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
.nr rst2man-indent-level -1
|
|
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
|
..
|
|
.sp
|
|
\fBWARNING:\fP
|
|
.INDENT 0.0
|
|
.INDENT 3.5
|
|
This page may be outdated and requires review.
|
|
Attributes have been added that are not documented.
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.SH SYNOPSIS
|
|
.INDENT 0.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
$HOME/.config/syncthing/config.xml
|
|
$HOME/Library/Application Support/Syncthing
|
|
%AppData%/Syncthing
|
|
%localappdata%/Syncthing
|
|
.ft P
|
|
.fi
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.SH DESCRIPTION
|
|
.sp
|
|
Syncthing uses a single directory to store configuration, crypto keys
|
|
and index caches. The location defaults to \fB$HOME/.config/syncthing\fP
|
|
(Unix\-like), \fB$HOME/Library/Application Support/Syncthing\fP (Mac),
|
|
\fB%AppData%/Syncthing\fP (Windows XP) or \fB%localappdata%/Syncthing\fP
|
|
(Windows 7/8). It can be changed at runtime using the \fB\-home\fP flag. In this
|
|
directory the following files are located:
|
|
.INDENT 0.0
|
|
.TP
|
|
.B cert.pem
|
|
The device\(aqs RSA public key, named "cert" for legacy reasons.
|
|
.TP
|
|
.B key.pem
|
|
The device\(aqs RSA private key. This needs to be protected.
|
|
.TP
|
|
.B config.xml
|
|
The configuration file, in XML format.
|
|
.TP
|
|
.B https\-cert.pem
|
|
The certificate for HTTPS GUI connections.
|
|
.TP
|
|
.B https\-key.pem
|
|
The key for HTTPS GUI connections.
|
|
.TP
|
|
.B index/
|
|
A directory holding the database with metadata and hashes of the files
|
|
currently on disk and available from peers.
|
|
.TP
|
|
.B csrftokens.txt
|
|
A list of recently issued CSRF tokens (for protection against browser cross
|
|
site request forgery).
|
|
.UNINDENT
|
|
.SH CONFIG FILE FORMAT
|
|
.sp
|
|
The following is shows the default configuration file:
|
|
.INDENT 0.0
|
|
.INDENT 3.5
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
<configuration version="2">
|
|
<folder id="default" directory="/Users/jb/Sync" ro="false" ignorePerms="false">
|
|
<device id="GXN5ECCWTA2B7EB5FXYL5OWGOADX5EF5VNJAQSIBAY6XHJ24BNOA"></device>
|
|
</folder>
|
|
<device id="GXN5ECCWTA2B7EB5FXYL5OWGOADX5EF5VNJAQSIBAY6XHJ24BNOA" name="jborg\-mbp">
|
|
<address>dynamic</address>
|
|
</device>
|
|
<gui enabled="true" tls="true">
|
|
<address>127.0.0.1:54096</address>
|
|
<user>jb</user>
|
|
<password>$2a$10$EKaTIcpz2...</password>
|
|
<apikey>O80CDOJ9LVUVCMHFK2OJDO4T882735</apikey>
|
|
</gui>
|
|
<options>
|
|
<listenAddress>:54097</listenAddress>
|
|
<globalAnnounceServer>announce.syncthing.net:22025</globalAnnounceServer>
|
|
<globalAnnounceEnabled>true</globalAnnounceEnabled>
|
|
<localAnnounceEnabled>true</localAnnounceEnabled>
|
|
<parallelRequests>16</parallelRequests>
|
|
<maxSendKbps>0</maxSendKbps>
|
|
<rescanIntervalS>60</rescanIntervalS>
|
|
<reconnectionIntervalS>60</reconnectionIntervalS>
|
|
<maxChangeKbps>10000</maxChangeKbps>
|
|
<startBrowser>true</startBrowser>
|
|
<upnpEnabled>true</upnpEnabled>
|
|
<urAccepted>0</urAccepted>
|
|
</options>
|
|
</configuration>
|
|
.ft P
|
|
.fi
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.SS configuration
|
|
.sp
|
|
This is the root element.
|
|
.INDENT 0.0
|
|
.TP
|
|
.B version
|
|
The config version. The current version is \fB2\fP\&.
|
|
.UNINDENT
|
|
.SS folder
|
|
.sp
|
|
One or more \fBfolder\fP elements must be present in the file. Each
|
|
element describes one folder.
|
|
.sp
|
|
Within the \fBfolder\fP element one or more \fBdevice\fP element should be
|
|
present. These must contain the \fBid\fP attribute and nothing else.
|
|
Mentioned devices are those that will be sharing the folder in question.
|
|
Each mentioned device must have a separate \fBdevice\fP element later in
|
|
the file. It is customary that the local device ID is included in all
|
|
repositories. Syncthing will currently add this automatically if it is
|
|
not present in the configuration file.
|
|
.INDENT 0.0
|
|
.TP
|
|
.B id
|
|
The folder ID, must be unique. (mandatory)
|
|
.TP
|
|
.B directory
|
|
The directory where the folder is stored on this
|
|
device; not sent to other devices. (mandatory)
|
|
.TP
|
|
.B ro
|
|
True if the folder is read only (will not be modified by Syncthing) on this
|
|
device. (optional, defaults to \fBfalse\fP)
|
|
.TP
|
|
.B ignorePerms
|
|
True if the folder should \fI\%ignore permissions\fP <\fBhttp://forum.syncthing.net/t/263\fP>\&.
|
|
.UNINDENT
|
|
.SS device
|
|
.sp
|
|
One or more \fBdevice\fP elements must be present in the file. Each
|
|
element describes a device participating in the cluster. It is customary
|
|
to include a \fBdevice\fP element for the local device; Syncthing will
|
|
currently add one if it is not present.
|
|
.INDENT 0.0
|
|
.TP
|
|
.B id
|
|
The device ID. This must be written in canonical form, that is without any
|
|
spaces or dashes. (mandatory)
|
|
.TP
|
|
.B name
|
|
A friendly name for the device. (optional)
|
|
.TP
|
|
.B address
|
|
The address section is only valid inside of \fBdevice\fP elements. It contains
|
|
a single address, on one of the following forms:
|
|
.INDENT 7.0
|
|
.IP \(bu 2
|
|
IPv4 addresses, IPv6 addresses within brackets, or DNS names, all
|
|
optionally followed by a port number.
|
|
.IP \(bu 2
|
|
\fBdynamic\fP: The address will be resolved using discovery.
|
|
.UNINDENT
|
|
.UNINDENT
|
|
.SS gui
|
|
.sp
|
|
There must be \fIexactly one\fP \fBgui\fP element.
|
|
.INDENT 0.0
|
|
.TP
|
|
.B enabled
|
|
\fBtrue\fP/\fBfalse\fP
|
|
.TP
|
|
.B tls
|
|
\fBtrue\fP/\fBfalse\fP: If true then the GUI will use HTTPS.
|
|
.TP
|
|
.B address
|
|
One or more address elements must be present, containing an \fBip:port\fP
|
|
listen address.
|
|
.TP
|
|
.B username
|
|
Set to require authentication.
|
|
.TP
|
|
.B password
|
|
Contains the bcrypt hash of the real password.
|
|
.TP
|
|
.B apikey
|
|
If set, this is the API key that enables usage of the REST interface.
|
|
.UNINDENT
|
|
.sp
|
|
Additionally, there must be \fIexactly one\fP \fBoptions\fP element. It contains the
|
|
following configuration settings as children:
|
|
.INDENT 0.0
|
|
.TP
|
|
.B listenAddress
|
|
\fBhost:port\fP or \fB:port\fP string denoting an address to listen for BEP
|
|
connections. More than one \fBlistenAddress\fP may be given.
|
|
(default: \fB0.0.0.0:22000\fP)
|
|
.TP
|
|
.B globalAnnounceServer
|
|
\fBhost:port\fP string denoting where a global announce server may be
|
|
reached. (default: \fBannounce.syncthing.net:22025\fP)
|
|
.TP
|
|
.B globalAnnounceEnabled
|
|
\fBtrue\fP/\fBfalse\fP (default: \fBtrue\fP)
|
|
.TP
|
|
.B localAnnounceEnabled
|
|
\fBtrue\fP/\fBfalse\fP (default: \fBtrue\fP)
|
|
.TP
|
|
.B parallelRequests
|
|
The maximum number of outstanding block requests to have against any given
|
|
peer. (default: \fB16\fP)
|
|
.TP
|
|
.B maxSendKbps
|
|
Rate limit
|
|
.TP
|
|
.B rescanIntervalS
|
|
The number of seconds to wait between each scan for modification of the
|
|
local repositories. A value of \fB0\fP disables the scanner. (default: \fB60\fP)
|
|
.TP
|
|
.B reconnectionIntervalS
|
|
The number of seconds to wait between each attempt to connect to currently
|
|
unconnected devices. (default: \fB60\fP)
|
|
.TP
|
|
.B maxChangeKbps
|
|
The maximum rate of change allowed for a single file. When this rate is
|
|
exceeded, further changes to the file are not announced, until the rate is
|
|
reduced below the limit. (default: \fB10000\fP)
|
|
.TP
|
|
.B startBrowser
|
|
\fBtrue\fP/\fBfalse\fP (default: \fBtrue\fP)
|
|
.TP
|
|
.B upnpEnabled
|
|
\fBtrue\fP/\fBfalse\fP (default: \fBtrue\fP)
|
|
.TP
|
|
.B urAccepted
|
|
Whether the user as accepted to submit anonymous usage data. The default,
|
|
\fB0\fP, mean the user has not made a choice, and Syncthing will ask at some
|
|
point in the future. \fB\-1\fP means no, \fB1\fP means yes.
|
|
.UNINDENT
|
|
.SH AUTHOR
|
|
The Syncthing Authors
|
|
.SH COPYRIGHT
|
|
2015, The Syncthing Authors
|
|
.\" Generated by docutils manpage writer.
|
|
.
|