opReports Installation Guide (Legacy version 2.x)
IF YOU ARE INSTALLING THE LATEST VERSION (3) please go to:
Installation (and Upgrade Guide) for opReports 3.x
Installation Prerequisites
- The individual performing this installation has some Linux experience.
- NMIS8 is installed on the same server where opReports will be installed
- NMIS8 is installed in /usr/local/nmis8
- OpReports will be installed into /usr/local/opmantek
- Root access is available (not always needed but much easier)
- Perl 5.10
- RRDtool 1.4.7
Installation Steps
- Copy the opReports tarball to the server (a tarball is a GZIP'd tar file, e.g. opReports-Linux-x86_64-2.3.tar.gz for 64bit Linux or opReports-Linux-i686-2.3.tar.gz for 32bit Linux)
- You may need to use SCP or FTP to get the file onto the server.
- The file will now likely be in the users home directory.
- If the installation directory does not already exist
- Change into the directory where the tarball was copied
- Untar the file
cd /usr/local tar xzvf ~/opReports-Linux-x86_64-<version>.tar.gz cd opmantek/ cp install/opReports.nmis conf/ cp install/opCommon.nmis conf/ bin/opfixperms.pl cp install/01opmantek.conf /etc/httpd/conf.d/ service httpd restart
Debian/Ubuntu
cp install/01opmantek.conf /etc/apache2/conf.d/ service apache2 restart
- Update the crontab to run the default reports every day for the last 1 day and every week for the last week. Below is the crontab entries required.
To edit the crontab, use the command "crontab -e"
###################################################### # Opmantek Config ###################################################### # Run opReports Batch 0 0 * * * /usr/local/opmantek/bin/opReports-daily.sh 0 0 * * Sun /usr/local/opmantek/bin/opReports-weekly.sh
Alternate Installation Directory
opReports can be installed into another directory if required, e.g. /opt/opmantek, the same process applies, but a few files will need to be changed.
Edit opReports.nmis and change the <omk_base> to be the new, e.g.
'<omk_base>' => '/opt/opmantek',
Edit the Apache include file, which if already copied to /etc/httpd/conf.d will be /etc/httpd/conf.d/01opmantek.conf and change the following lines to the new installation location:
Alias /opmantek/ "/usr/local/opmantek/htdocs/" ScriptAlias /cgi-omk/ "/usr/local/opmantek/cgi-bin/" <Directory "/usr/local/opmantek/cgi-bin">
Edit the crontab and use the locations of the two shell scripts, e.g.
0 0 * * * /opt/opmantek/bin/opReports-daily.sh 0 0 * * Sun /opt/opmantek/bin/opReports-weekly.sh
Edit each of the opReports shell scripts and update the following line
OMK=/opt/opmantek
Basic opReports Configuration
There are many configuration options in opReports, but the only one which must be updated to make everything work is the configuration for "report_server_prefix", this allows the emailed reports to point to the correct web server to load their configurations, this entry is in the opReports.nmis file and should be updated to be the public web prefix of the server, which the people receiving the emails would use to access the server (this might be the portal address).
'report_server_prefix' => 'http://nmis.domain.com',
Access opReports Web Page
The default URL to access opMaps is http://nmis.domain.com/cgi-omk/opReports.pl
Any authentication challenges will be the same as to login to your NMIS8 system.
Patching opReports
Often patches will be released for opReports, the following are commands to install a patch, unless other instructions are specifically provided.
unalias cp cd ~ tar xvf ~/opReports-<version>.tar.gz cd opmantek/ cp -r * /usr/local/opmantek/ /usr/local/opmantek/bin/opfixperms.pl /usr/local/opmantek/bin/opupdateconfig.pl /usr/local/opmantek/install/opReports.nmis /usr/local/opmantek/conf/opReports.nmis