Commit f4d4fd25 authored by Steve Johnson's avatar Steve Johnson

updated README

parent 431b8f3a
...@@ -2,14 +2,14 @@ ...@@ -2,14 +2,14 @@
This repository 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. This repository 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: ###Server source:
- ws2bridge.js: Source code for the NodeJS web socket bridge server. - ws2bridge.js: Source code for the NodeJS web socket bridge server.
####Server configuration: ###Server configuration:
These files are not kept in the repository but must reside on your server. See mse/samples for template files. 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: ####ws2bridge.config - Server configuration file in JSON format:
{ {
"httpPort" : 1338, "httpPort" : 1338,
...@@ -18,7 +18,7 @@ These files are not kept in the repository but must reside on your server. See m ...@@ -18,7 +18,7 @@ These files are not kept in the repository but must reside on your server. See m
"enableSSDP" : true // makes server discoverable using SSDP (mse client applications will discover local bridge servers) "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: ####ws2bridge-ssl.config - SSL Server configuration file in JSON format:
{ {
"httpPort" : 1339, "httpPort" : 1339,
...@@ -28,18 +28,19 @@ These files are not kept in the repository but must reside on your server. See m ...@@ -28,18 +28,19 @@ These files are not kept in the repository but must reside on your server. See m
} }
####Monitor page: (wsroot directory) ###Monitor page: (wsroot directory)
Shows status of the bridge on the server. Navigate with a browser to yourdomain:1338/monitor.html Shows status of the bridge on the server. Navigate with a browser to yourdomain:1338/monitor.html
- monitor.html - Bridge monitor page. - monitor.html - Bridge monitor page.
- monitor.js - Bridge monitor javascript source. - monitor.js - Bridge monitor javascript source.
####Installing and running the bridge servers ###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. 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. 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) Usage examples: (configure in your forever script or run from the command line)
# Standard bridge on port 1338 # Standard bridge on port 1338
/usr/local/bin/node /.../ws2bridge-ssl.js -config /.../ws2bridge.config /usr/local/bin/node /.../ws2bridge-ssl.js -config /.../ws2bridge.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