gui, man: Update docs & translations
This commit is contained in:
Jakob Borg
@@ -1,6 +1,6 @@
|
||||
.\" Man page generated from reStructuredText.
|
||||
.
|
||||
.TH "SYNCTHING-REST-API" "7" "May 21, 2016" "v0.12" "Syncthing"
|
||||
.TH "SYNCTHING-REST-API" "7" "June 03, 2016" "v0.12" "Syncthing"
|
||||
.SH NAME
|
||||
syncthing-rest-api \- REST API
|
||||
.
|
||||
@@ -54,7 +54,105 @@ Returns the current configuration.
|
||||
.nf
|
||||
.ft C
|
||||
{
|
||||
# etc
|
||||
{
|
||||
"version": 15,
|
||||
"folders": [
|
||||
{
|
||||
"id": "GXWxf\-3zgnU",
|
||||
"label": "MyFolder",
|
||||
"path": "...",
|
||||
"type": "readwrite",
|
||||
"devices": [
|
||||
{
|
||||
"deviceID": "..."
|
||||
}
|
||||
],
|
||||
"rescanIntervalS": 60,
|
||||
"ignorePerms": false,
|
||||
"autoNormalize": true,
|
||||
"minDiskFreePct": 1,
|
||||
"versioning": {
|
||||
"type": "",
|
||||
"params": {}
|
||||
},
|
||||
"copiers": 0,
|
||||
"pullers": 0,
|
||||
"hashers": 0,
|
||||
"order": "random",
|
||||
"ignoreDelete": false,
|
||||
"scanProgressIntervalS": 0,
|
||||
"pullerSleepS": 0,
|
||||
"pullerPauseS": 0,
|
||||
"maxConflicts": 10,
|
||||
"disableSparseFiles": false,
|
||||
"disableTempIndexes": false,
|
||||
"invalid": ""
|
||||
}
|
||||
],
|
||||
"devices": [
|
||||
{
|
||||
"deviceID": "...",
|
||||
"name": "Laptop",
|
||||
"addresses": [
|
||||
"dynamic",
|
||||
"tcp://192.168.1.2:22000"
|
||||
],
|
||||
"compression": "metadata",
|
||||
"certName": "",
|
||||
"introducer": false
|
||||
}
|
||||
],
|
||||
"gui": {
|
||||
"enabled": true,
|
||||
"address": "127.0.0.1:8384",
|
||||
"user": "Username",
|
||||
"password": "$2a$10$ZFws69T4FlvWwsqeIwL.TOo5zOYqsa/.TxlUnsGYS.j3JvjFTmxo6",
|
||||
"useTLS": false,
|
||||
"apiKey": "pGahcht56664QU5eoFQW6szbEG6Ec2Cr",
|
||||
"insecureAdminAccess": false,
|
||||
"theme": "default"
|
||||
},
|
||||
"options": {
|
||||
"listenAddresses": [
|
||||
"default"
|
||||
],
|
||||
"globalAnnounceServers": [
|
||||
"default"
|
||||
],
|
||||
"globalAnnounceEnabled": true,
|
||||
"localAnnounceEnabled": true,
|
||||
"localAnnouncePort": 21027,
|
||||
"localAnnounceMCAddr": "[ff12::8384]:21027",
|
||||
"maxSendKbps": 0,
|
||||
"maxRecvKbps": 0,
|
||||
"reconnectionIntervalS": 60,
|
||||
"relaysEnabled": true,
|
||||
"relayReconnectIntervalM": 10,
|
||||
"startBrowser": false,
|
||||
"natEnabled": true,
|
||||
"natLeaseMinutes": 60,
|
||||
"natRenewalMinutes": 30,
|
||||
"natTimeoutSeconds": 10,
|
||||
"urAccepted": \-1,
|
||||
"urUniqueId": "",
|
||||
"urURL": "https://data.syncthing.net/newdata",
|
||||
"urPostInsecurely": false,
|
||||
"urInitialDelayS": 1800,
|
||||
"restartOnWakeup": true,
|
||||
"autoUpgradeIntervalH": 12,
|
||||
"keepTemporariesH": 24,
|
||||
"cacheIgnoredFiles": false,
|
||||
"progressUpdateIntervalS": 5,
|
||||
"symlinksEnabled": true,
|
||||
"limitBandwidthInLan": false,
|
||||
"minHomeDiskFreePct": 1,
|
||||
"releasesURL": "https://upgrades.syncthing.net/meta.json",
|
||||
"alwaysLocalNets": [],
|
||||
"overwriteRemoteDeviceNamesOnConnect": false,
|
||||
"tempIndexMinBlocks": 10
|
||||
},
|
||||
"ignoredDevices": []
|
||||
}
|
||||
}
|
||||
.ft P
|
||||
.fi
|
||||
@@ -86,12 +184,14 @@ the corresponding GET request. The configuration will be saved to disk and the
|
||||
\fBNOTE:\fP
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
Return format changed in 0.12.0.
|
||||
Return format changed in 0.13.0.
|
||||
.UNINDENT
|
||||
.UNINDENT
|
||||
.sp
|
||||
Returns the list of configured devices and some metadata associated
|
||||
with them. The list also contains the local device itself as not connected.
|
||||
.sp
|
||||
The connection types are \fBTCP (Client)\fP, \fBTCP (Server)\fP, \fBRelay (Client)\fP and \fBRelay (Server)\fP\&.
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
@@ -104,7 +204,7 @@ with them. The list also contains the local device itself as not connected.
|
||||
"at" : "2015\-11\-07T17:29:47.691637262+01:00",
|
||||
"connected" : false,
|
||||
"inBytesTotal" : 1479,
|
||||
"type" : "direct\-accept",
|
||||
"type" : "",
|
||||
"outBytesTotal" : 1318,
|
||||
"address" : ""
|
||||
},
|
||||
@@ -116,12 +216,12 @@ with them. The list also contains the local device itself as not connected.
|
||||
"at" : "2015\-11\-07T17:29:47.691548971+01:00",
|
||||
"clientVersion" : "v0.12.1",
|
||||
"address" : "127.0.0.1:22002",
|
||||
"type" : "direct\-dial",
|
||||
"type" : "TCP (Client)",
|
||||
"outBytesTotal" : 550
|
||||
},
|
||||
"DOVII4U\-SQEEESM\-VZ2CVTC\-CJM4YN5\-QNV7DCU\-5U3ASRL\-YVFG6TH\-W5DV5AA" : {
|
||||
"outBytesTotal" : 0,
|
||||
"type" : "direct\-accept",
|
||||
"type" : "",
|
||||
"address" : "",
|
||||
"at" : "0001\-01\-01T00:00:00Z",
|
||||
"clientVersion" : "",
|
||||
@@ -131,7 +231,7 @@ with them. The list also contains the local device itself as not connected.
|
||||
},
|
||||
"UYGDMA4\-TPHOFO5\-2VQYDCC\-7CWX7XW\-INZINQT\-LE4B42N\-4JUZTSM\-IWCSXA4" : {
|
||||
"address" : "",
|
||||
"type" : "direct\-accept",
|
||||
"type" : "",
|
||||
"outBytesTotal" : 0,
|
||||
"connected" : false,
|
||||
"inBytesTotal" : 0,
|
||||
@@ -748,8 +848,8 @@ $ curl \-s http://localhost:8384/rest/stats/device | json
|
||||
.UNINDENT
|
||||
.SS GET /rest/stats/folder
|
||||
.sp
|
||||
Returns general statistics about folders. Currently, only contains the
|
||||
last synced file.
|
||||
Returns general statistics about folders. Currently contains the
|
||||
last scan time and the last synced file.
|
||||
.INDENT 0.0
|
||||
.INDENT 3.5
|
||||
.sp
|
||||
@@ -758,6 +858,7 @@ last synced file.
|
||||
$ curl \-s http://localhost:8384/rest/stats/folder | json
|
||||
{
|
||||
"folderid" : {
|
||||
"lastScan": "2016\-06\-02T13:28:01.288181412\-04:00",
|
||||
"lastFile" : {
|
||||
"filename" : "file/name",
|
||||
"at" : "2015\-04\-16T22:04:18.3066971+01:00"
|
||||
|
||||
Reference in New Issue
Block a user