wetty/docs/README.md

# Docs

![WeTTy](./terminal.png?raw=true)

- [Running as daemon](./service.md)
- [SSL Support](./ssl.md)
  - [Using NGINX](./nginx.md)
  - [Using Apache](./apache.md)
- [Automatic Login](./auto-login.md)
- [Downloading Files](./downloading-files.md)
- [Development Docs](./development.md)

## API

For WeTTy options and event details please refer to the [api docs](./API.md)

### Getting started

WeTTy is event driven. To Spawn a new server call `wetty.start()` with no
arguments.

```javascript
const wetty = require('wetty.js');

wetty
  .on('exit', ({ code, msg }) => {
    console.log(`Exit with code: ${code} ${msg}`);
  })
  .on('spawn', msg => console.log(msg));
wetty.start(/* server settings, see Options */).then(() => {
  console.log('server running');
  /* code you want to execute */
});
```
Replace hterm with Xterm.js (#29) * switch too xterm and webpack * handle disconects clearner * stop browser from over rulling ctrl+shift+c * update pkg.json * replace log statements with events * restructure cli * reduce use of shared state * remove ssh wrapper * minify, uglify and tree shake code bundle * use seperate containers for building frontend * fit sizing errors * add helmet * fix term resize * add loger * use custom fix function * stop server crashing after disconnect * make better on mobile * use a pty as a buffer to handle all keyboard keys * unwrap var * clean up structure of code * update readme * add api * refactor event emitter * expand emmitter class * fix event emitter calls * format docs * fix docs * clean up webpack 7 years ago			`# Docs`

Feature/remediation (#162) clean up server package to be for ogranised No longer use event emitting for logging ensure process env is typed correctly remove 301 redirect reenable text on mobile split static classes up to make repo more structured split docs up Add List of contributors Docs: Add @butlerx as a contributor Docs: Add @krishnasrinivas as a contributor Docs: Add @acalatrava as a contributor Docs: Add @Strubbl as a contributor Docs: Add @2sheds as a contributor Docs: Add @rabchev as a contributor Docs: Add @nosemeocurrenada as a contributor Docs: Add @lucamilanesio as a contributor Docs: Add @antonyjim as a contributor Docs: Add @mirtouf as a contributor Docs: Add @CoRfr as a contributor Docs: Add @benletchford as a contributor Docs: Add @SouraDutta as a contributor Docs: Add @koushikmln as a contributor Docs: Add @imuli as a contributor Docs: Add @perpen as a contributor Docs: Add @nathanleclaire as a contributor Docs: Add @MiKr13 as a contributor Docs: Add @cardil as a contributor Docs: Add @fbartels as a contributor Docs: Add @jarrettgilliam as a contributor Docs: Add @harryleesan as a contributor Docs: Add @inducer as a contributor Docs: Add @DenisKramer as a contributor Docs: Add @vamship as a contributor Docs: Add @tnguyen14 as a contributor Docs: Add @pojntfx as a contributor Docs: Add @nealey as a contributor Docs: Add @mtpiercey as a contributor Docs: Add @kholbekj as a contributor Docs: Add @khanzf as a contributor Docs: Add @jurruh as a contributor Docs: Add @jamtur01 as a contributor 5 years ago			`![WeTTy](./terminal.png?raw=true)`

			`- [Running as daemon](./service.md)`
			`- [SSL Support](./ssl.md)`
			`- [Using NGINX](./nginx.md)`
			`- [Using Apache](./apache.md)`
			`- [Automatic Login](./auto-login.md)`
			`- [Downloading Files](./downloading-files.md)`
			`- [Development Docs](./development.md)`

			`## API`

			`For WeTTy options and event details please refer to the [api docs](./API.md)`

			`### Getting started`
Replace hterm with Xterm.js (#29) * switch too xterm and webpack * handle disconects clearner * stop browser from over rulling ctrl+shift+c * update pkg.json * replace log statements with events * restructure cli * reduce use of shared state * remove ssh wrapper * minify, uglify and tree shake code bundle * use seperate containers for building frontend * fit sizing errors * add helmet * fix term resize * add loger * use custom fix function * stop server crashing after disconnect * make better on mobile * use a pty as a buffer to handle all keyboard keys * unwrap var * clean up structure of code * update readme * add api * refactor event emitter * expand emmitter class * fix event emitter calls * format docs * fix docs * clean up webpack 7 years ago
			WeTTy is event driven. To Spawn a new server call `wetty.start()` with no
			`arguments.`

			```javascript
			`const wetty = require('wetty.js');`

			`wetty`
			`.on('exit', ({ code, msg }) => {`
			console.log(`Exit with code: ${code} ${msg}`);
			`})`
			`.on('spawn', msg => console.log(msg));`
			`wetty.start(/* server settings, see Options */).then(() => {`
			`console.log('server running');`
			`/* code you want to execute */`
			`});`
			```