Name		Name	Last commit message	Last commit date
parent directory ..
.vscode		.vscode
static		static
templates		templates
tests		tests
.eslintrc.js		.eslintrc.js
.gitignore		.gitignore
README.md		README.md
app.js		app.js
buffer.js		buffer.js
install.sh		install.sh
jest.config.js		jest.config.js
package-lock.json		package-lock.json
package.json		package.json
rl.cache.js		rl.cache.js
rl.control.js		rl.control.js
rl.data.js		rl.data.js
rl.files.js		rl.files.js
rl.js		rl.js
rocketlogger-proxy.conf		rocketlogger-proxy.conf
rocketlogger-web.service		rocketlogger-web.service
util.js		util.js

README.md

RocketLogger Node.js Web Interface

Features

The RocketLogger web interface features are summarized as follows:

static source file serving
dynamic site rendering using nunjucks
RocketLogger CLI interface from web
websockets for server side data streaming using socket.io and zeromq

Installation

To install the webserver and its dependencies and to deploy it as system service, use the provided installer script:

sudo ./install.sh

This script takes care of installing and configuring the additional system and npm package dependencies listed under Dependencies.

To install the node.js server standalone in the source directory, use:

npm install .

When choosing this method, system package dependencies need to be installed and configured manually.

Dependencies and Requirements

Server: Node.js v18 or later, NGINX for reverse proxy
Client: reasonably recent web browser supporting ECMAScript 6

Node.js server dependencies

express - minimalist web framework
nunjucks - Jinja2 inspired web template engine
socket.io - websockets server side JavaScript library
zeromq - ZeroMQ message queueing library
gulp - file system listing
debug - debugging output utility

Browser client dependencies

bootstrap - responsive, mobile-first front-end component library
plotly.js - JavaScript plotting library
timesync - client-server time synchronization library
socket.io-client - websockets client side JavaScript library