Installation
=====================================

## Requirements

* Icinga Director (>= 1.1.0)
* php-xml for optional XML file support
* php-yaml for optional YAML file support
* php-zip for optional XLSX file support

If your distribution ships an older build of [php-yaml](http://pecl.php.net/package/yaml), make sure to use a release compatible with `PHP ≥ 8.2`.
In case your Linux distribution offers precompiled packages they should be fine, regardless of whether they ship `php-yaml` or `php-syck`. In either case please
let me know as I didn't test them on different operatingsystems yet.

## Install the Fileshipper module

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 `fileshipper`
module in one of your module paths. You can examine (and set) the module path(s)
in `Configuration / Application`. In a typical environment you'll probably drop the
module to `/usr/share/icingaweb2/modules/fileshipper`. Please note that the directory
name MUST be `fileshipper` and not `icingaweb2-module-fileshipper` or anything else.
To do so you could run the following commands on the CLI.

```sh
cd /usr/share/icingaweb2/modules
git clone https://github.com/Icinga/icingaweb2-module-fileshipper.git fileshipper
```

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

```sh
icingacli module enable fileshipper
```

That's all, now you are ready to define your first [Import Source](03-ImportSource.md)
definitions and to ship hand-crafted plain Icinga 2 [Config Files](04-FileShipping.md)!

## Setup Base Directory

The module doesn't allow you to freely choose any file on your system.

You have to provide a safe set of base directories in your `fileshipper`'s module config directory,
usually `/etc/icingaweb2/modules/fileshipper`. There you need to create an `imports.ini` that could look as follows:

```ini
[A bunch of files]
basedir = "/var/cache/various_files"

[Puppet facts store (YAML directory)]
basedir = "/var/cache/sample-nodes"
```
