Skip to content

TCR-650: Document resource usage limits for user-initiated scans #118

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 7, 2025
Merged

TCR-650: Document resource usage limits for user-initiated scans #118

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/config_file_description/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -254,6 +254,12 @@ to request Anti-bot Challenge again</td></tr>
<td># intensity level for file operations. Can be set from 1 to 7, default is 2</td></tr>
<tr><td><span class="notranslate">ram: 1024</span></td>
<td># intensity level for RAM consumption. The default value is 1024</td></tr>
<tr><td><span class="notranslate">user_scan_cpu: 2</span></td>
<td># intensity level for CPU consumption. Can be set from 1 to 7, default is 2. <br><br>This option is <b>for scans initiated by end-users</b>. More at <a href="/faq_and_known_issues/#_27-how-to-enable-scan-for-end-users">How to enable scan for end-users?</a> <br><br><b>Note:</b> The global/admin resource limits (<code>cpu</code>, <code>io</code>, <code>ram</code> without the <code>user_scan_</code> prefix) can also be <a href="/dashboard/#resource-consumption">controlled through UI.</a></br></br></br></br> </td></tr>
<tr><td><span class="notranslate">user_scan_io: 2</span></td>
<td># intensity level for file operations for scans initiated by end-users. Can be set from 1 to 7, default is 2</td></tr>
<tr><td><span class="notranslate">user_scan_ram: 1024</span></td>
<td># intensity level for RAM consumption for scans initiated by end-users. The default value is 1024</td></tr>
<tr>
<th colspan="2" align="left"><span class="notranslate">MALWARE_SCAN_SCHEDULE:</span></th></tr>
<tr><td><span class="notranslate">day_of_month: &lt;next day after installation&gt;</span></td>
Expand Down