Skip to content

Commit

Permalink
Merge pull request #11 from Achiefs/134-read-audit-option
Browse files Browse the repository at this point in the history
Document rule parameter
  • Loading branch information
okynos authored Apr 30, 2024
2 parents 7c9fb8a + dca032b commit e6b1e2a
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions docs/configuration-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -203,6 +203,27 @@ This parameter will come on each event produced by the process.

Allows to define custom labels on each event produced at the given path.

- #### rule

String
{: .label}

Default value: `wax`.

Allows to define custom Audit rule at the given path.

{: .note }
> The `rule` parameter support the following characters in any order:
> - `r` or `R`, enable read events at the given path.
> - `w` or `W`, enable write events at the given path.
> - `a` or `A`, enable attributes change events at the given path.
> - `x` or `X`, enable execution of code events at the given path.
>
> Examples of the format:
> - `rwax`, to detect all kind of events (It could be noisy).
> - `wax`, default value to detect write, attribute change and execution.
> - `w`, value to detect directory write changes.
---

- ## monitor
Expand Down

0 comments on commit e6b1e2a

Please sign in to comment.