Nouter

Nouter Node.js based home router software

Description

There is a lot of router software already out there. However most of the router software projects are specifically built with the idea of embedded home routers in mind.

This software is meant to run on those routers as well as any computer.

Next, to make things interesting we implement a first class web stack. Built on Node.js, Bootstrap, jQuery and most importantly with love.

Some features right now

• Admin panel
• Easy installation
• Profile base configuration system
• Works on Debian Linux
• Generates firewall
• Interfaces with dnsmasq
• Supports dual WAN with multiple routing tables

Some features down the road

• Run on embedded devices
• Drop in on top of OpenWRT
• Run on Windows
• Run on Mac
• Traffic tracking and chart generation

Software Requirements

• Node.js 6+ and NPM
• Sqlite3+

Installation

On Debian Linux (Ubuntu Included) do this $ apt-get -y install build-essential

$ cd /opt
$ git clone [email protected]:nullivex/nouter.git
$ cd nouter
$ npm install

Starting

First, setup a local config file like so.

'use strict';
module.exports = {
  admin: {
    enabled: true
  }
}

Of course any additional overrides can be added to the config here.

Second, start the system.

$ node app

Testing

The default test suite can be ran using npm

$ npm test

Debugging

All debug logging now uses the https://github.com/visionmedia/debug package.

The following can be used to see all messages (typically used in dev)

$ DEBUG=nouter:* node app

From there follow the debug filtering rules defined https://github.com/visionmedia/debug#wildcards

Changelog

1.0.0

• Initial release