Skip to content

Commit 78be75b

Browse files
authored
Merge pull request #182 from dmleonov-cloudlinux/master
Update realtime docs
2 parents 0a55b68 + 59a66c7 commit 78be75b

4 files changed

Lines changed: 15 additions & 10 deletions

File tree

docs/config_file_description/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ Available options:
147147
<li><span class="notranslate"><b>notify</b></span> – just display in dashboard</li>
148148
<li><span class="notranslate"><b>cleanup</b></span> – cleanup malicious file (default)</li></ul></td></tr>
149149
<tr><td><span class="notranslate">enable_scan_inotify: True</span></td>
150-
<td># enable (<span class="notranslate">True</span> (default)) or disable (<span class="notranslate">False</span>) real-time scanning for modified files using <a href="https://en.wikipedia.org/wiki/Inotify" target="_blank">inotify</a> library</td></tr>
150+
<td># enable (<span class="notranslate">True</span> (default)) or disable (<span class="notranslate">False</span>) real-time scanning for modified files. Uses <a href="https://man7.org/linux/man-pages/man7/fanotify.7.html" target="_blank">fanotify</a> as the primary monitoring mechanism (kernel 3.10+) with legacy <a href="https://en.wikipedia.org/wiki/Inotify" target="_blank">inotify</a> fallback. The config option name is kept for backward compatibility.</td></tr>
151151
<tr><td><span class="notranslate">enable_scan_pure_ftpd: True</span></td>
152152
<td># enable (<span class="notranslate">True</span> (default)) or disable (<span class="notranslate">False</span>) real-time scanning for files uploaded through PureFTPd</td></tr>
153153
<tr><td><span class="notranslate">enable_scan_modsec: True</span></td>
@@ -164,7 +164,9 @@ that were uploaded via http/https. Note that it requires <a href="https://modsec
164164
<tr><td><span class="notranslate">notify_on_detect: False</span></td>
165165
<td># notify (<span class="notranslate">True</span>) or not (<span class="notranslate">False</span>) (default value) an admin when malware is detected</td></tr>
166166
<tr><td><span class="notranslate">optimize_realtime_scan: True</span></td>
167-
<td># enable (<span class="notranslate">True</span>) (default value) or disable (<span class="notranslate">False</span>) the <a href="https://docs.cloudlinux.com/cloudlinux_os_kernel/#file-change-api" target="_blank">File Change API</a> and <b>fanotify</b> support to reduce the system load while watching for file changes in comparison with inotify watch. You can find the comparison table <a href="/dashboard/#general-2">here</a></td></tr>
167+
<td># enable (<span class="notranslate">True</span>) (default value) or disable (<span class="notranslate">False</span>) the <a href="https://docs.cloudlinux.com/cloudlinux_os_kernel/#file-change-api" target="_blank">File Change API</a> and <b>fanotify</b> support to reduce the system load while watching for file changes in comparison with inotify watch. You can find the comparison table <a href="/dashboard/#general-2">here</a>.
168+
<br/><br/>
169+
Starting from <b>imunify-realtime-av 8.0.7</b>, the realtime scanner automatically filters out file operations from system services (MySQL/MariaDB, PostgreSQL, Redis, Apache, etc.) to significantly reduce CPU overhead on busy servers. The system service threshold is auto-detected from the OS configuration — no manual setup is required.</td></tr>
168170
<tr><td><span class="notranslate">sends_file_for_analysis: True</span></td>
169171
<td># send (<span class="notranslate">True</span>) (default value) or not (<span class="notranslate">False</span>) malicious and suspicious files to the Imunify team for analysis</td></tr>
170172
<tr><td><span class="notranslate">i360_clamd: False</span></td>

docs/control_panel_integration/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,7 @@ By default, root is considered to be the only admin user.
233233

234234
### 2.5 Integration with Malware Scanner
235235

236-
To scan files for changes (to detect malware) using inotify, configure which directories to watch and which to ignore in the <span class="notranslate">`integration.conf`</span> file:
236+
To configure which directories the realtime malware scanner should watch and which to ignore, edit the <span class="notranslate">`integration.conf`</span> file:
237237

238238
* configure <span class="notranslate">`[malware].basedir`</span> – a root directory to watch (recursively)
239239
* configure <span class="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

docs/dashboard/README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -524,7 +524,7 @@ This is also a real time file scanner for vulnerability and it can:
524524

525525
* scan files uploaded via HTTP/HTTPS
526526

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)
528528

529529
* scan on-demand (any folder needed)
530530

@@ -1650,14 +1650,17 @@ Read [CXS integration](/ids_integration/#cxs-integration) documentation carefull
16501650
16511651
![](/images/SettingsMalware2.png)
16521652
1653-
* <span class="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.
1653+
* <span class="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.
16541654
::: tip Note
1655-
It requires inotify to be installed and may put an additional load on a system.
1655+
Real-time scanning may put additional load on a system. See the _Optimize real-time scan_ option below for ways to reduce this.
16561656
:::
1657-
* <span class="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 watchs.
1657+
* <span class="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.
16581658
:::tip Note
16591659
File change API can work only with ext4 file system.
16601660
:::
1661+
:::tip Note
1662+
Starting from **imunify-realtime-av 8.0.7**, the realtime scanner automatically filters out file operations from system services (MySQL/MariaDB, PostgreSQL, Redis, etc.) to significantly reduce CPU overhead. No configuration is needed — the system service threshold is auto-detected from the OS configuration.
1663+
:::
16611664
16621665
| | | | |
16631666
|--------------------------|:-----------:|:------------:|:-------------------:|

docs/faq_and_known_issues/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -371,7 +371,7 @@ grep 'IM360 WAF: Testing the IM360 ModSecurity ruleset' /var/log/imunify360/cons
371371

372372
### 16. How to check "automatically scan all modified files" works?
373373

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 <span class="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 <span class="notranslate">_Malicious_</span> tab shortly.
375375

376376
You can get a malware sample file on the [eicar.org](http://www.eicar.org/).
377377

@@ -593,7 +593,7 @@ Proactive Defense will prevent <span class="notranslate">`include`/`require`</sp
593593
There is a separate ignore list for false-positive hits: see [Ignore List](/dashboard/#ignore-list)
594594
:::
595595

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.
597597

598598
Patterns can be absolute:
599599

@@ -621,7 +621,7 @@ All patterns listed here have higher priority than stock watched and excluded li
621621
After making changes to this file, run the `imunify360-agent malware rebuild patterns` command.
622622
:::
623623

624-
The <span class="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 <span class="notranslate">`ignored.txt`</span> file contains additional regular expression patterns specifying what filesystem paths should not be monitored by the realtime scanner.
625625

626626
Patterns can be absolute:
627627

0 commit comments

Comments
 (0)