opEvents Installation Guide

Prerequisites

• The individual performing this installation has a small bit of Linux experience.

• Root access is available.

• Internet access is required for installing any missing, but required software packages.
• NMIS must be installed on the same server that opEvents is being installed on. If you do not yet have a working installation of NMIS in your server, please follow the procedure in the NMIS 8 Installation Guide and install NMIS before installing opEvents
• You will need a license for opEvents (evaluation available HERE).

Preparation

• For detailed information about Opmantek's interactive installer, including installation options (non-standard directory, non-interactive install, etc.)  please review the Opmantek Installer page.

• opEvents requires a working MongoDB installation (but not necessarily on the same server). With opEvents 1.2.6 and newer the installer will install and configure MongoDB for you. For previous versions of opEvents please follow the instructions in the MongoDB Installation Guide

  • While opEvents does not require any specific MongoDB setup, you will have to provide opEvents with the correct MongoDB server information, database name and user name/password (if you use authentication). opEvents works best with the default database name "nmis", and with MongoDB authentication enabled.

• Download opEvents from the Opmantek website.

Installing (or Upgrading) opEvents

Transfer the opEvents installer onto the server in question, either by direct download from the Opmantek website (using wget as demonstrated below), or from your desktop with scp, sftp or a similar file transfer tool.
Make a record of where you put the installer (we recommend using root's home directory or /tmp as good locations).

• Remember, you must have root access to run the installer, so either use sudo or log in as root:

  # become root
  sudo sh
  # If using wget, for example, change into the directory you want to download the installer into 
  cd /tmp
  # Here's an example of using wget to retrieve the installer from Opmantek's S3 server:
  wget http://dl-omk.opmantek.com/opEvents-Linux-x86_64-2.4.1.run

• Start the interactive installer and follow its instructions. The installer now fully covers both initial installations as well as upgrades from earlier versions of opEvents.

  # Next, start the interactive installer and follow the prompts.
  sh ./opEvents-Linux-x86_64-2.4.1.run
  Verifying archive integrity... All good.
  Uncompressing opEvents 2.4.1  100%
  
  ++++++++++++++++++++++++++++++++++++++++++++++++++++++
  opEvents (2.4.1) Installation script
  ++++++++++++++++++++++++++++++++++++++++++++++++++++++
  
  This installer will install opEvents into /usr/local/omk.
  To select a different installation location please rerun the 
  installer with the -t option.
  
  Ok to proceed with installation?
  Type 'y' or <Enter> to accept, or 'n' to decline:
  ...

• The installer will interactively guide you through the steps of installing opEvents. Please make sure to read the on-screen prompts carefully.
• When the installer finishes, opEvents is installed into /usr/local/omk, and the default configuration files are in /usr/local/omk/conf, ready for your initial config adjustments.
• A detailed log of the installation process is saved as /usr/local/omk/install.log, and subsequent upgrades or installations of other Opmantek products will add to that logfile.
  
  

Initial Configuration

• If the interactive installer installed MongoDB it will also configure opEvents to connect to it. However, if you did not instruct the installer to install mongoDB, or if yoy want to point opEvents to use mongoDB on another server, you will need to adjust the MongoDB-related settings:

  • Open /usr/local/omk/conf/opCommon.nmis in an editor, go to the database section and change the server, username and password to reflect your MongoDB installation.

  • The example below is from a default installation with a local MongoDB installed by the opEvents installer. Your entries should look similar to the following (but there might be extra settings related to other products):

      'database' => {
        'db_admin_port' => '28017',
        'db_connection_timeout' => 20000,
        'db_name' => 'nmis',
        'db_password' => 'op42flow42',
        'db_ping_timeout' => 2000,
        'db_port' => '27017',
        'db_query_timeout' => 5000,
        'db_server' => 'localhost',
        'db_use_v26_features' => 1,
        'db_username' => 'opUserRW',
        'db_write_concern' => 1
      },

• For opEvents versions before 1.2.2 Only 

/usr/local/omk/bin/opeventsd.pl act=setup
# you can also get an overview of opeventsd's capabilities by running opeventsd.pl --help

• After completing your configuration changes you'll need to restart both the opEvents daemon (opeventsd) as well as the Opmantek daemon (omkd).
  Simply run the following commands as root:

  # don't forget to become root, using sudo sh or su
  service opeventsd restart
  service omkd restart
  # to verify the status of the daemons:
  service opeventsd status
  service omkd status

Where to go from here

First you should test opEvents: open up a web browser, and point it to "http://<yourserverip>/omk/opEvents"; you will have to enter your license first, then you will see opEvents' main dashboard.

opEvents offers a rich and flexible set of configuration options to ensure it meets your requirements, but there are many more options than can be listed here. Please consult the opEvents documentation for details.