[](https://github.com/butlerx/wetty#contributors-)
[](https://github.com/butlerx/wetty/tree/main/docs) [](https://github.com/butlerx/wetty/blob/main/LICENSE)
> Terminal access in browser over http/https
[](https://github.com/butlerx/wetty/blob/main/docs/terminal.png?raw=true)
Terminal over HTTP and https. WeTTY is an alternative to ajaxterm and anyterm but much better than them because WeTTY uses xterm.js which is a full fledged implementation of terminal emulation written entirely in JavaScript. WeTTY uses websockets rather than Ajax and hence better response time.
## Prerequisites
```
$ wetty --help
Options:
--help, -h Print help message [boolean]
--version Show version number [boolean]
--conf config file to load config from [string]
--ssl-key path to SSL key [string]
--ssl-cert path to SSL certificate [string]
--ssh-host ssh server host [string]
--ssh-port ssh server port [number]
--ssh-user ssh user [string]
--title window title [string]
--ssh-auth defaults to "password", you can use "publickey,password"
instead [string]
--ssh-pass ssh password [string]
--ssh-key path to an optional client private key (connection will be
password-less and insecure!) [string]
--ssh-config Specifies an alternative ssh configuration file. For further
details see "-F" option in ssh(1) [string]
--force-ssh Connecting through ssh even if running as root [boolean]
--known-hosts path to known hosts file [string]
--base, -b base path to wetty [string]
--port, -p wetty listen port [number]
--host wetty listen host [string]
--command, -c command to run in shell [string]
--allow-iframe Allow wetty to be embedded in an iframe, defaults to allowing
same origin [boolean]
```
Open your browser on `http://yourserver:3000/wetty` and you will prompted to login. Or go to `http://yourserver:3000/wetty/ssh/` to specify the user beforehand.
If you run it as root it will launch `/bin/login` (where you can specify the user name), else it will launch `ssh` and connect by default to `localhost`. The SSH connection can be forced using the `--force-ssh` option.
If instead you wish to connect to a remote host you can specify the `--ssh-host` option, the SSH port using the `--ssh-port` option and the SSH user using the `--ssh-user` option.
Check out the [Flags docs](https://butlerx.github.io/wetty/flags) for a full list of flags
### Docker container
To use WeTTY as a docker container, a docker image is available on [docker hub](https://hub.docker.com/r/wettyoss/wetty). To run this image, use
```
docker run --rm -p 3000:3000 wettyoss/wetty --ssh-host=
```
and you will be able to open a ssh session to the host given by `YOUR-IP` under the URL [http://localhost:3000/wetty](http://localhost:3000/wetty).
It is recommended to drive WeTTY behind a reverse proxy to have HTTPS security and possibly Let’s Encrypt support. Popular containers to achieve this are [nginx-proxy](https://github.com/nginx-proxy/nginx-proxy) and [traefik](https://traefik.io/traefik/). For traefik there is an example docker-compose file in the containers directory.
## FAQ
[](https://github.com/butlerx/wetty#faq)
Check out the [docs](https://github.com/butlerx/wetty/tree/main/docs)
- [Running as daemon](https://butlerx.github.io/wetty/service)
- [HTTPS Support](https://butlerx.github.io/wetty/https)
- [Using NGINX](https://butlerx.github.io/wetty/nginx)
- [Using Apache](https://butlerx.github.io/wetty/apache)
- [Automatic Login](https://butlerx.github.io/wetty/auto-login)
- [Downloading Files](https://butlerx.github.io/wetty/downloading-files)
### What browsers are supported?
Contributions, issues and feature requests are welcome!
Feel free to check [issues page](https://github.com/butlerx/wetty/issues).
Please read the [development docs](https://butlerx.github.io/wetty/development) for installing from source and running is dev node
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):