feat/moar config (#43)

* docs: document how to use the signalling server

* feat: moar config options (added option to config host

Author: daviddias

README.md

@@ -24,18 +24,43 @@
 
 ## Example
 
-```
+```JavaScript
 TODO
 ```
 
-## Installation
+## Usage
+
+### Installation
+
+```bash
+> npm install libp2p-webrtc-star
+```
+
+### API
 
-### npm
+Follows the interface defined by `interface-transport`
 
-```sh
-> npm i libp2p-webrtc-star
+[![](https://raw.githubusercontent.com/diasdavid/interface-transport/master/img/badge.png)](https://github.com/libp2p/interface-transport)
+
+### Signalling server
+
+`libp2p-webrtc-star` comes with its own signalling server, used for peers to handshake their signalling data and establish a connection. You can install it in your machine by installing the module globally:
+
+```bash
+> npm install --global libp2p-webrtc-star
 ```
 
+This will expose a `star-sig` cli tool. To spawn a server do:
+
+```bash
+> star-sig --port=9090 --host=127.0.0.1
+```
+
+Defaults:
+
+- `port` - 13579
+- `host` - '0.0.0.0'
+
 ### This module uses `pull-streams`
 
 We expose a streaming interface based on `pull-streams`, rather then on the Node.js core streams implementation (aka Node.js streams). `pull-streams` offers us a better mechanism for error handling and flow control guarantees. If you would like to know more about why we did this, see the discussion at this [issue](https://github.com/ipfs/js-ipfs/issues/362).
@@ -51,17 +76,11 @@ You can learn more about pull-streams at:
 
 If you are a Node.js streams user, you can convert a pull-stream to a Node.js stream using the module [`pull-stream-to-stream`](https://github.com/pull-stream/pull-stream-to-stream), giving you an instance of a Node.js stream that is linked to the pull-stream. For example:
 
-```js
+```JavaScript
 const pullToStream = require('pull-stream-to-stream')
 
 const nodeStreamInstance = pullToStream(pullStreamInstance)
 // nodeStreamInstance is an instance of a Node.js Stream
 ```
 
 To learn more about this utility, visit https://pull-stream.github.io/#pull-stream-to-stream.
-
-
-
-## API
-
-[![](https://raw.githubusercontent.com/diasdavid/interface-transport/master/img/badge.png)](https://github.com/libp2p/interface-transport)

gulpfile.js

@@ -1,7 +1,7 @@
 'use strict'
 
 const gulp = require('gulp')
-const sigServer = require('./src/signalling-server')
+const sigServer = require('./src/signalling')
 
 let sigS
 
@@ -11,11 +11,17 @@ gulp.task('test:browser:before', boot)
 gulp.task('test:browser:after', stop)
 
 function boot (done) {
-  sigS = sigServer.start(15555, (err, info) => {
+  const options = {
+    port: 15555,
+    host: '127.0.0.1'
+  }
+
+  sigServer.start(options, (err, server) => {
     if (err) {
       throw err
     }
-    console.log('sig-server started on:', info.uri)
+    sigS = server
+    console.log('signalling on:', server.info.uri)
     done()
   })
 }

package.json

@@ -4,7 +4,7 @@
   "description": "libp2p WebRTC transport that includes a discovery mechanism provided by the signalling-star",
   "main": "src/index.js",
   "bin": {
-    "star-sig": "src/signalling-server/bin.js"
+    "star-sig": "src/signalling/bin.js"
   },
   "browser": {
     "wrtc": false
@@ -72,4 +72,4 @@
     "interfect <[email protected]>",
     "michaelfakhri <[email protected]>"
   ]
-}
+}

src/signalling-server/bin.js

@@ -0,0 +1,27 @@
+#!/usr/bin/env node
+
+'use strict'
+
+const signalling = require('./index')
+const argv = require('minimist')(process.argv.slice(2))
+
+let server
+
+signalling.start({
+  port: argv.port || argv.p || 9090,
+  host: argv.host || argv.h || '0.0.0.0'
+}, (err, _server) => {
+  if (err) {
+    throw err
+  }
+  server = _server
+
+  console.log('Listening on:', server.info.uri)
+})
+
+process.on('SIGINT', () => {
+  server.stop(() => {
+    console.log('Signalling server stopped')
+    process.exit()
+  })
+})

src/signalling/bin.js

@@ -7,7 +7,8 @@ log.error = debug('signalling-server:error')
 module.exports = {
   log: log,
   hapi: {
-    port: process.env.PORT || 8135,
+    port: process.env.PORT || 13579,
+    host: '0.0.0.0',
     options: {
       connections: {
         routes: {

src/signalling-server/config.js renamed to src/signalling/config.js

@@ -6,30 +6,32 @@ const log = config.log
 
 exports = module.exports
 
-exports.start = (port, callback) => {
-  if (typeof port === 'function') {
-    callback = port
-    port = undefined
+exports.start = (options, callback) => {
+  if (typeof options === 'function') {
+    callback = options
+    options = {}
   }
 
-  if (!port) {
-    port = config.hapi.port
-  }
+  const port = options.port || config.hapi.port
+  const host = options.host || config.hapi.host
 
   const http = new Hapi.Server(config.hapi.options)
 
   http.connection({
-    port: port
+    port: port,
+    host: host
   })
 
   http.start((err) => {
     if (err) {
       return callback(err)
     }
+
     log('signaling server has started on: ' + http.info.uri)
+
     http.peers = require('./routes-ws')(http).peers
 
-    callback(null, http.info)
+    callback(null, http)
   })
 
   return http

src/signalling-server/index.js renamed to src/signalling/index.js

@@ -1,6 +1,6 @@
 'use strict'
 
-require('./signalling-server/test-signalling-server.js')
+require('./signalling/test-signalling-server.js')
 require('./webrtc-star/test-instance.js')
 require('./webrtc-star/test-filter.js')
 require('./webrtc-star/test-listen.js')

src/signalling-server/routes-ws/index.js renamed to src/signalling/routes-ws/index.js

@@ -6,9 +6,9 @@ const io = require('socket.io-client')
 const parallel = require('async/parallel')
 const multiaddr = require('multiaddr')
 
-const sigServer = require('../../src/signalling-server')
+const sigServer = require('../../src/signalling')
 
-describe('signalling server', () => {
+describe('signalling', () => {
   const sioOptions = {
     transports: ['websocket'],
     'force new connection': true
@@ -27,32 +27,40 @@ describe('signalling server', () => {
   let c4mh = multiaddr('/libp2p-webrtc-star/ip4/127.0.0.1/tcp/9090/ws/ipfs/QmcgpsyWgH8Y8ajJz1Cu72KnS5uo2Aa2LpzU7kinSoooo4')
 
   it('start and stop signalling server (default port)', (done) => {
-    const sigS = sigServer.start((err, info) => {
+    sigServer.start((err, server) => {
       expect(err).to.not.exist
-      expect(info.port).to.equal(8135)
-      expect(info.protocol).to.equal('http')
-      expect(info.address).to.equal('0.0.0.0')
-      sigS.stop(done)
+      expect(server.info.port).to.equal(13579)
+      expect(server.info.protocol).to.equal('http')
+      expect(server.info.address).to.equal('0.0.0.0')
+      server.stop(done)
     })
   })
 
   it('start and stop signalling server (custom port)', (done) => {
-    const sigS = sigServer.start(12345, (err, info) => {
+    const options = {
+      port: 12345
+    }
+    sigServer.start(options, (err, server) => {
       expect(err).to.not.exist
-      expect(info.port).to.equal(12345)
-      expect(info.protocol).to.equal('http')
-      expect(info.address).to.equal('0.0.0.0')
-      sigS.stop(done)
+      expect(server.info.port).to.equal(12345)
+      expect(server.info.protocol).to.equal('http')
+      expect(server.info.address).to.equal('0.0.0.0')
+      server.stop(done)
     })
   })
 
   it('start signalling server for client tests', (done) => {
-    sigS = sigServer.start(12345, (err, info) => {
+    const options = {
+      port: 12345
+    }
+
+    sigServer.start(options, (err, server) => {
       expect(err).to.not.exist
-      expect(info.port).to.equal(12345)
-      expect(info.protocol).to.equal('http')
-      expect(info.address).to.equal('0.0.0.0')
-      sioUrl = info.uri
+      expect(server.info.port).to.equal(12345)
+      expect(server.info.protocol).to.equal('http')
+      expect(server.info.address).to.equal('0.0.0.0')
+      sioUrl = server.info.uri
+      sigS = server
       done()
     })
   })