summaryrefslogtreecommitdiffstats
path: root/doc/75-Background-Daemon.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 12:43:12 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 12:43:12 +0000
commitcd989f9c3aff968e19a3aeabc4eb9085787a6673 (patch)
treefbff2135e7013f196b891bbde54618eb050e4aaf /doc/75-Background-Daemon.md
parentInitial commit. (diff)
downloadicingaweb2-module-director-cd989f9c3aff968e19a3aeabc4eb9085787a6673.tar.xz
icingaweb2-module-director-cd989f9c3aff968e19a3aeabc4eb9085787a6673.zip
Adding upstream version 1.10.2.upstream/1.10.2upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/75-Background-Daemon.md')
-rw-r--r--doc/75-Background-Daemon.md65
1 files changed, 65 insertions, 0 deletions
diff --git a/doc/75-Background-Daemon.md b/doc/75-Background-Daemon.md
new file mode 100644
index 0000000..69cecfc
--- /dev/null
+++ b/doc/75-Background-Daemon.md
@@ -0,0 +1,65 @@
+<a id="Background-Daemon"></a>Background-Daemon
+===============================================
+
+The Icinga Director Background Daemon is available (and mandatory) since v1.7.0.
+It is responsible for various background tasks, including fully automated Import,
+Sync & Config Deployment Tasks.
+
+Daemon Installation
+-------------------
+
+To run the Background Daemon, you need to tell `systemd` about your new service.
+First make sure that the system user `icingadirector` exists. In case it doesn't,
+please create one:
+
+```sh
+useradd -r -g icingaweb2 -d /var/lib/icingadirector -s /bin/false icingadirector
+install -d -o icingadirector -g icingaweb2 -m 0750 /var/lib/icingadirector
+```
+
+Then copy the provided Unit-File from our [contrib](../contrib/systemd/icinga-director.service)
+to `/etc/systemd/system`, enable and start the service:
+
+```sh
+MODULE_PATH=/usr/share/icingaweb2/modules/director
+cp "${MODULE_PATH}/contrib/systemd/icinga-director.service" /etc/systemd/system/
+systemctl daemon-reload
+```
+
+Now your system knows about the Icinga Director Daemon. You should make sure that
+it starts automatically each time your system boots:
+
+```sh
+systemctl enable icinga-director.service
+```
+
+Starting the Daemon
+-------------------
+
+You now can start the Background daemon like any other service on your Linux system:
+
+```sh
+systemctl start icinga-director.service
+```
+
+Stopping the Daemon
+-------------------
+
+You now can stop the Background daemon like any other service on your Linux system:
+
+```sh
+systemctl stop icinga-director.service
+```
+
+Getting rid of the old Job Daemon
+---------------------------------
+
+Before v1.7.0, Icinga Director shipped an optional Job Daemon. This one is no longer
+needed and should be removed from your system as follows:
+
+```sh
+systemctl stop director-jobs
+systemctl disable director-jobs
+rm /etc/systemd/system/director-jobs.service
+systemctl daemon-reload
+```