luxolus
/
kdnotify
2
0
Fork 0
Code Issues Pull Requests Releases Activity

merge: master <--- fix/#3-readme-usage 

* HEAD
| \
| * ab1d9fb <github@luxolus.com> doc: correct #usage guidance
| /
| master

Closes: #3
Signed-off-by: Bazaah <github@luxolus.com>
This commit is contained in:
Paul Stemmet 2022-12-10 19:20:13 +00:00
parent fc51e39d55 ab1d9fb064
commit 9d8ab7b055
Signed by: Paul Stemmet
GPG Key ID: EDEA539F594E7E75
1 changed files with 12 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -9,15 +9,16 @@ prone handling of parsing and processing each event individually.
## Usage
The primary usage of this binary requires two things:
The primary usage of this binary requires three things:
1. A configuration file in `/etc/kdnotify/config.yaml`
2. Enabling Keepalived to use this project for notifications via:
2. A running kdnotify service, see [kdnotify.socket](./systemd/kdnotify.socket)
3. Enabling Keepalived to use this project for notifications via:
```conf
# Or in any other block where vrrp_notify_fifo_script is legal
global {
vrrp_notify_fifo_script "/bin/kdnotify watch" [username [groupname]]
global_defs {
notify_fifo /run/kdnotify.fifo [username [groupname]]
}
```
@ -26,12 +27,13 @@ global {
You can run `make help` in the repo root to get a list of available targets, but these
are the most useful:
| Target | Description |
|:----------|:-------------------------------------------------------------|
| `build` | Build the binary to `build/kdnotify` |
| `check` | Run project checks and lints |
| `install` | Install project to the provided Prefix= (defaults to `/bin`) |
| `clean` | Cleans build directory |
| Target | Description |
|:------------|:----------------------------------------|
| `build` | Build the binary to `build/kdnotify` |
| `check` | Run project checks and lints |
| `install` | Install the project to the local system |
| `clean` | Cleans build directory |
| `configure` | Configures build time directives |
Make sure you run `check` before merging to `master`.