Skip to content

Commit 969480c

Browse files
author
jdv
committed
final fix
1 parent 72db2f7 commit 969480c

File tree

2 files changed

+30
-14
lines changed

2 files changed

+30
-14
lines changed

crowdsec-docs/unversioned/getting_started/health_check.mdx

Lines changed: 26 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ import CodeBlock from '@theme/CodeBlock';
1111

1212
<small className="health-check-version" style={{position: 'relative', top: '-30px'}}>Health Check Version: 0.2.0</small>
1313

14-
Welcome to the interactive Health-Check of your CrowdSec setup.
15-
We'll guide you through a series of tests to ensure that your Security Stack is fully functional and ready to protect your services:
16-
**Detecting**, **Threat Sharing** and **Remediating**.
17-
*This guide covers cases of protecting common services such as web servers (HTTP) and SSH.*
14+
Welcome to the interactive Health-Check of your CrowdSec setup.
15+
We'll guide you through a series of tests to ensure that your Security Stack is fully functional and ready to protect your services:
16+
**Detecting**, **Threat Sharing** and **Remediating**.
17+
*This guide covers cases of protecting common services such as web servers (HTTP) and SSH.*
1818

1919
We'll first test the final functionality of each component (top-down approach) before diving into detailed troubleshooting if issues arise.
2020

@@ -23,6 +23,10 @@ This health check is divided into three main sections:
2323
- [**🔗 Connectivity**](#-crowdsec-connectivity-checks): Verifying communication with the CrowdSec network to receive the community blocklist.
2424
- [**🛡️ Protection**](#-remediation-checks): Confirming that your bouncers automatically block threats detected by CrowdSec
2525

26+
:::tip Your feedback matters!
27+
Help us improve this health check guide by sharing your experience: [📝 **Health Check Feedback Form** ↗️](https://forms.gle/DJboC7oisjmA8qt78)
28+
:::
29+
2630
* * *
2731

2832
## 📡 Detection checks
@@ -53,9 +57,10 @@ We'll trigger the dummy scenario `crowdsecurity/http-generic-test` by accessing
5357
</TabItem>
5458
</Tabs>
5559

56-
**Notes:**
57-
- Requests from private IP addresses won't trigger alerts (private IPs are whitelisted by default).
58-
- You can also test via a browser if easier, especially from another device.
60+
**Notes:**
61+
- ⚠️ **Important**: Requests from **private IP addresses won't trigger alerts** (private IPs are whitelisted by default).
62+
- If testing from localhost or your internal network (192.168.x.x, 10.x.x.x, 172.16.x.x), the test will fail.
63+
- **Solution**: Test from an external device with a public IP address, or test via a browser from your phone using mobile data.
5964
- This scenario can be triggered again only after a 5-minutes delay.
6065
</details>
6166

@@ -328,7 +333,16 @@ Were all the tests related to your setup successful?
328333

329334
**⚠️ Log format mismatch:**
330335
- If your logs don't follow the expected format (e.g., they've been customized), CrowdSec might not parse them properly.
331-
- You can find more information on how to create your own parsers in the [CrowdSec documentation](https://doc.crowdsec.net/docs/next/log_processor/parsers/format).
336+
- **Check which log format the Hub parser expects:**
337+
- Each parser on the Hub documents the expected log format. For example:
338+
- [**NGINX parser** ↗️](https://app.crowdsec.net/hub/author/crowdsecurity/log-parsers/nginx-logs) expects the default combined log format
339+
- [**Apache parser** ↗️](https://app.crowdsec.net/hub/author/crowdsecurity/log-parsers/apache2-logs) expects the standard combined format
340+
- Compare your actual log format with the expected format to identify mismatches
341+
- **For custom log formats:**
342+
- **Example**: If you use a custom NGINX log format like `log_format custom '$remote_addr - $request - $status';`, you'll need a custom parser
343+
- Use the [**CrowdSec Playground** ↗️](https://playground.crowdsec.net/) to test and develop your parsers interactively
344+
- The playground lets you test GROK patterns, parsers, and scenarios in real-time before deploying them
345+
- Full guide on creating parsers: [CrowdSec Parser Documentation](https://doc.crowdsec.net/docs/next/log_processor/parsers/format)
332346

333347
</details>
334348

@@ -694,10 +708,8 @@ You might want to continue to the next recommended steps:
694708
</details>
695709
</details>
696710

697-
## 💬 Your feedback is important!
698-
699-
Help us improve this health check guide!
700-
Give us feedback via this form: [📝 Health Check Feedback Form ↗️](https://forms.gle/DJboC7oisjmA8qt78)
711+
## 💬 Get Help & Give Feedback
701712

702-
[📨 Open an issue on GitHub ↗️](https://github.com/crowdsecurity/crowdsec-docs/issues/new) or
703-
🗣️ Join the conversation on [Discord ↗️](https://discord.gg/wGN7ShmEE8)
713+
- 📝 [Health Check Feedback Form ↗️](https://forms.gle/DJboC7oisjmA8qt78)
714+
- 📨 [Open an issue on GitHub ↗️](https://github.com/crowdsecurity/crowdsec-docs/issues/new)
715+
- 🗣️ [Join us on Discord ↗️](https://discord.gg/wGN7ShmEE8)

crowdsec-docs/unversioned/getting_started/introduction.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,10 @@ CrowdSec Security Engine uses the following default ports (bound to localhost/lo
8181
* 6060/tcp: Prometheus metrics port
8282
* 8080/tcp: API port
8383

84+
## Next Steps
85+
86+
After installing CrowdSec, use our **[interactive Health-Check guide](health_check.mdx)** to verify your setup is working correctly. It will walk you through testing detection, connectivity, and remediation to ensure your Security Stack is fully functional.
87+
8488
## Resources
8589

8690

0 commit comments

Comments
 (0)