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

2021-06-16 07:45:27 +02:00
parent 89740490ac
commit adb7763f87
55 changed files with 716 additions and 123 deletions
@@ -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" "Jun 07, 2021" "v1" "Syncthing"
+.TH "STDISCOSRV" "1" "Jun 14, 2021" "v1" "Syncthing"
 .SH NAME
 stdiscosrv \- Syncthing Discovery Server
 .SH SYNOPSIS
@@ -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" "Jun 07, 2021" "v1" "Syncthing"
+.TH "STRELAYSRV" "1" "Jun 14, 2021" "v1" "Syncthing"
 .SH NAME
 strelaysrv \- Syncthing Relay Server
 .SH SYNOPSIS
@@ -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" "Jun 07, 2021" "v1" "Syncthing"
+.TH "SYNCTHING-BEP" "7" "Jun 14, 2021" "v1" "Syncthing"
 .SH NAME
 syncthing-bep \- Block Exchange Protocol v1
 .SH INTRODUCTION AND DEFINITIONS
@@ -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" "Jun 07, 2021" "v1" "Syncthing"
+.TH "SYNCTHING-CONFIG" "5" "Jun 14, 2021" "v1" "Syncthing"
 .SH NAME
 syncthing-config \- Syncthing Configuration
 .SH SYNOPSIS
@@ -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" "Jun 07, 2021" "v1" "Syncthing"
+.TH "SYNCTHING-DEVICE-IDS" "7" "Jun 14, 2021" "v1" "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" "Jun 07, 2021" "v1" "Syncthing"
+.TH "SYNCTHING-EVENT-API" "7" "Jun 14, 2021" "v1" "Syncthing"
 .SH NAME
 syncthing-event-api \- Event API
 .SH DESCRIPTION
@@ -356,6 +356,28 @@ been started for that file/folder, where disappearing implies that the
 downloads have been finished or failed for that file/folder. There is
 always a last event emitted with no data, which implies all downloads
 have finished/failed.
+.SS Failure
+.sp
+Generated for specific errors that will also be sent to the usage
+reporting server, if enabled in the configuration.  These are usually
+of special interest to the developers to troubleshoot complex errors.
+The \fBdata\fP field contains a textual error message.
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+{
+  "id": 93,
+  "globalID": 93,
+  "type": "Failure",
+  "time": "2021\-06\-07T21:22:03.414609034+02:00",
+  "data": "index handler got paused while already paused"
+}
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
 .SS FolderCompletion
 .sp
 The \fBFolderCompletion\fP event is emitted when the local or remote
@@ -422,6 +444,29 @@ New in version 0.11.12.
 The statechanged event.
 .UNINDENT
 .UNINDENT
+.SS FolderPaused
+.sp
+Generated when the configuration changes regarding the “paused” state
+of a folder.  Sent repeatedly for each changed folder.
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+{
+  "id": 93,
+  "globalID": 93,
+  "type": "FolderPaused",
+  "time": "2021\-06\-07T23:45:03.414609034+02:00",
+  "data": {
+    "id": "abcde\-fghij",
+    "label": "My folder"
+  }
+}
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
 .SS FolderRejected
 .sp
 Deprecated since version v1.13.0: This event is still emitted for compatibility, but deprecated.  Use
@@ -450,7 +495,30 @@ have, or have but do not share with the device in question.
 .fi
 .UNINDENT
 .UNINDENT
-.SS Folder Scan Progress
+.SS FolderResumed
+.sp
+Generated when the configuration changes regarding the “paused” state
+of a folder.  Sent repeatedly for each changed folder.
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+{
+  "id": 93,
+  "globalID": 93,
+  "type": "FolderResumed",
+  "time": "2021\-06\-07T23:45:03.414609034+02:00",
+  "data": {
+    "id": "abcde\-fghij",
+    "label": "My folder"
+  }
+}
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.SS FolderScanProgress
 .sp
 Emitted in regular intervals (folder setting ProgressIntervalS, 2s by default)
 during scans giving the amount of bytes already scanned and to be scanned in
@@ -600,7 +668,7 @@ The \fBaction\fP field is either \fBupdate\fP (contents changed), \fBmetadata\fP
 .sp
 New in version 0.11.10: The \fBmetadata\fP action.

-.SS Listen Addresses Changed
+.SS ListenAddressesChanged
 .sp
 This event is emitted when a listen address changes.
 .INDENT 0.0
@@ -709,7 +777,7 @@ changes during a scan.
 .fi
 .UNINDENT
 .UNINDENT
-.SS Login Attempt
+.SS LoginAttempt
 .sp
 When authentication is enabled for the GUI, this event is emitted on every
 login attempt. If either the username or password are incorrect, \fBsuccess\fP
@@ -742,7 +810,7 @@ New in version 1.14.0.

 .sp
 Emitted when pending devices were added / updated (connection from
-unknown ID) or removed (device is ignored or added).
+unknown ID) or removed (device is ignored, dismissed or added).
 .INDENT 0.0
 .INDENT 3.5
 .sp
