IPCluster

IPCluster is a "bare-metal" library for Node.js to manage multi-core concurrency, with sticky sessions and zero-downtime reloading.

Features

• Sticky sessions (via iptables abuse) - suitable for long-polling
• Configurable per-process and cluster memory limits
• Graceful shutdowns and restarts

Dependencies

• npm modules - commander, q

IPCluster sticky sessions currently requires iptables for sticky sessions and so is Linux-only

Setup

npm dependencies

npm install

iptables sudo support

sudo iptables support is required in order to support sticky sessions.

Add to sudoers (visudo):

<node> ALL=(ALL) NOPASSWD: /sbin/iptables -t nat -L
<node> ALL=(ALL) NOPASSWD: /sbin/iptables -t nat -[ID] PREROUTING -p tcp -m tcp -s 0.0.0.*/0.0.0.* -d * --dport 80 -j REDIRECT --to-ports ?????
<node> ALL=(ALL) NOPASSWD: /sbin/iptables -t nat -[ID] PREROUTING -p tcp -m tcp -s 0.0.0.*/0.0.0.* -d * --dport 443 -j REDIRECT --to-ports ?????

etc. for other ports

Change <node> to the running user.

Thankfully, iptables does not allow duplicate copies of most flags, so that the * wildcards can't be abused (much). Nonetheless, sercurity feedback is welcome. An alternative for * would be appreciated.

Contributing

git pre-commit hook

Being a JS project, we require the code to be lint free, based on our Zopim's jshint rules (see the file .jshtinrc at the root of the project for details)

Installing jshint

Make sure you add "/usr/local/share/npm/bin" to your PATH, and then do the install as follow:

# installing jshint
npm install jshint -g

# testing install, should show "jshint vX.Y.Z"
jshint -version

Installing the precommit hook

After you have cloned the meshim-server project locally, run the following command at the root of the project:

ln -s ../../support/pre-commit .git/hooks/pre-commit

Testing

meshim-server contains some unit tests made with nodeunit (with many more to come, thanks to you!). The tests can be run with grunt, the task runner. At the root of the project run:

grunt test

Do run the test suite (which also run jshint), prior to committing.

Installing grunt

npm install -g grunt-cli