Skip to content

Heath Check V0.2.0 #804

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Heath Check V0.2.0 #804

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e65b215
adding additionnal hint for cscli/crowdsec issues
Jun 23, 2025
2f20dcc
healthcheck version udpate
Jun 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions crowdsec-docs/unversioned/getting_started/health_check.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import CodeBlock from '@theme/CodeBlock';

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

Welcome to the interactive Health-Check of your CrowdSec setup.
We'll guide you through a series of tests to ensure that your Security Stack is fully functional and ready to protect your services:
Expand Down Expand Up @@ -183,7 +183,7 @@ Were all the tests related to your setup successful?

<details id="troubleshooting_service">
<summary>⚙️ CrowdSec Service Troubleshooting -- is the CrowdSec service running?</summary>

Let’s check if the CrowdSec service is active:
<CodeBlock className="language-bash">sudo systemctl status crowdsec</CodeBlock>
- ☑️ You should see: "**active (running)**"
Expand All @@ -196,12 +196,17 @@ Were all the tests related to your setup successful?
For linux systems, the logs are typically located in `/var/log/crowdsec.log`.
<CodeBlock className="language-bash">less /var/log/crowdsec.log</CodeBlock>

Common reasons the service might fail::
If you got an error trying to run the `cscli` or trying to start `crowdsec`.
Common reasons the service might fail:
- Misconfiguration in the `config.yaml` file.
- Port conflicts with other services. By default, CrowdSec uses port 8080 for the Local API (LAPI) and port 6060 for the Local API metrics.
- The port configuration can be setup in `config.yaml` file or by setting the environment variables depending on your implementation
- Insufficient permissions to access the log files or directories.
- Acquisition files format errors.

Other more low level reasons might be:
- `cscli` doesn't exist in your $PATH hence can't be called from anywhere.
- You might not have `sudo` permissions to run the command or privileges on the config.yaml file used when running `cscli` or `crowdsec`.

</details>
</details>
Expand Down