From a4a4a84d79e95d34f80346c423b4e84f7af3f03d Mon Sep 17 00:00:00 2001
From: Daniel Baumann <daniel.baumann@progress-linux.org>
Date: Sun, 28 Apr 2024 14:45:13 +0200
Subject: Adding upstream version 1.1.0.

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
---
 doc/01-Installation.md | 68 ++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 68 insertions(+)
 create mode 100644 doc/01-Installation.md

(limited to 'doc/01-Installation.md')

diff --git a/doc/01-Installation.md b/doc/01-Installation.md
new file mode 100644
index 0000000..0841623
--- /dev/null
+++ b/doc/01-Installation.md
@@ -0,0 +1,68 @@
+<a id="Installation"></a>Installation
+=====================================
+
+Requirements
+------------
+
+* Icinga Web 2 (&gt;= 2.4.1)
+* PHP (&gt;= 5.6 or 7.x)
+
+The Icinga Web 2 `monitoring` module needs to be configured and enabled.
+
+Installation from .tar.gz
+-------------------------
+
+Download the latest version and extract it to a folder named `map`
+in one of your Icinga Web 2 module path directories.
+
+You might want to use a script as follows for this task:
+```sh
+ICINGAWEB_MODULEPATH="/usr/share/icingaweb2/modules"
+REPO_URL="https://github.com/nbuchwitz/icingaweb2-module-map"
+TARGET_DIR="${ICINGAWEB_MODULEPATH}/map"
+MODULE_VERSION="1.1.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/nbuchwitz/icingaweb2-module-map"
+TARGET_DIR="${ICINGAWEB_MODULEPATH}/map"
+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 `map` module either on the CLI by running
+
+```sh
+icingacli module enable map
+```
+
+Or go to your Icinga Web 2 frontend, choose `Configuration` -&gt; `Modules`...
+
+![Choose Configuration - Modules](screenshot/01_installation/101_menu-configuration-modules.png)
+
+...choose the `map` module and `enable` it:
+
+![Enable the module](screenshot/01_installation/102_enable-module.png)
+
+It might afterwards be necessary to refresh your web browser to be sure that
+newly provided styling is loaded.
+
+Getting started with the map
+---------------------------------------------
+
+That's it, *Map* is now ready for use. Please read more on [adding markers to your map](02-Add-Items-to-map.md).
-- 
cgit v1.2.3