[icinga-checkins] icinga.org: icinga-web/mhein/default: * Minor changes to the README and INSTALL files.

git at icinga.org git at icinga.org
Mon Jan 10 09:12:33 CET 2011


Module: icinga-web
Branch: mhein/default
Commit: d6e6fa0fa82e76eac948de86be197d1b76e47ba4
URL:    https://git.icinga.org/?p=icinga-web.git;a=commit;h=d6e6fa0fa82e76eac948de86be197d1b76e47ba4

Author: Gunnar Beutner <gunnar.beutner at netways.de>
Date:   Fri Jan  7 13:43:44 2011 +0100

* Minor changes to the README and INSTALL files.
* Added a paragraph about how to enable mod_rewrite.

---

 README      |    4 ++--
 doc/INSTALL |   47 ++++++++++++++++++++++++++---------------------
 2 files changed, 28 insertions(+), 23 deletions(-)

diff --git a/README b/README
index 8b6d5fb..72b7cf0 100755
--- a/README
+++ b/README
@@ -4,8 +4,8 @@
 Icinga-Web
 
 This is a new, versatile, web frontend to use with Icinga.
-It is official part of the Icinga project and aims to
-replace the regular cgi's.
+It is an official part of the Icinga project and aims to
+replace the regular CGIs.
 
 For detailed information about installation, legal and all
 other, please take a look into ./doc
diff --git a/doc/INSTALL b/doc/INSTALL
index 166379a..c372eb8 100644
--- a/doc/INSTALL
+++ b/doc/INSTALL
@@ -1,6 +1,6 @@
-THIS INSTALLATION DOCUMENT IS STILL EXPERIMENTAL,
+THIS INSTALLATION DOCUMENT IS STILL EXPERIMENTAL.
 
-please report bugs and typos to dev.icinga.org
+Please report bugs and typos to http://dev.icinga.org/
 
 0) Introduction
 
@@ -16,11 +16,11 @@ https://dev.icinga.org/projects/icinga-web/wiki
 
 1) Prerequisites
 
-You need a running dbms and php (with PEAR and CLI) environment w/ icinga and ido (ido2db).
-The Icinga API is mandatory being installed too. (It's important to have the newest version
-of the api to use the newest icinga-web)
+You need a running DBMS and PHP (with PEAR and CLI) environment w/ Icinga and IDO (ido2db).
+The Icinga API is also a mandatory dependency. (It's important to have the newest version
+of the API to use the newest icinga-web)
 
-If there's something missing on your system, please refer to docs.icinga.org.
+If there's something missing on your system, please refer to http://docs.icinga.org/.
 
 2) The beautiful GNU-install conglomerate
 
@@ -55,7 +55,7 @@ with autoconf. On Debian/Ubuntu systems you'll need some packages like 'make' an
 		
 		If the command runs without errors you will have a ready configured icinga-web.
 		
-		Keep in mind that you configure the icinga-web database not the icinga idoutils database!
+		Keep in mind that you configure the icinga-web database not the Icinga IDOUtils database!
 
 		
 	2.3) The make command and its targets
@@ -64,26 +64,28 @@ with autoconf. On Debian/Ubuntu systems you'll need some packages like 'make' an
 		
 		Type 'make' to see a list of available options.
 		
-		To install to the desired location type 'sudo make install' at the prompt. Be sure to use root
-		privileges to to this.
+		To install to the desired location type 'make install' at the prompt. Be sure to use root
+		privileges to do this.
 		
 		Install also overwrites your existing directory and any old configuration in there. To avoid 
-		data loss make backups or write down your configure command to match you needs.
+		data loss make backups or write down your configure command to match you needs. Alternatively
+		you can use 'make upgrade' to upgrade an existing icinga-web installation while keeping your
+		old configuration files.
 
-		'make testdeps' checks if you meet all the required (php) dependencies for icinga-web
+		'make testdeps' checks if you meet all the required (PHP) dependencies for icinga-web.
 		
 		'make' can also install and upgrade new or existing databases by using the following targets:
 		
 		make db-initialize	- creates a spick-and-span database
