Skip to content

Commit d9fe98d

Browse files
committed
docs: Improve documentation with enhanced links and clarifications across multiple sections
1 parent 35a3e2f commit d9fe98d

File tree

8 files changed

+58
-27
lines changed

8 files changed

+58
-27
lines changed

docs/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,12 +50,12 @@ Nothing. We're not even kidding, we don't collect any data at all. You can set u
5050

5151
## How does it look?
5252

53-
When a user gets the plugin added, a new icon will appear, this icon is brandable to customize it to your own logo and name.
53+
When a user gets the plugin added, a new icon will appear, this icon is [brandable](settings/branding.md) to customize it to your own logo and name.
5454

5555
<figure><img src=".gitbook/assets/image (1).png" alt=""><figcaption></figcaption></figure>
5656

5757
When visiting a page that is suspect, but our certainty if the page is phishing is too low we'll show a banner on the page to warn users, if we're sure about the page being an AITM or phishing attack, we'll block the page entirely:
5858

5959
<figure><img src=".gitbook/assets/image (3).png" alt=""><figcaption></figcaption></figure>
6060

61-
This too is completely brandable, and can be made to match company colours. The Contact Admin button is a mailto: link that contains the information about what page the user tried to visit, including a defanged URL.
61+
This too is completely [brandable](settings/branding.md), and can be made to match company colours. The Contact Admin button is a mailto: link that contains the information about what page the user tried to visit, including a defanged URL.

docs/advanced/creating-detection-rules.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Creating Detection Rules
22

