From 678feb74d14a1c19a8daa5728acb0ae4bd641ae4 Mon Sep 17 00:00:00 2001 From: gulewin Date: Fri, 13 Mar 2020 23:46:11 -0400 Subject: [PATCH] doc: update documentation to mention Ping server plugin --- doc/server_plugin.md | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/doc/server_plugin.md b/doc/server_plugin.md index fa511b3a..1f1d7e28 100644 --- a/doc/server_plugin.md +++ b/doc/server_plugin.md @@ -70,7 +70,7 @@ The response can look like any of the following: ### Operation -Currently `Login` and `NewProxy` operations are supported. +Currently `Login`, `NewProxy` and `Ping` operations are supported. #### Login @@ -135,6 +135,24 @@ Create new proxy } ``` +#### Ping + +Heartbeat from frpc + +``` +{ + "content": { + "user": { + "user": , + "metas": mapstring + "run_id": + }, + "timestamp": , + "privilege_key": + } +} +``` + ### Server Plugin Configuration ```ini @@ -155,7 +173,7 @@ ops = NewProxy addr: the address where the external RPC service listens on. 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