iwebpp.io

iWebPP name-client library for node.js

npm install iwebpp.io
1 downloads in the last day
7 downloads in the last week
115 downloads in the last month

iWebPP.io - Run Peer and P2P Web Service.

Features

  • Run http and https over udp, taking udp high data transfer performance
  • Run web service in peer or p2p style, behind NAT/FW
  • Support both TURN and STUN data channel with Websocket
  • Support web proxy over STUN or TURN
  • Support SDP session reconnect automatically
  • Realtime web streaming from peer
  • Provide end-to-end security, ip-port-based ACL
  • Multiplex connections on single udp port, saving system resources
  • Extend client/central server style web service transparently
  • Easy to use API, reuse existing http/web and node.js technology
  • Peer Service management

Discussion group: https://groups.google.com/d/forum/iwebpp

Install

  1. install iwebpp.io module by npm install iwebpp.io
  2. iwebpp.io depends on node-httpp, please npm install httpp-binary.if the binary didn't work, just build it from source: https://github.com/InstantWebP2P/node-httpp.git

Usage/API:

1. create iWebPP client

var WEBPP = require('iwebpp.io');
var nmcln = new WEBPP({
  usrinfo: {domain: '51dese.com', usrkey: 'dese'}, // fill usrkey. And, 51dese.com is only useful domain by now
});
nmcln.on('ready', function(){
  console.log('iwebpp.io ready with vURL:'+nmcln.vurl);
  // ...
});

2. hook node.js web server in peer. Websocket server is supported with wspp module as well. This is an express App example. file peerweb.js.

var express = require('express');
var WebSocket = require('wspp');
var WebSocketServer = WebSocket.Server;
var WEBPP = require('iwebpp.io');
var nmcln = new WEBPP({
  usrinfo: {domain: '51dese.com', usrkey: 'dese'}, // fill your usrkey. And, 51dese.com is only useful domain by now
});
nmcln.on('ready', function(){
  // 2.1
  // create your express App
  var app = express();
  app.use(express.directory(__dirname + '/public'));
  app.use(express.static(__dirname + '/public'));
  app.use(function(req, res){
      res.end('invalid path');
  });
  // hook app on business server
  nmcln.bsrv.srv.on('request', app);
  console.log('Now access your web server via URL:'+nmcln.vurl);
  // 2.2
  // create your websocket server
  var wss = new WebSocketServer({httpp: true, server: nmcln.bsrv.srv});
  wss.on('connection', function(client){
    console.log('new ws connection');
  });
  console.log('Now connect to your websocket server via URL:'+nmcln.vurl);
});

3. launch web server by bin/win32/node.exe peerweb.js in Windows32 machine.

4. STUN/TURN session setup case, please refer to demos/clnt.js

For web service over STUN, please refer to https://github.com/InstantWebP2P/iwebpp.io-stun-proxy

More demos:

Look on demos/

TODO:

  • User authentication
  • Domain authorization
  • Improve documents, RFC draft


License

(The MIT License)

Copyright (c) 2012-2013 Tom Zhou(iwebpp@gmail.com)

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.

npm loves you