Choose how you want to run Nebulosa

Nebulosa is a single application divided into Client ad Server, this was by design to have it act as a BNC if needed (and because browsers don't like IRC connection).

There are two ways of running and using Nebulosa, you can either:

• Host the server locally and use it just like a normal IRC client
• Host the server remotely and use it like a BNC with a Web Client

Because of this, this guide will often refer to Server and Client as two separate machines, however if you want to run the server locally just assume they're the same thing.

(Server) Install prerequisites

Nebulosa runs on Node.js, which is the main requirement to run it.
You'll need to install it before proceeding (source and binaries in the official website.)
If you're on Linux, good chances are that it's in one of your repositories (for example, it's in EPEL if you use any RHEL-based distribution.)

Nebulosa is hosted on GitHub, so download and install Git as well

(Server) Install Nebulosa and required modules

To download Nebulosa, open a shell, browse to your path of choice and then execute the following command, A "Nebulosa" folder will be created with all the files inside. git clone git@github.com:Hamcha/Nebulosa.git

Browse into the folder where Nebulosa files have been put and execute this command to install all the required Node.js modules:

npm install

As one of the dependencies require Git to be downloaded (node-irc) please be sure to have it installed.

(Server) Configuring Nebulosa

The configuration file of Nebulosa is called config.coffee. It's pretty well commented so you should have no problem figuring out what to change and how.

(Server) Running Nebulosa

To run Nebulosa you can either use the provided run scripts (run.sh and run.bat, depending on what platform you are) or just execute:

coffee main.coffee

(Client) Opening the Web Interface

Once Nebulosa is running open a browser and go to http://<SERVER_IP>:<PORT>. If you are running the server locally it's likely the IP is likely to be "localhost" and the default port on config.coffee is 8033