NerdOfCode / wetty

WeTTY... but it works in an iFrame

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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

git clone git@github.com:NerdOfCode/wetty.git && cd wetty
npm install && npm start

Note: You will most likely have to run wetty as root, due to the networking port it accesses(3001/tcp)...

Usage

Open your browser on http://yourserver:3001/wetty and you will prompted to login. Or go to http://yourserver:3001/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

WeTTY... but it works in an iFrame

License:MIT License


Languages

Language:TypeScript 76.9%Language:JavaScript 17.5%Language:CSS 3.8%Language:Dockerfile 1.8%