aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar Joe Banks <[email protected]>2024-06-09 21:29:32 +0100
committerGravatar Joe Banks <[email protected]>2024-06-09 21:29:32 +0100
commit3b610eef29422fd405ed1b1446eba7c654811cc0 (patch)
tree6c2ff8330e59f738f4eeb8a9b8868aa0813d4b35
parentAdd demo docker-compose.yml file (diff)
Add warning for inotifywait notifying on all file events (inc. reads)
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
index 67ad675..1d0059d 100644
--- a/README.md
+++ b/README.md
@@ -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: