Skip to content

Commit 08be5c2

Browse files
committed
wip
1 parent fb86358 commit 08be5c2

File tree

3 files changed

+38
-5
lines changed

3 files changed

+38
-5
lines changed

crowdsec-docs/docs/intro.mdx

Lines changed: 38 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,25 @@ id: intro
77
import useBaseUrl from '@docusaurus/useBaseUrl';
88
import AcademyPromo from '@site/src/components/AcademyPromo';
99

10+
<!-- @tko
11+
12+
- replace the image with a gif
13+
- edit the image to have the same background color
14+
- add the cool miniature for the console
15+
16+
-->
17+
1018
<div style={{display: 'flex'}}>
1119
<div style={{textAlign: 'center', flex: '1'}}>
12-
<img width="800" height="auto" src={useBaseUrl('/img/crowdsec_ecosystem.png')} />
20+
<img width="800" height="auto" src={useBaseUrl('/img/simplified_SE_overview.png')} />
1321
</div>
1422
</div>
1523
&nbsp;
1624
&nbsp;
1725

18-
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 analysis and threat patterns called scenarios.
26+
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.
1927

20-
CrowdSec is a modular framework, offering a variety of [popular scenarios](https://app.crowdsec.net/hub/collections). Users can choose their protection scenarios and deploy [Remediation Components](https://app.crowdsec.net/hub/bouncers) to block malicious access.
28+
CrowdSec is a modular framework, offering a variety of [scenarios](https://app.crowdsec.net/hub/collections). Users can choose their protection scenarios and deploy [Remediation Components](https://app.crowdsec.net/hub/bouncers) to block malicious access.
2129

2230
The crowd-sourced aspect allows sharing attack information among users, enhancing real-time attack detection and preemptive blocking of known bad actors from your system.
2331

@@ -26,8 +34,9 @@ The crowd-sourced aspect allows sharing attack information among users, enhancin
2634
In addition to the core "detect and react" mechanism, CrowdSec is committed to several other key aspects:
2735

2836
- **Easy Installation**: Effortless out-of-the-box installation on all [supported platforms](/getting_started/versions_matrix.md).
29-
- **Simplified Daily Operations**: Use [cscli](/cscli/cscli.md) and the [hub](http://hub.crowdsec.net) for effortless maintenance and keeping your detection mechanisms up-to-date.
37+
- **Simplified Daily Operations**: Use the [console](http://app.crowdsec.net) and [cscli](/cscli/cscli.md) for effortless maintenance and keeping your detection mechanisms up-to-date.
3038
- **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.
39+
- **Versatile**: The Security Engine can analyze [system logs](/docs/data_sources/intro) and [HTTP Requests](/docs/next/appsec/intro) to exhaustively protect your perimeter.
3140
- **Observability**: Providing valuable insights into the system's activity:
3241
- Users can view/manage alerts from the ([Console](https://app.crowdsec.net/signup)).
3342
- Operations personnel have access to detailed Prometheus metrics ([Prometheus](/observability/prometheus.md)).
@@ -38,12 +47,36 @@ In addition to the core "detect and react" mechanism, CrowdSec is committed to s
3847
## Architecture
3948

4049

50+
<!-- @kka : update schema:
51+
- align text
52+
- rename data sources to log sources
53+
- move log sources out of the SE box
54+
-->
4155
<div style={{display: 'flex'}}>
4256
<div style={{textAlign: 'center', flex: '1'}}>
43-
<img src={useBaseUrl('/img/crowdsec_architecture.png')}></img>
57+
<img src={useBaseUrl('/img/simplified_SE_underthehood.gif')}></img>
4458
</div>
4559
</div>
4660

61+
Under the hood, the Security Engine has various components:
62+
63+
- The [Log Processor](...) is in charge of detection: it analyzes logs from various data sources or HTTP requests from web servers.
64+
- The [Local API](...) acts as a middle man between the [Log Processors](...) and the [Remediation Components](...) which are in charge of enforcing decisions.
65+
- The [Remediation Components](...) - also known as bouncers - are in charge of blocking bad IPs by using the components already available.
66+
67+
68+
<!-- @tko
69+
- decide which ones to keep in the list and make (short) dedicated pages for those
70+
-->
71+
72+
This architecture allows great flexibility in setups. Find the one relevant to you:
73+
- I have one or more machine with no log pit (ie. VPS)
74+
- I have an existing log pit (ie. rsyslog)
75+
- I am running containers
76+
- I am running kubernetes
77+
- Just show me an example architecture
78+
79+
4780
<AcademyPromo
4881
image="crowdsec_fundamentals.svg"
4982
description="Watch a short series of videos on how to install CrowdSec and protect your infrastructure"
129 KB
Loading
750 KB
Loading

0 commit comments

Comments
 (0)