You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.*
18
18
19
19
We'll first test the final functionality of each component (top-down approach) before diving into detailed troubleshooting if issues arise.
20
20
@@ -23,6 +23,10 @@ This health check is divided into three main sections:
23
23
-[**🔗 Connectivity**](#-crowdsec-connectivity-checks): Verifying communication with the CrowdSec network to receive the community blocklist.
24
24
-[**🛡️ Protection**](#-remediation-checks): Confirming that your bouncers automatically block threats detected by CrowdSec
25
25
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
+
26
30
* * *
27
31
28
32
## 📡 Detection checks
@@ -53,9 +57,10 @@ We'll trigger the dummy scenario `crowdsecurity/http-generic-test` by accessing
53
57
</TabItem>
54
58
</Tabs>
55
59
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.
59
64
- This scenario can be triggered again only after a 5-minutes delay.
60
65
</details>
61
66
@@ -328,7 +333,16 @@ Were all the tests related to your setup successful?
328
333
329
334
**⚠️ Log format mismatch:**
330
335
- 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)
332
346
333
347
</details>
334
348
@@ -694,10 +708,8 @@ You might want to continue to the next recommended steps:
694
708
</details>
695
709
</details>
696
710
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
701
712
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)
Copy file name to clipboardExpand all lines: crowdsec-docs/unversioned/getting_started/introduction.mdx
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -81,6 +81,10 @@ CrowdSec Security Engine uses the following default ports (bound to localhost/lo
81
81
* 6060/tcp: Prometheus metrics port
82
82
* 8080/tcp: API port
83
83
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.
0 commit comments