Skip to content

Commit 9e2277c

Browse files
Update README.md
1 parent 087ce02 commit 9e2277c

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ Advanced environment variables
3535
| :--- | :--- | :---| :---|
3636
| SESSION_STORAGE_SIZE | string | 10M | Storage size limit for single connection |
3737
| KUBECTL_INSECURE_SKIP_TLS_VERIFY | bool | true | whether to skip tls verify |
38+
| GOTTY_OPTIONS | string | --port 8080 --permit-write --permit-arguments | Gotty options, see [more](https://github.com/webkubectl/gotty/blob/master/GOTTY_USAGE.md#options) |
3839
| WELCOME_BANNER | string | Welcome to Web Kubectl, try kubectl --help. | Welcome banner after web terminal opened |
3940

4041
# Usage
@@ -104,8 +105,8 @@ http://<webkubectl-address>:<port>/terminal/?token=<token fetched from api>
104105

105106
# Security
106107
- **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.
107-
- **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).
108-
- **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.
108+
- **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).
109+
- **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.
109110

110111
# Dependencies
111112
- [webkubectl/gotty](https://github.com/webkubectl/gotty)

0 commit comments

Comments
 (0)