From cc228f18685d68c643a28dec0a2e342c494f3938 Mon Sep 17 00:00:00 2001 From: mmetc <92726601+mmetc@users.noreply.github.com> Date: Tue, 6 Dec 2022 15:55:27 +0100 Subject: [PATCH] Typos, grammar (#1905) --- README.md | 14 +++++++------- debian/control | 4 ++-- docker/README.md | 4 ++-- pkg/csconfig/database.go | 2 +- pkg/parser/README.md | 8 ++++---- rpm/SPECS/crowdsec.spec | 2 +- 6 files changed, 17 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index b90b5e38a..6428c3a80 100644 --- a/README.md +++ b/README.md @@ -32,11 +32,11 @@

-:dancer: This is a community driven project, we need your feedback. +:dancer: This is a community-driven project, we need your feedback. ## -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
- Process cold logs, for forensic, tests and chasing false-positives & false negatives (click to expand) + Process cold logs, for forensic, tests and chasing false positives & false negatives (click to expand)
diff --git a/debian/control b/debian/control index b2d2bac20..ef727ec0b 100644 --- a/debian/control +++ b/debian/control @@ -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 \ No newline at end of file +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 diff --git a/docker/README.md b/docker/README.md index d1d1102c0..23e8c8945 100644 --- a/docker/README.md +++ b/docker/README.md @@ -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` diff --git a/pkg/csconfig/database.go b/pkg/csconfig/database.go index 85b75d737..65aa23e4a 100644 --- a/pkg/csconfig/database.go +++ b/pkg/csconfig/database.go @@ -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.") } } diff --git a/pkg/parser/README.md b/pkg/parser/README.md index 46111e3c1..62a56e618 100644 --- a/pkg/parser/README.md +++ b/pkg/parser/README.md @@ -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 diff --git a/rpm/SPECS/crowdsec.spec b/rpm/SPECS/crowdsec.spec index fb6ab4e3c..41ed04d12 100644 --- a/rpm/SPECS/crowdsec.spec +++ b/rpm/SPECS/crowdsec.spec @@ -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