https://github.com/jpillora/node-shell-http

Shell access over HTTP
https://github.com/jpillora/node-shell-http

Last synced: about 1 month ago
JSON representation

Shell access over HTTP

• Host: GitHub
• URL: https://github.com/jpillora/node-shell-http
• Owner: jpillora
• Created: 2014-03-01T05:23:55.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2014-03-03T03:09:30.000Z (almost 11 years ago)
• Last Synced: 2024-10-14T11:41:16.720Z (3 months ago)
• Language: JavaScript
• Size: 160 KB
• Stars: 2
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# shell-http

## Summary

Shell access over HTTP

Install a [pnode](https://github.com/jpillora/pnode) RPC server over your HTTP servers

to provide shell access via Node's `child_process`.

## Usage

### Install `shell-http` on your server

```

npm install --save shell-http

```

``` js

var http = require("http");

//create server

var server = http.createServer(function(req, res) {

  res.end('a normal http server...');

}).listen(3000, function() {

  console.log("listening on http://localhost:3000");

});

//install shell daemon

var sh = require("shell-http");

sh.install(server);

```

### Connect with the `shell-http` API

```js

var sh = require("shell-http");

//create client

var client = sh.connect('http://localhost:3000');

//use 'client.std[in|out|err]'

setTimeout(function() {

  client.stdin.write("date\n");

}, 100);

client.stdout.on('data', function(data) {

  process.stdout.write("the date is: "+data);

});

```

### Connect with the `shell-http` CLI

```

npm install -g shell-http

```

```

shell-http --help

  Usage: shell-http [options] url

  Options:

    -h, --help            output usage information

    -V, --version         output the version number

    -c, --client          run in client mode (default)

    -s, --server          run in server mode

    -t, --token [abc123]  secret token

```

### Live demo running on Heroku:

```

shell-http --token foobar http://shell-http-demo.herokuapp.com

```

```

Using token "foobar"

Connecting to http://shell-http-demo.herokuapp.com:80...

  Connected to '6c11425f-1d0d-4dca-89d3-0d3aee003867' (http://shell-http-demo.herokuapp.com:80)

  Server Time '2014-03-01T09:57:26.501Z' (Uptime 11077822.03734204sec)

  Memory Usage 4.342GB/35.968GB (12.07% free)

  Average CPU Loads [3.3427734375,3.77587890625,3.6591796875] (4.0 max)

$ date

> Sat Mar  1 09:57:34 UTC 2014

```

## Security Considerations

This project was created for fun and is not production ready. However, if you are

intent on using it, I strongly advise you run it over an HTTPS server

with the access token (`SHELL_HTTP_TOKEN` env var) set to a cryptographically

strong passphrase.

## API

**Todo**

#### MIT License

Copyright © 2014 Jaime Pillora <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining

a copy of this software and associated documentation files (the

'Software'), to deal in the Software without restriction, including

without limitation the rights to use, copy, modify, merge, publish,

distribute, sublicense, and/or sell copies of the Software, and to

permit persons to whom the Software is furnished to do so, subject to

the following conditions:

The above copyright notice and this permission notice shall be

included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,

EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF

MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.

IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY

CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,

TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE

SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.