@@ -756,13 +824,13 @@ unknown ID) or removed (device is ignored or added).
    "added": [
      {
        "address": "127.0.0.1:51807",
-        "device": "EJHMPAQ\-OGCVORE\-ISB4IS3\-SYYVJXF\-TKJGLTU\-66DIQPF\-GJ5D2GX\-GQ3OWQK",
+        "deviceID": "EJHMPAQ\-OGCVORE\-ISB4IS3\-SYYVJXF\-TKJGLTU\-66DIQPF\-GJ5D2GX\-GQ3OWQK",
        "name": "My dusty computer"
      }
    ],
    "removed": [
      {
-        "device": "P56IOI7\-MZJNU2Y\-IQGDREY\-DM2MGTI\-MGL3BXN\-PQ6W5BM\-TBBZ4TJ\-XZWICQ2"
+        "deviceID": "P56IOI7\-MZJNU2Y\-IQGDREY\-DM2MGTI\-MGL3BXN\-PQ6W5BM\-TBBZ4TJ\-XZWICQ2"
      }
    ]
  }
@@ -777,8 +845,10 @@ New in version 1.14.0.

 .sp
 Emitted when pending folders were added / updated (offered by some
-device, but not shared to them) or removed (folder ignored or added or
-no longer offered from the remote device).
+device, but not shared to them) or removed (folder ignored, dismissed
+or added or no longer offered from the remote device).  A removed
+entry without a \fBdeviceID\fP attribute means that the folder is no
+longer pending for any device.
 .INDENT 0.0
 .INDENT 3.5
 .sp
@@ -791,15 +861,18 @@ no longer offered from the remote device).
  "data": {
    "added": [
      {
-        "device": "EJHMPAQ\-OGCVORE\-ISB4IS3\-SYYVJXF\-TKJGLTU\-66DIQPF\-GJ5D2GX\-GQ3OWQK",
-        "folder": "GXWxf\-3zgnU",
+        "deviceID": "EJHMPAQ\-OGCVORE\-ISB4IS3\-SYYVJXF\-TKJGLTU\-66DIQPF\-GJ5D2GX\-GQ3OWQK",
+        "folderID": "GXWxf\-3zgnU",
        "folderLabel": "My Pictures"
      }
    ],
    "removed": [
      {
-        "device": "P56IOI7\-MZJNU2Y\-IQGDREY\-DM2MGTI\-MGL3BXN\-PQ6W5BM\-TBBZ4TJ\-XZWICQ2",
-        "folder": "neyfh\-sa2nu"
+        "deviceID": "P56IOI7\-MZJNU2Y\-IQGDREY\-DM2MGTI\-MGL3BXN\-PQ6W5BM\-TBBZ4TJ\-XZWICQ2",
+        "folderID": "neyfh\-sa2nu"
+      },
+      {
+        "folderID": "abcde\-fghij"
      }
    ]
  }
@@ -835,7 +908,7 @@ Files that are updated locally produce a local\-change\-detected event.
 .fi
 .UNINDENT
 .UNINDENT
-.SS Remote Download Progress
+.SS RemoteDownloadProgress
 .sp
 This event is emitted when a download\-progress message is
 received. It returns a map \fBdata\fP of filenames with a count of
@@ -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" "Jun 07, 2021" "v1" "Syncthing"
+.TH "SYNCTHING-FAQ" "7" "Jun 14, 2021" "v1" "Syncthing"
 .SH NAME
 syncthing-faq \- Frequently Asked Questions
 .INDENT 0.0
@@ -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" "Jun 07, 2021" "v1" "Syncthing"
+.TH "SYNCTHING-GLOBALDISCO" "7" "Jun 14, 2021" "v1" "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" "Jun 07, 2021" "v1" "Syncthing"
+.TH "SYNCTHING-LOCALDISCO" "7" "Jun 14, 2021" "v1" "Syncthing"
 .SH NAME
 syncthing-localdisco \- Local Discovery Protocol v4
 .SH MODE OF OPERATION
@@ -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" "Jun 07, 2021" "v1" "Syncthing"
+.TH "SYNCTHING-NETWORKING" "7" "Jun 14, 2021" "v1" "Syncthing"
 .SH NAME
 syncthing-networking \- Firewall Setup
 .SH ROUTER SETUP
@@ -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" "Jun 07, 2021" "v1" "Syncthing"
+.TH "SYNCTHING-RELAY" "7" "Jun 14, 2021" "v1" "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" "Jun 07, 2021" "v1" "Syncthing"
+.TH "SYNCTHING-REST-API" "7" "Jun 14, 2021" "v1" "Syncthing"
 .SH NAME
 syncthing-rest-api \- REST API
 .sp
@@ -603,6 +603,32 @@ Returns information about current system status and resource usage. The CPU perc
    "global@https://discovery\-v6\-2.syncthing.net/v2/": "Post https://discovery\-v6\-2.syncthing.net/v2/: dial tcp [2604:a880:800:10::182:a001]:443: connect: no route to host",
    "global@https://discovery\-v6\-3.syncthing.net/v2/": "Post https://discovery\-v6\-3.syncthing.net/v2/: dial tcp [2400:6180:0:d0::d9:d001]:443: connect: no route to host"
  },
