How to install NeoStats

August 23, 2017

NeoStats is a powerful and extendable set of *services* for IRC. By Services, we do not mean NickServ/Chanserv etc but additional services.
These additional services include things like StatServ which gives you statistics on the number of users/operators/channels/servers, and MoraleServ, which is a *fun* module, to send funny messages to users, and utility modules. Some modules have a useful function on your network, other modules are developed for fun, and to make your IRC network more attractive to users.

1. Installing and configuring NeoStats
————————————–

This section explains how to install and configure NeoStats. We recommend that you read this section in full before trying to install NeoStats.

If you have any problems NOT addressed in this or other documents, please see the Support section for how to contact us for help.

1.1 General notes
—————–

All commands and filenames are case sensitive. This means that NeoStats, neostats and NEOSTATS are all different things. When typing commands you should use the same case as provided in this file or things will not work correctly.

1.2 Getting Started
——————-

wget  https://www.sisrv.net/files/NeoStats-3.0.1.tar.gz

Now you need to uncompress NeoStats. To do this type the following:

tar xvfz NeoStats-3.0.1.tar.gz

This will vary depending on the version you run of NeoStats. Change the x in NeoStats3.0.x.tar.gz to match your filename e.g.

NeoStats-3.0.1.tar.gz

1.3 Running configure
———————

You must first run the configure script so that NeoStats can determine your build environment.

To run configure, you must first change to the directory where you uncompressed NeoStats. e.g.

cd ~/NeoStats-3.0.1

Your prompt should look something like:

[user@host NeoStats3.0.1]

Now type:

./configure

The configure script will then check to see if all necessary programs to run NeoStats are installed on your system.

Optional settings:
——————

There are some options you can pass to configure if you wish.

Debugging:

Most users will never look at this option. It compiles NeoStats with debugging turned on. I would only suggest using this if you have problems and are about to make a bug report.

–enable-debug Enables Debugging

Enabling RAW command:

We strongly recommend against the use of this option. Use of RAW commands can cause desync on your network and badly formatted commands can crash your network. If you do enable this option, we will not provide any support for your use of this command. Please do not contact us for support of the RAW command.

–enable-raw

1.4 Compiling NeoStats
———————-

You should now be back at a shell prompt, type:

make

it will go through the source and compile it into an executable
binary file.

1.5 Installing NeoStats
———————–

If you are upgrading a working version of NeoStats. Please read section
1.9 Notes for Upgraders now.

NeoStats must be “installed” into its own directory. By default NeoStats will install into ~/NeoStats3.0/ i.e. in your home directory e.g.

/home/sisrv/NeoStats3.0/

If you wish to change the install location, please type

./configure –help

and follow the instructions on screen.

To install NeoStats type:

make install

This will create the necessary files, and copy them to the installation directory.

1.6 Setting up the neostats.conf file
————————————-

Now you should change to the installation directory (~/NeoStats/, or whatever you specified in ./configure) e.g.

cd ~/NeoStats3.0

Your prompt should look something like:

[user@host NeoStats3.0]

Once in this directory, you need to create a configuration file. You should now run the makeconf script and answer the questions:

./bin/makeconf

You must edit neostats.conf to check that everything is set the way you want it before NeoStats will run. You can do this with:

pico neostats.conf

All the options are described in the neostats.conf file and you should refer to this file for assistance.

When you are finished, save the file. If using pico as in the previous example, press Ctrl-X then hit Y and enter to save the file and exit.

1.7 Compiling additional modules
——————————–

If you have downloaded other NeoStats modules e.g. OPSB, you should now install them. If you are upgrading NeoStats, you must rebuild all other separate modules to work with the new version of NeoStats. See the documentation with these modules for instructions on building and installing them.

Modules written for previous series of NeoStats will not work with the 3.0 series. You must contact the module author for an updated version of the module. All official modules have a 3.0 compatible version available.

1.8 Running NeoStats
——————–

NeoStats is now configured and installed.

Before running NeoStats you must make sure that your server(s) have C:
N: and U: lines for your NeoStats server.
WE WILL NOT ASSIST YOU WITH ADDING C: N: AND U: LINES TO YOUR SERVER,
YOU SHOULD READ THE IRCD DOCUMENTATION IF YOU DO NOT KNOW HOW TO DO
IT!!! DO NOT CONTACT US ABOUT C: N: and U: Lines

Once your C/N/U lines are setup, you need to start NeoStats. You should change to the directory where NeoStats in installed e.g.

cd ~/NeoStats3.0

Then to run NeoStats type:

./neostats start

It should link and sync with your server in a matter of seconds.

ircd hosting