-		make db-drop 		- drops your database with a security query to avoid casualties
+		make db-drop 		- drops your database with a security query to avoid accidents
 		make db-upgrade		- upgrades old tables to a newer version (Just the same as db-initialize
 					  with a better name ;-))
 		make db-doc2sql		- if you require plain SQL scripts, use this option to generate SQL from
 					  Doctrine. This can be useful for packaging or manual db install
 							  
 		To use the database creation commands you have to grant privileges to the user who will execute
-		the commands on your dbms. If the user defined via configure is a low-privileged one, 'make' asks
-		about a more privileged one e.g. a root user. If this does not work for you, alter
+		the commands on your DBMS. If the user defined via configure is a low-privileged one, 'make' asks
+		about a more privileged one, e.g. a root user. If this does not work for you, alter
 		'etc/build.properties' to match the requirements of a root user.
 		
 		You can also read install-fromscratch.txt to get deeper involved in how to use the phing-build
@@ -91,30 +93,33 @@ with autoconf. On Debian/Ubuntu systems you'll need some packages like 'make' an
 
 3) Database
 
-	Create a db user for your likings. The user must have default data privileges like SELECT, UPDATE, INSERT, DELETE.
+	Create a DB user for icinga-web. The user must have default data privileges like SELECT, UPDATE, INSERT and DELETE.
 
 		SQL> GRANT USAGE ON *.* TO 'icinga_web'@'localhost' IDENTIFIED BY 'icinga_web';
 		SQL> GRANT SELECT, INSERT, UPDATE, DELETE, CREATE, DROP, ALTER, INDEX ON icinga_web.* TO 'icinga_web'@'localhost';
 		SQL> FLUSH PRIVILEGES;
 
-	After configure, use make db-initialize for creating the database and applying the schema with prefilled data.
+	After configure, use 'make db-initialize' for creating the database and applying the schema with prefilled data.
 
 	Section 2.3, http://docs.icinga.org the install-fromscratch.txt file should give you more detailed information how it works.
 
 4) Webserver configuration
 
-	Three things have to be available on the system: you have to set up apache, with mod_rewrite and php5.
+	Three things have to be available on the system: you have to set up Apache, mod_rewrite and PHP 5.
 
 	Copy etc/apache2/icinga-web.conf to your webserver include dir e.g. /etc/apache2/conf.d. If you have
 	a properly configured icinga-web (--with-web-apache-path=PATH) you can simply run
 	'make install-apache-config'.
 
+	You will also need to enable mod_rewrite. On a Debian/Ubuntu system this can be done using 'a2enmod rewrite'.
+	After enabling mod_rewrite you will usually have to restart Apache: '/etc/init.d/apache2 restart'.
+
 	Furthermore you should take a look to '/path/to/pub/.htaccess'. Apache's mod_rewrite needs a correct
 	definition of 'RewriteBase' to operate in subdirectories. Please change this to your webpath (NOT THE PHYSICAL ONE) .
 
 5) Web configuration
 
-	Keep a look into app/modules/Web/config/icinga-io.site.xml for the IcingaApi factories: IcingaData and IcingaCommand.
+	Have a look at app/modules/Web/config/icinga-io.site.xml for the IcingaApi factories: IcingaData and IcingaCommand.
 	In IcingaData you can set the credentials for the Icinga API e.g. using the Icinga IDOUtils database.
 	In IcingaCommand you can specify the credentials for sending commands via Icinga Core command pipe - local or
 	remote via SSH.
@@ -183,11 +188,11 @@ with autoconf. On Debian/Ubuntu systems you'll need some packages like 'make' an
 			
 		</parameter>
 		
-	After change the files in the config directory, clear the cache: 'rm -rf app/cache/config/*.php'
+	After changing the files in the config directory, clear the cache: 'rm -rf app/cache/config/*.php'
 
-6) Running the interface and being glad
+6) Running the interface
 
-	After a restart of apache you will be able to visit the interface in your browser by using the
+	After a restart of Apache you will be able to visit the interface in your browser by using the
 	URL of the recently set up web interface like http://localhost/icinga-web.
 	
 	You can login with the following credentials:





More information about the icinga-checkins mailing list