From 0fadbadd05d37d4fd177e6e6527f2a7c0dafc329 Mon Sep 17 00:00:00 2001 From: khromenokroman Date: Sat, 24 Aug 2024 15:06:33 +0200 Subject: [PATCH] Add systemd support example to installation guide Include an example unit file for enabling systemd support with the `-DUSE_SYSTEMD=ON` build option. This addition clarifies how to configure and manage the service using systemd. --- doc/website/getting-started/installation.md | 26 +++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/doc/website/getting-started/installation.md b/doc/website/getting-started/installation.md index 32d253baf3..27963728a9 100644 --- a/doc/website/getting-started/installation.md +++ b/doc/website/getting-started/installation.md @@ -177,6 +177,32 @@ The `CMakeLists.txt` from `iceoryx_meta` can be used to easily develop iceoryx w Please take a look at the CMake file [build_options.cmake](../../../iceoryx_meta/build_options.cmake) to get an overview of the available build options for enabling additional features. +If systemd support is enabled `-DUSE_SYSTEMD=ON`, the unit file may look like this: + +````bash +#$ vim /usr/lib/systemd/system/test_iceoryx.service +[Unit] +Description=Test application roudi + +[Service] +Type=notify +User=roma +RestartSec=10 +Restart=always +ExecStart=/usr/bin/iox-roudi +TimeoutStartSec=10 +WatchdogSec=5 + +[Install] +WantedBy=multi-user.target + +```` +Do not forget to do this after adding the unit file `systemctl daemon-reload` + +Launch example `systemctl start test_iceoryx` + +Example of a stop `systemctl stop test_iceoryx` + ## Build with script As an alternative, we provide a build-test script which we use to integrate iceoryx into our infrastructure.