Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Cp0204 committed May 4, 2024
1 parent 5882658 commit ceb2b03
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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 支持 |

## 赞助
Expand Down

0 comments on commit ceb2b03

Please sign in to comment.