doc: update documentation to mention Ping server plugin

This commit is contained in:
gulewin 2020-03-13 23:46:11 -04:00
parent 2f2f714c1e
commit 678feb74d1

View File

@ -70,7 +70,7 @@ The response can look like any of the following:
### Operation ### Operation
Currently `Login` and `NewProxy` operations are supported. Currently `Login`, `NewProxy` and `Ping` operations are supported.
#### Login #### Login
@ -135,6 +135,24 @@ Create new proxy
} }
``` ```
#### Ping
Heartbeat from frpc
```
{
"content": {
"user": {
"user": <string>,
"metas": map<string>string
"run_id": <string>
},
"timestamp": <int64>,
"privilege_key": <string>
}
}
```
### Server Plugin Configuration ### Server Plugin Configuration
```ini ```ini
@ -155,7 +173,7 @@ ops = NewProxy
addr: the address where the external RPC service listens on. addr: the address where the external RPC service listens on.
path: http request url path for the POST request. path: http request url path for the POST request.
ops: operations plugin needs to handle (e.g. "Login", "NewProxy"). ops: operations plugin needs to handle (e.g. "Login", "NewProxy", "Ping").
### Metadata ### Metadata