[icinga-checkins] icinga.org: icinga-web/mfriedrich/fixes: * Updated documentation.

git at icinga.org git at icinga.org
Thu Jan 13 17:54:24 CET 2011


Module: icinga-web
Branch: mfriedrich/fixes
Commit: bf0fcbcd8d1359ee7bd4eb50fb3f4cf1fe31e378
URL:    https://git.icinga.org/?p=icinga-web.git;a=commit;h=bf0fcbcd8d1359ee7bd4eb50fb3f4cf1fe31e378

Author: Gunnar Beutner <gunnar.beutner at netways.de>
Date:   Wed Jan 12 13:01:59 2011 +0100

* Updated documentation.

---

 doc/LICENSE              |    6 ++--
 doc/icinga-api-types.txt |   54 +++++++++++++++++++++++-----------------------
 2 files changed, 30 insertions(+), 30 deletions(-)

diff --git a/doc/LICENSE b/doc/LICENSE
index be148cc..4c89102 100644
--- a/doc/LICENSE
+++ b/doc/LICENSE
@@ -3,7 +3,7 @@
 
 icinga-web:
 
-a new generation of interface for icinga.
+a new generation of interface for Icinga.
 
 Copyright (c) 2009, Icinga Development Team
 All rights reserved.
@@ -17,7 +17,7 @@ the Open Source GPL 2 license.
 
 Opensource License:
 
-icinga-web, web2.0 frontend for the icinga core
+icinga-web, web2.0 frontend for the Icinga core
 Copyright (C) 2009  Icinga Development Team
 
 This program is free software; you can redistribute it and/or modify
@@ -44,6 +44,6 @@ Vendor and foreign components:
 
 All trademarks and registered trademarks mentioned herein
 are the property of their respective owners and their
-choosen licenses.
+chosen licenses.
 
 --------------------------------------------------------
diff --git a/doc/icinga-api-types.txt b/doc/icinga-api-types.txt
index 60110a6..e2e57ff 100644
--- a/doc/icinga-api-types.txt
+++ b/doc/icinga-api-types.txt
@@ -7,33 +7,33 @@ your initial connection to icnga. To display a brief help description run
 
 	sh configure --help
 
-in the root of the src directory. You can also edit this parameters by hand.
-The connection to icinga is located in
+in the root of the src directory. You can also edit those parameters by hand.
+The connection parameters for Icinga are located in
 
-	app/modules/Web/config/module.xml
+	app/modules/Web/config/icinga-io.site.xml
 
-Search for the 'api.interfaces.data' setting and alter the configuration to
-suite your environment
+Search for the 'api.interfaces.data' setting and update the configuration to
+suit your environment.
 
-2) Connection constants
+2) Connection type
 
-The connstants used to select the main interface, e.g. for databases or
-something other, like mklifestatus.
+The 'api.interfaces.data' option is used to select the main interface, e.g. databases or
+something else, like mk_lifestatus.
 
-	CONNECTION_IDO					database abstraction layer
+	CONNECTION_IDO				database abstraction layer
 	CONNECTION_IDO_ABSTRACTION		not implemented
-	CONNECTION_FILE					native file interface
+	CONNECTION_FILE				native file interface
 	CONNECTION_LIVESTATUS			mk_lifestatus connector
 
-Please note that the both file connections are experimental. The data
-is not compatible to icinga-web
+Please note that both file connection types are experimental. Their data formats
+are not compatible with icinga-web.
 
 3) Connection specific settings
 
-Every connection requires different configuration. The icinga-web module.xml
-parameters are completely free. To define an api option, simply prefix the
-option key with 'config_'. If you need to define 'host', add 'config_host' to
-your xml parameters.
+Every connection type requires different configuration parameters. To define an API
+option, simply prefix the option key with 'config_'. For example, if you need to
+define the API option 'host', add 'config_host' to your XML parameters. Other parameters
+not listed below can also be specified - these are ignored by icinga-web.
 
 3.1) CONNECTION_IDO
 
@@ -42,16 +42,15 @@ your xml parameters.
 
 				  Supported types: mysql, oci, oci8, pgsql
 
-				  There are two oracle drivers. The oci8 using the original
-				  oracle client libraries which is more robust
+				  There are two Oracle drivers. The oci8 driver uses
+				  the original Oracle client libraries which are
+				  more robust.
 
 	host		: Target of the database system
 	port		: Over the network you'll need a port
 	database	: Name of the database (depends on your ido2db setup)
-	user		: Username to connect to
-	password	: Password to authenticate
-
-
+	user		: Username to connect with
+	password	: Password used for authentication
 
 
 3.2) CONNECTION_LIFESTATUS
@@ -61,18 +60,19 @@ your xml parameters.
 	host		: Target instruction for tcp
 	port		: Nummeric port value for tcp connections
 
-	NOTICE: This interface is not ready to work with productive software
+	NOTICE: This interface is not ready for use in production environments.
+
 
 3.3) CONNECTION_FILE (DEPRECATED)
 
-	This implementation is deprecated and is not active developed. If you have
+	This implementation is deprecated and is not being actively worked on. If you have
 	something dev related, please provide patches.
 
-	status.dat		: Location to your icinga status.dat file
+	status.dat	: Location to your icinga status.dat file
 	objects.cache	: Path to objects cache file
 	retention.dat	: Path to retention.dat
 
-	All the files have to exit and must be readable by the user running
+	All the files have to exist and must be readable by the user running
 	Apache or CLI or whatever.
 
-	NOTICE: This interface is not ready to work with productive software
+	NOTICE: This interface is not ready for use in production environments.





More information about the icinga-checkins mailing list