From 9e2277c3316a1f9ce1959e524667b0c51ce1d920 Mon Sep 17 00:00:00 2001 From: liqiang-fit2cloud Date: Wed, 23 Oct 2019 14:32:43 +0800 Subject: [PATCH] Update README.md --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 57be454..08741c9 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,7 @@ Advanced environment variables | :--- | :--- | :---| :---| | SESSION_STORAGE_SIZE | string | 10M | Storage size limit for single connection | | KUBECTL_INSECURE_SKIP_TLS_VERIFY | bool | true | whether to skip tls verify | +| GOTTY_OPTIONS | string | --port 8080 --permit-write --permit-arguments | Gotty options, see [more](https://github.com/webkubectl/gotty/blob/master/GOTTY_USAGE.md#options) | | WELCOME_BANNER | string | Welcome to Web Kubectl, try kubectl --help. | Welcome banner after web terminal opened | # Usage @@ -104,8 +105,8 @@ http://:/terminal/?token= # Security - **Token validation**：The token fetched from api will be invalid immediately after it's used once, and it expires after 5 minutes if not used. -- **Authentication**：By default all resources can be accessed without any authentication, to restrict anonymous access, you can enable the basic authentication of gotty, see [how to](https://github.com/yudai/gotty#options). -- **SSL/TLS**：By default all traffic between the server and clients are NOT encrypted, we recommend you enable SSL/TLS option of gotty, see [how to](https://github.com/yudai/gotty#options). Alternatively you can deploy Web Kubectl behind a proxy and enable SSL/TLS for the proxy, please note that the proxy should support WebSocket protocol. +- **Authentication**：By default all resources can be accessed without any authentication, to restrict anonymous access, you can enable the basic authentication of gotty, see [how to](https://github.com/webkubectl/gotty/blob/master/GOTTY_USAGE.md#options). +- **SSL/TLS**：By default all traffic between the server and clients are NOT encrypted, we recommend you enable SSL/TLS option of gotty, see [how to](https://github.com/webkubectl/gotty/blob/master/GOTTY_USAGE.md#options). Alternatively you can deploy Web Kubectl behind a proxy and enable SSL/TLS for the proxy, please note that the proxy should support WebSocket protocol. # Dependencies - [webkubectl/gotty](https://github.com/webkubectl/gotty)