[Pkg-nagios-changes] [pkg-icinga-web] 07/11: Update README.Debian

Markus Frosch (old DM Account) lazyfrosch-guest at moszumanska.debian.org
Tue Sep 9 13:02:08 UTC 2014


This is an automated email from the git hooks/post-receive script.

lazyfrosch-guest pushed a commit to branch master
in repository pkg-icinga-web.

commit a7d577c3e7c89d8401504b22ad69ed7d54667aa4
Author: Markus Frosch <markus at lazyfrosch.de>
Date:   Tue Sep 9 14:34:00 2014 +0200

    Update README.Debian
---
 debian/icinga-web.README.Debian | 139 +++++++++++++++++++---------------------
 1 file changed, 65 insertions(+), 74 deletions(-)

diff --git a/debian/icinga-web.README.Debian b/debian/icinga-web.README.Debian
index 263f4a6..3f93d6c 100644
--- a/debian/icinga-web.README.Debian
+++ b/debian/icinga-web.README.Debian
@@ -1,105 +1,96 @@
 icinga-web for Debian
 =====================
 
-Notes:
+  [ XML config cache ]
 
-  * Apache2 configuration
-    due to changes introduced with Apache 2.4 the debconf setting which
-    webservers are enabled is now removed.
+    !!! IMPORTANT !!!
 
-    If you want to disable icinga-web in your webserver do the following:
+    If you change any part of Icinga Web's XML configuration, you *have* to
+    clear the config cache.
 
-    Apache >= 2.4:
-     $ a2disconf icinga-web
-     $ service apache2 reload
+    You can do this with proper permissions and the script:
+      /usr/lib/icinga-web/bin/clearcache.sh
 
-    Apache < 2.4:
-     $ rm /etc/apache2/conf.d/icinga-web.conf     # remove link
-     $ touch /etc/apache2/conf.d/icinga-web.conf  # create empty file
-     $ service apache2 reload
+    The cache itself is located in /var/cache/icinga-web/config/
 
-  * [Security Information]
-    The Yahoo Interface library is used in Icinga Web to render certain
-    pie charts, unfortunatly this causes problems due to a cross site
-    scripting issue.
+  [ IDO Database connection ]
 
-    The flash component has been removed from Debian and the charting
-    feature is disabled.
+    The connection to Icinga's IDO is no longer configured automatically.
 
-    Though a upstream fix is applied to allow the usage - when the user
-    decides to...
+    You will either have to do this by hand, or use one of the config packages:
+      icinga-web-config-icinga
+      icinga-web-config-icinga2-ido-mysql
+      icinga-web-config-icinga2-ido-pgsql
 
-    If you want to use the TO charts you have to either download a .swf
-    file to your server or use a swf loaded from yahooapis.com on demand.
+    Manual changes should be done inside: /etc/icinga-web/conf.d/databases.xml
 
-    See the file /usr/share/icinga-web/app/modules/AppKit/lib/js/AppKit.js
-    for configuration options.
+    WARNING: Make sure to disable the corresponding <xi:include part of that
+             file. This avoids inclusion of automatic generated configs.
 
-    Remote files:
-     uncomment the respective lines there and run
-     /usr/lib/icinga-web/bin/clearcache.sh
+    Other README's to check:
+      /usr/share/doc/icinga-web-config-icinga2-ido-mysql/README.Debian
+      /usr/share/doc/icinga-web-config-icinga2-ido-pgsql/README.Debian
+      /usr/share/doc/icinga-web-config-icinga/README.Debian
+      /usr/share/doc/icinga-idoutils/README.Debian
 
-    Local files:
-     download both files
-      http://yui.yahooapis.com/2.8.2/build/charts/assets/charts.swf
-      http://swfobject.googlecode.com/svn/trunk/swfobject/expressInstall.swf
+  [ Icinga 2 Command Pipe ]
 
