tsl0922/ttyd
Ttyd
ttyd is a web-based terminal emulator that shares a command-line shell over a web connection. It serves as a remote console and shell gateway, allowing for remote system administration and command execution through a standard web browser.
The project includes specialized capabilities for rendering graphical images via the Sixel standard and supporting bidirectional file uploads and downloads using the ZMODEM transfer protocol. It supports collaborative terminal sharing, enabling multiple concurrent users to connect to the same running process or session in real time.
The system provides security through SSL traffic encryption and access control via basic authentication, system account credentials, or reverse-proxy compatible headers. It also supports isolated environment provisioning by spawning a fresh container for each new user connection and allows for custom shell execution configurations, including specified working directories and user identities.
Features
- Web-Based Terminal Gateways - Exposes command-line processes as interactive web applications for remote browser-based access.
- Web-Based Terminal Emulators - Provides a web-based terminal emulator that shares a command-line shell over a web connection.
- WebSocket Piping - Uses persistent bidirectional WebSockets to pipe terminal input and output between the server and browser.
- Pseudo-Terminal Interfaces - Allocates pseudo-terminal devices to enable interactive shell behavior within the browser emulator.
- Child Process Execution - Spawns and manages shell child processes, mapping their standard streams to web client connections.
- Remote Administration Interfaces - Provides a web-based interface for executing system commands and managing remote servers without SSH.
- Collaborative Terminal Sessions - Enables multiple users to connect to the same running terminal session for real-time collaborative interaction.
- Custom Command Execution - Allows configuring specific applications or scripts to run as the primary process for the terminal.
- Containerized Provisioning - Automatically provisions a new, isolated container for every user connection to ensure a clean environment.
- Zmodem Transfers - Supports bidirectional file transfers between the client and server using the ZMODEM protocol.
- Remote File Transfers - Facilitates bidirectional file movement between local machines and remote terminals.
- Shell Command Execution - Allows configuring custom shell commands with specific working directories, user IDs, and group IDs.
- Terminal Multiplexers - Implements terminal multiplexing to broadcast a single shell session to multiple concurrent web clients.
- Container Isolation Technologies - Spawns a fresh, isolated container for each new user connection to ensure environment security.
- Containerized Environments - Uses container technology to provide isolated and consistent shell environments for each user.
- Terminal Graphics Rendering - Displays high-fidelity graphics and images within the terminal emulator using the Sixel standard.
- Reverse Proxy Authentication - Supports identity verification via external HTTP headers provided by reverse proxies before granting terminal access.
- Secure Remote Access - Secures remote terminal access using SSL encryption and authenticated communication channels.
- Inline Image Renderers - Renders Sixel-encoded graphical images directly within the web-based terminal emulator.
- Terminal Utilities - Shares terminal sessions over the web.
Star history
How this analysis was created: This summary and feature list are AI-generated from collected project material and can contain mistakes. Stars, license and language are imported from GitHub. Inclusion does not mean that we have tested or audited this project. Check the source documentation for any feature you depend on. Learn more on our About page.
