Skip to content

Commit

Permalink
Add warning for inotifywait notifying on all file events (inc. reads)
Browse files Browse the repository at this point in the history
  • Loading branch information
jb3 committed Jun 9, 2024
1 parent 92ebbe7 commit 3b610ee
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,16 @@ used by any other aspect of the container, for example, mounting to
`/opt/owl-corp/` and using `/opt/owl-corp/hook.sh` as your `INOTIFY_HOOK_SCRIPT`
option.

> [!WARNING]
>
> By default, `inotifywait` will notify on *all* file events, this includes
> things like reading directories and opening files.
>
> It is highly recommended to refer to the above mentioned [inotifywait
> manpage][manpage] for the full list of events to narrow down to those which
> only modify a file in the ways you specifically wish to observe.

## Usage

A Docker compose file using this image might look like the following:
Expand Down

0 comments on commit 3b610ee

Please sign in to comment.