[icinga-checkins] icinga.org: icinga-doc/master: Feature #1053

git at icinga.org git at icinga.org
Tue Jan 18 21:47:27 CET 2011


Module: icinga-doc
Branch: master
Commit: 8475c1dac7fc89e5b7617207b25e2f5c122642cd
URL:    https://git.icinga.org/?p=icinga-doc.git;a=commit;h=8475c1dac7fc89e5b7617207b25e2f5c122642cd

Author: Lara Berdelsmann <berdelsmann at arcor.de>
Date:   Tue Jan 18 21:46:54 2011 +0100

Feature #1053

---

 en/Icinga.xml            |    1 +
 en/icinga-web-config.xml |   79 ++++++++++++++++++++++++++++++++++++++-------
 2 files changed, 67 insertions(+), 13 deletions(-)

diff --git a/en/Icinga.xml b/en/Icinga.xml
index cf3809e..3ccc15b 100644
--- a/en/Icinga.xml
+++ b/en/Icinga.xml
@@ -238,6 +238,7 @@
 
       <xi:include href="cgis.xml" />
       <xi:include href="icinga-web-scratch.xml" />
+<xi:include href="icinga-web-config.xml" />
       <xi:include href="icinga-web-intro.xml" />
       <xi:include href="icinga-web-pnp.xml" />
     </chapter>
diff --git a/en/icinga-web-config.xml b/en/icinga-web-config.xml
index 9ed6609..bf209b1 100644
--- a/en/icinga-web-config.xml
+++ b/en/icinga-web-config.xml
@@ -22,36 +22,44 @@ app/modules/AppKit/
 |-- models
 |-- templates
 |-- validate