-     and store them in /usr/share/icinga-web/lib/ext3/resources/
+    When you are using Icinga 2 as monitoring system and are *not* using the
+    config packages, you will have to configure the path to Icinga's command
+    pipe manually.
 
-     make sure to also change AppKit.js to uncomment the respective lines and
-     run /usr/lib/icinga-web/bin/clearcache.sh
+    Configuration is in:
+      /etc/icinga-web/conf.d/access.xml
 
-  * Please also read /usr/share/doc/icinga-idoutils/README.Debian
-    this file will explain how to enable the IDO in the first place
+  [ Icinga Web database ]
 
-  * Supported databases are: MySQL and PostgreSQL (by auto configuration)
+    Configuration for Icinga Web's internal database is provided via
+    dbconfig-common in the maintainer scripts of this file.
 
-  * PostgreSQL with ident authentication:
-    
-     This is not really supported, just because icinga-web runs as www-data
-     per default. You will have to do some configuration stuff to run
-     icinga-web with ident. But you'll have to do this on your own.
-    
-     Though the maintainer scripts will create you a config for the
-     socket connection.
-    
-     Every access rights the maintainer script changes is checked
-     against dpkg-statoverride - so make sure to use it.
-     
-  * Icinga Web uses two database connections
+    General database configuration:
+      /etc/icinga-web/conf.d/databases.xml
 
-    1) IDO database, which is configured with by a dependency
-       on the icinga-idoutils packet
- 
-       generated file: /etc/icinga-web/conf.d/database-ido.xml
+    Auto-generated configuration:
+      /etc/icinga-web/conf.d/database-web.xml
 
-    2) Icinga Web database, which stores users and settings and
-       is configured by using the dbconfig-common system and debconf
+  [ Apache2 configuration ]
+    due to changes introduced with Apache 2.4 the debconf setting which
+    webservers are enabled is now removed.
 
-       generated file: /etc/icinga-web/conf.d/database-web.xml
+    If you want to disable icinga-web in your webserver do the following:
 
-  * If you want to to use different database connection settings
-    modify the file
-      /etc/icinga-web/conf.d/databases.xml
-    and comment the includes of the auto generated xml files
+    Apache >= 2.4:
+     $ a2disconf icinga-web
+     $ service apache2 reload
+
+    Apache < 2.4:
+     $ rm /etc/apache2/conf.d/icinga-web.conf     # remove link
+     $ touch /etc/apache2/conf.d/icinga-web.conf  # create empty file
+     $ service apache2 reload
+
+  [ Notes regarding PostgreSQL ident authentication [
+
+    This is not really supported, just because icinga-web runs as www-data
+    per default. You will have to do some configuration stuff to run
+    icinga-web with ident. But you'll have to do this on your own.
+
+    Though the maintainer scripts will create you a config for the
+    socket connection.
+
+    Every access rights the maintainer script changes is checked
+    against dpkg-statoverride - so make sure to use it.
+
+  [ Jasper Reporting integration ]
+
+    The module is disabled by default, to activate it you have to edit:
 
-  * Jasper Reporting is disabled by default
-    to activate it you have to edit:
-      
       /etc/icinga-web/conf.d/cronks.xml
         comment out the xml node <cronk name="icingaReportingDefault">
-      
+        or change the hide/enabled values
+
       /etc/icinga-web/conf.d/module_reporting.xml
         set <module enabled="true">
         and change the url and user/pass to fit your jasper instance
 
-     Please see the Icinga Wiki for more information.
-
-  * If you change any configuration or code file of Icinga Web
-    it is necessary to clear the cache.
-
-    To achieve this run this command as root:
-      /usr/lib/icinga-web/bin/clearcache.sh
-
- -- Markus Frosch <markus at lazyfrosch.de>  Mon, 24 Jun 2013 11:36:34 +0200
+ -- Markus Frosch <lazyfrosch at debian.org>  Tue, 09 Sep 2014 13:15:20 +0200
 

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-nagios/pkg-icinga-web.git



More information about the Pkg-nagios-changes mailing list