From 0349a1042ae1e9a15c6ff673b8b8057df0d9109c Mon Sep 17 00:00:00 2001 From: Michael Friedrich Date: Wed, 10 Oct 2018 09:18:36 +0200 Subject: [PATCH] Add release download URL and methods (tarball, git) to the docs fixes #1656 --- doc/02-Installation.md | 53 +++++++++++++++++++++++++++++++++++++++--- 1 file changed, 50 insertions(+), 3 deletions(-) diff --git a/doc/02-Installation.md b/doc/02-Installation.md index a6332845..240eca06 100644 --- a/doc/02-Installation.md +++ b/doc/02-Installation.md @@ -74,10 +74,57 @@ in `Configuration / Application`. In a typical environment you'll probably drop module to `/usr/share/icingaweb2/modules/director`. Please note that the directory name MUST be `director` and not `icingaweb2-module-director` or anything else. +#### Installation from release tarball + +Download the [latest version](https://github.com/Icinga/icingaweb2-module-director/releases) +and extract it to a folder named `director` in one of your Icinga Web 2 module path directories. + +You might want to use a script as follows for this task: + + ICINGAWEB_MODULEPATH="/usr/share/icingaweb2/modules" + REPO_URL="https://github.com/icinga/icingaweb2-module-director" + TARGET_DIR="${ICINGAWEB_MODULEPATH}/director" + MODULE_VERSION="1.5.1" + 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 + +Proceed to enabling the module. + +#### 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: + + + ICINGAWEB_MODULEPATH="/usr/share/icingaweb2/modules" + REPO_URL="https://github.com/icinga/icingaweb2-module-director" + TARGET_DIR="${ICINGAWEB_MODULEPATH}/director" + MODULE_VERSION="1.5.1" + git clone "${REPO_URL}" "${TARGET_DIR}" + +You can now directly use our current GIT master or check out a specific version. + + cd "${TARGET_DIR}" && git checkout "v${MODULE_VERSION}" + +Proceed to enabling the module. + +#### Enable the newly installed module + +Enable the `director` module either on the CLI by running + + icingacli module enable director + +Or go to your Icinga Web 2 frontend, choose `Configuration / Modules`, +select the `director` module and choose `State: enable`. ### Run the graphical kickstart wizard -Now go to your web frontend, Configuration, Modules, director - and enable the -module. Choose either Director directly from the menu or got to the Configuration -tab. Either way you'll reach the kickstart wizards. Follow the instructions and +Choose either `Icinga Director` directly from the main menu or +navigate into `Configuration / Modules / director` and select the `Configuration` +tab. + +Either way you'll reach the kickstart wizards. Follow the instructions and you're all done! +