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

This commit is contained in:
Syncthing Release Automation
2022-02-28 03:46:00 +00:00
parent f890fe6fd3
commit f25947e5eb
19 changed files with 375 additions and 94 deletions
+1 -1
View File
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "STDISCOSRV" "1" "Feb 20, 2022" "v1" "Syncthing"
.TH "STDISCOSRV" "1" "Feb 23, 2022" "v1" "Syncthing"
.SH NAME
stdiscosrv \- Syncthing Discovery Server
.SH SYNOPSIS
+1 -1
View File
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "STRELAYSRV" "1" "Feb 20, 2022" "v1" "Syncthing"
.TH "STRELAYSRV" "1" "Feb 23, 2022" "v1" "Syncthing"
.SH NAME
strelaysrv \- Syncthing Relay Server
.SH SYNOPSIS
+2 -2
View File
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "SYNCTHING-BEP" "7" "Feb 20, 2022" "v1" "Syncthing"
.TH "SYNCTHING-BEP" "7" "Feb 23, 2022" "v1" "Syncthing"
.SH NAME
syncthing-bep \- Block Exchange Protocol v1
.SH INTRODUCTION AND DEFINITIONS
@@ -48,7 +48,7 @@ for the last block which may be smaller.
.sp
The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”,
“SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this
document are to be interpreted as described in [RFC 2119](\fI\%https://datatracker.ietf.org/doc/html/rfc2119\fP).
document are to be interpreted as described in \fI\%RFC 2119\fP <\fBhttps://datatracker.ietf.org/doc/html/rfc2119.html\fP>\&.
.SH TRANSPORT AND AUTHENTICATION
.sp
BEP is deployed as the highest level in a protocol stack, with the lower
+6 -5
View File
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "SYNCTHING-CONFIG" "5" "Feb 20, 2022" "v1" "Syncthing"
.TH "SYNCTHING-CONFIG" "5" "Feb 23, 2022" "v1" "Syncthing"
.SH NAME
syncthing-config \- Syncthing Configuration
.SH SYNOPSIS
@@ -904,9 +904,9 @@ untrusted\&.
.UNINDENT
.UNINDENT
.sp
There must be exactly one \fBgui\fP element. The GUI configuration is also used
by the rest\-api and the event\-api\&. The following attributes may
be set on the \fBgui\fP element:
There must be exactly one \fBgui\fP element. The GUI configuration is also used by
the /dev/rest and the /dev/events\&. The following attributes may be
set on the \fBgui\fP element:
.INDENT 0.0
.TP
.B enabled
@@ -922,7 +922,8 @@ still possible but not required.
.INDENT 0.0
.TP
.B debugging
This enables profiling and additional debugging endpoints in the rest\-api\&.
This enables /users/profiling and additional endpoints in the REST
API, see /rest/debug\&.
.UNINDENT
.sp
The following child elements may be present:
+1 -1
View File
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "SYNCTHING-DEVICE-IDS" "7" "Feb 20, 2022" "v1" "Syncthing"
.TH "SYNCTHING-DEVICE-IDS" "7" "Feb 23, 2022" "v1" "Syncthing"
.SH NAME
syncthing-device-ids \- Understanding Device IDs
.sp
+2 -2
View File
@@ -27,13 +27,13 @@ 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" "Feb 20, 2022" "v1" "Syncthing"
.TH "SYNCTHING-EVENT-API" "7" "Feb 23, 2022" "v1" "Syncthing"
.SH NAME
syncthing-event-api \- Event API
.SH DESCRIPTION
.sp
Syncthing provides a simple long polling interface for exposing events from the
core utility towards a GUI. To receive events, see events\-get\&.
core utility towards a GUI. To receive events, see /rest/events\-get\&.
.SH EVENT STRUCTURE
.sp
Each event is represented by an object similar to the following:
+3 -3
View File
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "SYNCTHING-FAQ" "7" "Feb 20, 2022" "v1" "Syncthing"
.TH "SYNCTHING-FAQ" "7" "Feb 23, 2022" "v1" "Syncthing"
.SH NAME
syncthing-faq \- Frequently Asked Questions
.INDENT 0.0
@@ -414,11 +414,11 @@ locally may be overwritten by those on other devices.
.sp
An alternative way is to shut down Syncthing, move the folder on disk (including
the \fB\&.stfolder\fP marker), edit the path directly in \fBconfig.xml\fP in the
configuration folder (see config) and then start Syncthing again.
configuration folder (see /users/config) and then start Syncthing again.
.SS How do I configure multiple users on a single machine?
.sp
Each user should run their own Syncthing instance. Be aware that you might need
to configure listening ports such that they do not overlap (see config).
to configure listening ports such that they do not overlap (see /users/config).
.SS Does Syncthing support syncing between folders on the same system?
.sp
No. Syncthing is not designed to sync locally and the overhead involved in
+1 -1
View File
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "SYNCTHING-GLOBALDISCO" "7" "Feb 20, 2022" "v1" "Syncthing"
.TH "SYNCTHING-GLOBALDISCO" "7" "Feb 23, 2022" "v1" "Syncthing"
.SH NAME
syncthing-globaldisco \- Global Discovery Protocol v3
.SH ANNOUNCEMENTS
+1 -1
View File
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "SYNCTHING-LOCALDISCO" "7" "Feb 20, 2022" "v1" "Syncthing"
.TH "SYNCTHING-LOCALDISCO" "7" "Feb 23, 2022" "v1" "Syncthing"
.SH NAME
syncthing-localdisco \- Local Discovery Protocol v4
.SH MODE OF OPERATION
+1 -1
View File
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "SYNCTHING-NETWORKING" "7" "Feb 20, 2022" "v1" "Syncthing"
.TH "SYNCTHING-NETWORKING" "7" "Feb 23, 2022" "v1" "Syncthing"
.SH NAME
syncthing-networking \- Firewall Setup
.SH ROUTER SETUP
+1 -1
View File
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "SYNCTHING-RELAY" "7" "Feb 20, 2022" "v1" "Syncthing"
.TH "SYNCTHING-RELAY" "7" "Feb 23, 2022" "v1" "Syncthing"
.SH NAME
syncthing-relay \- Relay Protocol v1
.SH WHAT IS A RELAY?
+311 -37
View File
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "SYNCTHING-REST-API" "7" "Feb 20, 2022" "v1" "Syncthing"
.TH "SYNCTHING-REST-API" "7" "Feb 23, 2022" "v1" "Syncthing"
.SH NAME
syncthing-rest-api \- REST API
.sp
@@ -43,6 +43,13 @@ the configuration file. To use an API key, set the request header
\fBX\-API\-Key\fP to the API key value. For example, \fBcurl \-X POST \-H
"X\-API\-Key: abc123" http://localhost:8384/rest/...\fP can be used to invoke
with \fBcurl\fP (add \fB\-k\fP flag when using HTTPS with a Syncthing generated or self signed certificate).
.SH RESULT PAGINATION
.sp
Some \fIGET\fP endpoints take optional \fBpage\fP and \fBperpage\fP arguments for
pagination. No more than \fBperpage\fP (defaults to 65536 if not given) result
entries are returned in an array. To access further entries, passing the
\fBpage\fP parameter will advance in the results by that many pages. The actually
used parameters are always returned as attributes in the response object.
.SH SYSTEM ENDPOINTS
.SS GET /rest/system/browse
.sp
@@ -594,7 +601,8 @@ error. The new error will be displayed on any active GUI clients.
New in version 0.12.0.
.sp
Returns the list of recent log entries.
Returns the list of recent log entries. The optional \fBsince\fP parameter limits
the results to message newer than the given timestamp in \fI\%RFC 3339\fP <\fBhttps://datatracker.ietf.org/doc/html/rfc3339.html\fP> format.
.INDENT 0.0
.INDENT 3.5
.sp
@@ -612,6 +620,9 @@ Returns the list of recent log entries.
.fi
.UNINDENT
.UNINDENT
.SS GET /rest/system/log.txt
.sp
Returns the same information, formatted as a text log instead of a JSON object.
.SS POST /rest/system/pause
.sp
Pause the given device or all devices.
@@ -648,13 +659,14 @@ information for that folder will be erased:
.sp
.nf
.ft C
$ curl \-X POST \-H "X\-API\-Key: abc123" http://localhost:8384/rest/system/reset?folder=ab1c2\-def3g
curl \-X POST \-H "X\-API\-Key: abc123" http://localhost:8384/rest/system/reset?folder=ab1c2\-def3g
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBCaution\fP: See \fB\-\-reset\-database\fP for \fB\&.stfolder\fP creation side\-effect and caution regarding mountpoints.
\fBCaution\fP: See \fB\-\-reset\-database\fP for \fB\&.stfolder\fP creation
side\-effect and caution regarding mountpoints.
.SS POST /rest/system/restart
.sp
Post with empty body to immediately restart Syncthing.
@@ -827,8 +839,8 @@ Returns the current Syncthing version information.
New in version 1.12.0.
.sp
These endpoints facilitate access and modification of the configuration in a granular way. Config sent to the endpoints must be in the same
format as returned by the corresponding GET request. When posting the
These endpoints facilitate access and modification of the configuration in a granular way. Config sent to the endpoints must be 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 \fI\%/rest/config/restart\-required\fP to check if
a restart is required.
@@ -857,6 +869,20 @@ Put the desired folder\- respectively device\-ID in place of *id*. \fBGET\fP
returns the folder/device for the given ID, \fBPUT\fP replaces the entire config,
\fBPATCH\fP replaces only the given child objects and \fBDELETE\fP removes the
folder/device.
.SS /rest/config/defaults/folder, /rest/config/defaults/device
.sp
\fBGET\fP returns a template folder / device configuration object with all default
values, which only needs a unique ID to be applied. \fBPUT\fP replaces the
default config (omitted values are reset to the hard\-coded defaults), \fBPATCH\fP
replaces only the given child objects.
.SS /rest/config/defaults/ignores
.sp
New in version 1.19.0.
.sp
\fBGET\fP returns an object with a single \fBlines\fP attribute listing ignore
patterns to be used by default on folders, as an array of single\-line strings.
\fBPUT\fP replaces the default ignore patterns from an object of the same format.
.SS /rest/config/options, /rest/config/ldap, /rest/config/gui
.sp
\fBGET\fP returns the respective object, \fBPUT\fP replaces the entire object and
@@ -869,9 +895,9 @@ Concerns the mesh network structure.
New in version 1.18.0.
.sp
Remove records about a pending remote device which tried to connect.
Valid values for the \fBdevice\fP parameter are those from the
corresponding /rest/cluster\-pending\-devices\-get endpoint.
Remove records about a pending remote device which tried to connect. Valid
values for the \fBdevice\fP parameter are those from the corresponding
cluster\-pending\-devices\-get endpoint.
.INDENT 0.0
.INDENT 3.5
.sp
@@ -917,12 +943,11 @@ configured in our instance.
New in version 1.18.0.
.sp
Remove records about a pending folder announced from a remote device.
Valid values for the \fBfolder\fP and \fBdevice\fP parameters are those
from the corresponding /rest/cluster\-pending\-folders\-get
endpoint. The \fBdevice\fP parameter is optional and affects
announcements of this folder from the given device, or from \fIany\fP
device if omitted.
Remove records about a pending folder announced from a remote device. Valid
values for the \fBfolder\fP and \fBdevice\fP parameters are those from the
corresponding cluster\-pending\-folders\-get endpoint. The \fBdevice\fP
parameter is optional and affects announcements of this folder from the given
device, or from \fIany\fP device if omitted.
.INDENT 0.0
.INDENT 3.5
.sp
@@ -934,12 +959,13 @@ $ curl \-X DELETE \-H "X\-API\-Key: abc123" http://localhost:8384/rest/cluster/p
.UNINDENT
.UNINDENT
.sp
Returns status 200 and no content upon success, or status 500 and a
plain text error on failure. A /events/pendingfolderschanged
event will be generated in response.
Returns status 200 and no content upon success, or status 500 and a plain text
error on failure. A /events/pendingfolderschanged event will be
generated in response.
.sp
For a more permanent effect, also for future announcements of the same
folder ID, the folder should be ignored in the configuration instead.
For a more permanent effect, also for future announcements of the same folder
ID, the folder should be ignored in the configuration
instead.
.SS GET /rest/cluster/pending/folders
.sp
New in version 1.13.0.
@@ -986,6 +1012,115 @@ Other offering devices are also omitted from the result.
.fi
.UNINDENT
.UNINDENT
.SH FOLDER ENDPOINTS
.sp
Runtime state of the individual shared folders.
.SS GET /rest/folder/errors
.sp
New in version 0.14.53.
.sp
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 common pagination parameters\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{
"folder": "nnhic\-sxuae",
"errors": [
{
"path": "noperm.txt",
"error": "hashing: open /path/to/folder/noperm.txt: permission denied"
}
],
"page": 1,
"perpage": 100
}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS GET /rest/folder/pullerrors
.sp
Deprecated since version v0.14.53: This endpoint still works as before but is deprecated. Use
folder\-errors\-get instead, which returns the same information.
.sp
See \fI\%d510e3cca3d5caae42121fa206b3decc981ae59e\fP <\fBhttps://github.com/syncthing/syncthing/commit/d510e3cca3d5caae42121fa206b3decc981ae59e\fP>
.SS GET /rest/folder/versions
.sp
New in version 0.14.44.
.sp
Takes one mandatory parameter, \fBfolder\fP, and returns the list of archived
files that could be recovered. How many versions are available depends on the
/users/versioning configuration. Each entry specifies when the file
version was archived as the \fBversionTime\fP, the \fBmodTime\fP when it was last
modified before being archived, and the size in bytes.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{
"dir1/dir2/bar": [
{
"versionTime": "2022\-02\-06T20:44:12+01:00",
"modTime": "2021\-01\-14T13:21:22+01:00",
"size": 4
}
],
"baz": [
{
"versionTime": "2022\-02\-06T20:44:20+01:00",
"modTime": "2021\-01\-14T13:23:49+01:00",
"size": 4
}
],
"foo": [
{
"versionTime": "2022\-02\-06T20:55:31+01:00",
"modTime": "2022\-02\-06T20:44:13+01:00",
"size": 4
},
{
"versionTime": "2022\-02\-06T20:44:20+01:00",
"modTime": "2021\-01\-14T13:21:16+01:00",
"size": 4
}
]
}
.ft P
.fi
.UNINDENT
.UNINDENT
.SS POST /rest/folder/versions
.sp
Restore archived versions of a given set of files. Expects an object with
attributes named after the relative file paths, with timestamps as values
matching valid \fBversionTime\fP entries in the corresponding
folder\-versions\-get response object.
.sp
Takes the mandatory parameter \fBfolder\fP (folder ID). Returns an object
containing any error messages that occurred during restoration of the file, with
the file path as attribute name.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
curl \-X POST \-H X\-API\-key:... http://127.0.0.1:8384/rest/folder/versions?folder=default \-d \(aq{
"dir1/dir2/bar": "2022\-02\-06T20:44:12+01:00",
"baz": "2022\-02\-06T20:44:20+01:00"
}\(aq
.ft P
.fi
.UNINDENT
.UNINDENT
.SH DATABASE ENDPOINTS
.SS GET /rest/db/browse
.sp
@@ -1233,19 +1368,62 @@ provides a list of strings which represent globbing patterns described by gobwas
.UNINDENT
.SS POST /rest/db/ignores
.sp
Expects a format similar to the output of \fBGET\fP call, but only
Expects a format similar to the output of db\-ignores\-get call, but only
containing the \fBignore\fP field (\fBexpanded\fP field should be omitted).
It takes one parameter, \fBfolder\fP, and either updates the content of
the \fB\&.stignore\fP echoing it back as a response, or returns an error.
.SS GET /rest/db/localchanged
.sp
New in version 0.14.55.
.sp
Takes one mandatory parameter, \fBfolder\fP, and returns the list of files which
were changed locally in a receive\-only folder. Thus they differ from the global
state and could be reverted by pulling from remote devices again, see
db\-revert\-post\&.
.sp
The results can be paginated using the common pagination parameters\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{
"files": [
{
"flags": "0755",
"sequence": 6,
"modified": "2015\-04\-20T23:06:12+09:00",
"name": "ls",
"size": 34640,
"version": [
"5157751870738175669:1"
]
}
],
"page": 1,
"perpage": 100
}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This is an expensive call, increasing CPU and RAM usage on the device.
Use sparingly.
.UNINDENT
.UNINDENT
.SS GET /rest/db/need
.sp
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
Furthermore takes an optional \fBpage\fP and \fBperpage\fP arguments for pagination.
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:
The results can be paginated using the common pagination parameters\&. 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
.IP 1. 3
\fBprogress\fP has 15 items
@@ -1262,8 +1440,13 @@ section in the response will have 10 items. If you issue a request query with
2 items. If you issue a query for \fBpage=3\fP and \fBperpage=10\fP, you will only
have the last 10 items of the \fBrest\fP section.
.sp
In all these calls, \fBtotal\fP will be 30 to indicate the total number of
available items.
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Return format changed in version 0.14.43, removing the \fBtotal\fP count
attribute.
.UNINDENT
.UNINDENT
.INDENT 0.0
.INDENT 3.5
.sp
@@ -1293,8 +1476,7 @@ available items.
...
],
"page": 1,
"perpage": 100,
"total": 2000
"perpage": 100
}
.ft P
.fi
@@ -1304,7 +1486,8 @@ available items.
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This is an expensive call, increasing CPU and RAM usage on the device. Use sparingly.
This is an expensive call, increasing CPU and RAM usage on the device.
Use sparingly.
.UNINDENT
.UNINDENT
.SS POST /rest/db/override
@@ -1338,7 +1521,50 @@ curl \-X POST http://127.0.0.1:8384/rest/db/prio?folder=default&file=foo/bar
.UNINDENT
.UNINDENT
.sp
Response contains the same output as \fBGET /rest/db/need\fP
Response contains the same output as db\-need\-get\&.
.SS GET /rest/db/remoteneed
.sp
New in version 0.14.43.
.sp
Takes the mandatory parameters \fBfolder\fP and \fBdevice\fP, and returns the list
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 common pagination parameters\&.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
{
"files": [
{
"flags": "0755",
"sequence": 6,
"modified": "2015\-04\-20T23:06:12+09:00",
"name": "ls",
"size": 34640,
"version": [
"5157751870738175669:1"
]
}
],
"page": 1,
"perpage": 100
}
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
This is an expensive call, increasing CPU and RAM usage on the device.
Use sparingly.
.UNINDENT
.UNINDENT
.SS POST /rest/db/revert
.sp
New in version 0.14.50.
@@ -1503,6 +1729,11 @@ To receive only a limited number of events, add the \fBlimit=<n>\fP parameter wi
suitable value for \fBn\fP and only the \fIlast\fP \fBn\fP events will be returned. This
can be used to catch up with the latest event ID after a disconnection for
example: \fB/rest/events?since=0&limit=1\fP\&.
.SS GET /rest/events/disk
.sp
This convenience endpoint provides the same event stream, but pre\-filtered to show
only /events/localchangedetected and /events/remotechangedetected
event types. The \fBevents\fP parameter is not used.
.SH STATISTICS ENDPOINTS
.SS GET /rest/stats/device
.sp
@@ -1532,14 +1763,13 @@ last scan time and the last synced file.
.sp
.nf
.ft C
$ curl \-s http://localhost:8384/rest/stats/folder | json
{
"folderid" : {
"folderid": {
"lastScan": "2016\-06\-02T13:28:01.288181412\-04:00",
"lastFile" : {
"filename" : "file/name",
"at" : "2015\-04\-16T22:04:18.3066971+01:00"
}
"lastFile": {
"filename": "file/name",
"at": "2015\-04\-16T22:04:18.3066971+01:00"
}
}
}
.ft P
@@ -1663,6 +1893,50 @@ Returns the data sent in the anonymous usage report.
.fi
.UNINDENT
.UNINDENT
.SH DEBUG ENDPOINTS
.SS Debug Endpoints
.sp
These endpoints require the \fBgui.debugging\fP configuration option to
be enabled and yield an access denied error code otherwise.
.SS GET /rest/debug/peerCompletion
.sp
Summarizes the completion precentage for each remote device. Returns an object
with device IDs as keys and an integer percentage as values.
.SS GET /rest/debug/httpmetrics
.sp
Returns statistics about each served REST API endpoint, to diagnose how much
time was spent generating the responses.
.SS GET /rest/debug/cpuprof
.sp
Used to capture a profile of what Syncthing is doing on the CPU. See
/users/profiling\&.
.SS GET /rest/debug/heapprof
.sp
Used to capture a profile of what Syncthing is doing with the heap memory. See
/users/profiling\&.
.SS GET /rest/debug/support
.sp
Collects information about the running instance for troubleshooting purposes.
Returns a “support bundle” as a zipped archive, which should be sent to the
developers after verifying it contains no sensitive personal information.
Credentials for the web GUI and the API key are automatically redacted already.
.SS GET /rest/debug/file
.sp
Shows diagnostics about a certain file in a shared folder. Takes the \fBfolder\fP
(folder ID) and \fBfile\fP (folder relative path) parameters.
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ curl \-H X\-API\-Key:... "http://localhost:8384/rest/debug/file?folder=default&file=foo/bar"
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
The returned object contains the same info as db\-file\-get, plus a summary
of \fBglobalVersions\fP\&.
.SH AUTHOR
The Syncthing Authors
.SH COPYRIGHT
+1 -1
View File
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "SYNCTHING-SECURITY" "7" "Feb 20, 2022" "v1" "Syncthing"
.TH "SYNCTHING-SECURITY" "7" "Feb 23, 2022" "v1" "Syncthing"
.SH NAME
syncthing-security \- Security Principles
.sp
+1 -1
View File
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "SYNCTHING-STIGNORE" "5" "Feb 20, 2022" "v1" "Syncthing"
.TH "SYNCTHING-STIGNORE" "5" "Feb 23, 2022" "v1" "Syncthing"
.SH NAME
syncthing-stignore \- Prevent files from being synchronized to other nodes
.SH SYNOPSIS
+1 -1
View File
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "SYNCTHING-VERSIONING" "7" "Feb 20, 2022" "v1" "Syncthing"
.TH "SYNCTHING-VERSIONING" "7" "Feb 23, 2022" "v1" "Syncthing"
.SH NAME
syncthing-versioning \- Keep automatic backups of deleted files by other nodes
.sp
+1 -1
View File
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "SYNCTHING" "1" "Feb 20, 2022" "v1" "Syncthing"
.TH "SYNCTHING" "1" "Feb 23, 2022" "v1" "Syncthing"
.SH NAME
syncthing \- Syncthing
.SH SYNOPSIS