icinga-php-library/README.md

Icinga PHP Library - IPL

This project bundles all Icinga PHP libraries into one piece and can be integrated as library into Icinga Web 2.

Requirements

• Icinga Web 2 (>= 2.9)
• PHP (>= 5.6, 7+ recommended)

Bundled Parts

• ipl-html
• ipl-i18n
• ipl-orm
• ipl-sql
• ipl-stdlib
• ipl-validator
• ipl-web

Installation

Please download the latest release and install it in one of your configured library paths. The default library path for Icinga Web 2 installations is: /usr/share/icinga-php

Download or clone this repository there (e.g. /usr/share/icinga-php/ipl) and you're done.

Note: Do NOT install the GIT master, it will not work! Checking out a branch like stable/1.0.0 or a tag like v1.0.0 is fine.

Examples

Sample Tarball installation

INSTALL_PATH="/usr/share/icinga-php/ipl"
INSTALL_VERSION="v1.0.0"
mkdir "$INSTALL_PATH"
&& wget -q "https://github.com/Icinga/icinga-php-library/archive/$INSTALL_VERSION.tar.gz" -O - \
   | tar xfz - -C "$INSTALL_PATH" --strip-components 1

Sample GIT installation

INSTALL_PATH="/usr/share/icinga-php/ipl"
INSTALL_VERSION="stable/1.0.0"
git clone https://github.com/Icinga/icinga-php-library.git "$INSTALL_PATH" --branch "$INSTALL_VERSION"