www/cms/documentation/gettingstarted.xhtml

   1 <!--#include virtual="/doctype.inc" -->
   2
   3 <head>
   4 <title>Getting Started with the i-scream Central Monitoring System</title>
   5 <!--#include virtual="/style.inc" -->
   6 </head>
   7
   8 <body>
   9
  10 <div id="container">
  11
  12 <div id="main">
  13
  14 <!--#include virtual="/header.inc" -->
  15
  16 <div id="contents">
  17 <h1 class="top">Getting Started</h1>
  18
  19 <h2>Getting Started with the i-scream Central Monitoring System</h2>
  20
  21 <h3>1. Installing the corba services (pre-requisite for the server)</h3>
  22 <p>The server requires a CORBA Naming Service to run. It may be that you already
  23 have such a system running, in which case you can use that. Simply edit the
  24 jacorb.properties file to point to your Naming service. If you don't have a
  25 naming service running you could just set up your own manually, but if like us
  26 you want the easy approach, install our corba services program.</p>
  27 <p>This program runs the naming service and provides a builtin webserver to
  28 serve requests to the server application. The documentation details how to get
  29 this running. It should simply be a case of extracting and running.</p>
  30 <h3>1. Installing the server</h3>
  31 <p>The first stage is to download and install the server application. The
  32 latest versions of all i-scream applications can be found at the following
  33 URL:</p>
  34 <p><a href="http://www.i-scream.org/downloads">http://www.i-scream.org/downloads</a></p>
  35 <p>Once downloaded, the archive should be extracted to a directory of your
  36 choice. The server will run on most Java enabled platforms (including
  37 Windows, Linux and FreeBSD).</p>
  38 <p>The archive consists of only a few files and directories. The main file is
  39 the iscream-server.jar archive which contains all the binary code for the
  40 server. The lib directory contains other JAR archives which the server
  41 requires to run. The etc directory contains (or will contain)
  42 configuration for most of the i-scream central monitoring system. The next
  43 step is to configure the server to suit your requirements.</p>
  44 <h3>2. Configuring the server</h3>
  45 <p>The configuration is split into two main files. The first,
  46 default.properties can be considered a bootstrap configuration. This means
  47 that it provides basic configuration to get the server started, after
  48 which point the main configuration system takes over. This file should be
  49 checked through, and is pretty well explained by comments.</p>
  50 <p>The rest of the server configuration is based on system.conf. This can
  51 hold the entire system configuration, including hosts. It may also specify
  52 other configuration files to be included in the main configuration. This
  53 file is also commented extensively.</p>
  54 <p>This step may well take some time to get right, and you can come back to
  55 it at any point. Lots of the configuration can be changed "on the fly"
  56 as well.</p>
  57 <p>For fuller and complete details of the configuration system, and the
  58 server in general, please see the Server User Guide in the documentation
  59 section of the website.</p>
  60 <h3>2a. Setting up the database</h3>
  61 <p>The i-scream central monitoring system can make use of a database for
  62 generating historical reports. The documentation explains how you would
  63 configure the system to do this. You will need to create a single basic
  64 table yourself, this is also explained in the documentation.</p>
  65 <h3>3. Starting the server</h3>
  66 <p>Starting up the server is a trivial task. Usually you can just get away
  67 with running the run script provided. This will boot the server up
  68 displaying some basic information to the console. If something goes wrong,
  69 the error message should point to the cause.</p>
  70 <h3>4. Setting up hosts</h3>
  71 <p>Hosts can be run on either Unix (tested with Solaris, FreeBSD and some
  72 Linux distributions) or Windows. Both are equally easy to setup.</p>
  73 <p>Firstly, the Unix host is called &quot;ihost&quot;. This can be downloaded from the
  74 i-scream website. Once extracted it just needs to be started up. You need two
  75 pieces of information to do this: the filtermanager (part of the server) host
  76 and port number. If you haven't changed much in terms of configuration this will
  77 be the machine the server is running on, and port 4567. To start ihost you
  78 simply type:</p>
  79 </font>
  80 <pre>ihost.pl server.domain.com port</pre>
  81 <font face="arial,sans-serif" size="2">
  82 <p>ihost will then contact the server to obtain it's configuration and start
  83 sending information.</p>
  84 <p>The windows host, winhost, is very similar. All you need to do is install it
  85 using the provided installer in the download, and then edit the ini file to
  86 provide the two bits of information above. Running the application starts up
  87 communication with the server and data sending commences.</p>
  88 <p>Full details of both of these hosts can be found in the relevant
  89 documentation on the website.</p>
  90 <h3>5. Using Conient</h3>
  91 <p>Conient allows you to view, in real time, the data being sent by the
  92 hosts. This is a perfect way to test that all the above steps have
  93 successfully been completed.</p>
  94 <p>At present Conient is simply another archive which can be extracted and
  95 run. However, in the near future we hope to have an installer to make life
  96 easier. Conient is a Java application and will run on most Java enabled
  97 platforms.</p>
  98 <p>After extracting, the run script can be used to start Conient, or in some
  99 cases the JAR file can be executed manually. The GUI will then load. The
 100 configuration section requires you to enter a host and port for the
 101 server. By default this will be the machine on which the server is running
 102 and port 4510. Conient will then connect upon request and start displaying
 103 information.</p>
 104 <p>Assuming data is displayed you have successfully setup the i-scream
 105 central monitoring system. Well done!</p>
 106 <p>This is explained in much more detail in the Conient documentation.</p>
 107 <h3>6. Setting up DBReporter</h3>
 108 <p>If you are making use of a database you can setup the DBReporter to
 109 generate web-based reports of the information collected. This is just a
 110 case of extracting the archive to a suitable location, configuring it, and
 111 setting it to run on a regular basis (we suggest daily). DBReporter will
 112 also ensure the database is kept relatively clean.</p>
 113 <p>Full instructions are available in the DBReporter documentation.</p>
 114 <h3>7. Setting up the Web Interface</h3>
 115 <p>The Web interface allows you to view various aspects of the i-scream
 116 central monitoring system's output. These include realtime viewing of data
 117 (much like Conient), links to the DBReporter above, and full displaying of
 118 the alerts that can be generated by the server.</p>
 119 <p>The archive contains a series of PHP scripts which should be placed on
 120 your PHP enabled web server. The configuration files allow you to tailor
 121 the setup to suit your needs.</p>
 122 <p>Full instructions are available in the relevant documentation.</p>
 123 <h3>8. Further</h3>
 124 <p>You may decide to expand your setup to cover a larger network. For example, a
 125 distributed filter arrangement could cut down on the amount of traffic
 126 being sent around the network. The server itself can be distributed to suit your
 127 needs. You may wish to run the database section of the server on the same
 128 machine as the database, while running the rest on another machine.</p>
 129 <p>Some discussion about this is available in the server documentation.</p>
 130 <p>If you have any questions about any of the above, please don't hesitate to
 131 contact us at <a href="mailto:dev@i-scream.org">dev@i-scream.org</a>. If you find we've missed something out,
 132 again, please let us know.</p>
 133 <p>Finally, we'd like to thank you for trying this i-scream product. We realise
 134 that it's still at an early stage, and we therefore appreciate you taking
 135 the time to try it out.</p>
 136 <p>The i-scream team.</p>
 137 </div>
 138
 139 <!--#include virtual="/footer.inc" -->
 140
 141 </div>
 142
 143 <!--#include virtual="/menu.inc" -->
 144
 145 </div>
 146
 147 </body>
 148 </html>