From 3d2f120220698fa9e1e2e54dad4712def5911c41 Mon Sep 17 00:00:00 2001 From: Johannes Meyer Date: Tue, 22 Mar 2022 15:03:20 +0100 Subject: [PATCH] Update documentation --- doc/02-Installation.md | 67 +++++------------------------------------- 1 file changed, 8 insertions(+), 59 deletions(-) diff --git a/doc/02-Installation.md b/doc/02-Installation.md index 3fa72c1..65be978 100644 --- a/doc/02-Installation.md +++ b/doc/02-Installation.md @@ -1,71 +1,20 @@ -Installation -===================================== +# Installation -Requirements ------------- +## Requirements -* Icinga Web 2 (>= 2.9) -* PHP (>= 7.0) +* PHP (>= 7.0) +* Icinga Web 2 (>= 2.9) * Icinga Web 2 libraries: * [Icinga PHP Library (ipl)](https://github.com/Icinga/icinga-php-library) (>= 0.8) * [Icinga PHP Thirdparty](https://github.com/Icinga/icinga-php-thirdparty) (>= 0.10) * Icinga Web 2 modules: * The `monitoring` or `icingadb` module needs to be configured and enabled. -Installation from .tar.gz -------------------------- +## Install Icinga Business Process Modeling -Download the latest version and extract it to a folder named `businessprocess` -in one of your Icinga Web 2 module path directories. +Install it [like any other module](https://icinga.com/docs/icinga-web-2/latest/doc/08-Modules/#installation). +Use `businessprocess` as name. -You might want to use a script as follows for this task: -```sh -ICINGAWEB_MODULEPATH="/usr/share/icingaweb2/modules" -REPO_URL="https://github.com/Icinga/icingaweb2-module-businessprocess" -TARGET_DIR="${ICINGAWEB_MODULEPATH}/businessprocess" -MODULE_VERSION="2.2.0" -URL="${REPO_URL}/archive/v${MODULE_VERSION}.tar.gz" -install -d -m 0755 "${TARGET_DIR}" -wget -q -O - "$URL" | tar xfz - -C "${TARGET_DIR}" --strip-components 1 -``` - -Installation from GIT repository --------------------------------- - -Another convenient method is the installation directly from our GIT repository. -Just clone the repository to one of your Icinga Web 2 module path directories. -It will be immediately ready for use: - -```sh -ICINGAWEB_MODULEPATH="/usr/share/icingaweb2/modules" -REPO_URL="https://github.com/Icinga/icingaweb2-module-businessprocess" -TARGET_DIR="${ICINGAWEB_MODULEPATH}/businessprocess" -git clone "${REPO_URL}" "${TARGET_DIR}" -``` - -You can now directly use our current GIT master or check out a specific version. - -Enable the newly installed module ---------------------------------- - -Enable the `businessprocess` module either on the CLI by running - -```sh -icingacli module enable businessprocess -``` - -Or go to your Icinga Web 2 frontend, choose `Configuration` -> `Modules`... - -![Choose Configuration - Modules](screenshot/02_installation/101_menu-configuration-modules.png) - -...choose the `businessprocess` module and `enable` it: - -![Enable the module](screenshot/02_installation/102_enable-module.png) - -It might afterwards be necessary to refresh your web browser to be sure that -newly provided styling is loaded. - -Create your first Business Process definition ---------------------------------------------- +## Create your first Business Process definition That's it, *Business Process* is now ready for use. Please read more on [how to get started](03-Getting-Started.md).