/websocket_server

A general purpose broadcasting web-socket server, written in node.js. Compatible with v17.3-ninja

Primary LanguageJavaScriptGNU Affero General Public License v3.0AGPL-3.0

This is a basic web-socket server, similar to that provided by piesocket.com. It accepts messages and broadcasts them to everyone else connected.

Purpose

This can be used with a number of apps provided by Steve Seguin, including caption.ninja, vdo.ninja, chat.overlay.ninja, and more.

Due to the simplicity and generic nature of this app, this server is suitable really only for personal or private use, as published data is broadcasted to everyone connected.

Installation

sudo apt-get update
sudo apt-get upgrade
sudo apt-get install nodejs -y
sudo apt-get install npm -y
sudo npm install express
sudo npm install ws
sudo npm install fs
sudo add-apt-repository ppa:certbot/certbot  
sudo apt-get install certbot -y
sudo certbot certonly // register your domain

Run

sudo nodejs server.js // port 443 needs to be open. THIS STARTS THE SERVER

If using with VDO.Ninja

If using this with a ninja deploy, you'll also need to deploy ninja v17.3 or newer, and then update the index.html of the ninja installation with the connection details. You'll need to enable the customWSS mode and set the wss server address to whatever you setup, such as with:

session.wss = "wss://wss.contribute.cam:443";
session.customWSS = true;

note: The most update to date directions on how to configure VDO.Ninja will likely be found in its index.html file; this repository's instructions may be out of date in comparison.