I2Mobile: Difference between revisions

From Coolscript
Jump to navigation Jump to search
 
(13 intermediate revisions by 2 users not shown)
Line 1: Line 1:


i2Mobile (beta) is a lightweight web interface for Icinga2, designed for mobile clients, running on Apache, it is based on the API (Rest) interface of [https://www.icinga.org/ Icinga2].<br>
i2Mobile (beta) is a lightweight web interface for Icinga2, designed for mobile clients, running on Apache, this is based on the API (Rest) interface of [https://www.icinga.org/ Icinga2].<br>
The aim of this is to have a simple, easy and fast client for mobile phones.<br><br>
The aim of this is to have a simple, easy and fast client for mobile phones.<br><br>
{|align=right
{|align=right
Line 6: Line 6:
  |}
  |}
'''Features'''
'''Features'''
*Using the Icinga2 API to retrieve the status, no more status.cgi
*Use the Icinga2 API to retrieve the status - no more use of status.cgi (nagios/icinga1)
*Fast and Bandwidth friendly (less data)
*Fast and bandwidth friendly (less data)
*Display hosts and services with the state of error, warning and ok
*Display hosts and services with the state of error, warning and ok
*Hide hosts and services when they are acknowledged or unknown.
*Mobile silence
*Additional hide host and services by custom attributes
**Hide hosts and services whenever they have been acknowledged
**Hide hosts and services which state is unknown
**Hide host and services by custom attributes (optional)


<br>
<br>
=Requirements=
=Requirements=
<br>
<br>
* Linux, Apache and Perl for the WebUI
* Linux, Apache and Perl
* Access to the Icinga2 API Host
* Access to the already existing Icinga2 API Host
<br>
<br>


=Screenshots=
=Screenshots=
Line 45: Line 46:
|style="width:40%; vertical-align: top;"|
|style="width:40%; vertical-align: top;"|
*'''Service List'''
*'''Service List'''
[[image:i2mobile-srvlist.png|320px|left]]
[[image:I2mobile-srvlist.png|320px|left]]
|style="width:40%; vertical-align: top;"|
|style="width:40%; vertical-align: top;"|
*'''Service Detail'''
*'''Service Detail'''
Line 55: Line 56:


<br><br>
<br><br>
=Installation=
=Installation=
'''Note: The scripts has been tested on Debian 8 with Apache 2.4'''
'''Note: The scripts has been tested on Debian 8 with Apache 2.4'''
*Get the tar file from the link below
*Get the tar file from the link below
*Unextract
*Copy the entire web directory to your www root, in this example /var/www/i2mobile
*Copy the entire web directory to your www root, in this example we assume: /var/www/i2mobile
*Make your Apache user (eg www-data) owner of the new www directory and files
*Make your Apache user owner of the new target directory and files
*Copy the configuration example to /etc/i2mobile.xml
*Copy the configuration example to /etc/i2mobile.xml
*Copy the web config template to /etc/apache2/sites-available/i2mobile.domain.com.conf
*Copy the web config template to /etc/apache2/sites-available/i2mobile.domain.com.conf
Line 115: Line 114:
   vars.is_ignore = "1"
   vars.is_ignore = "1"
  }
  }
<br>


=Authentication options=
=Authentication options=
Authentication can be established using the Apache htaccess options, however, there is the alternative option to work with session cookies which is '''less secure'''<br>
Authentication can be established using the Apache htaccess options, however, there is the alternative option to work with session cookies which is '''less secure''' but<br>
but allows the i2Mobile user to access the web quickly with no authentication prompt. The idea of session cookies is to create a GUID, keep it local in i2mobile.xml
allows the i2Mobile user to access the web quickly without prompting for authentication.<br>
and use it as reference.<br>A helper page is available to add the session cookie on the client mobile browser.<br>
The idea of session cookies is to create a GUID and then keep them local in i2mobile.xml and use it as reference for each web user.<br>
A helper page is available to add the session cookie to the client mobile browser, the mobile client should then receive a email or sms including the link to add the session cookie.<br>
'''Sample'''
'''Sample'''
*CookieID="aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
*CookieID="aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"
Line 136: Line 135:
  </Authentication>
  </Authentication>