-`-- views</programlisting></para>
+|-- views</programlisting></para>
 
   <para><emphasis role="bold">Customised Configuration</emphasis></para>
 
   <note>
     <para>Your specific Icinga configuration settings like api, authentication and database settings can be set in
     app/modules/Appkit(/Cronks/Web)/config/*.site.xml- Files and will be used in the first place. They won't get overwritten during upgrade
-    proces</para>
+    process.</para>
   </note>
 
   <para><emphasis role="bold">Global Configuration Section: </emphasis></para>
 
   <para><emphasis role="bold">app/config</emphasis></para>
 
-  <para>Here you find the global configuration files for e.g. the Web Session, the Icinga Web Path and the database informations.</para>
+  <para>Here you find the global configuration files for e.g. the Web session, the Icinga web path and the database informations.</para>
 
   <para>The main interesting files:</para>
 
-  <para>database.xml, holds the connection information for your icinga-web database</para>
+  <itemizedlist>
+    <listitem>
+      <para>database.xml - holds the connection information for your icinga-web database</para>
+    </listitem>
 
-  <para>factories.xml, holds the config for your web session, e.g. the session_cookie_lifetime- parameter</para>
+    <listitem>
+      <para>factories.xml - holds the config for your web session, e.g. the session_cookie_lifetime- parameter</para>
+    </listitem>
 
-  <para>icinga.xml, holds the config for your Icinga Web root-dir, Web path.</para>
+    <listitem>
+      <para>icinga.xml - holds the config for your Icinga Web root-dir, Web path.</para>
+    </listitem>
+  </itemizedlist>
 
   <para>Example: change the session_cookie_lifetime</para>
 
-  <para>The Session Lifetime is the time in Seconds until the Icinga Web session expires. It can be configured on global level in the file
+  <para>The Session Lifetime is the time in seconds until the Icinga Web session expires. It can be configured on global level in the file
   app/config/factories.xml.</para>
 
-  <programlisting>vi app/config/factories.xml
+  <programlisting>#> vi app/config/factories.xml
 
 <ae:parameter name="session_cookie_lifetime">3600</ae:parameter></programlisting>
 
@@ -91,7 +99,7 @@ app/modules/AppKit/
             <ae:parameter name="ldap_filter_user"><![CDATA[(&(sAmAccountName=__USERNAME__))]]></ae:parameter>
         </ae:parameter></programlisting>
 
-  <para>The auth.xml holds documentation for the global config. The ldap authentication should be done with some basic ldap
+  <para>The auth.xml holds the documentation for the global config. The ldap authentication should be done with some basic ldap
   knowledge.</para>
 
   <para>You can also duplicate the provider to provide more authentication bases. You can split the auth into authentication and authorising
@@ -104,19 +112,64 @@ app/modules/AppKit/
   <para>All the cronks are implemented there: Grids, iframes. All of them are simple html sites which holds ExtJS component codes. If you
   need to add a new cronk, this module is your friend.</para>
 
+  <para>If you want to develop a new Cronk take a look at <link
+  xlink:href="https://dev.icinga.org/projects/icinga-development/wiki/HowToDevelopCronks">HowToDevelopCronks</link></para>
+
+  <para>To change the configuration, go to the Cronks module.</para>
+
+  <programlisting>#> ls app/modules/Cronks/config
+autoload.xml  config_handlers.xml  cronks.xml  module.xml  validators.xml</programlisting>
+
+  <itemizedlist>
+    <listitem>
+      <para>module.xml - to define new categories in which the cronks appears, module.xml holds all the information</para>
+    </listitem>
+
+    <listitem>
+      <para>cronks.xml - to make new cronks accessible or define new iframe cronks</para>
+    </listitem>
+  </itemizedlist>
   <para><emphasis role="bold">app/modules/Web</emphasis></para>
 
   <para>Or better:<emphasis role="bold"> Icinga</emphasis>. This module holds all Icinga related stuff, IcingaAPI2Json, status information.
   Also the IcingaAPI connection is configured here.</para>
 
-  <para>The Session Lifetime (the time until the Icinga Web session expires) can be configured on global level in the file
-  /usr/local/icinga-web/app/config/factories.xml :</para>
+  <para>Example: Change the IcingaApi connection settings</para>
+
+  <para>Take a look at app/modules/Web/config/icinga-io.xml, here you'll find the default settings for the IcingaApi connection.</para>
+
+  <programlisting>#> vi app/modules/Web/config/icinga-io.xml
+
+          <setting name="api.interfaces.data">
+                                        <!-- IcingaApi connection interface -->
+                                        <ae:parameter name="api_type">IcingaApi::CONNECTION_IDO</ae:parameter>
+
+                                        <!-- Suits for all interfaes -->
+                                        <ae:parameter name="config_type">mysql</ae:parameter>
+                                        <ae:parameter name="config_host">localhost</ae:parameter>
+                                        <ae:parameter name="config_port">3306</ae:parameter>
+
+                                        <!-- ###BEGIN_CONNECTION_IDO### -->
+                                        <!-- Database specific (IcingaApi::CONNECTION_IDO) -->
+                                        <ae:parameter name="config_database">icinga</ae:parameter>
+                                        <ae:parameter name="config_user">icinga</ae:parameter>
+                                        <ae:parameter name="config_password">icinga</ae:parameter>
+                                        <ae:parameter name="config_table_prefix">icinga_</ae:parameter>
+                                        <!-- ###END_CONNECTION_IDO### --></programlisting>
+
+  <para>If you want to change these settings to your needs, please edit app/modules/Web/config/icinga-io.site.xml.</para>
 
   <note>
-    <para>Optional: Ihre spezifischen &name-icinga; Datenbankeinstellungen können Sie vornehmen in app / config /database.site.xml. Diese
-    Informationen bleiben während eines Update- Prozesses erhalten.</para>
+    <para>After changing those configs you need to clear the config cache!</para>
   </note>
 
+  <programlisting> #> rm -rf app/cache/config/*.php</programlisting>
+
+  <para>or</para>
+
+  <programlisting>/icinga-web/bin/clearcache.sh</programlisting>
+<para>You need more informations? Please have a look at our <link
+  xlink:href="https://dev.icinga.org/projects/icinga-development/wiki/">Development Wiki.</link></para>
   <indexterm zone="icinga-web-config">
     <primary>Configuration Options Icinga Web</primary>
   </indexterm>





More information about the icinga-checkins mailing list