Merge pull request #158 from dmleonov-cloudlinux/master

Per-user malware scan schedule documentation

Author: annkots

docs/command_line_interface/README.md

@@ -493,6 +493,29 @@ imunify360-agent config update '{"MALWARE_SCAN_INTENSITY": {"cpu": 5}}'
 
 The successful output should display the configuration file content.
 
+### Per-user configuration
+
+You can view and update configuration for a specific system user. Only the options allowed to end users are available (e.g., <span class="notranslate">MALWARE_SCAN_SCHEDULE</span>). Missing user options inherit values from the admin/global config.
+
+<div class="notranslate">
+
+```
+# Show effective configuration for a user
+imunify360-agent config show --user <username> --json
+
+# Set per-user background malware scan schedule: weekly at 03:00 on Monday
+imunify360-agent config update '{"MALWARE_SCAN_SCHEDULE": {"interval": "week", "hour": 3, "day_of_week": 1}}' --user <username>
+
+# Disable scheduled background scans for a user
+imunify360-agent config update '{"MALWARE_SCAN_SCHEDULE": {"interval": "none"}}' --user <username>
+```
+
+</div>
+
+::: tip Note
+Daily/Weekly schedules are available on <b>Imunify360</b> and <b>ImunifyAV+</b>. On <b>ImunifyAV</b>, only <span class="notranslate">none</span> and <span class="notranslate">month</span> intervals are available.
+:::
+
 ## Doctor
 
 Collecting information about Imunify360 state, generating the report and sending it to Imunify360 Support Team. This command can be used in case of any troubles or issues with Imunify360. This command will generate a key to be sent to Imunify360 Support Team. With that key Imunify360 Support Team can help with any problem as fast as possible.

docs/config_file_description/README.md

@@ -292,6 +292,53 @@ to request Anti-bot Challenge again</td></tr>
 <td># when the background scan shall start, hour. Can be from 0 to 23, the default value is 3</td></tr>
 <tr><td><span class="notranslate">interval: MONTH</span></td>
 <td># interval of scan. Supported values: strings <span class="notranslate">`NONE`</span> (no scan), <span class="notranslate">`DAY`</span>, <span class="notranslate">`WEEK`</span>, <span class="notranslate">`MONTH`</span>, the default value is <span class="notranslate">`MONTH`</span></td></tr>
+
+<tr>
+<td colspan="2">
+
+<p><b>Per-user overrides</b></p>
+<p>
+You can override <span class="notranslate">MALWARE_SCAN_SCHEDULE</span> <b>per user</b>.
+Per-user config files are stored at <span class="notranslate">/etc/imunify360/user_config/&lt;username&gt;/imunify360.config</span> and support the same schema as the admin config for this section.
+When both admin and user values exist, the user value is used for that option; missing user options inherit the admin value.
+</p>
+
+<p><b>Example (YAML) of per-user schedule:</b></p>
+<div class="notranslate">
+
+```
+MALWARE_SCAN_SCHEDULE:
+  interval: week   # allowed: none, day, week, month
+  hour: 2          # 0..23
+  day_of_week: 1   # 0..7 (0/7 = Sunday)
+```
+
+</div>
+
+<p><b>CLI examples for per-user:</b></p>
+<div class="notranslate">
+
+```
+# Show effective config for a user
+imunify360-agent config show --user <username> --json
+
+# Set a weekly scan at 03:00 on Monday for a user
+imunify360-agent config update '{"MALWARE_SCAN_SCHEDULE": {"interval": "week", "hour": 3, "day_of_week": 1}}' --user <username>
+
+# Disable scheduled scans for a user
+imunify360-agent config update '{"MALWARE_SCAN_SCHEDULE": {"interval": "none"}}' --user <username>
+```
+
+</div>
+
+<p><b>License notes</b></p>
+<p>
+Daily/Weekly schedules are available on <b>Imunify360</b> and <b>ImunifyAV+</b>. On <b>ImunifyAV</b>, only <span class="notranslate">none</span> and <span class="notranslate">month</span> intervals are available.
+If a non-eligible interval is configured, the agent will ignore it and keep the schedule at a safe default.
+</p>
+
+</td>
+</tr>
 <tr>
 <th align="left"><span class="notranslate">PAM:</span></th>
 <th align="left"># effective way to prevent brute-force attacks against FTP/SSH</th>