From d1ff623a55059b391a9c8daaa0c2ee8cdd77d285 Mon Sep 17 00:00:00 2001 From: gulewin Date: Mon, 16 Mar 2020 21:02:00 -0400 Subject: [PATCH] doc: document NewWorkConn server plugin --- doc/server_plugin.md | 23 +++++++++++++++++++++-- 1 file changed, 21 insertions(+), 2 deletions(-) diff --git a/doc/server_plugin.md b/doc/server_plugin.md index 1f1d7e28..cacb0a42 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`, `NewProxy` and `Ping` operations are supported. +Currently `Login`, `NewProxy`, `Ping` and `NewWorkConn` operations are supported. #### Login @@ -153,6 +153,25 @@ Heartbeat from frpc } ``` +#### NewWorkConn + +New work connection received from frpc (RPC sent after `run_id` is matched with an existing frp connection) + +``` +{ + "content": { + "user": { + "user": , + "metas": mapstring + "run_id": + }, + "run_id": + "timestamp": , + "privilege_key": + } +} +``` + ### Server Plugin Configuration ```ini @@ -173,7 +192,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", "Ping"). +ops: operations plugin needs to handle (e.g. "Login", "NewProxy", ...). ### Metadata