From ceb2b03a5fa6e9b05720da25eccfb120b82b05de Mon Sep 17 00:00:00 2001 From: Cp0204 Date: Sat, 4 May 2024 23:29:39 +0800 Subject: [PATCH] update README --- README.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index e1a519a..538cc2a 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,10 @@ 如一座“桥”，连通了宿主机环境，让你在浏览器中轻松使用宿主机终端 +Docker containers based on ttyd bypass the isolation mechanism. + +A "bridge" to the host environment, allowing you to easily use the host terminal in your browser. + [![docker tag][docker-tag-image]][docker-url] [![docker pulls][docker-pulls-image]][docker-url] [![docker image size][docker-image-size-image]][docker-url] [docker-tag-image]: https://img.shields.io/docker/v/cp0204/ttydbridge @@ -39,13 +43,13 @@ docker run -d \ | 变量名 | 默认值 | 描述 | | ------------------------------- | ------- | -------------------------------------------------- | -| `EXEC_DIR` | `/opt` | 运行目录，必须配合卷映射三处一致，不懂勿改 | +| `EXEC_DIR` | `/opt` | 程序运行目录，必须配合卷映射三处一致，不懂勿改 | | `START_COMMAND` | `login` | ttyd 初始命令，`login`使用系统鉴权，`bash`直接进入 | | `PORT` | `2222` | 网页端口 | -| `ALLOW_WRITE` | `true` | 允许写入 | +| `ALLOW_WRITE` | `true` | 允许终端输入 | | `HTTP_USERNAME` `HTTP_PASSWORD` | | HTTP基础验证凭据，同时设置时生效 | -| `ENABLE_SSL` | `false` | 启用 SSL | -| `SSL_CERT` `SSL_KEY` `SSL_CA` | | 证书路径，当 ENABLE_SSL=true 时生效 | +| `ENABLE_SSL` | `false` | 启用 SSL （https） | +| `SSL_CERT` `SSL_KEY` `SSL_CA` | | 主机证书路径，当 ENABLE_SSL=true 时生效 | | `ENABLE_IPV6` | `false` | 启用 IPv6 支持 | ## 赞助