https://github.com/cp0204/ttydbridge

A Docker app makes it easy to use the host terminal in the web | 轻松在网页中使用主机终端
https://github.com/cp0204/ttydbridge

docker remote-access ssh terminal ttyd web

Last synced: 6 days ago
JSON representation

A Docker app makes it easy to use the host terminal in the web | 轻松在网页中使用主机终端

• Host: GitHub
• URL: https://github.com/cp0204/ttydbridge
• Owner: Cp0204
• License: agpl-3.0
• Created: 2024-05-03T15:39:51.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-05-23T04:35:55.000Z (8 months ago)
• Last Synced: 2024-05-23T04:59:25.273Z (8 months ago)
• Topics: docker, remote-access, ssh, terminal, ttyd, web
• Language: Shell
• Homepage: https://hub.docker.com/r/cp0204/ttydbridge
• Size: 66.4 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


![logo](img/icon.png)

# ttydBridge

English | [简体中文](/README_CN.md)

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]][github-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

[docker-pulls-image]: https://img.shields.io/docker/pulls/cp0204/ttydbridge

[docker-image-size-image]: https://img.shields.io/docker/image-size/cp0204/ttydbridge

[github-url]: https://github.com/Cp0204/ttydbridge

[docker-url]: https://hub.docker.com/r/cp0204/ttydbridge



## Usage

Run the container:

```shell

docker run -d \

  --name ttdybridge \

  -e PORT=2222 \

  -v /opt:/opt \

  --pid host \

  --privileged \

  --restart unless-stopped \

  cp0204/ttdybridge:latest

```

Access the web terminal via `http://yourhost:2222` and login with your system user.

## Environment

| Name                            | Default | Description                                                                                               |

| ------------------------------- | ------- | --------------------------------------------------------------------------------------------------------- |

| `EXEC_DIR`                      | `/opt`  | Program execution dir, must be consistent with volume mappings, **DO NOT MODIFY if you don't understand** |

| `START_COMMAND`                 | `login` | ttyd initial command, `login` uses system authentication, `bash` enters directly                          |

| `PORT`                          | `2222`  | Web port                                                                                                  |

| `ALLOW_WRITE`                   | `true`  | Allow terminal input                                                                                      |

| `HTTP_USERNAME` `HTTP_PASSWORD` |         | HTTP basic authentication, effective when set at the same time                                            |

| `ENABLE_SSL`                    | `false` | Enable SSL (https)                                                                                        |

| `SSL_CERT` `SSL_KEY` `SSL_CA`   |         | Host certificate paths, effective when ENABLE_SSL=true                                                    |

| `ENABLE_IPV6`                   | `false` | Enable IPv6 support                                                                                       |

| `AUTO_ALLOW_PORT`               | `false` | Automatically allow web ports                                                                             |

## Donate

Enjoyed the project? Consider buying me a coffee - it helps me keep going!



![WeChatPay](https://cdn.jsdelivr.net/gh/Cp0204/Cp0204@main/img/wechat_pay_qrcode.png)

## Thank

- [ttyd](https://github.com/tsl0922/ttyd) : Share your terminal over the web