OpenSource-Hub
W

WeTTY

5.3k stars·Developer Tools·SHA-256 checksum verified

Browser-based terminal emulator using xterm.js and WebSocket. Connect to local shell or any SSH server. No plugins required.

Smart Download

Visit Project Homepage

No installer available yet — head to the source repository

Run a full terminal in your browser via HTTP/HTTPS, with SSH support and fast WebSocket communication.

Core Features

  • No extra client needed – terminal runs in browser
  • SSH to any remote host with password or public key auth
  • Fast WebSocket-based communication
  • SSL/HTTPS support
  • Can be embedded in iframe

What It Can't Do

  • When run as non-root it tries to SSH to localhost – ensure SSH server is running,Using --ssh-key disables password check, potentially insecure,Use reverse proxy (nginx/traefik) for HTTPS in production to protect credentials

Use Cases

  • Remote server administration from any device
  • Docker/SSH debugging in browser
  • Classroom demos without local terminal setup

Detailed Introduction

WeTTY is a web-based terminal emulator that lets you access a shell or SSH session directly from your browser. It uses xterm.js (a full terminal emulator written in JavaScript) and WebSocket instead of Ajax, resulting in lower latency and smoother interaction. You can connect to any SSH server, specify user, port, and authentication method (password or public key). It also supports running a local shell when started as root. Easy to install via npm, and a Docker image is available. For production, run behind a reverse proxy (nginx/traefik) for HTTPS.

Troubleshooting & FAQ (2)

Troubleshooting
How to fix 'Module not found' error when starting Wetty 3.0.0 in Docker?

Update to the latest Wetty release. The 'Cannot find module' bug was fixed in a later version. Pull the latest image: docker pull wettyoss/wetty:latest, then recreate your container with the same configuration. Ensure you are not pinned to version 3.0.0.

GitHub Issue #604
Troubleshooting
How to fix xterm-addon-fit not resizing terminal properly in Wetty?

This is a known issue in Wetty 2.6.0. The fix is available on the main branch but not yet released. As a workaround, check out the main branch, build, and run from source:

git clone https://github.com/butlerx/wetty.git
cd wetty
pnpm i
pnpm build
pnpm start <your options>

A new release with the fix is expected.

GitHub Issue #532

Tags

terminalweb-basedsshxterm.jswebsocketbrowser

Getting Started

1

Download installer

Click the button above to download the installer for your system

2

Install the software

Double-click the downloaded installer and follow the prompts

3

Install Node.js 18+ if not present

4

Run `npm install -g wetty`

5

Start with `wetty` (default port 3000)

Install Guide
  1. Install Node.js 18+ if not present
  2. Run `npm install -g wetty`
  3. Start with `wetty` (default port 3000)
File Integrity

Checksum not available

This project has not published a SHA-256 checksum on its GitHub Release page

SHA256 Checksum

No checksum available

Download directly from GitHub Releases and verify file integrity yourself

All SHA-256 checksums on this platform are extracted from the project's official GitHub Release page, without any modification. You can independently verify them on the GitHub Releases page.

Open Source Transparency

View GitHub Source
Environment Guide

Uninstall Info

Run `npm uninstall -g wetty` to remove. If using Docker, stop and remove the container.

No Extra Dependencies

Ready to use after download. No additional runtime required.

Project Info
LicenseMIT
Last Updated2026-06-27 08:30:18
GitHub RepositoryOfficial Website

Having issues? Check the FAQ below

2 FAQs

Similar Projects