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
Copy file name to clipboardExpand all lines: crowdsec-docs/docs/intro.mdx
+21-21Lines changed: 21 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,9 +8,9 @@ import AcademyPromo from "@site/src/components/academy-promo"
8
8
9
9
# Security Engine Overview
10
10
11
-
The [CrowdSec Security Engine](https://github.com/crowdsecurity/crowdsec) is an open-source, lightweight software that detects and blocks malicious actors from accessing your systems at various levels, using log and HTTP Requests analysis with threat patterns called scenarios.
11
+
The [CrowdSec Security Engine](https://github.com/crowdsecurity/crowdsec) is an open-source, lightweight security engine that detects and blocks malicious actors. It analyzes logs and HTTP requests using behavior-based patterns called scenarios.
12
12
13
-
CrowdSec is a modular security tool offering [behavior-based detection](https://app.crowdsec.net/hub/collections), including [AppSec rules](https://app.crowdsec.net/hub/appsec-rules), and optional components to block threats called [Remediation Components](https://app.crowdsec.net/hub/bouncers)
13
+
CrowdSec is modular: it provides [behavior-based detection](https://app.crowdsec.net/hub/collections), including [AppSec rules](https://app.crowdsec.net/hub/appsec-rules), and optional [Remediation Components](https://app.crowdsec.net/hub/bouncers) that enforce blocks.
14
14
15
15
<divstyle={{ display: "flex" }}>
16
16
<divstyle={{ textAlign: "center", flex: "1" }}>
@@ -23,20 +23,20 @@ CrowdSec is a modular security tool offering [behavior-based detection](https://
23
23
</div>
24
24
25
25
26
-
The crowd-sourced aspect allows the sharing of attacks they detected and blocked. Participants of this crowd-sourced threat intel receive, automatically via the security engine, a curated list of validated attackers (community blocklist) enhancing their real-time protection capabilities by taking preemptive actions against known threats.
26
+
CrowdSec is crowdsourced: when you participate, you share the attacks you detect and block. In return, the Security Engine automatically downloads a curated list of validated attackers (the community blocklist), so you can take action sooner against known threats.
27
27
28
28
## Main Features
29
29
30
30
In addition to the core "detect and react" mechanism, CrowdSec is committed to several other key aspects:
31
31
32
-
-**Easy Installation**: Effortless out-of-the-box installation on all [supported platforms](/u/getting_started/intro).
33
-
-**Simplified Daily Operations**: You have access to our Web UI administration via [CrowdSec's console](http://app.crowdsec.net) or the powerful [Command line tool cscli](/cscli/cscli.md) for effortless maintenance and keeping your detection mechanisms up-to-date.
34
-
-**Reproducibility**: The Security Engine can analyze not only live logs but also [cold logs](/u/user_guides/replay_mode), making it easier to detect potential false triggers, conduct forensic analysis, or generate reports.
35
-
-**Versatile**: The Security Engine can analyze[system logs](/log_processor/data_sources/introduction.md) and [HTTP Requests](/appsec/intro.md) to exhaustively protect your perimeter.
32
+
-**Easy Installation**: Get started quickly on all [supported platforms](/u/getting_started/intro).
33
+
-**Simplified Daily Operations**: Manage and maintain your setup from the [CrowdSec Console](http://app.crowdsec.net)(Web UI) or with the [cscli command-line tool](/cscli/cscli.md).
34
+
-**Reproducibility**: Analyze live logs and [cold logs](/u/user_guides/replay_mode)to validate detections, run forensic analysis, or generate reports.
35
+
-**Versatile**: Protect your perimeter by analyzing[system logs](/log_processor/data_sources/introduction.md) and [HTTP requests](/appsec/intro.md).
36
36
-**Observability**: Providing valuable insights into the system's activity:
37
-
-Users can view/manage alerts from the ([Console](https://app.crowdsec.net/signup)).
38
-
-Operations personnel have access to detailed Prometheus metrics ([Prometheus](/observability/prometheus.md)).
39
-
-Administrators can utilize a user-friendly command-line interface tool ([cscli](/observability/cscli.md)).
37
+
-View and manage alerts in the [Console](https://app.crowdsec.net/signup).
-Use the [cscli CLI](/observability/cscli.md) for administration.
40
40
-**API-Centric**: All components communicate via an [HTTP API](/local_api/intro.md), facilitating multi-machine setups.
41
41
42
42
## Architecture
@@ -49,23 +49,23 @@ In addition to the core "detect and react" mechanism, CrowdSec is committed to s
49
49
50
50
Under the hood, the Security Engine has various components:
51
51
52
-
- The [Log Processor](/log_processor/intro.mdx)is in charge of detection: it analyzes logs from [various data sources](/log_processor/data_sources/introduction.md)or[HTTP requests](/appsec/intro.md) from web servers.
53
-
- The [Appsec](appsec/intro) feature is part of the Log Processor and filters HTTP Requests from the compatible web servers.
54
-
- The [Local API](local_api/intro.md) acts as a middle man:
52
+
- The [Log Processor](/log_processor/intro.mdx)handles detection. It analyzes logs from [various data sources](/log_processor/data_sources/introduction.md)and[HTTP requests](/appsec/intro.md) from compatible web servers.
53
+
- The [Appsec](appsec/intro) feature is part of the Log Processor. It filters HTTP requests from compatible web servers.
54
+
- The [Local API](local_api/intro.md) acts as a middleman:
55
55
- Between the [Log Processors](/log_processor/intro.mdx) and the [Remediation Components](/u/bouncers/intro) which are in charge of enforcing decisions.
56
56
- And with the [Central API](/central_api/intro.md) to share alerts and receive blocklists.
57
-
- The [Remediation Components](/u/bouncers/intro)- also known as bouncers - block malicious IPs at your chosen level—whether via IpTables, firewalls, web servers, or reverse proxies. [See the full list on our CrowdSec Hub.](https://app.crowdsec.net/hub/remediation-components)
57
+
- The [Remediation Components](/u/bouncers/intro)(also called bouncers) block malicious IPs at your chosen level—IpTables, firewalls, web servers, or reverse proxies. [See the full list on the CrowdSec Hub.](https://app.crowdsec.net/hub/remediation-components)
58
58
59
59
## Deployment options
60
60
61
-
This architecture allows for both simple/standalone setups, or more distributed ones including as illustrated below:
61
+
This architecture supports simplestandalone setups and more distributed deployments:
62
62
63
-
- Single machine ? Follow our[getting started guide](/u/getting_started/intro)
64
-
- Multiple machines? Use the [distributed setup guide](/u/user_guides/multiserver_setup)
65
-
-Already have a log pit (such as rsyslog or loki)?[Run crowdsec next to it](/u/user_guides/log_centralization), not on the production workloads
66
-
-Running Kubernetes? Have a look at [our helm chart](/u/getting_started/installation/kubernetes)
67
-
-Running containers? The [docker data source](/log_processor/data_sources/docker.md) might be what you need
68
-
-Just looking for a WAF? Look at [our quickstart](appsec/intro)
63
+
- Single machine: Follow the[getting started guide](/u/getting_started/intro).
64
+
- Multiple machines: Use the [distributed setup guide](/u/user_guides/multiserver_setup).
65
+
-Centralized logs (rsyslog, Loki, ...):[Run CrowdSec next to your log pipeline](/u/user_guides/log_centralization), not on production workloads.
66
+
- Kubernetes: See [our Helm chart](/u/getting_started/installation/kubernetes).
67
+
-Containers: Use the [Docker data source](/log_processor/data_sources/docker.md).
68
+
-WAF only: Start with the [AppSec quickstart](appsec/intro).
0 commit comments