particle-os-modules/modules/systemd/README.md
xyny 4e79916835
docs: enhacements to module documentation (#54)
* docs: chore: rn ":" from "Example configuration"

* docs: correct title casing for fonts module title

* docs: document OS_VERSION in example,...
non-copr example for rpmrepos

* docs: remove bling fonts option from bling example

* docs: start yafti README the same way as others
"The yafti module..."
2023-10-01 08:41:01 -07:00

41 lines
1 KiB
Markdown

# `systemd` Module for Startingpoint
The `systemd` module streamlines the management of systemd units during image building. Units are divided into `system` and `user` categories, with `system` units managed directly using `systemctl` and `user` units using `systemctl --user`. You can specify which units to enable or disable under each category.
## Example Configuration
```yaml
type: systemd
system:
enabled:
- example.service
disabled:
- example.target
user:
enabled:
- example.timer
disabled:
- example.service
```
In this example:
### System Units
- `example.service`: Enabled (runs on system boot)
- `example.target`: Disabled (does not run on system boot)
### User Units
- `example.timer`: Enabled (runs for the user)
- `example.service`: Disabled (does not run for the user)
This configuration achieves the same results as the following commands:
```sh
# System Units
systemctl enable example.service
systemctl disable example.target
# User Units
systemctl --user enable example.timer
systemctl --user disable example.service
```