Add Installation documentation and make update

Added documentation to the makefile and to docs
and an additional update command to the makefile, so configuration
dosn't get overwritten.

refs #4175
This commit is contained in:
Jannis Moßhammer 2013-07-03 14:00:55 +02:00
parent 42d579dd9e
commit f080871020
2 changed files with 54 additions and 1 deletions

View File

@ -6,11 +6,18 @@ INSTALL=@INSTALL@
INSTALL_OPTS=@INSTALL_OPTS@
INSTALL_OPTS_WEB=@INSTALL_OPTS_WEB@
default:
@echo "Icinga2Web make targets: "
@echo " -install: \t\t Install the application and overwrite configs"
@echo " -update: \t\t Install the application without touching the configs"
@echo " -install-apache-config: \t Install the apache configuration"
#
# Installs the whole application w\o httpd configurations
#
install: install-static-files install-runtime-dirs
update: install-application
#
# Removes files created by ./configure
#
@ -43,7 +50,7 @@ install-tests: copy-folder-tests
#
# Install configurations for apache2
#
install-apache-configs:
install-apache-config:
$(INSTALL) -m 644 $(INSTALL_OPTS) "./etc/apache/icinga2web.conf" $(WWW_CONF_PATH)/icinga2web.conf;
#

46
doc/installation.md Normal file
View File

@ -0,0 +1,46 @@
# Installation
## configure && make
### Basic installation
If you like to configurea and install icinga2-web from the command line or
if you want to create packages, configure and make is the best choice for installation.
`
./configure && make install && make install-apache2-config
`
will install the application to the default target (/usr/local/icinga2-web). Also
an apache configuration entry is added to your apache server, so you should restart
your web server according to your systems configuration.
### Installation directory
If you want to install the application to a different directory, use the --prefix flag in your
configure call:
`
./configure --prefix=/my/target/directory
`
### Authentication
By default, icinga2-web will be installed to authenticate againts its internal database,
but you can configure it to use ldap-authentication by adding the `--with-ldap-authentication`
flag. You must provide the authentication details for your ldap server by using the --with-ldap-* flags.
To see a full list of the flags, call `./configure --help`
### Icinga backend
The default option for icinga2web is to configure all icinga backends with the default settings (for example
/usr/local/icinga/ as the icinga directory) but only enable statusdat. To use a different backend,
call `--with-icinga-backend=` and provide ido, livestatus or statusdat as an option. To further configure
your backend, take a look at the various options described in `./configure --help`
Quick and Dirty
----------------
tdb.