From the above sample it is possible to immediate disable the web access by setting Enabled to 0 or set the Expire to yesterday.<br>
From the above sample it is possible to immediate disable the web access by setting Enabled to 0 or set the Expire to yesterday.<br>
You may also use a small tool called addsc.pl which is available within the web directory, this will add the record to the configuration.<br>
You may also use a small helper tool called addsc.pl which is available within the web directory, this tool creates the GUID and Link for the mobile client.<br>
'''Debugging'''<br>
'''Debugging'''<br>
A status page is available to obtain the validly of the session cookie
See the status page which is available to obtain the validly of the session cookie
*http://i2mobile.domain.com/env.pl
*http://i2mobile.domain.com/env.pl
<br>
<br>
Line 148: Line 147:
'''Download the script'''<br>
'''Download the script'''<br>
Version 1.0 - 16KB<br>
Version 1.0 - 16KB<br>
[[File:Download.png|60px|link=http://coolscript.org/download/i2mobile.1.0.tar.gz|Download]]
[[File:Download.png|60px|link=https://coolscript.org/download/scripts/i2mobile.1.0.tar.gz|Download]]
<br>
<br>
|style="width:70%; vertical-align: top;"|
|style="width:70%; vertical-align: top;"|
Line 157: Line 156:
<br><hr><br>
<br><hr><br>


'''Feedbacks or comments are very welcome, no matter which direction. Please send to postmaster at coolscript.org'''
'''Feedbacks or comments are very welcome, no matter which direction. Please drop a email to postmaster at coolscript.org'''

Latest revision as of 13:07, 4 March 2022

i2Mobile (beta) is a lightweight web interface for Icinga2, designed for mobile clients, running on Apache, this is based on the API (Rest) interface of Icinga2.
The aim of this is to have a simple, easy and fast client for mobile phones.

Features

  • Use the Icinga2 API to retrieve the status - no more use of status.cgi (nagios/icinga1)
  • Fast and bandwidth friendly (less data)
  • Display hosts and services with the state of error, warning and ok
  • Mobile silence
    • Hide hosts and services whenever they have been acknowledged
    • Hide hosts and services which state is unknown
    • Hide host and services by custom attributes (optional)


Requirements


  • Linux, Apache and Perl
  • Access to the already existing Icinga2 API Host


Screenshots



  • All hosts and services are running
  • Warnings present



  • Critical Errors
  • Warnings and Crticals



  • Service List
  • Service Detail





Installation

Note: The scripts has been tested on Debian 8 with Apache 2.4

  • Get the tar file from the link below
  • Copy the entire web directory to your www root, in this example /var/www/i2mobile
  • Make your Apache user (eg www-data) owner of the new www directory and files
  • Copy the configuration example to /etc/i2mobile.xml
  • Copy the web config template to /etc/apache2/sites-available/i2mobile.domain.com.conf
    • Configure and rename the web config to your requriements


  • Setup Apache, enable the web site and switch on the cgi module, example:
a2ensite i2mobile.domain.com
a2enmod cgi
  • Install the required perl modules using MCPAN:
# perl -MCPAN -e 'install REST::Client'
# perl -MCPAN -e 'install JSON'
# perl -MCPAN -e 'install MIME::Base64'
# perl -MCPAN -e 'install Data::Dumper'
# perl -MCPAN -e 'install Data::GUID'

Configure i2Mobile

Configuration is done in /etc/i2mobile.xml. These are the minimum settings:

  • IcingaHost=URL and Port to the Icinga2 Host
  • Password=The password
  • CookieAuthentication=Optional authentication using a session cookie
  • Contact=Optional contact information
  • URL==Optional Site URL

Example:

<?xml version="1.0" encoding="UTF-8"?>
<CONFIG>
 <System 
  IcingaHost="https://your.ip.here:5665" 
  Password="user:123456789" 
  CookieAuthentication="0" 
  Contact="you@domain.com" 
  URL="http://i2mobile.domain.com"></System>
</CONFIG>


Thats it, setup is finsihed.

Display options

Services and hosts can be hided in i2Mobile, the idea is to show only important information and hide services and hosts which are not interested for the mobile user

  • Service sample
apply Service "Something" {
 ...
 //this will hide the service from i2Mobile
 vars.is_ignore = "1"
}
  • Host sample
apply Host "Something" {
 ...
 //this will hide the host from i2Mobile
 vars.is_ignore = "1"
}

Authentication options

Authentication can be established using the Apache htaccess options, however, there is the alternative option to work with session cookies which is less secure but
allows the i2Mobile user to access the web quickly without prompting for authentication.
The idea of session cookies is to create a GUID and then keep them local in i2mobile.xml and use it as reference for each web user.
A helper page is available to add the session cookie to the client mobile browser, the mobile client should then receive a email or sms including the link to add the session cookie.
Sample

Full configuration sample

  • i2mobile.xml
<Authentication 
 Enabled="1" 
 CookieID="aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" 
 Name="John Public" 
 MailTo="jp@domain.com" 
 Expire="20180701"
</Authentication>

From the above sample it is possible to immediate disable the web access by setting Enabled to 0 or set the Expire to yesterday.
You may also use a small helper tool called addsc.pl which is available within the web directory, this tool creates the GUID and Link for the mobile client.
Debugging
See the status page which is available to obtain the validly of the session cookie


Download


Download the script
Version 1.0 - 16KB
Download






Feedbacks or comments are very welcome, no matter which direction. Please drop a email to postmaster at coolscript.org