Skip to content

Commit 759f80a

Browse files
committed
add advanced configuration to the docs
1 parent c0444b1 commit 759f80a

3 files changed

Lines changed: 71 additions & 0 deletions

File tree

docs/.vuepress/config-client/sidebar.ts

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -190,5 +190,14 @@ export default {
190190
"/wordpress_plugin/"
191191
]
192192
}
193+
],
194+
'/whmcs_cloudlinux_monetize/': [
195+
{
196+
collapsable: false,
197+
children: [
198+
"/whmcs_cloudlinux_monetize/",
199+
"/whmcs_cloudlinux_monetize/UPGRADE"
200+
]
201+
}
193202
]
194203
}

docs/whmcs_cloudlinux_monetize/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -188,6 +188,10 @@ When products are imported, you can configure additional settings:
188188
189189
![](/images/whmcs_cloudlinux_monetize/product_notification_setting.png)
190190
191+
### Advanced Configuration
192+
193+
For additional product-level settings including webhooks and optional parameters, see the **[Advanced Configuration](./advanced_configuration)** guide.
194+
191195
### Price Recalculations
192196
193197
The module automatically updates product pricing on a daily basis through a scheduled cron job. This ensures that:
Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Advanced Configuration
2+
3+
## Overview
4+
5+
The Advanced Configuration section in the CloudLinux Monetize module dashboard allows administrators to configure product-level settings for Imunify Patch.
6+
7+
## Accessing Advanced Configuration
8+
9+
1. Navigate to **Addons > CloudLinux Monetize** in the WHMCS admin area
10+
2. Locate the **Imunify Patch** product
11+
3. Click the **Advanced Configuration** toggle below the product to expand the settings
12+
13+
## Settings
14+
15+
### Enable Notifications
16+
17+
Controls whether Imunify sends promotional notifications to customers in the hosting panel. When enabled, customers with patchable vulnerabilities receive notifications with a direct link to subscribe and enable protection.
18+
19+
### Webhooks
20+
21+
Webhooks allow you to receive real-time HTTP POST notifications about Imunify Patch security events on your own endpoints.
22+
23+
| Field | Description |
24+
|-------|-------------|
25+
| **URL** | The endpoint that will receive webhook notifications (e.g., `https://ops.example.com/imunify/webhook`) |
26+
| **Secret** | A shared secret used to sign requests. If set, each request includes an `X-Imunify-Signature` header for verification |
27+
| **Events** | A comma-separated list of event types to subscribe to. If omitted, all supported event types are delivered |
28+
29+
**Supported events:**
30+
31+
| Event | Description |
32+
|-------|-------------|
33+
| `vulnerability_found` | Triggered when a new vulnerability is detected on a customer's website |
34+
| `vulnerabilities_patched_digest` | Triggered when a digest of patched vulnerabilities is available |
35+
36+
To manage webhooks, click **Add Webhook** to create a new entry, fill in the fields, and click **Save Configuration**. Use the trash icon to remove a webhook.
37+
38+
### Optional Parameters
39+
40+
A JSON field for specifying additional configuration parameters. The `optional_parameters` object is designed to be extensible.
41+
42+
**Limiting rollout to specific servers:**
43+
44+
You can limit the initial rollout of Imunify Patch to a subset of servers by specifying their IP addresses:
45+
46+
```
47+
{
48+
"enabled_for_ids": ["192.0.2.1", "192.0.2.2"]
49+
}
50+
```
51+
52+
- If `enabled_for_ids` is present, Imunify Patch UI, detection, and reporting are only enabled for the listed server IPs.
53+
- If `enabled_for_ids` is omitted, the product applies to the entire server fleet.
54+
55+
## Saving Configuration
56+
57+
Click **Save Configuration** at the bottom of the settings. A success message confirms the settings have been saved and synchronized with the CloudLinux API.
58+

0 commit comments

Comments
 (0)