Skip to content
master
Go to file
Code

Files

Permalink
Failed to load latest commit information.

README.md

WeTTY = Web + TTY.

All Contributors

Version Node Version Documentation License: MIT Twitter: cianbutlerx

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

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
Cian Butler

💻 📖
Krishna Srinivas
Krishna Srinivas

💻
acalatrava
acalatrava

💻
Strubbl
Strubbl

💻
Oleg Kurapov
Oleg Kurapov

💻
Boyan Rabchev
Boyan Rabchev

💻
Jimmy
Jimmy

💻
Luca Milanesio
Luca Milanesio

💻
Anthony Jund
Anthony Jund

💻
mirtouf
mirtouf

💻
Bertrand Roussel
Bertrand Roussel

💻
Ben Letchford
Ben Letchford

💻
SouraDutta
SouraDutta

💻
Koushik M.L.N
Koushik M.L.N

💻
Imuli
Imuli

💻
perpen
perpen

💻
Nathan LeClaire
Nathan LeClaire

💻
Mihir Kumar
Mihir Kumar

💻
Chris Suszynski
Chris Suszynski

💻
Felix Bartels
Felix Bartels

💻
Jarrett Gilliam
Jarrett Gilliam

💻
Harry Lee
Harry Lee

💻
Andreas Klöckner
Andreas Klöckner

💻
DenisKramer
DenisKramer

💻
Vamshi K Ponnapalli
Vamshi K Ponnapalli

💻
Tri Nguyen
Tri Nguyen

📖
Felix Pojtinger
Felix Pojtinger

📖
Neale Pickett
Neale Pickett

💻
Matthew Piercey
Matthew Piercey

📖
Kasper Holbek Jensen
Kasper Holbek Jensen

📖
Farhan Khan
Farhan Khan

💻
Jurre Vriesen
Jurre Vriesen

💻
James Turnbull
James Turnbull

💻

This project follows the all-contributors specification. Contributions of any kind welcome!

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2019 Cian Butler butlerx@notthe.cloud.
This project is MIT licensed.


About

Terminal in browser over http/https. (Ajaxterm/Anyterm alternative, but much better)

Resources

License

You can’t perform that action at this time.