Documentation

From NETINV Wiki
Jump to: navigation, search

Contents

System Requirements

PHP 5.3 (apc_fetch extension)

Internet Connection (For update checks.)

Development System

Following are the specifications of the server NETINV is developed on. Other configurations will probably work, but this one is the only one that's guaranteed.

  • OS: Ubuntu 12.10 x64
  • CPU: 2.2Ghz Single Core
  • RAM: 512MB
  • NIC: Dual 1000 Mbps
  • Software
    • Apache 2.2.22
    • PHP 5.4.6

Note: Dev system hardware and software subject to change.

Default Credentials

There's only one user account that comes with NETINV, and its credentials are...

Username: netinv

Password: netinv

Configuration

All of NETINV's configuration parameters are stored in the config.php file in the NETINV root directory. The available options are as follows:

This should point to the hostname or IP of your mysql server.

$config_mysql_server_hostname (Default: localhost)

This is the port of your mysql server.

$config_mysql_server_port (Default: 3306)

This is the username NETINV will use to make database modifications. It must have full privileges to the database you plan on using with NETINV.

$config_mysql_server_username (Default: username)

This is the password for the database user NETINV will run under.

$config_mysql_server_password (Default: password)

This is the name of the database where NETINV will store all its information.

$config_mysql_database_name (Default: NETINV)

NETINV uses Google Analytics to do a very minimal amount of usage tracking. The only thing it does is send when you visit a page, and what that page is. It does absolutely nothing close to interacting with your database.

$config_usage_tracking (Default: true)

Setting this to true will make it so NETINV doesn't try and use the internet to function. This disables the news ticker on the admin CP, system updates, usage tracking, and feedback.

$config_offline (Defaut: false)

Setting this to true causes NETINV to create log files of user activity in the logs directory.

$config_logging (Defaut: true)

This is the directory where logs will be stored for NETINV. It needs to be the full directory from the system root. NO TRAILING SLASH.

$config_logging_directory (Default: /var/www/logs)

This is the directory where logs can be accessed via a web browser. It can either be relative to the site root (/logs), or an absolute path (http://ex.com/logs). Setting this to false will disable log viewing in the admin panel. NO TRAILING SLASH.

$config_logging_web_directory (Default: /logs)

User Permissions

There are 5 different permission levels that NETINV operates with.

4: Everything (admin): Can do everything.
3: Everything (Non-admin): Can do everything that isn't specifically on the admin panel, except modify attachments.
2: Modify: Will be able to modify any existing data, but not add or delete anything that doesn't already exist. Can see IP addresses.
1: Read Only. Will not be able to do anything but look at data (including attachments). Can not see device IP addresses.
0: Public, un-authenticated user. By default it isn't used anywhere, and we don't advise changing that. It may also not work properly if you do.

All permission levels inherit the abilities of levels below them.

File Permissions

NETINV requires the following CHMOD permissions to work properly. (NETINV document root = /)

/: 644
/attachments/: 777
/attachments/index.html: 644
/logs/: 777 (Or other logs directory as set in config.php)
/logs/index.html: 644 (Or other logs directory as set in config.php)

If you set permissions in that order (top->bottom) NETINV should work as expected.

Versioning

NETINV exists in 3 different development stages.

  • Alpha(a): Features are still being added, and the system is very unpolished and buggy. An alpha release being publicly available is highly unlikely.
  • Beta(b): All the intended features are added, but the system hasn't been thoroughly tested for bugs. A beta release will probably be publicly available when it's created, but don't expect everything to work.
  • Release(r): Everything's been tested and there shouldn't be any major bugs. Release versions are the only ones recommended to be put into production. If you put an alpha or beta release in production, don't be surprised when you have to can your whole install because the release version isn't compatible with it.

Alpha and beta versions are also followed by a number which indicates the build number for that version. Ex: 2.0b68

Device Groups

NETINV uses a system of device groups to help organize the different devices in your system. Basically, to differentiate between things like switches, PDUs, and the like.

Device groups control the following:

  • The number of columns a device has.
  • The port and protocol used on the link to a device when viewing that device.
  • The titles of the columns for the device.
  • The default value for the columns of a device when fields in those columns are left blank.
Personal tools