+  "discoveryStatus": {
+    "IPv4 local": {
+      "error": null
+    },
+    "IPv6 local": {
+      "error": null
+    },
+    "global@https://discovery\-v4\-1.syncthing.net/v2/": {
+      "error": "500 Internal Server Error"
+    },
+    "global@https://discovery\-v4\-2.syncthing.net/v2/": {
+      "error": "Post https://discovery\-v4\-2.syncthing.net/v2/: net/http: request canceled while waiting for connection (Client.Timeout exceeded while awaiting headers)"
+    },
+    "global@https://discovery\-v4\-3.syncthing.net/v2/": {
+      "error": "Post https://discovery\-v4\-3.syncthing.net/v2/: net/http: request canceled while waiting for connection (Client.Timeout exceeded while awaiting headers)"
+    },
+    "global@https://discovery\-v6\-1.syncthing.net/v2/": {
+      "error": "Post https://discovery\-v6\-1.syncthing.net/v2/: dial tcp [2001:470:28:4d6::5]:443: connect: no route to host"
+    },
+    "global@https://discovery\-v6\-2.syncthing.net/v2/": {
+      "error": "Post https://discovery\-v6\-2.syncthing.net/v2/: dial tcp [2604:a880:800:10::182:a001]:443: connect: no route to host"
+    },
+    "global@https://discovery\-v6\-3.syncthing.net/v2/": {
+      "error": "Post https://discovery\-v6\-3.syncthing.net/v2/: dial tcp [2400:6180:0:d0::d9:d001]:443: connect: no route to host"
+    }
+  },
  "discoveryMethods": 8,
  "goroutines": 49,
  "lastDialStatus": {
@@ -641,6 +667,14 @@ The \fBconnectionServiceStatus\fP entries gained \fB"error": null\fP
 attributes where previously there would be no \fBerror\fP attribute at all
 in the success case.

+.sp
+New in version 1.18.0: The \fBdiscoveryStatus\fP dictionary lists all configured discovery methods, not
+only failed ones like the now deprecated \fBdiscoveryErrors\fP\&.  Each entry is
+an object itself (for consistency with other fields), where a \fBnull\fP value
+for the \fBerror\fP attribute means the method is running successfully.  This
+effectively deprecates the \fBdiscoveryMethods\fP attribute as well, which now
+always matches the number of entries in \fBdiscoveryStatus\fP\&.
+
 .SS GET /rest/system/upgrade
 .sp
 Checks for a possible upgrade and returns an object describing the
@@ -724,6 +758,31 @@ and \fBPATCH\fP replaces only the given child objects.
 .SH CLUSTER ENDPOINTS
 .sp
 Concerns the mesh network structure.
+.SS DELETE /rest/cluster/pending/devices
+.sp
+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.
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+$ curl \-X DELETE \-H "X\-API\-Key: abc123" http://localhost:8384/rest/cluster/pending/devices?device=P56IOI7\-MZJNU2Y\-IQGDREY\-DM2MGTI\-MGL3BXN\-PQ6W5BM\-TBBZ4TJ\-XZWICQ2
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+Returns status 200 and no content upon success, or status 500 and a
+plain text error on failure.  A /events/pendingdeviceschanged
+event will be generated in response.
+.sp
+For a more permanent effect, also for future connections from the same
+device ID, the device should be ignored in the configuration instead.
 .SS GET /rest/cluster/pending/devices
 .sp
 New in version 1.13.0.
@@ -747,6 +806,34 @@ configured in our instance.
 .fi
 .UNINDENT
 .UNINDENT
+.SS DELETE /rest/cluster/pending/folders
+.sp
+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.
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+$ curl \-X DELETE \-H "X\-API\-Key: abc123" http://localhost:8384/rest/cluster/pending/folders?folder=cpkn4\-57ysy&device=P56IOI7\-MZJNU2Y\-IQGDREY\-DM2MGTI\-MGL3BXN\-PQ6W5BM\-TBBZ4TJ\-XZWICQ2
+.ft P
+.fi
+.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.
+.sp
+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.
@@ -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" "Jun 07, 2021" "v1" "Syncthing"
+.TH "SYNCTHING-SECURITY" "7" "Jun 14, 2021" "v1" "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" "Jun 07, 2021" "v1" "Syncthing"
+.TH "SYNCTHING-STIGNORE" "5" "Jun 14, 2021" "v1" "Syncthing"
 .SH NAME
 syncthing-stignore \- Prevent files from being synchronized to other nodes
 .SH SYNOPSIS
@@ -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" "Jun 07, 2021" "v1" "Syncthing"
+.TH "SYNCTHING-VERSIONING" "7" "Jun 14, 2021" "v1" "Syncthing"
 .SH NAME
 syncthing-versioning \- Keep automatic backups of deleted files by other nodes
 .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" "Jun 07, 2021" "v1" "Syncthing"
+.TH "SYNCTHING" "1" "Jun 14, 2021" "v1" "Syncthing"
 .SH NAME
 syncthing \- Syncthing
 .SH SYNOPSIS