==================================================

             NetHorus: an Open Source Network Management System

             ==================================================


Requirements
------------

To use NetHorus fully, you will need:

  * A working Rails 2.2.2 installation
  * A database supported by Rails
  * A network of SNMP-manageable devices


Installation
------------

If you're updating an existing codebase from Subversion, please see
'Updating' at the end of this document.

To install NetHorus, download the latest source code from Subversion:

  svn co http://svn.nethorus.org/svn/nethorus/

Copy the file config/database.example to config/database.yml and edit
database.yml, changing the adapter, username and password as appropriate. 
You can change the database names too if you want, but keep the stanzas
named as 'development', 'test' and 'live'.

An example stanza is:

  development:
    adapter: mysql
    encoding: utf8
    database: nethorus_development
    username: nethorus
    password: GF4i3pXlooTGeoci
    socket: /var/run/mysqld/mysqld.sock

Next, create the database with rake:

  rake db:create

Then, create the tables:

  rake db:schema:load

Now, start the Mongrel web server:

  mongrel_rails start

Finally, start the SNMP proxy:

  external/snmp_proxy.pl

You are now running NetHorus.


Updating
--------

To update a Subversion copy of NetHorus, run the following command in the
directory holding your source code:

  svn update

Make sure you keep your database schema up-to-date by running any migrations
as necessary:

  rake db:migrate

That's it!