Skip to content

Commit e52136c

Browse files
authored
Adjustments to HTML Tables to fix build time warnings, breadcrumbs customization
Adjustments to HTML Tables to fix build time warnings, breadcrumbs customization
2 parents 3e28bc6 + d24f65a commit e52136c

File tree

3 files changed

+51
-49
lines changed

3 files changed

+51
-49
lines changed

docs/.vuepress/theme/components/Breadcrumb.vue

Lines changed: 11 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -14,36 +14,20 @@
1414
<script setup>
1515
import { computed, inject } from "vue";
1616
import { usePageData, useSiteData } from "@vuepress/client";
17+
import documents from "../../config-client/documents";
1718
1819
const page = usePageData();
1920
const site = useSiteData();
2021
const { locales: { siteTitle } } = inject("themeConfig");
2122
22-
// Title mapping for specific paths
23-
const titleMap = {
24-
'/billing/': 'Billing',
25-
'/command_line_interface/': 'Command Line Interface',
26-
'/config_file_description/': 'Config File Description',
27-
'/control_panel_integration/': 'Control Panel Integration',
28-
'/dashboard/': 'Dashboard',
29-
'/email/': 'Email',
30-
'/faq_and_known_issues/': 'FAQ and Known Issues',
31-
'/features/': 'Features',
32-
'/ids_integration/': 'IDS Integration',
33-
'/imunify_patch/': 'Imunify Patch',
34-
'/imunifyav/': 'ImunifyAV',
35-
'/installation/': 'Installation',
36-
'/introduction/': 'Introduction',
37-
'/localization/': 'Localization',
38-
'/myimunify/': 'MyImunify',
39-
'/patchman/': 'Patchman',
40-
'/terminology/': 'Terminology',
41-
'/uninstall/': 'Uninstall',
42-
'/update/': 'Update',
43-
'/user_interface/': 'User Interface',
44-
'/whmcs_plugin/': 'WHMCS Plugin',
45-
'/wordpress_plugin/': 'WordPress Plugin',
46-
};
23+
// Generate title mapping from documents
24+
const titleMap = computed(() => {
25+
const map = {};
26+
documents.forEach(doc => {
27+
map[doc.link] = doc.title;
28+
});
29+
return map;
30+
});
4731
4832
const breadCrumbs = computed(() => {
4933
const segments = page.value.path.split("/").filter(Boolean);
@@ -60,7 +44,7 @@ const breadCrumbs = computed(() => {
6044
if (isLast) {
6145
title = page.value.title;
6246
} else {
63-
title = titleMap[fullPath] || fullPath;
47+
title = titleMap.value[fullPath] || fullPath;
6448
}
6549
6650
crumbs.push({ path: fullPath, title });
@@ -87,7 +71,7 @@ const breadCrumbs = computed(() => {
8771
cursor pointer
8872
8973
&:hover
90-
color #1994f9
74+
color $accentColor
9175
9276
&:last-child
9377
cursor default

docs/config_file_description/README.md

Lines changed: 34 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ Note that if YAML is used, it accepts any format: `True`/`true`/`yes`/`y`, etc.
1212
:::
1313

1414
<table>
15+
<tbody>
1516
<tr>
1617
<th colspan="2" align="left"><span class="notranslate">AUTO_WHITELIST:</span></th>
1718
</tr>
@@ -113,7 +114,8 @@ Changes of config files will be applied automatically. You don’t need to resta
113114
<tr>
114115
<td width="250px;"><span class="notranslate">prev_settings: </span></td><td># for internal usage, do not edit</td></tr>
115116
<tr>
116-
<th colspan="2" align="left"><span class="notranslate">MOD_SEC_BLOCK_BY_SEVERITY:</span></th></tr>
117+
<th colspan="2" align="left"><span class="notranslate">MOD_SEC_BLOCK_BY_SEVERITY:</span></th>
118+
</tr>
117119
<tr><td><span class="notranslate">enable: True</span></td><td># allows to enable or disable option that moves IPs to <span class="notranslate">Gray List</span> if the ModSecurity rule is triggered</td></tr>
118120
<tr><td><span class="notranslate">max_incidents: 2</span></td><td># set a number of repeats of the ModSecurity incident from the same IP for adding it to <span class="notranslate">Gray List</span></td></tr>
119121
<tr><td><span class="notranslate">check_period: 120</span></td>
@@ -129,7 +131,8 @@ Changes of config files will be applied automatically. You don’t need to resta
129131
<tr><td><span class="notranslate">max_incidents: 10</span></td>
130132
<td># set a number of repeats of the ModSecurity incident from the same IP for adding it to <span class="notranslate">Gray List</span></td></tr>
131133
<tr>
132-
<th colspan="2" align="left"><span class="notranslate">MALWARE_SCANNING:</span></th></tr>
134+
<th colspan="2" align="left"><span class="notranslate">MALWARE_SCANNING:</span></th>
135+
</tr>
133136
<tr><td><span class="notranslate">try_restore_from_backup_first: False</span></td>
134137
<td># allows to enable (<span class="notranslate">True</span>) or disable (<span class="notranslate">False</span> – the default value) automatic malicious file restore from backup if a clean copy exists,
135138
otherwise <span class="notranslate"><em>default_action</em></span> is applied</td></tr>
@@ -184,24 +187,29 @@ Scanner's behaviour is based on other scan optimizations, therefore it is better
184187
<tr><td><span class="notranslate">db_timeout: 15</span></td>
185188
<td># set the maximum time in seconds for connecting to or reading from a database during a scan/clean/restore operation.</td></tr>
186189
<tr>
187-
<th colspan="2" align="left"><span class="notranslate">CAPTCHA:</span></th></tr>
190+
<th colspan="2" align="left"><span class="notranslate">CAPTCHA:</span></th>
191+
</tr>
188192
<tr><td><span class="notranslate">cert_refresh_timeout: 3600</span></td>
189193
<td># set in seconds how often SSL certificate will be refreshed</td></tr>
190194
<tr>
191-
<th colspan="2" align="left"><span class="notranslate">CONTROL_PANEL:</span></th></tr>
195+
<th colspan="2" align="left"><span class="notranslate">CONTROL_PANEL:</span></th>
196+
</tr>
192197
<tr><td><span class="notranslate">compromised_user_password_reset: True</span></td>
193198
<td># enables resetting passwords for compromised cPanel accounts. Upon activating this functionality, our platform will detect instances where a cPanel account password has been breached and will subsequently prevent access using the previous password. End-users will then be prompted to create a new password via the <a href="https://docs.cpanel.net/knowledge-base/security/how-to-reset-a-cpanel-account-password/" target="_blank">cPanel password reset process</a>.</td></tr>
194199
<tr>
195-
<th colspan="2" align="left"><span class="notranslate">ERROR_REPORTING:</span></th></tr>
200+
<th colspan="2" align="left"><span class="notranslate">ERROR_REPORTING:</span></th>
201+
</tr>
196202
<tr><td><span class="notranslate">enable: True</span></td>
197203
<td># automatically report errors to imunify360 team</td></tr>
198204
<tr>
199-
<th colspan="2" align="left"><span class="notranslate">SEND_ADDITIONAL_DATA:</span></th></tr>
205+
<th colspan="2" align="left"><span class="notranslate">SEND_ADDITIONAL_DATA:</span></th>
206+
</tr>
200207
<tr><td><span class="notranslate">enable: True</span></td>
201208
<td># send anonymized data from query string/post parameters and cookies. True is the default value.</td></tr>
202209
<tr>
203210
<th align="left"><span class="notranslate">NETWORK_INTERFACE:</span></th>
204-
<th aligh="left"># manages for what network interfaces Imunify360 rules will be applied</th></tr>
211+
<th aligh="left"># manages for what network interfaces Imunify360 rules will be applied</th>
212+
</tr>
205213
<tr>
206214
<td><span class="notranslate">eth_device: None</span></td>
207215
<td># by default, Imunify360 will auto-configure iptables to filter all traffic.
@@ -211,10 +219,13 @@ If you want iptables rules to be applied to a specific NIC only, list them here
211219
<tr><td><span class="notranslate">eth_device_skip: []</span></td>
212220
<td># if you don't want iptables\ip6tables rules to be applied to specific NICs, list them here (e.g <span class="notranslate">[eth1, eth2]</span>)</td></tr>
213221
<tr>
214-
<th colspan="2" align="left"><span class="notranslate">BACKUP_RESTORE:</span></th></tr>
222+
<th colspan="2" align="left"><span class="notranslate">BACKUP_RESTORE:</span></th>
223+
</tr>
215224
<tr><td><span class="notranslate">max_days_in_backup: 90</span></td>
216225
<td># restore from backup files that are not older than <span class="notranslate"><em>max_days_in_backup</em></span></td></tr>
226+
<tr>
217227
<th colspan="2" align="left"><span class="notranslate">CAPTCHA_DOS:</span></th>
228+
</tr>
218229
<tr><td><span class="notranslate">enabled: True</span></td>
219230
<td># enable (<span class="notranslate">True</span> (default) or disable (<span class="notranslate">False</span>) Anti-bot Challenge Dos protection</td></tr>
220231
<tr><td><span class="notranslate">time_frame: 21600</span></td>
@@ -227,11 +238,13 @@ to the Anti-bot Challenge Dos list without an ability to request Anti-bot Challe
227238
<td># set in seconds the time on which to add the IP in Anti-bot Challenge Dos list without an ability
228239
to request Anti-bot Challenge again</td></tr>
229240
<tr>
230-
<th colspan="2" align="left"><span class="notranslate">BLOCKED_PORTS:</span></th></tr>
241+
<th colspan="2" align="left"><span class="notranslate">BLOCKED_PORTS:</span></th>
242+
</tr>
231243
<tr><td><span class="notranslate">default_mode: allowed</span></td>
232244
<td># defines the default state of ports which is not explicitly set by user (<span class="notranslate"><em>denied</em></span> by default or <span class="notranslate"><em>allowed</em></span> by default). Currently only <span class="notranslate"><em>allowed</em></span> is supported</td></tr>
233245
<tr>
234-
<th colspan="2" align="left"><span class="notranslate">WEBSHIELD:</span></th></tr>
246+
<th colspan="2" align="left"><span class="notranslate">WEBSHIELD:</span></th>
247+
</tr>
235248
<tr><td><span class="notranslate">known_proxies_support: True</span></td>
236249
<td># enable CDN support, treat IPs behind CDN as any other IPs. (True is the default value).</td></tr>
237250
<tr><td><span class="notranslate">enable: True</span></td>
@@ -241,15 +254,17 @@ to request Anti-bot Challenge again</td></tr>
241254
<tr><td><span class="notranslate">panel_protection: False</span></td>
242255
<td># enable (<span class="notranslate">True</span>) or disable (<span class="notranslate">False</span> – default) <a href="https://docs.imunify360.com/features/#cpanel-account-protection">cPanel account protection</a> – applies the Anti-Bot JavaScript challenge on cPanel login ports 2082/2083.</td></tr>
243256
<tr>
244-
<th colspan="2" align="left"><span class="notranslate">PROACTIVE_DEFENCE:</span></th></tr>
257+
<th colspan="2" align="left"><span class="notranslate">PROACTIVE_DEFENCE:</span></th>
258+
</tr>
245259
<tr><td><span class="notranslate">blamer: True</span></td>
246260
<td># enable (<span class="notranslate">True</span> (default)) or disable (<span class="notranslate">False) Blamer</span>. See also: <a href="https://blog.imunify360.com/forcibly-enable-blamer" target="_blank">How to forcibly enable Blamer for all users on the server</a>.</td></tr>
247261
<tr><td><span class="notranslate">mode: LOG</span></td>
248262
<td># available modes:<ul><li><span class="notranslate">KILL</span></li><li><span class="notranslate">DISABLED</span></li><li><span class="notranslate">LOG</span> (default)</li></ul></td></tr>
249263
<tr><td><span class="notranslate">php_immunity: False</span></td>
250264
<td># enable (<span class="notranslate">True</span>) or disable (<span class="notranslate">False (default)) PHP Immunity </span> (allows to automatically detect & patch vulnerabilities in software at the Proactive Defense level preventing re-infections through the same vulnerability). By enabling this feature, Blamer will be enabled as well and Proactive Defence switched into the KILL mode.</td></tr>
251265
<tr>
252-
<th colspan="2" align="left"><span class="notranslate">MALWARE_SCAN_INTENSITY:</span></th></tr>
266+
<th colspan="2" align="left"><span class="notranslate">MALWARE_SCAN_INTENSITY:</span></th>
267+
</tr>
253268
<tr><td><span class="notranslate">cpu: 2</span></td>
254269
<td># intensity level for CPU consumption. Can be set from 1 to 7, default is 2</td></tr>
255270
<tr><td><span class="notranslate">io: 2</span></td>
@@ -263,7 +278,8 @@ to request Anti-bot Challenge again</td></tr>
263278
<tr><td><span class="notranslate">user_scan_ram: 1024</span></td>
264279
<td># intensity level for RAM consumption for scans initiated by end-users. The default value is 1024</td></tr>
265280
<tr>
266-
<th colspan="2" align="left"><span class="notranslate">MALWARE_SCAN_SCHEDULE:</span></th></tr>
281+
<th colspan="2" align="left"><span class="notranslate">MALWARE_SCAN_SCHEDULE:</span></th>
282+
</tr>
267283
<tr><td><span class="notranslate">day_of_month: &lt;next day after installation&gt;</span></td>
268284
<td># when the background scan shall start, day of the month. Can be from 1 to 31, the default value is the &lt;next day after installation&gt;.</td></tr>
269285
<tr><td><span class="notranslate">day_of_week: 0</span></td>
@@ -274,7 +290,8 @@ to request Anti-bot Challenge again</td></tr>
274290
<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>
275291
<tr>
276292
<th align="left"><span class="notranslate">PAM:</span></th>
277-
<th align="left"># effective way to prevent brute-force attacks against FTP/SSH</th></tr>
293+
<th align="left"># effective way to prevent brute-force attacks against FTP/SSH</th>
294+
</tr>
278295
<tr><td><span class="notranslate">enable: False</span></td>
279296
<td># enable (<span class="notranslate">True</span>) or disable (<span class="notranslate">False</span>) (default value) PAM brute-force attack protection</td></tr>
280297
<tr><td><span class="notranslate">exim_dovecot_protection: False</span></td>
@@ -285,7 +302,8 @@ to request Anti-bot Challenge again</td></tr>
285302
<td># enable (<span class="notranslate">True</span>) (default value) or disable (<span class="notranslate">False</span>) the Dovecot native module.</td></tr>
286303
<tr>
287304
<th align="left"><span class="notranslate">KERNELCARE:</span> (<b><font color="Red">deprecated</font></b>)</th>
288-
<th align="left"># KernelCare extension for Imunify360 which allows tracing malicious invocations to detect privilege escalation attempts</th></tr>
305+
<th align="left"># KernelCare extension for Imunify360 which allows tracing malicious invocations to detect privilege escalation attempts</th>
306+
</tr>
289307
<tr><td><span class="notranslate">edf: False</span> (<b><font color="Red">deprecated</font></b>)</td>
290308
<td># enable (<span class="notranslate">True</span>) or disable (<span class="notranslate">False</span>) (default value) exploit detection framework</td></tr>
291309
<tr><th colspan="2" align="left"><span class="notranslate">MALWARE_CLEANUP:</span></th></tr>
@@ -341,6 +359,7 @@ to request Anti-bot Challenge again</td></tr>
341359
<tr><th colspan="2" align="left"><span class="notranslate">MALWARE_DATABASE_SCAN:</span></th></tr>
342360
<tr><td><span class="notranslate">enable: True</span></td>
343361
<td># enable (<span class="notranslate">True</span>) the Malware Database Scanner - a database antivirus with automated malware detection and clean-up of web applications. Requires MariaDB/MySQL DB management system version 5.5. Recommended version is 5.6+. Note, that only WordPress, Joomla, and Magento databases are supported now.</td></tr>
362+
</tbody>
344363
</table>
345364

346365
<span class="notranslate">Active Response</span> is an ossec-driven (IDS) feature of Imunify360 which has been re-engineered to make it capable of blocking access to a specific server port being attacked.

docs/imunifyav/config_file_description/README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ _/etc/sysconfig/imunify360/imunify360.config_
88
In the config file it is possible to set up ImunifyAV(+) configuration. The following options are available:
99

1010
<table>
11+
<tbody>
1112
<tr>
1213
<th colspan="2" align="left"><span class="notranslate">MALWARE_SCANNING:</span></th></tr>
1314
<tr><td><span class="notranslate">max_signature_size_to_scan: 1048576</span></td>
@@ -30,19 +31,17 @@ In the config file it is possible to set up ImunifyAV(+) configuration. The foll
3031
<td># allows to use (True) the regex matching Hyperscan library in Malware Scanner to greatly improve the scanning speed. True is the default value. Hyperscan requires its own signatures set that will be downloaded from the files.imunify360.com and compiled locally.<br><b>Platform requirements</b>:<br>* Hyperscan supports Debian, Ubuntu and CentOS/CloudLinux 7 and later.<br>* SSE3 processor instructions support. It is quite common nowadays, but may be lacking in virtual environments or in some rather old servers.</td></tr>
3132
<tr><td><span class="notranslate">crontabs: True</span></td>
3233
<td># enable (<span class="notranslate">True</span>) scan of the system and user crontab files for malicious jobs. The default value is <span class="notranslate">True</span>.</td></tr>
33-
<th colspan="2" align="left"><span class="notranslate">ERROR_REPORTING:</span></th>
34+
<tr><th colspan="2" align="left"><span class="notranslate">ERROR_REPORTING:</span></th></tr>
3435
<tr><td><span class="notranslate">enable: True</span></td>
3536
<td># automatically report errors to the Imunify team</td></tr>
36-
<tr>
37-
<th colspan="2" align="left"><span class="notranslate">MALWARE_SCAN_INTENSITY:</span></th></tr>
37+
<tr><th colspan="2" align="left"><span class="notranslate">MALWARE_SCAN_INTENSITY:</span></th></tr>
3838
<tr><td><span class="notranslate">cpu: 2</span></td>
3939
<td># intensity level for CPU consumption. Can be set from 1 to 7, default is 2</td></tr>
4040
<tr><td><span class="notranslate">io: 2</span></td>
4141
<td># intensity level for file operations. Can be set from 1 to 7, default is 2</td></tr>
4242
<tr><td><span class="notranslate">ram: 2048</span></td>
4343
<td># intensity level for RAM consumption. Minimum value is 1024, default is 2048</td></tr>
44-
<tr>
45-
<th colspan="2" align="left"><span class="notranslate">MALWARE_SCAN_SCHEDULE:</span></th></tr>
44+
<tr><th colspan="2" align="left"><span class="notranslate">MALWARE_SCAN_SCHEDULE:</span></th></tr>
4645
<tr><td><span class="notranslate">day_of_month: &lt;next day after installation&gt;</span></td>
4746
<td># when the background scan shall start, day of the month. Can be from 1 to 31, the default value is the &lt;next day after installation&gt;.</td></tr>
4847
<tr><td><span class="notranslate">day_of_week: 0</span></td>
@@ -70,14 +69,14 @@ In the config file it is possible to set up ImunifyAV(+) configuration. The foll
7069
<td># enable (<span class="notranslate">True</span>) or disable (<span class="notranslate">False</span>) (the default value) “scan” action in the UI of the end-user.</td></tr>
7170
<tr>
7271
<td width="250px;"><span class="notranslate">upgrade_button: True</span></td><td># enable (<span class="notranslate">True</span> - the default value) or disable (<span class="notranslate">False</span>) the Imunify upgrade button.</td></tr>
73-
<tr>
74-
<th colspan="2" align="left"><span class="notranslate">RESOURCE_MANAGEMENT:</span></th></tr>
72+
<tr><th colspan="2" align="left"><span class="notranslate">RESOURCE_MANAGEMENT:</span></th></tr>
7573
<tr><td><span class="notranslate">ram_limit: 500</span></td>
7674
<td># intensity level for RAM consumption. Minimum value is 500, default is 500</td></tr>
7775
<tr><td><span class="notranslate">io_limit: 2</span></td>
7876
<td># intensity level for file operations. Can be set from 1 to 7, default is 2</td></tr>
7977
<tr><td><span class="notranslate">cpu_limit: 2</span></td>
8078
<td># intensity level for CPU consumption. Can be set from 1 to 7, default is 2</td></tr>
79+
</tbody>
8180
</table>
8281

8382
## How to apply changes from CLI

0 commit comments

Comments
 (0)