hacktoberfest xtermjs xterm-js xterm wetty terminal anyterm ajaxterm

butlerx 8b5a7df712 use snowpack to import client modules to avoid bundling		4 years ago
.github	Create codeql-analysis.yml	4 years ago
assets	use snowpack to import client modules to avoid bundling	4 years ago
conf	restructor repo to reduce top level files	4 years ago
containers	restructor repo to reduce top level files	4 years ago
docs	Fix broken link in README.md	5 years ago
src	use snowpack to import client modules to avoid bundling	4 years ago
.all-contributorsrc	Feature/remediation (#162)	5 years ago
.dockerignore	Replace hterm with Xterm.js (#29)	7 years ago
.eslintignore	use snowpack to import client modules to avoid bundling	4 years ago
.eslintrc.json	restructor repo to reduce top level files	4 years ago
.gitignore	use snowpack to import client modules to avoid bundling	4 years ago
.npmignore	restructor repo to reduce top level files	4 years ago
.prettierrc.json	use snowpack to import client modules to avoid bundling	4 years ago
LICENSE	Update LICENSE	7 years ago
README.md	restructor repo to reduce top level files	4 years ago
docker-compose.yml	restructor repo to reduce top level files	4 years ago
package.json	use snowpack to import client modules to avoid bundling	4 years ago
tsconfig.json	use snowpack to import client modules to avoid bundling	4 years ago
yarn.lock	use snowpack to import client modules to avoid bundling	4 years ago

README.md

WeTTY = Web + TTY.

Terminal access in browser over http/https

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 then Ajax and hence better response time.

Prerequisites

node >=6.9
make
python
build-essential

Install

yarn global add wetty

Usage

wetty [-h] [--port PORT] [--base BASE] [--sshhost SSH_HOST] [--sshport SSH_PORT] [--sshuser SSH_USER] [--host HOST] [--command COMMAND] [--forcessh] [--bypasshelmet] [--title TITLE] [--sslkey SSL_KEY_PATH] [--sslcert SSL_CERT_PATH]

Open your browser on http://yourserver:3000/wetty and you will prompted to login. Or go to http://yourserver:3000/wetty/ssh/<username> to specify the user before hand.

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 --forcessh option.

If instead you wish to connect to a remote host you can specify the --sshhost option, the SSH port using the --sshport option and the SSH user using the --sshuser option.

Check out the Flags docs for a full list of flags

FAQ

Check out the docs

What browsers are supported?

WeTTy supports all browsers that xterm.js supports.

Author

👤 Cian Butler butlerx@notthe.cloud

Twitter: @cianbutlerx
Github: @butlerx

Contributing ✨

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

Please read the development docs for installing from source and running is dev node

Thanks goes to these wonderful people (emoji key):

_{Cian Butler} 💻 📖	_{Krishna Srinivas} 💻	_acalatrava 💻	_Strubbl 💻	_{Oleg Kurapov} 💻	_{Boyan Rabchev} 💻	_Jimmy 💻
_{Luca Milanesio} 💻	_{Anthony Jund} 💻	_mirtouf 💻	_{Bertrand Roussel} 💻	_{Ben Letchford} 💻	_SouraDutta 💻	_{Koushik M.L.N} 💻
_Imuli 💻	_perpen 💻	_{Nathan LeClaire} 💻	_{Mihir Kumar} 💻	_{Chris Suszynski} 💻	_{Felix Bartels} 💻	_{Jarrett Gilliam} 💻
_{Harry Lee} 💻	_{Andreas Klöckner} 💻	_DenisKramer 💻	_{Vamshi K Ponnapalli} 💻	_{Tri Nguyen} 📖	_{Felix Pojtinger} 📖	_{Neale Pickett} 💻
_{Matthew Piercey} 📖	_{Kasper Holbek Jensen} 📖	_{Farhan Khan} 💻	_{Jurre Vriesen} 💻	_{James Turnbull} 💻