N|Solid Documentation


Quick Start Guide

This guide will help you quickly install all of the N|Solid components onto your development machine on OS X or Linux. For instructions on installing the individual components for a production cluster, see the installation guide.

Installing The OS X Developer Bundle

To install the Developer Bundle for OS X:

  1. Go to downloads.nodesource.com
  2. Click on the Mac OS button to get an installable package
  3. Double click on the downloaded pkg file and follow the instructions to install the N|Solid compoments

Installing The Linux Developer Bundle

To install the Developer Bundle for Linux, you must first set up the repository appropriate for your system. Please refer to the "Set Up the NodeSource N|Solid Repository" instructions in the installation guide for instructions on how to do this.

Once the repository is set up, use one of the following commands for an rpm based system as the root user:

For N|Solid built on Node.js v6 LTS (Boron)

$ yum -y install nsolid-developer-bundle-boron

For N|Solid built on Node.js v4 LTS (Argon)

$ yum -y install nsolid-developer-bundle-argon

On a deb based system, use one of the following commands:

For N|Solid built on Node.js v6 LTS (Boron)

$ apt-get -y install nsolid-developer-bundle-boron

For N|Solid built on Node.js v4 LTS (Argon)

$ apt-get -y install nsolid-developer-bundle-argon

These commands will install all of the needed N|Solid components for you.

Setting Up the N|Solid Console

Using the developer bundle on either OS X or Linux is quite easy. To launch the console, open a terminal window and enter the command:

$ nsolid-console

to start the console. Note that you do not have to be the root user to run the console, only to install it. Logs for each process can be found under /tmp/nsolid-*.

Once the Console is running, you can see the user interface by opening a new web browser window to http://localhost:3000

You should be redirected to http://localhost:3000/welcome, where you will be asked to enter your License Key. If you already have and know your License Key, paste it in here. Otherwise click Get License Key at the bottom of the form.

Welcome Screen

Fill out all fields on the Register or Retrieve Key form and a key will be emailed to you. If you have previously set up a key, your existing key will be emailed to you, if not, a new one will be generated and emailed to you.

Register or Retrieve Key

Once you've received your N|Solid license key, paste it into the form found at http://localhost:3000/welcome/license and click SUBMIT.

Enter License Key

Once a valid key is entered, you should be immediately redirected to the N|Solid console.

N|Solid Console Up and Running

Running Node Applications in N|Solid

The next step is to configure your shell to use the N|Solid Runtime.

On OS X, open a second Terminal window and run:

$ source /usr/local/nsolid/nsolid-env

On Linux, open a second Terminal window and run:

$ source /opt/nsolid/nsolid-env

This will activate the N|Solid shell.

From within the N|Solid shell, any Node application that you start from this terminal will then be shown in the N|Solid Console.

For example, monitor the Nodejs REPL using N|Solid by running:

(nsolid) $ NSOLID_APPNAME="REPL" node

If you have an existing Nodejs application, e.g. "index.js", you can monitor it with N|Solid by running:

(nsolid) $ NSOLID_APPNAME="My_Application" node index.js

You can customize the name of your application in the N|Solid Console by changing the NSOLID_APPNAME environmental variable. If you do not specify an app name, N|Solid will look for a 'name' property in your package.json, and if that is not found your application will be named 'untitled application'

You are now ready to use N|Solid for your own applications!