summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorKeith Burdis <keith@burdis.org>2013-02-08 16:25:23 +0000
committerKeith Burdis <keith@burdis.org>2013-02-08 16:25:23 +0000
commitdfe7bf4b64c394b7ad3230e2b39e0038a896fde4 (patch)
tree40781da659d44c7720ada6e151a7f7c552090a18 /README.md
parente255fdd16537226a18c5b58a837f875c020943dd (diff)
Updated documentation ready for release.
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 19 insertions, 4 deletions
diff --git a/README.md b/README.md
index bcbe0a4..d3ce813 100644
--- a/README.md
+++ b/README.md
@@ -24,7 +24,7 @@ Currently only tested on Redhat-like systems.
include check_mk
-Installs the 'omd' package from the system repository. The default 'omd' site is used.
+Installs the 'monitoring' package from the system repository. The default 'monitoring' site is used.
### Example 2
@@ -33,7 +33,7 @@ Installs the 'omd' package from the system repository. The default 'omd' site is
package => 'omd-0.56-rh60-29.x86_64.rpm'
}
-Installs the specified 'omd' package after retrieving it from the Puppet file store.
+Installs the specified omd package after retrieving it from the Puppet file store.
### Example 3
@@ -41,8 +41,8 @@ Installs the specified 'omd' package after retrieving it from the Puppet file st
site => 'acme',
}
-Installs the 'omd' package from the system repository. A site called 'acme' is
-used making the URL http://hostname/acme/check_mk/
+Installs the omd package from the system repository. A site called 'acme' is
+created making the URL http://hostname/acme/check_mk/ running as the 'acme' user.
### check_mk parameters
@@ -50,8 +50,23 @@ used making the URL http://hostname/acme/check_mk/
*filestore*: The Puppet file store location where the package can be found (eg. 'puppet:///files/check_mk'). Optional.
+*site*: The name of the omd site (and the user/group it runs as). Default: 'monitoring'
+
*workspace*: The directory to use to store files used during installation. Default: '/root/check_mk'
+### Notes
+
+* A user and group with the same value as the site parameter is created. By default this is 'monitoring'.
+
+* The URL is http://yourhostname/sitename/check_mk/ - for example http://monhost.domain/monitoring/check_mk/
+
+* The default username/password is omdadmin/omd. To change this or add additional users log in as the site user and run htpasswd - for example:
+
+ # su - monitoring
+ monitoring$ htpasswd -b ~/etc/htpasswd guest guest
+
+* A user called 'guest' is configured as a guest user but is not enabled unless a password is set (as above).
+
## Agent
* Installs the check_mk-agent and check_mk-agent-logwatch packages