Install Director Branches¶

Please install this module in a directory named directorbranches in one of your Icinga Web 2 module paths. The default path is /usr/share/icingaweb2/modules.

No configuration is required, this module hooks into your existing Icinga Director module.

Info

A paid subscription is required for Director Branches. Get more information on icinga.com/subscription

Requirements¶

Icinga Director (> 1.9), installed and configured

Installation¶

As with any Icinga Web 2 module, installation is pretty straight-forward. In case you’re installing it from source, all you have to do is to drop the directorbranches module in one of your module paths. In a typical environment you drop the module to /usr/share/icingaweb2/modules/directorbranches

# Please fill in your Icinga Subscription Credentials:
SUBSCRIPTION_USERNAME=my-subscription
SUBSCRIPTION_PASSWORD=***

# You can customize these settings, but we suggest to stick with our defaults:
MODULE_VERSION="1.3.0"
ICINGAWEB_MODULEPATH="/usr/share/icingaweb2/modules"
REPO_URL="https://packages.icinga.com/subscription/icinga-director-branches"
TARGET_DIR="${ICINGAWEB_MODULEPATH}/directorbranches"
URL="${REPO_URL}/directorbranches_v${MODULE_VERSION}.tar.gz"

install -d -m 0755 "${TARGET_DIR}"

test -d "${TARGET_DIR}_TMP" && rm -rf "${TARGET_DIR}_TMP"
test -d "${TARGET_DIR}_BACKUP" && rm -rf "${TARGET_DIR}_BACKUP"
install -d -o root -g root -m 0755 "${TARGET_DIR}_TMP"

wget --user "${SUBSCRIPTION_USERNAME}" --password "${SUBSCRIPTION_PASSWORD}" \
  -q -O - "$URL" | tar xfz - -C "${TARGET_DIR}_TMP" --strip-components 1 \
  && mv "${TARGET_DIR}" "${TARGET_DIR}_BACKUP" \
  && mv "${TARGET_DIR}_TMP" "${TARGET_DIR}" \
  && rm -rf "${TARGET_DIR}_BACKUP"

Last but not least go to Configuration / Modules and enable the directorbranches module, or run the following command on the CLI:

icingacli module enable directorbranches

That’s all, now you are ready to create your first Configuration Branch!