From b252e1abe96b24adcc6d98cacaeea2764006612e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ren=C3=A9=20Jochum?= Date: Tue, 29 Sep 2020 20:58:33 +0200 Subject: [PATCH] Update docs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: René Jochum --- README.md | 22 +++++++++++++++------- 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 7d0d1b3..f288b69 100644 --- a/README.md +++ b/README.md @@ -4,18 +4,26 @@ LQL API Server for check_mk ## Commands the client supports -### localclient +### localclient - Local LQL Client -Local LQL Client - requires a local lql unix socket +requires a local lql unix socket -### sshclient +### localserver: Local LQL Server -SSH LQL Client - connects to your Server by SSH opens a SSH tunnel to the server's lql Socket and runs a query on it. +requires a local lql unix socket -### sshserver +### sshclient: SSH LQL Client -SSH LQL Server - connects to your Server by SSH opens a SSH tunnel to the server's lql Socket and runs an API Server for that socket. +connects to your Server by SSH opens a SSH tunnel to the server's lql Socket and runs a query on it. + +### sshserver: SSH LQL Server + +Connects to your Server by SSH opens a SSH tunnel to the server's lql Socket and runs an API Server for that socket. ### Version -Prints the version \ No newline at end of file +Prints the version + +## OpenAPI 3.0 Support in sshserver + +This support's OpenAPI 3.0 use the url http://localhost:8080/openapi.json and browse it over an OpenAPI browser. \ No newline at end of file