3-
The extension uses a rule-driven architecture where all detection logic is defined in `rules/detection-rules.json`. This file contains:
3+
The extension uses a rule-driven architecture where all detection logic is defined in [`rules/detection-rules.json`](https://github.com/CyberDrain/Check/blob/main/rules/detection-rules.json). This file contains:
44

55
- **Trusted domain patterns** - Microsoft domains that are always trusted
66
- **Exclusion system** - Domains that should never be scanned
@@ -13,16 +13,16 @@ Each of these rules has their own schema. You can create a custom rules file and
1313

1414
**Important:** After updating rules via the UI or changing custom URLs, reload any open tabs for changes to take effect on those pages. The extension loads rules at startup and on the configured interval.
1515

16-
Contributions to our rules can be done via [https://github.com/CyberDrain/Check/blob/main/rules/detection-rules.json](../../rules/detection-rules.json)
16+
Contributions to our rules can be done via [https://github.com/CyberDrain/Check/blob/main/rules/detection-rules.json](https://github.com/CyberDrain/Check/blob/main/rules/detection-rules.json)
1717

1818
## Rule Configuration and Updates
1919

20-
Rules are managed by the `DetectionRulesManager` class in `scripts/modules/detection-rules-manager.js`. The manager:
20+
Rules are managed by the [`DetectionRulesManager`](https://github.com/CyberDrain/Check/blob/main/scripts/modules/detection-rules-manager.js) class. It's job is to:
2121

22-
- Loads rules at extension startup
23-
- Checks for updates based on the configured interval (default: 24 hours)
24-
- Caches rules locally in browser storage for offline use
25-
- Falls back to local rules (`rules/detection-rules.json`) if remote fetch fails
22+
- Load rules at extension startup
23+
- Check for updates based on the configured interval (default: 24 hours)
24+
- Cache rules locally in browser storage for offline use
25+
- Fall back to local rules ([`rules/detection-rules.json`](https://github.com/CyberDrain/Check/blob/main/rules/detection-rules.json)) if remote fetch fails
2626

2727
**Update Process:**
2828

@@ -33,6 +33,10 @@ Rules are managed by the `DetectionRulesManager` class in `scripts/modules/detec
3333

3434
## Exclusions
3535

36+
{% hint style="info" %}
37+
**For simple exclusions:** Most users should use the [Settings → Detection Rules](../settings/detection-rules.md#url-allowlist-regex-or-url-with-wildcards) UI field, which supports both wildcards and regex patterns. This section is for advanced users creating custom rule files.
38+
{% endhint %}
39+
3640
To exclude domains from all scanning (complete bypass), add them to the `exclusion_system.domain_patterns` array:
3741

3842
```json

docs/settings/about.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,5 +41,5 @@ The About section provides quick access to essential resources:
4141

4242
### Development and Support
4343

44-
- **GitHub Repository** - View source code, report issues, and contribute to the project
45-
- **CyberDrain Website** - Learn more about CyberDrain's solutions and services
44+
- **[GitHub Repository](https://github.com/CyberDrain/Check)** - View source code, report issues, and contribute to the project
45+
- **[CyberDrain Website](https://cyberdrain.com)** - Learn more about CyberDrain's solutions and services

docs/settings/activity-logs.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ You tried to log into Office 365 but got blocked. Looking at logs:​Timestamp:
103103
1. Check "Enable Debug Logging"
104104
2. Reproduce the problem
105105
3. Export logs (see below)
106-
4. Send logs to support
106+
4. Send logs to support (see [Common Issues](../troubleshooting/common-issues.md) for additional troubleshooting steps)
107107
5. Uncheck debug logging when done (saves storage space)
108108

109109
**For admins wanting to simulate end-user experience**
@@ -147,12 +147,12 @@ You tried to log into Office 365 but got blocked. Looking at logs:​Timestamp:
147147
2. Go to Activity Logs
148148
3. Look for "Threat Blocked" entries around that time
149149
4. Click the entry to see why it was blocked
150-
5. If you think it was blocked incorrectly, contact support with the log details
150+
5. If you think it was blocked incorrectly, contact support with the log details or check [Common Issues](../troubleshooting/common-issues.md) for known problems
151151

152152
**Scenario 3: Preparing for support**
153153

154154
1. Enable debug logging
155155
2. Try to reproduce the problem
156156
3. Export logs immediately after the problem occurs
157157
4. Disable debug logging
158-
5. Send the exported file to support
158+
5. Send the exported file to support or check [Common Issues](../troubleshooting/common-issues.md) first

docs/settings/detection-rules.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,32 @@ Controls how often Check fetches updated detection rules. The default is 24 hour
3333

3434
### **URL Allowlist (Regex or URL with wildcards)**
3535

36-
Add URLs or patterns that should be excluded from phishing detection. This is useful for internal company sites or trusted third-party services that might trigger false positives. You can use:
36+
{% hint style="info" %}
37+
**Need to allowlist a phishing training service?**
38+
39+
MSPs and IT departments commonly need to exclude phishing training platforms (like KnowBe4, Proofpoint, etc.) from detection. Check [Advanced → Creating Detection Rules](../advanced/creating-detection-rules.md#exclusions) for technical details.
40+
{% endhint %}
41+
42+
Add URLs or patterns that should be excluded from phishing detection. This is useful for internal company sites or trusted third-party services that might trigger false positives.
43+
44+
**How it works:** Your allowlist patterns are **added to** (not replacing) the default CyberDrain exclusions, providing additional protection without losing baseline coverage.
45+
46+
You can use:
3747

3848
- **Simple URLs with wildcards:** `https://google.com/*` or `https://*.microsoft.com/*`
3949
- **Advanced regex patterns:** `^https://trusted\.example\.com/.*`
4050

51+
**Copy-paste examples (based on existing default exclusions):**
52+
53+
```
54+
https://*.google.com/*
55+
https://*.auth0.com/*
56+
https://*.amazon.com/*
57+
https://*.facebook.com/*
58+
https://training.your-company.com/*
59+
https://*.internal-domain.com/*
60+
```
61+
4162
Enter one pattern per line. These patterns are added to the exclusion rules without replacing the entire ruleset from your Config URL.
4263

4364
### Updating Rules Manually

docs/settings/general.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ This is Check's main job - blocking dangerous websites. When this is turned on (
1414

1515
CIPP is a system that IT professionals use to monitor security across multiple organizations. Enabling CIPP monitoring allows you to send detection information from Check directly to CIPP, thus allowing you to alert and report on what's happening with your endpoints. When enabled, you would configure the CIPP Server URL and Tenant ID/Domain below.
1616

17+
View CIPP reporting activity in the [Activity Logs](activity-logs.md) section.
18+
1719
### **CIPP Server URL**
1820

1921
Enter the base URL of your CIPP server for reporting Microsoft 365 logon detections. This should be the full URL to your CIPP instance (e.g., `https://your-cipp-server.com`). This field is only active when CIPP Reporting is enabled.
@@ -24,6 +26,8 @@ Enter your tenant identifier to include with CIPP alerts for multi-tenant enviro
2426

2527
{% hint style="info" %}
2628
Currently, CIPP displays these alerts in the logbook. Future updates to CIPP are planned to provide additional functionality. Keep an eye on the CIPP release notes for more updates!
29+
30+
You can monitor CIPP reporting status and activity in [Activity Logs](activity-logs.md).
2731
{% endhint %}
2832

2933
## User Interface

docs/troubleshooting/common-issues.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,29 +4,33 @@
44

55
<summary>Policies not appearing in Group Policy Management Console</summary>
66

7-
* Verify ADMX/ADML files are in correct location
7+
- Verify ADMX/ADML files are in correct location (see [Windows deployment docs](../deployment/chrome-edge-deployment-instructions/windows/README.md))
88

9-
- Ensure files are not blocked (right-click > Properties > Unblock)
10-
- Refresh Group Policy Editor
9+
* Ensure files are not blocked (right-click > Properties > Unblock)
10+
* Refresh Group Policy Editor
11+
12+
For complete deployment instructions, see [Domain Deployment guide](../deployment/chrome-edge-deployment-instructions/windows/domain-deployment.md).
1113

1214
</details>
1315

1416
<details>
1517

1618
<summary>Policies not applying to extension</summary>
1719

18-
* Check registry values are present
19-
* Restart browser after policy changes
20-
* Verify extension has necessary permissions
20+
- Check registry values are present (see [Manual Deployment guide](../deployment/chrome-edge-deployment-instructions/windows/manual-deployment.md))
21+
- Restart browser after policy changes
22+
- Verify extension has necessary permissions
23+
24+
For troubleshooting policy deployment, consult the [Windows deployment documentation](../deployment/chrome-edge-deployment-instructions/windows/README.md).
2125

2226
</details>
2327

2428
<details>
2529

2630
<summary>Custom branding not working</summary>
2731

28-
* Verify URLs are accessible via HTTPS
29-
* Check image formats are supported (PNG, JPG, SVG)
30-
* Ensure color codes are valid hex format
32+
- Verify URLs are accessible via HTTPS
33+
- Check image formats are supported (PNG, JPG, SVG)
34+
- Ensure color codes are valid hex format
3135

3236
</details>

docs/troubleshooting/testing-check.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,4 @@ Whether you are contributing to the Check repo, developing your own detection ru
66
We greatly caution against sharing phishing links. There is a security risk with client-side code being run from some phish kits in circulation.&#x20;
77
{% endhint %}
88

9-
Instructions for how to spin up Evilginx 3.0 can be found via this blog post from Jan Bakker.
10-
11-
[https://janbakker.tech/running-evilginx-3-0-on-windows/](https://janbakker.tech/running-evilginx-3-0-on-windows/)
9+
Instructions for how to spin up Evilginx 3.0 can be found via [this blog post from Jan Bakker](https://janbakker.tech/running-evilginx-3-0-on-windows/).

0 commit comments

Comments
 (0)