Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
liqiang-fit2cloud committed Oct 23, 2019
1 parent 087ce02 commit 9e2277c
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -104,8 +105,8 @@ http://<webkubectl-address>:<port>/terminal/?token=<token fetched from api>

# 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)
Expand Down

0 comments on commit 9e2277c

Please sign in to comment.