User Tools

Site Tools


  Main   About   Help   Download
nconf:help:documentation:start:installation

Installation guide

Interactive installation

1. Download and unpack

Download the NConf archive. Upload it onto a webserver of your choice. Make sure your server covers all of the NConf system requirements.

If you have console access, upload the uncompressed archive to your server and uncompress it there.

tar -zxvf nconf-VERSION.tgz

Another option is to uncompress the archive on your local PC, then upload all the files with an FTP account to your webserver.

2. Set permissions

Make sure the following directories are writable to your webserver user.

You can change permissions on the console or via FTP client (CHMOD)

 ./config  
 ./output  
 ./static_cfg  
 ./temp

3. Create the database

Create a new MySQL database for NConf, create a user to access the database, grant the apropriate privileges.

InnoDB

Make sure InnoDB for MySQL is set up properly prior to creating the database!

Depending on your setup, you can create the database with phpMyAdmin, on the commandline, or with whatever tool is at your disposal (for detailed instructions on how to set up MySQL by commandline, please refer to the manual installation section).

Your user will need the following privileges:

SELECT, INSERT, UPDATE, DELETE, CREATE, ALTER, DROP

4. Begin interactive installation

Using your browser, start the installation process by navigating to
http://www.mydomain.com/nconf/INSTALL.php

The the exact URL will depend on your webserver configuration.

It could also be something like this: http://nconf.mydomain.com/INSTALL.php

Pre-install check

The pre-install check will try to detect some requirements. If all checks are OK, you may safely proceed with the installation.

If one or more checks fail, you may still proceed to install NConf, but it might not work properly

Step 1

Step 1 of the installation asks you for the MySQL information. Enter the required information like hostname, database name, username and password. Make sure you have created a new database and have given sufficent privileges to the user you're connecting with.

Step 2

NCONFDIR
This is the directory where NConf is located (auto detected)
NAGIOS_BIN
This is the path to the Nagios binary. The binary is needed in order to do syntax checking of the generated config. NConf will not work properly if these checks cannot be executed. This path should either point to the original binary (if Nagios is installed on the same host), to a symbolic link or to a copy of the binary (copy it to the nconf/bin/ folder).

  • Make sure the binary is executable to the webserver user.

TEMPLATE_DIR
This defines which design-template (skin) to use.
Making your own styles is not supported yet!

Step 3

Step 3 allows you to activate basic authentication for NConf. More sophisticated authentication methods are available, but these must be configured manually after completing the installation.

Step 4

After the installation is complete, remove the following files and directories:

  • INSTALL
  • INSTALL.php
  • UPDATE
  • UPDATE.php

5. Get OS logo icons (optional, but nice)

If you like, download the OS logo icons and unpack them to

nconf/img/logos/base/

The icons can be downloaded here: MonitoringExchange: Base Images

6. Getting started after installation

Please refer to the following documentation, to continue after installation: Getting started

Manual installation (commandline)

1. Download and unpack

Download and unpack the NConf archive to your webserver's document root folder.

2. Set permissions

Make sure the following directories are writable to your webserver user:

 ./config  
 ./output  
 ./static_cfg  
 ./temp

3. Create the database

Create a new MySQL database for NConf, create a user to access the database, grant the appropriate privileges.

InnoDB

Make sure InnoDB for MySQL is set up properly prior to creating the database!

On the commandline, you would proceed like this:

$> mysql -u root -p  
Enter password:  
mysql> CREATE DATABASE DBNAME;  
mysql> GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, ALTER ON DBNAME.* \
TO 'DB_USER'@'localhost' IDENTIFIED BY 'DB_PASS';

Please refer to the MySQL manual on how to set up InnoDB (the steps might vary depending on your OS distribution).

4. Create the database structure

$> mysql -u DBUSER -p DBNAME < INSTALL/create_database.sql

mysql -u DBUSER -p DBNAME < INSTALL/create_database.sql

5. Configure NConf

Copy the contents of ./config.orig to ./config. Make sure you also copy the hidden files.

Edit ./config/mysql.php, set at least the following values:

DBHOST  
DBNAME  
DBUSER  
DBPASS

Edit ./config/nconf.php, set at least the following values:

NCONFDIR  
NAGIOS_BIN

6. Clean up

Remove the INSTALL and UPDATE folders, as well as the INSTALL.php and UPDATE.php scripts.

7. Get OS logo icons (optional, but nice)

If you like, download the OS logo icons and unpack them to

nconf/img/logos/base/

The icons can be downloaded here: MonitoringExchange: Base Images

8. Authentication

If you need authentication, configure ./conf/authentication.php appropriately.

Getting started after installation

Please refer to the following documentation, to continue after installation: Getting started

nconf/help/documentation/start/installation.txt ยท Last modified: 11.12.2011 16:41 by fgander