Sign inSign up

wettyoss/wetty

By wettyoss

โ€ขUpdated 17 days ago

Terminal access in browser over http/https

Image
30

1M+

wettyoss/wetty repository overview

โ WeTTY = Web + TTY.

All Contributors

Version Node Version Documentation License: MIT Twitter: cianbutlerx

Terminal access in browser over http/https

WeTTy

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 >=14
  • make
  • python
  • build-essential

โ Install

yarn global add wetty

โ Usage

$ 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]
  --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]
  --bypass-helmet  disable helmet from placing security restrictions   [boolean]

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 --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โ  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 [email protected]โ 

โ 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โ ):

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 โ [email protected]โ .
This project is MITโ  licensed.


Tag summary

Content type

Image

Digest

sha256:4f7c56d5bโ€ฆ

Size

213.6 MB

Last updated

17 days ago

docker pull wettyoss/wetty