Skip to content

Commit

Permalink
iox-eclipse-iceoryx#2330 Add systemd support example to installation …
Browse files Browse the repository at this point in the history
…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.
  • Loading branch information
khromenokroman committed Aug 24, 2024
1 parent 4b4651c commit 3c334a6
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions doc/website/getting-started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 3c334a6

Please sign in to comment.