Commit 73f667fe authored by Steve Johnson's avatar Steve Johnson

updated README

parent e77797d5
......@@ -2,7 +2,8 @@ My Stuff Everywhere(TM) by Cable Television Laboratories, Inc. is licensed under
Based on a work at github.com/cablelabs/mse
http://creativecommons.org/licenses/by-nc-sa/4.0/legalcode
The license text below was current as of 9/30/2014. Up to date
license information can be found here: http://creativecommons.org/licenses/by-nc-sa/4.0/legalcode
Attribution 4.0 International
......
#My Stuff Everywhere™ - sdom-ws2bridge repository
##Overview
This respository contains the websocket bridge server code. This server allows communications between the shared TV and remote applications and also provides directory services for determining which applications and devices are connected on the same network.
####Server source:
- ws2bridge.js: Source code for the NodeJS web socket bridge server.
####Server configuration:
These files are not kept in the repository but must reside on your server. See mse/samples for template files.
- ws2bridge.config - Server configuration file in JSON format:
{
"httpPort" : 1338,
"filterByAddress" : true, // enables subnet address matching for connections
"enableKeepalive" : true, // enables the keep-alive for better connection states
"enableSSDP" : true // makes server discoverable using SSDP (mse client applications will discover local bridge servers)
}
- ws2bridge-ssl.config - SSL Server configuration file in JSON format:
{
"httpPort" : 1339,
"filterByAddress" : true, // enables subnet address matching for connections
"enableKeepalive" : true, // enables the keep-alive for better connection states
"enableSSDP" : false // SSL version is on a secure server with a well known address - not discoverable)
}
####Monitor page: (wsroot directory)
Shows status of the bridge on the server. Navigate with a browser to yourdomain:1338/monitor.html
- monitor.html - Bridge monitor page.
- monitor.js - Bridge monitor javascript source.
####Installing and running the bridge servers
You can use a forever script on your server to keep the bridges running. There is a sample script in the mse repository in the samples folder.
The bridge (non-SSL) running on your server should ideally be only a backup - there should be discoverable bridge(s) located on the same LAN as the remote and shared applications. This could exist in the TV, cable router/proxy, or even implemented on the users mobile device.
Usage examples: (configure in your forever script or run from the command line)
# Standard bridge on port 1338
/usr/local/bin/node /.../ws2bridge-ssl.js -config /.../ws2bridge.config
# SSL bridge on port 1339
/usr/local/bin/node /.../ws2bridge-ssl.js -ssl -config /.../ws2bridge-html5-ssl.config
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment