mirror of
https://github.com/octoleo/syncthing.git
synced 2024-09-07 23:49:02 +00:00
gui, man, authors: Update docs, translations, and contributors
This commit is contained in:
parent
2e313716e5
commit
a28441a9bf
@ -189,7 +189,7 @@
|
||||
"Generate": "I-generate",
|
||||
"Global Discovery": "Global na Pagtuklas",
|
||||
"Global Discovery Servers": "Mga Server ng Global na Pagtuklas",
|
||||
"Global State": "State ng Global",
|
||||
"Global State": "Global na Kalagayan",
|
||||
"Help": "Tulong",
|
||||
"Hint: only deny-rules detected while the default is deny. Consider adding \"permit any\" as last rule.": "Hint: deny-rules lang ang nakita habang ang default ay deny. Isaalang-alang ang pagdaragdag ng \"pahintulutan ang alinman\" bilang huling panuntunan.",
|
||||
"Home page": "Pahina ng panimula",
|
||||
|
@ -359,7 +359,7 @@
|
||||
"Start Browser": "啟動瀏覽器",
|
||||
"Statistics": "統計",
|
||||
"Stopped": "已停止",
|
||||
"Stores and syncs only encrypted data. Folders on all connected devices need to be set up with the same password or be of type \"{%receiveEncrypted%}\" too.": "僅存儲和同步加密數據。所有連接設備上的文件夾都需要設置相同的密碼或類型為 「{%receiveEncrypted%}」。",
|
||||
"Stores and syncs only encrypted data. Folders on all connected devices need to be set up with the same password or be of type \"{%receiveEncrypted%}\" too.": "僅存儲和同步加密數據。所有連接設備上的文件夾都需要設置相同的密碼或類型為 「{{receiveEncrypted}}」。",
|
||||
"Subject:": "主題:",
|
||||
"Support": "支持",
|
||||
"Support Bundle": "支持捆綁包",
|
||||
@ -498,6 +498,6 @@
|
||||
"items": "條目",
|
||||
"seconds": "秒",
|
||||
"{%device%} wants to share folder \"{%folder%}\".": "{{device}} 想將 「{{folder}}」 文件夾共享給您。",
|
||||
"{%device%} wants to share folder \"{%folderlabel%}\" ({%folder%}).": "{{device}} 想要共享「{{device}}」({{folderlabel}})文件夾給您。",
|
||||
"{%device%} wants to share folder \"{%folderlabel%}\" ({%folder%}).": "{{device}} 想要共享「{{folderlabel}}」({{folder}})文件夾給您。",
|
||||
"{%reintroducer%} might reintroduce this device.": "{{reintroducer}} 可能會重新引入此設備。"
|
||||
}
|
||||
|
@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "STDISCOSRV" "1" "Jul 09, 2024" "v1.27.7" "Syncthing"
|
||||
.TH "STDISCOSRV" "1" "Jul 18, 2024" "v1.27.7" "Syncthing"
|
||||
.SH NAME
|
||||
stdiscosrv \- Syncthing Discovery Server
|
||||
.SH SYNOPSIS
|
||||
@ -112,7 +112,7 @@ 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 \X'tty: link #getting-started'\fI\%Getting Started\fP\X'tty: link' first.
|
||||
haven’t yet, head over to \fI\%Getting Started\fP first.
|
||||
.SS Installing
|
||||
.sp
|
||||
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
|
||||
|
@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "STRELAYSRV" "1" "Jul 09, 2024" "v1.27.7" "Syncthing"
|
||||
.TH "STRELAYSRV" "1" "Jul 18, 2024" "v1.27.7" "Syncthing"
|
||||
.SH NAME
|
||||
strelaysrv \- Syncthing Relay Server
|
||||
.SH SYNOPSIS
|
||||
|
@ -28,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" "Jul 09, 2024" "v1.27.7" "Syncthing"
|
||||
.TH "SYNCTHING-BEP" "7" "Jul 18, 2024" "v1.27.7" "Syncthing"
|
||||
.SH NAME
|
||||
syncthing-bep \- Block Exchange Protocol v1
|
||||
.SH INTRODUCTION AND DEFINITIONS
|
||||
@ -378,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 \X'tty: link #untrusted'\fI\%Untrusted Device Encryption\fP\X'tty: link' for details on the encryption scheme.
|
||||
no encryption. See \fI\%Untrusted Device Encryption\fP for details on the encryption scheme.
|
||||
.SS Index and Index Update
|
||||
.sp
|
||||
The Index and Index Update messages define the contents of the senders
|
||||
|
@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "SYNCTHING-CONFIG" "5" "Jul 09, 2024" "v1.27.7" "Syncthing"
|
||||
.TH "SYNCTHING-CONFIG" "5" "Jul 18, 2024" "v1.27.7" "Syncthing"
|
||||
.SH NAME
|
||||
syncthing-config \- Syncthing Configuration
|
||||
.SH SYNOPSIS
|
||||
@ -84,7 +84,7 @@ with a custom certificate for HTTPS as desired.
|
||||
.sp
|
||||
The database is by default stored in the same directory as the config, but
|
||||
the location may be overridden by the \fB\-\-data\fP or \fB\-\-home\fP flags or the
|
||||
corresponding environment varibles (\fB$STDATADIR\fP or \fBSTHOMEDIR\fP).
|
||||
corresponding environment variables (\fB$STDATADIR\fP or \fBSTHOMEDIR\fP).
|
||||
.sp
|
||||
The database directory contains the following files, among others:
|
||||
.INDENT 0.0
|
||||
@ -602,7 +602,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
|
||||
\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\&.
|
||||
\fI\%How do I serve a folder from a read only filesystem?\fP\&. Default is \fB\&.stfolder\fP\&.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
@ -751,7 +751,7 @@ element:
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
.B id (mandatory)
|
||||
The \X'tty: link #device-ids'\fI\%device ID\fP\X'tty: link'\&.
|
||||
The \fI\%device ID\fP\&.
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
@ -1334,7 +1334,7 @@ automatic upgrades.
|
||||
.TP
|
||||
.B upgradeToPreReleases
|
||||
If \fBtrue\fP, automatic upgrades include release candidates (see
|
||||
\X'tty: link #releases'\fI\%Versions & Releases\fP\X'tty: link').
|
||||
\fI\%Versions & Releases\fP).
|
||||
.UNINDENT
|
||||
.INDENT 0.0
|
||||
.TP
|
||||
@ -1489,7 +1489,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 \X'tty: link #cmdoption-reset-deltas'\fI\%\-\-reset\-deltas\fP\X'tty: link'\&. This used
|
||||
equivalent to starting Syncthing with \fI\%\-\-reset\-deltas\fP\&. 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\&.
|
||||
@ -1616,7 +1616,7 @@ including the appropriate \fI\%folder.device\fP element underneath.
|
||||
Added in version 1.19.0.
|
||||
|
||||
.sp
|
||||
Template for the \X'tty: link #ignoring-files'\fI\%ignore patterns\fP\X'tty: link' applied to new
|
||||
Template for the \fI\%ignore patterns\fP 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
|
||||
@ -1688,12 +1688,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 \X'tty: link #folder-sendonly'\fI\%Send Only Folder\fP\X'tty: link' to prevent other
|
||||
that the files you are backing up are in a \fI\%Send Only Folder\fP 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 \X'tty: link #ignoring-files'\fI\%ignore list\fP\X'tty: link'\&.
|
||||
folder that stores the configuration files to the \fI\%ignore list\fP\&.
|
||||
If you’d also like to backup your configuration files, add another folder in
|
||||
send only mode for just the configuration folder.
|
||||
.SH AUTHOR
|
||||
|
@ -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" "Jul 09, 2024" "v1.27.7" "Syncthing"
|
||||
.TH "SYNCTHING-DEVICE-IDS" "7" "Jul 18, 2024" "v1.27.7" "Syncthing"
|
||||
.SH NAME
|
||||
syncthing-device-ids \- Understanding Device IDs
|
||||
.sp
|
||||
|
@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "SYNCTHING-EVENT-API" "7" "Jul 09, 2024" "v1.27.7" "Syncthing"
|
||||
.TH "SYNCTHING-EVENT-API" "7" "Jul 18, 2024" "v1.27.7" "Syncthing"
|
||||
.SH NAME
|
||||
syncthing-event-api \- Event API
|
||||
.SH DESCRIPTION
|
||||
@ -456,7 +456,7 @@ Added in version 0.11.12.
|
||||
\fBSEE ALSO:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
The \X'tty: link #statechanged'\fI\%StateChanged\fP\X'tty: link' event.
|
||||
The \fI\%StateChanged\fP event.
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SS FolderPaused
|
||||
@ -716,7 +716,7 @@ Added in version 0.11.10: The \fBmetadata\fP action.
|
||||
|
||||
.SS ListenAddressesChanged
|
||||
.sp
|
||||
This event is emitted when a \X'tty: link #listen-addresses'\fI\%listen address\fP\X'tty: link' changes.
|
||||
This event is emitted when a \fI\%listen address\fP changes.
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
@ -981,7 +981,7 @@ Deprecated since version v1.1.2: The \fBfolderID\fP field is a legacy name kept
|
||||
|
||||
.SS RemoteDownloadProgress
|
||||
.sp
|
||||
This event is emitted when a \X'tty: link #download-progress'\fI\%DownloadProgress\fP\X'tty: link' message is
|
||||
This event is emitted when a \fI\%DownloadProgress\fP 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\&.
|
||||
|
@ -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" "Jul 09, 2024" "v1.27.7" "Syncthing"
|
||||
.TH "SYNCTHING-FAQ" "7" "Jul 18, 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
|
||||
\X'tty: link #config-option-folder.junctionsasdirs'\fI\%the configuration\fP\X'tty: link' on a per\-folder
|
||||
\fI\%the configuration\fP 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, \X'tty: link #temporary-files'\fI\%temporary files\fP\X'tty: link', etc.)
|
||||
\fB\&.stversions\fP, \fI\%temporary files\fP, 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
|
||||
\X'tty: link #temporary-files'\fI\%Temporary files\fP\X'tty: link' are used to store partial data
|
||||
\fI\%Temporary files\fP 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).
|
||||
@ -236,7 +236,7 @@ oyster!)
|
||||
\fBSEE ALSO:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
\X'tty: link #device-ids'\fI\%Understanding Device IDs\fP\X'tty: link'
|
||||
\fI\%Understanding Device IDs\fP
|
||||
.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
|
||||
\X'tty: link #firewall-setup'\fI\%Firewall Setup\fP\X'tty: link' to enable direct connections.
|
||||
\fI\%Firewall Setup\fP 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 \X'tty: link #config-option-options.setlowpriority'\fI\%lower the
|
||||
process priority\fP\X'tty: link' when starting up.
|
||||
To minimize the impact of this, Syncthing attempts to \fI\%lower the
|
||||
process priority\fP 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
|
||||
@ -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 \X'tty: link #config-option-gui.insecureskiphostcheck'\fI\%gui.insecureSkipHostcheck\fP\X'tty: link' in the advanced settings, or
|
||||
Set \fI\%gui.insecureSkipHostcheck\fP 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 \X'tty: link #config-locations'\fI\%database
|
||||
folder\fP\X'tty: link' inside Syncthing’s data directory and re\-start
|
||||
note this in the logs and exit. To overcome this delete the \fI\%database
|
||||
folder\fP 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,7 +374,7 @@ 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 \X'tty: link #relaying'\fI\%relay servers\fP\X'tty: link'\&. Relay servers
|
||||
most likely connections to \fI\%relay servers\fP\&. 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 \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
|
||||
@ -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
|
||||
\X'tty: link #conflict-handling'\fI\%Conflicting Changes\fP\X'tty: link'
|
||||
\fI\%Conflicting Changes\fP
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.SS How do I serve a folder from a read only filesystem?
|
||||
@ -682,7 +682,7 @@ echo 204800 | sudo tee /proc/sys/fs/inotify/max_user_watches
|
||||
.SS How do I reset the GUI password?
|
||||
.sp
|
||||
If you’ve forgotten / lost the GUI password, you can reset it using 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
|
||||
\fI\%\-\-gui\-password\fP (and possibly \fI\%\-\-gui\-user\fP) options to the
|
||||
\fBsyncthing generate\fP subcommand. This should be done while Syncthing is not
|
||||
running.
|
||||
.INDENT 0.0
|
||||
@ -694,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 \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
|
||||
\fIAlternatively, in step 2\fP, you can manually delete the \fI\%<user>\fP and \fI\%<password>\fP 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
|
||||
|
@ -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" "Jul 09, 2024" "v1.27.7" "Syncthing"
|
||||
.TH "SYNCTHING-GLOBALDISCO" "7" "Jul 18, 2024" "v1.27.7" "Syncthing"
|
||||
.SH NAME
|
||||
syncthing-globaldisco \- Global Discovery Protocol v3
|
||||
.SH ANNOUNCEMENTS
|
||||
|
@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "SYNCTHING-LOCALDISCO" "7" "Jul 09, 2024" "v1.27.7" "Syncthing"
|
||||
.TH "SYNCTHING-LOCALDISCO" "7" "Jul 18, 2024" "v1.27.7" "Syncthing"
|
||||
.SH NAME
|
||||
syncthing-localdisco \- Local Discovery Protocol v4
|
||||
.SH MODE OF OPERATION
|
||||
@ -55,7 +55,7 @@ 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
|
||||
\X'tty: link #device-ids'\fI\%Understanding Device IDs\fP\X'tty: link' in the Syncthing documentation.
|
||||
\fI\%Understanding Device IDs\fP in the Syncthing documentation.
|
||||
.SH ANNOUNCEMENT PACKET
|
||||
.sp
|
||||
The Announcement packet has the following structure:
|
||||
|
@ -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" "Jul 09, 2024" "v1.27.7" "Syncthing"
|
||||
.TH "SYNCTHING-NETWORKING" "7" "Jul 18, 2024" "v1.27.7" "Syncthing"
|
||||
.SH NAME
|
||||
syncthing-networking \- Firewall Setup
|
||||
.SH ROUTER SETUP
|
||||
@ -55,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, \X'tty: link #relaying'\fI\%Relaying\fP\X'tty: link' may work well enough to get
|
||||
In the absence of port forwarding, \fI\%Relaying\fP may work well enough to get
|
||||
devices connected and synced, but will perform poorly in comparison to a
|
||||
direct connection.
|
||||
.SS Local Discovery
|
||||
@ -159,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 \X'tty: link #proxying'\fI\%Using Proxies\fP\X'tty: link'\&.
|
||||
Syncthing can use a SOCKS5 proxy for outbound connections. Please see \fI\%Using Proxies\fP\&.
|
||||
.SH AUTHOR
|
||||
The Syncthing Authors
|
||||
.SH COPYRIGHT
|
||||
|
@ -28,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" "Jul 09, 2024" "v1.27.7" "Syncthing"
|
||||
.TH "SYNCTHING-RELAY" "7" "Jul 18, 2024" "v1.27.7" "Syncthing"
|
||||
.SH NAME
|
||||
syncthing-relay \- Relay Protocol v1
|
||||
.SH WHAT IS A RELAY?
|
||||
|
@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "SYNCTHING-REST-API" "7" "Jul 09, 2024" "v1.27.7" "Syncthing"
|
||||
.TH "SYNCTHING-REST-API" "7" "Jul 18, 2024" "v1.27.7" "Syncthing"
|
||||
.SH NAME
|
||||
syncthing-rest-api \- REST API
|
||||
.sp
|
||||
@ -102,7 +102,7 @@ $ curl \-H \(dqX\-API\-Key: yourkey\(dq localhost:8384/rest/system/browse?curren
|
||||
.UNINDENT
|
||||
.SS GET /rest/system/config (DEPRECATED)
|
||||
.sp
|
||||
Deprecated since version v1.12.0: This endpoint still works as before but is deprecated. Use \X'tty: link #rest-config'\fI\%/rest/config\fP\X'tty: link'
|
||||
Deprecated since version v1.12.0: This endpoint still works as before but is deprecated. Use \fI\%/rest/config\fP
|
||||
instead.
|
||||
|
||||
.sp
|
||||
@ -371,7 +371,7 @@ Returns the current configuration.
|
||||
.SS GET /rest/system/config/insync (DEPRECATED)
|
||||
.sp
|
||||
Deprecated since version v1.12.0: This endpoint still works as before but is deprecated. Use
|
||||
\X'tty: link #rest-config-insync'\fI\%/rest/config/restart\-required\fP\X'tty: link' instead.
|
||||
\fI\%/rest/config/restart\-required\fP instead.
|
||||
|
||||
.sp
|
||||
Returns whether the config is in sync, i.e. whether the running
|
||||
@ -395,7 +395,7 @@ instead.
|
||||
Post the full contents of the configuration, in the same format as returned by
|
||||
the corresponding GET request. When posting the configuration succeeds,
|
||||
the posted configuration is immediately applied, except for changes that require a restart. Query
|
||||
\X'tty: link #rest-config-insync'\fI\%/rest/config/restart\-required\fP\X'tty: link' to check if a restart is required.
|
||||
\fI\%/rest/config/restart\-required\fP to check if a restart is required.
|
||||
.sp
|
||||
This endpoint is the main point to control Syncthing, even if the change only
|
||||
concerns a very small part of the config: The usual workflow is to get the
|
||||
@ -682,7 +682,7 @@ curl \-X POST \-H \(dqX\-API\-Key: abc123\(dq http://localhost:8384/rest/system/
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
\fBCaution\fP: See \X'tty: link #cmdoption-reset-database'\fI\%\-\-reset\-database\fP\X'tty: link' for \fB\&.stfolder\fP creation
|
||||
\fBCaution\fP: See \fI\%\-\-reset\-database\fP for \fB\&.stfolder\fP creation
|
||||
side\-effect and caution regarding mountpoints.
|
||||
.SS POST /rest/system/restart
|
||||
.sp
|
||||
@ -902,7 +902,7 @@ patterns to be used by default on folders, as an array of single\-line strings.
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
The \X'tty: link #config-option-gui.password'\fI\%gui.password\fP\X'tty: link' configuration option has special handling to
|
||||
The \fI\%gui.password\fP configuration option has special handling to
|
||||
accept already hashed passwords. Any valid bcrypt hash is stored verbatim,
|
||||
while a plaintext password is first hashed.
|
||||
.UNINDENT
|
||||
@ -1035,7 +1035,7 @@ Added in version 0.14.53.
|
||||
Takes one mandatory parameter, \fBfolder\fP, and returns the list of errors
|
||||
encountered during scanning or pulling.
|
||||
.sp
|
||||
The results can be paginated using the \X'tty: link #rest-pagination'\fI\%common pagination parameters\fP\X'tty: link'\&.
|
||||
The results can be paginated using the \fI\%common pagination parameters\fP\&.
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
@ -1418,7 +1418,7 @@ were changed locally in a receive\-only folder. Thus they differ from the globa
|
||||
state and could be reverted by pulling from remote devices again, see
|
||||
\fI\%POST /rest/db/revert\fP\&.
|
||||
.sp
|
||||
The results can be paginated using the \X'tty: link #rest-pagination'\fI\%common pagination parameters\fP\X'tty: link'\&.
|
||||
The results can be paginated using the \fI\%common pagination parameters\fP\&.
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
@ -1455,7 +1455,7 @@ Use sparingly.
|
||||
Takes one mandatory parameter, \fBfolder\fP, and returns lists of files which are
|
||||
needed by this device in order for it to become in sync.
|
||||
.sp
|
||||
The results can be paginated using the \X'tty: link #rest-pagination'\fI\%common pagination parameters\fP\X'tty: link'\&. Pagination happens, across the union of all needed files,
|
||||
The results can be paginated using the \fI\%common pagination parameters\fP\&. Pagination happens, across the union of all needed files,
|
||||
that is \- across all 3 sections of the response. For example, given the current
|
||||
need state is as follows:
|
||||
.INDENT 0.0
|
||||
@ -1559,7 +1559,7 @@ Takes the mandatory parameters \fBfolder\fP and \fBdevice\fP, and returns the li
|
||||
of files which are needed by that remote device in order for it to become in
|
||||
sync with the shared folder.
|
||||
.sp
|
||||
The results can be paginated using the \X'tty: link #rest-pagination'\fI\%common pagination parameters\fP\X'tty: link'\&.
|
||||
The results can be paginated using the \fI\%common pagination parameters\fP\&.
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
@ -1730,7 +1730,7 @@ To receive events, perform a HTTP GET of \fB/rest/events\fP\&.
|
||||
.sp
|
||||
To filter the event list, in effect creating a specific subscription for only
|
||||
the desired event types, add a parameter \fBevents=EventTypeA,EventTypeB,...\fP
|
||||
where the event types are any of the \X'tty: link #event-types'\fI\%Event Types\fP\X'tty: link'\&. If no filter is
|
||||
where the event types are any of the \fI\%Event Types\fP\&. If no filter is
|
||||
specified, all events \fIexcept\fP \fI\%LocalChangeDetected\fP and
|
||||
\fI\%RemoteChangeDetected\fP are included.
|
||||
.sp
|
||||
@ -1908,7 +1908,7 @@ Returns the data sent in the anonymous usage report.
|
||||
.SH DEBUG ENDPOINTS
|
||||
.SS Debug Endpoints
|
||||
.sp
|
||||
These endpoints require the \X'tty: link #config-option-gui.debugging'\fI\%gui.debugging\fP\X'tty: link' configuration option to
|
||||
These endpoints require the \fI\%gui.debugging\fP configuration option to
|
||||
be enabled and yield an access denied error code otherwise.
|
||||
.SS GET /rest/debug/peerCompletion
|
||||
.sp
|
||||
|
@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "SYNCTHING-SECURITY" "7" "Jul 09, 2024" "v1.27.7" "Syncthing"
|
||||
.TH "SYNCTHING-SECURITY" "7" "Jul 18, 2024" "v1.27.7" "Syncthing"
|
||||
.SH NAME
|
||||
syncthing-security \- Security Principles
|
||||
.sp
|
||||
|
@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "SYNCTHING-STIGNORE" "5" "Jul 09, 2024" "v1.27.7" "Syncthing"
|
||||
.TH "SYNCTHING-STIGNORE" "5" "Jul 18, 2024" "v1.27.7" "Syncthing"
|
||||
.SH NAME
|
||||
syncthing-stignore \- Prevent files from being synchronized to other nodes
|
||||
.SH SYNOPSIS
|
||||
@ -124,7 +124,7 @@ 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
|
||||
\X'tty: link #scanning'\fI\%watcher\fP\X'tty: link' is enabled, those directories will also be
|
||||
\fI\%watcher\fP 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:
|
||||
|
@ -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" "Jul 09, 2024" "v1.27.7" "Syncthing"
|
||||
.TH "SYNCTHING-VERSIONING" "7" "Jul 18, 2024" "v1.27.7" "Syncthing"
|
||||
.SH NAME
|
||||
syncthing-versioning \- Keep automatic backups of deleted files by other nodes
|
||||
.sp
|
||||
@ -285,7 +285,7 @@ files permanently.
|
||||
.SH CONFIGURATION PARAMETER REFERENCE
|
||||
.sp
|
||||
The versioning settings are grouped into their own section of each folder in the
|
||||
\X'tty: link #config-option-folder.versioning'\fI\%configuration file\fP\X'tty: link'\&. The following shows an
|
||||
\fI\%configuration file\fP\&. The following shows an
|
||||
example of such a section in the XML:
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
@ -326,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 \X'tty: link #config-option-folder.filesystemtype'\fI\%filesystemType\fP\X'tty: link' from the folder element is used
|
||||
otherwise the \fI\%filesystemType\fP from the folder element is used
|
||||
instead. Refer to that option description for possible values. Ignored for
|
||||
the \fBexternal\fP versioning strategy.
|
||||
.sp
|
||||
|
@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
||||
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
||||
..
|
||||
.TH "SYNCTHING" "1" "Jul 09, 2024" "v1.27.7" "Syncthing"
|
||||
.TH "SYNCTHING" "1" "Jul 18, 2024" "v1.27.7" "Syncthing"
|
||||
.SH NAME
|
||||
syncthing \- Syncthing
|
||||
.SH SYNOPSIS
|
||||
@ -367,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 \X'tty: link #untrusted-decrypt'\fI\%decryption\fP\X'tty: link' for
|
||||
devices, see the relevant section on \fI\%decryption\fP for
|
||||
details. It does not depend on Syncthing to be running, but works on offline
|
||||
data.
|
||||
.sp
|
||||
|
Loading…
Reference in New Issue
Block a user