Typos, grammar (#1905)
This commit is contained in:
mmetc
GitHub
parent
fdda940ac0
commit
cc228f1868
14
README.md
14
README.md
|
|
@ -32,11 +32,11 @@
|
|||
</p>
|
||||
|
||||
|
||||
:dancer: This is a community driven project, <a href="https://forms.gle/ZQBQcptG2wYGajRX8">we need your feedback</a>.
|
||||
:dancer: This is a community-driven project, <a href="https://forms.gle/ZQBQcptG2wYGajRX8">we need your feedback</a>.
|
||||
|
||||
## <TL;DR>
|
||||
|
||||
CrowdSec is a free, modern & collaborative behavior detection engine, coupled with a global IP reputation network. It stacks on fail2ban's philosophy but is IPV6 compatible and 60x faster (Go vs Python), uses Grok patterns to parse logs and YAML scenario to identify behaviors. CrowdSec is engineered for modern Cloud / Containers / VM based infrastructures (by decoupling detection and remediation). Once detected you can remedy threats with various bouncers (firewall block, nginx http 403, Captchas, etc.) while the aggressive IP can be sent to CrowdSec for curation before being shared among all users to further improve everyone's security. See [FAQ](https://doc.crowdsec.net/docs/faq) or read below for more.
|
||||
CrowdSec is a free, modern & collaborative behavior detection engine, coupled with a global IP reputation network. It stacks on fail2ban's philosophy but is IPV6 compatible and 60x faster (Go vs Python), it uses Grok patterns to parse logs and YAML scenarios to identify behaviors. CrowdSec is engineered for modern Cloud / Containers / VM-based infrastructures (by decoupling detection and remediation). Once detected you can remedy threats with various bouncers (firewall block, nginx http 403, Captchas, etc.) while the aggressive IP can be sent to CrowdSec for curation before being shared among all users to further improve everyone's security. See [FAQ](https://doc.crowdsec.net/docs/faq) or read below for more.
|
||||
|
||||
## 2 mins install
|
||||
|
||||
|
|
@ -75,7 +75,7 @@ cd crowdsec-v* && sudo ./wizard.sh -i
|
|||
|
||||
## :information_source: About the CrowdSec project
|
||||
|
||||
Crowdsec is an open-source, lightweight software, detecting peers with aggressive behaviors to prevent them from accessing your systems. Its user friendly design and assistance offers a low technical barrier of entry and nevertheless a high security gain.
|
||||
Crowdsec is an open-source, lightweight software, detecting peers with aggressive behaviors to prevent them from accessing your systems. Its user-friendly design and assistance offer a low technical barrier of entry and nevertheless a high security gain.
|
||||
|
||||
The architecture is as follows :
|
||||
|
||||
|
|
@ -87,15 +87,15 @@ Once an unwanted behavior is detected, deal with it through a [bouncer](https://
|
|||
|
||||
## Outnumbering hackers all together
|
||||
|
||||
By sharing the threat they faced, all users are protecting each-others (hence the name Crowd-Security). Crowdsec is designed for modern infrastructures, with its "*Detect Here, Remedy There*" approach, letting you analyse logs coming from several sources in one place and block threats at various levels (applicative, system, infrastructural) of your stack.
|
||||
By sharing the threat they faced, all users are protecting each-others (hence the name Crowd-Security). Crowdsec is designed for modern infrastructures, with its "*Detect Here, Remedy There*" approach, letting you analyze logs coming from several sources in one place and block threats at various levels (applicative, system, infrastructural) of your stack.
|
||||
|
||||
CrowdSec ships by default with scenarios (brute force, port scan, web scan, etc.) adapted for most context, but you can easily extend it by picking more of them from the **[HUB](https://hub.crowdsec.net)**. It is also easy to adapt an existing one or create one yourself.
|
||||
CrowdSec ships by default with scenarios (brute force, port scan, web scan, etc.) adapted for most contexts, but you can easily extend it by picking more of them from the **[HUB](https://hub.crowdsec.net)**. It is also easy to adapt an existing one or create one yourself.
|
||||
|
||||
## :point_right: What it is not
|
||||
|
||||
CrowdSec is not a SIEM, storing your logs (neither locally nor remotely). Your data are analyzed locally and forgotten.
|
||||
|
||||
Signals sent to the curation platform are limited to the very strict minimum: IP, Scenario, Timestamp. They are only used to allow the system to spot new rogue IPs, rule out false positives or poisoning attempts.
|
||||
Signals sent to the curation platform are limited to the very strict minimum: IP, Scenario, Timestamp. They are only used to allow the system to spot new rogue IPs, and rule out false positives or poisoning attempts.
|
||||
|
||||
## :arrow_down: Install it !
|
||||
|
||||
|
|
@ -141,7 +141,7 @@ Or look directly at [installation documentation](https://doc.crowdsec.net/docs/g
|
|||
### Hot & Cold logs
|
||||
|
||||
<details>
|
||||
<summary>Process cold logs, for forensic, tests and chasing false-positives & false negatives (click to expand)</summary>
|
||||
<summary>Process cold logs, for forensic, tests and chasing false positives & false negatives (click to expand)</summary>
|
||||
<img src="https://github.com/crowdsecurity/crowdsec-docs/blob/main/crowdsec-docs/static/img/forensic-mode.gif?raw=true">
|
||||
</details>
|
||||
|
||||
|
|
|
|||
4
debian/control
vendored
4
debian/control
vendored
|
|
@ -4,5 +4,5 @@ Build-Depends: debhelper, jq, bash, git
|
|||
|
||||
Package: crowdsec
|
||||
Architecture: any
|
||||
Description: Crowdsec - An open-source, lightweight agent to detect and respond to bad behaviours. It also automatically benefits from our global community-wide IP reputation database
|
||||
Depends: coreutils
|
||||
Description: Crowdsec - An open-source, lightweight agent to detect and respond to bad behaviors. It also automatically benefits from our global community-wide IP reputation database
|
||||
Depends: coreutils
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
|
||||
# What is Crowdsec
|
||||
|
||||
Crowdsec - An open-source, lightweight agent to detect and respond to bad behaviours. It also automatically benefits from our global community-wide IP reputation database.
|
||||
Crowdsec - An open-source, lightweight agent to detect and respond to bad behaviors. It also automatically benefits from our global community-wide IP reputation database.
|
||||
|
||||
# How to use this image
|
||||
|
||||
|
|
@ -124,7 +124,7 @@ Check this full-stack example using docker-compose: https://github.com/crowdsecu
|
|||
The container is built with a specific docker
|
||||
[configuration](https://github.com/crowdsecurity/crowdsec/blob/master/docker/config.yaml).
|
||||
If you need to change it and the docker variables (see below) are not enough,
|
||||
you can bind `/etc/crowdsec/config.yaml` to your a configuration file.
|
||||
you can bind `/etc/crowdsec/config.yaml` to your configuration file.
|
||||
|
||||
## Notifications
|
||||
If you wish to use the [notification system](https://docs.crowdsec.net/docs/notification_plugins/intro), you will need to mount at least a custom `profiles.yaml` and a notification configuration to `/etc/crowdsec/notifications`
|
||||
|
|
|
|||
|
|
@ -60,7 +60,7 @@ func (c *Config) LoadDBConfig() error {
|
|||
|
||||
if c.DbConfig.Type == "sqlite" {
|
||||
if c.DbConfig.UseWal == nil {
|
||||
log.Warning("You are using sqlite without WAL, this can have an impact of performance. If you do not store the database in a network share, set db_config.use_wal to true. Set explicitly to false to disable this warning.")
|
||||
log.Warning("You are using sqlite without WAL, this can have a performance impact. If you do not store the database in a network share, set db_config.use_wal to true. Set explicitly to false to disable this warning.")
|
||||
}
|
||||
|
||||
}
|
||||
|
|
|
|||
|
|
@ -58,7 +58,7 @@ statics:
|
|||
### OnSuccess flag
|
||||
> `onsuccess: next_stage|continue`
|
||||
|
||||
- *mandatory* indicates the behaviour to follow if node succeeds. `next_stage` make line go to next stage, while `continue` will continue processing of current stage.
|
||||
- *mandatory* indicates the behavior to follow if the node succeeds. `next_stage` make the line go to the next stage, while `continue` will continue processing the current stage.
|
||||
|
||||
### Statics
|
||||
|
||||
|
|
@ -107,7 +107,7 @@ grok:
|
|||
pattern: "^%{GREEDYDATA:request}\\?%{GREEDYDATA:http_args}$"
|
||||
apply_on: request
|
||||
```
|
||||
`pattern` which is a valid pattern, optionally with a `apply_on` that indicates to which field it should be applied
|
||||
`pattern` which is a valid pattern, optionally with an `apply_on` that indicates to which field it should be applied
|
||||
|
||||
|
||||
### Patterns syntax
|
||||
|
|
@ -123,7 +123,7 @@ pattern_syntax:
|
|||
|
||||
### Enrichment
|
||||
|
||||
Enrichment mechanism is exposed via statics :
|
||||
The Enrichment mechanism is exposed via statics :
|
||||
|
||||
```yaml
|
||||
statics:
|
||||
|
|
@ -162,7 +162,7 @@ statics: #D
|
|||
value: http
|
||||
```
|
||||
|
||||
The evaluation process of a node is as follow :
|
||||
The evaluation process of a node is as follows:
|
||||
- apply the `filter` (A), if it doesn't match, exit
|
||||
- iterate over the list of nodes (A') and apply the node process to each.
|
||||
- if a `grok` entry is present, process it
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
Name: crowdsec
|
||||
Version: %(echo $VERSION)
|
||||
Release: %(echo $PACKAGE_NUMBER)%{?dist}
|
||||
Summary: Crowdsec - An open-source, lightweight agent to detect and respond to bad behaviours. It also automatically benefits from our global community-wide IP reputation database
|
||||
Summary: Crowdsec - An open-source, lightweight agent to detect and respond to bad behaviors. It also automatically benefits from our global community-wide IP reputation database
|
||||
|
||||
License: MIT
|
||||
URL: https://crowdsec.net
|
||||
|
|
|
|||
Loading…
Reference in a new issue