granicus.if.org Git - icinga2/blob - doc/14-alternative-frontends.md

   1 # <a id="alternative-frontends"></a> Alternative Frontends
   2
   3 ## <a id="setting-up-icinga-classic-ui"></a> Setting up Icinga Classic UI 1.x
   4
   5 Icinga 2 can write `status.dat` and `objects.cache` files in the format that
   6 is supported by the Icinga 1.x Classic UI. [External commands](5-advanced-topics.md#external-commands)
   7 (a.k.a. the "command pipe") are also supported. It also supports writing Icinga 1.x
   8 log files which are required for the reporting functionality in the Classic UI.
   9
  10 ### <a id="installing-icinga-classic-ui"></a> Installing Icinga Classic UI 1.x
  11
  12 The Icinga package repository has both Debian and RPM packages. You can install
  13 the Classic UI using the following packages:
  14
  15   Distribution  | Packages
  16   --------------|---------------------
  17   Debian        | icinga2-classicui
  18   RHEL/SUSE     | icinga2-classicui-config icinga-gui
  19
  20 The Debian packages require additional packages which are provided by the
  21 [Debian Monitoring Project](http://www.debmon.org) (`debmon`) repository.
  22
  23 `libjs-jquery-ui` requires at least version `1.10.*` which is not available
  24 in Debian 7 (Wheezy) and Ubuntu 12.04 LTS (Precise). Add the following repositories
  25 to satisfy this dependency:
  26
  27   Distribution                  | Package Repositories
  28   ------------------------------|------------------------------
  29   Debian Wheezy                 | [wheezy-backports](http://backports.debian.org/Instructions/) or [debmon](http://www.debmon.org)
  30   Ubuntu 12.04 LTS (Precise)    | [Icinga PPA](https://launchpad.net/~formorer/+archive/icinga)
  31
  32 On all distributions other than Debian you may have to restart both your web
  33 server as well as Icinga 2 after installing the Classic UI package.
  34
  35 Icinga Classic UI requires the [StatusDataWriter](5-advanced-topics.md#status-data), [CompatLogger](5-advanced-topics.md#compat-logging)
  36 and [ExternalCommandListener](5-advanced-topics.md#external-commands) features.
  37 Enable these features and restart Icinga 2.
  38
  39     # icinga2 feature enable statusdata compatlog command
  40
  41 In order for commands to work you will need to [setup the external command pipe](2-getting-started.md#setting-up-external-command-pipe).
  42
  43 ### <a id="setting-up-icinga-classic-ui-summary"></a> Setting Up Icinga Classic UI 1.x Summary
  44
  45 Verify that your Icinga 1.x Classic UI works by browsing to your Classic
  46 UI installation URL:
  47
  48   Distribution  | URL                                                                      | Default Login
  49   --------------|--------------------------------------------------------------------------|--------------------------
  50   Debian        | [http://localhost/icinga2-classicui](http://localhost/icinga2-classicui) | asked during installation
  51   all others    | [http://localhost/icinga](http://localhost/icinga)                       | icingaadmin/icingaadmin
  52
  53 For further information on configuration, troubleshooting and interface documentation
  54 please check the official [Icinga 1.x user interface documentation](http://docs.icinga.org/latest/en/ch06.html).
  55
  56 ## <a id="setting-up-icinga-web"></a> Setting up Icinga Web 1.x
  57
  58 Icinga 2 can write to the same schema supplied by `Icinga IDOUtils 1.x` which
  59 is an explicit requirement to run `Icinga Web` next to the external command pipe.
  60 Therefore you need to setup the [DB IDO feature](2-getting-started.md#configuring-db-ido-mysql) remarked in the previous sections.
  61
  62 ### <a id="installing-icinga-web"></a> Installing Icinga Web 1.x
  63
  64 The Icinga package repository has both Debian and RPM packages. You can install
  65 Icinga Web using the following packages:
  66
  67   Distribution  | Packages
  68   --------------|-------------------------------------------------------
  69   RHEL/SUSE     | icinga-web icinga-web-{mysql,pgsql}
  70   Debian        | icinga-web icinga-web-config-icinga2-ido-{mysql,pgsql}
  71
  72 ### <a id="icinga-web-rpm-notes"></a> Icinga Web 1.x on RPM based systems
  73
  74 Additionally you need to setup the `icinga_web` database and import the database schema.
  75 Details can be found in the package `README` files, for example [README.RHEL](https://github.com/Icinga/icinga-web/blob/master/doc/README.RHEL)
  76
  77 The Icinga Web RPM packages install the schema files into
  78 `/usr/share/doc/icinga-web-*/schema` (`*` means package version).
  79
  80 On SuSE-based distributions the schema files are installed in
  81 `/usr/share/doc/packages/icinga-web/schema`.
  82
  83 Example for RHEL and MySQL:
  84
  85     # mysql -u root -p
  86
  87     mysql> CREATE DATABASE icinga_web;
  88            GRANT SELECT, INSERT, UPDATE, DELETE, DROP, CREATE VIEW, INDEX, EXECUTE ON icinga_web.* TO 'icinga_web'@'localhost' IDENTIFIED BY 'icinga_web';
  89            quit
  90
  91     # mysql -u root -p icinga_web <  /usr/share/doc/icinga-web-<version>/schema/mysql.sql
  92
  93 Icinga Web requires the IDO feature as database backend using MySQL or PostgreSQL.
  94 Enable that feature, e.g. for MySQL.
  95
  96     # icinga2 feature enable ido-mysql
  97
  98 If you've changed your default credentials you may either create a read-only user
  99 or use the credentials defined in the IDO feature for Icinga Web backend configuration.
 100 Edit `databases.xml` accordingly and clear the cache afterwards. Further details can be
 101 found in the [Icinga Web documentation](http://docs.icinga.org/latest/en/icinga-web-config.html).
 102
 103     # vim /etc/icinga-web/conf.d/databases.xml
 104
 105     # icinga-web-clearcache
 106
 107 Additionally you need to enable the `command` feature for sending [external commands](5-advanced-topics.md#external-commands):
 108
 109     # icinga2 feature enable command
 110
 111 In order for commands to work you will need to [setup the external command pipe](2-getting-started.md#setting-up-external-command-pipe).
 112
 113 Then edit the Icinga Web configuration for sending commands in `/etc/icinga-web/conf.d/access.xml`
 114 (RHEL) or `/etc/icinga-web/access.xml` (SUSE) setting the command pipe path
 115 to the default used in Icinga 2. Make sure to clear the cache afterwards.
 116
 117     # vim /etc/icinga-web/conf.d/access.xml
 118
 119                 <write>
 120                     <files>
 121                         <resource name="icinga_pipe">/var/run/icinga2/cmd/icinga2.cmd</resource>
 122                     </files>
 123                 </write>
 124
 125     # icinga-web-clearcache
 126
 127 > **Note**
 128 >
 129 > The path to the Icinga Web `clearcache` script may differ. Please check the
 130 > [Icinga Web documentation](https://docs.icinga.org) for details.
 131
 132 ### <a id="icinga-web-debian-notes"></a> Icinga Web on Debian systems
 133
 134 Since Icinga Web `1.11.1-2` the IDO auto-configuration has been moved into
 135 additional packages on Debian and Ubuntu.
 136
 137 The package `icinga-web` no longer configures the IDO connection. You must now
 138 use one of the config packages:
 139
 140  - `icinga-web-config-icinga2-ido-mysql`
 141  - `icinga-web-config-icinga2-ido-pgsql`
 142
 143 These packages take care of setting up the [DB IDO](2-getting-started.md#configuring-db-ido-mysql) configuration,
 144 enabling the external command pipe for Icinga Web and depend on
 145 the corresponding packages of Icinga 2.
 146
 147 Please read the `README.Debian` files for details and advanced configuration:
 148
 149  - `/usr/share/doc/icinga-web/README.Debian`
 150  - `/usr/share/doc/icinga-web-config-icinga2-ido-mysql/README.Debian`
 151  - `/usr/share/doc/icinga-web-config-icinga2-ido-pgsql/README.Debian`
 152
 153 When changing Icinga Web configuration files make sure to clear the config cache:
 154
 155     # /usr/lib/icinga-web/bin/clearcache.sh
 156
 157 > **Note**
 158 >
 159 > If you are using an older version of Icinga Web, install it like this and adapt
 160 > the configuration manually as shown in [the RPM notes](14-alternative-frontends.md#icinga-web-rpm-notes):
 161 >
 162 > `apt-get install --no-install-recommends icinga-web`
 163
 164 ### <a id="setting-up-icinga-web-summary"></a> Setting Up Icinga Web 1.x Summary
 165
 166 Verify that your Icinga 1.x Web works by browsing to your Web installation URL:
 167
 168   Distribution  | URL                                                         | Default Login
 169   --------------|-------------------------------------------------------------|--------------------------
 170   Debian        | [http://localhost/icinga-web](http://localhost/icinga-web)  | asked during installation
 171   all others    | [http://localhost/icinga-web](http://localhost/icinga-web)  | root/password
 172
 173 For further information on configuration, troubleshooting and interface documentation
 174 please check the official [Icinga 1.x user interface documentation](http://docs.icinga.org/latest/en/ch06.html).
 175