You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: update realtime scanner references from inotify to fanotify
The realtime scanner (im-rt2) uses fanotify as the primary file
monitoring mechanism since its initial release, with inotify only as
a legacy fallback. Update documentation to reflect this:
- dashboard: clarify fanotify is primary, inotify is fallback
- config: update enable_scan_inotify description (name kept for compat)
- control_panel_integration: remove inotify-specific wording
- faq: replace "inotify scanner" and "inotify/fanotify" references
Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]>
<td># enable (<spanclass="notranslate">True</span> (default)) or disable (<spanclass="notranslate">False</span>) real-time scanning for modified files using <ahref="https://en.wikipedia.org/wiki/Inotify"target="_blank">inotify</a> library</td></tr>
150
+
<td># enable (<spanclass="notranslate">True</span> (default)) or disable (<spanclass="notranslate">False</span>) real-time scanning for modified files. Uses <ahref="https://man7.org/linux/man-pages/man7/fanotify.7.html"target="_blank">fanotify</a> as the primary monitoring mechanism (kernel 3.10+) with legacy <ahref="https://en.wikipedia.org/wiki/Inotify"target="_blank">inotify</a> fallback. The config option name is kept for backward compatibility.</td></tr>
<td># enable (<spanclass="notranslate">True</span> (default)) or disable (<spanclass="notranslate">False</span>) real-time scanning for files uploaded through PureFTPd</td></tr>
Copy file name to clipboardExpand all lines: docs/control_panel_integration/README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -233,7 +233,7 @@ By default, root is considered to be the only admin user.
233
233
234
234
### 2.5 Integration with Malware Scanner
235
235
236
-
To scan files for changes (to detect malware) using inotify, configure which directories to watch and which to ignore in the <spanclass="notranslate">`integration.conf`</span> file:
236
+
To configure which directories the realtime malware scanner should watch and which to ignore, edit the <spanclass="notranslate">`integration.conf`</span> file:
237
237
238
238
* configure <spanclass="notranslate">`[malware].basedir`</span> – a root directory to watch (recursively)
239
239
* configure <spanclass="notranslate">`[malware].pattern_to_watch`</span> – only directories that match this ([Python](https://docs.python.org/3/howto/regex.html#regex-howto)) regex in the basedir are actually going to be watched
Copy file name to clipboardExpand all lines: docs/dashboard/README.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -524,7 +524,7 @@ This is also a real time file scanner for vulnerability and it can:
524
524
525
525
* scan files uploaded via HTTP/HTTPS
526
526
527
-
* scan files for changes via [inotify](https://en.wikipedia.org/wiki/Inotify)
527
+
* scan files for changes in real time (using [fanotify](https://man7.org/linux/man-pages/man7/fanotify.7.html) with legacy [inotify](https://en.wikipedia.org/wiki/Inotify) fallback)
* <spanclass="notranslate">_Automatically scan all modified files_</span> – enables real-time scanning for modified files using [inotify](https://en.wikipedia.org/wiki/Inotify)library. The Scanner searches for modified files in user’s DocumentRoot directories.
1639
+
* <spanclass="notranslate">_Automatically scan all modified files_</span> – enables real-time scanning for modified files. The scanner uses [fanotify](https://man7.org/linux/man-pages/man7/fanotify.7.html) (kernel 3.10+) as the primary file monitoring mechanism, with a legacy [inotify](https://en.wikipedia.org/wiki/Inotify)fallback for older systems. The Scanner searches for modified files in user’s DocumentRoot directories.
1640
1640
::: tip Note
1641
-
It requires inotify to be installed and may put an additional load on a system.
1641
+
Real-time scanning may put additional load on a system. See the _Optimize real-time scan_ option below for ways to reduce this.
1642
1642
:::
1643
1643
* <spanclass="notranslate">_Optimize real-time scan_</span> – enables the [File Change API](https://docs.cloudlinux.com/cloudlinux_os_kernel/#file-change-api) and **fanotify** support to reduce the system load while watching for file changes in comparison with inotify watches.
### 16. How to check "automatically scan all modified files" works?
373
373
374
-
To check "automatically scan all modified files" (i.e inotify scanner), upload a malware sample to some account's webroot via SSH and check if it will appear in the <spanclass="notranslate">_Malicious_</span> tab shortly.
374
+
To check "automatically scan all modified files" (the realtime scanner), upload a malware sample to some account's webroot via SSH and check if it will appear in the <spanclass="notranslate">_Malicious_</span> tab shortly.
375
375
376
376
You can get a malware sample file on the [eicar.org](http://www.eicar.org/).
377
377
@@ -593,7 +593,7 @@ Proactive Defense will prevent <span class="notranslate">`include`/`require`</sp
593
593
There is a separate ignore list for false-positive hits: see [Ignore List](/dashboard/#ignore-list)
594
594
:::
595
595
596
-
The `watched.txt` file contains additional shell-like glob patterns specifying what file system directories should be monitored by inotify/fanotify realtime scanner.
596
+
The `watched.txt` file contains additional shell-like glob patterns specifying what file system directories should be monitored by the realtime scanner.
597
597
598
598
Patterns can be absolute:
599
599
@@ -621,7 +621,7 @@ All patterns listed here have higher priority than stock watched and excluded li
621
621
After making changes to this file, run the `imunify360-agent malware rebuild patterns` command.
622
622
:::
623
623
624
-
The <spanclass="notranslate">`ignored.txt`</span> file contains additional regular expression patterns specifying what filesystem paths should not be monitored by inotify/fanotify realtime scanner.
624
+
The <spanclass="notranslate">`ignored.txt`</span> file contains additional regular expression patterns specifying what filesystem paths should not be monitored by the realtime scanner.
0 commit comments