Skip to content

Commit c059a3e

Browse files
committed
typos
1 parent 6f3d358 commit c059a3e

File tree

15 files changed

+23
-23
lines changed

15 files changed

+23
-23
lines changed

crowdsec-docs/docs/appsec/alerts_and_scenarios.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ We can now create a scenario that will trigger when a single IPs triggers this r
115115
type: leaky
116116
format: 3.0
117117
name: crowdsecurity/foobar-enum
118-
description: "Ban IPs repeateadly triggering out of band rules"
118+
description: "Ban IPs repeatedly triggering out of band rules"
119119
filter: "evt.Meta.log_type == 'appsec-info' && evt.Meta.rule_name == 'crowdsecurity/foobar-access'"
120120
distinct: evt.Meta.target_uri
121121
leakspeed: "60s"

crowdsec-docs/docs/appsec/configuration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ sidebar_position: 6
66

77
## Overview
88

9-
This page explains the interraction between various files involved in AppSec configuration and the details about the processing pipeline AppSec request processing.
9+
This page explains the interaction between various files involved in AppSec configuration and the details about the processing pipeline AppSec request processing.
1010

1111
**Prerequisites**:
1212
- Familiarity with [AppSec concepts](/appsec/intro.md)
@@ -24,7 +24,7 @@ The goals of the acquisition file are:
2424
- To specify the **address** and **port** where the AppSec-enabled Remediation Component(s) will forward the requests to.
2525
- And specify one or more [AppSec configuration files](#appsec-configuration) to use as definition of what rules to apply and how.
2626

27-
Details can be found in the [AppSec Datasource page](/log_processor/data_sources/apps).
27+
Details can be found in the [AppSec Datasource page](/log_processor/data_sources/appsec.md).
2828

2929
### Defining Multiple AppSec Configurations
3030

crowdsec-docs/docs/appsec/quickstart/traefik.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Additionally, we'll show how to monitor these alerts through the [console](https
2525
- Traefik Plugin **[Remediation Component](/u/bouncers/intro)**: Thanks to [maxlerebourg](https://github.com/maxlerebourg) and team they created a [Traefik Plugin](https://plugins.traefik.io/plugins/6335346ca4caa9ddeffda116/crowdsec-bouncer-traefik-plugin) that allows you to block requests directly from Traefik.
2626

2727
:::info
28-
Prior to starting the guide ensure you are using the [Traefik Plugin](https://plugins.traefik.io/plugins/6335346ca4caa9ddeffda116/crowdsec-bouncer-traefik-plugin) and **NOT** the older [traefik-crowdsec-bouncer](https://app.crowdsec.net/hub/author/fbonalair/remediation-components/traefik-crowdsec-bouncer) as it hasnt recieved updates to use the new AppSec Component.
28+
Prior to starting the guide ensure you are using the [Traefik Plugin](https://plugins.traefik.io/plugins/6335346ca4caa9ddeffda116/crowdsec-bouncer-traefik-plugin) and **NOT** the older [traefik-crowdsec-bouncer](https://app.crowdsec.net/hub/author/fbonalair/remediation-components/traefik-crowdsec-bouncer) as it hasnt received updates to use the new AppSec Component.
2929
:::
3030

3131
:::warning
@@ -77,7 +77,7 @@ If you have a folder in which you are persisting the configuration files, you ca
7777
There steps will change depending on how you are running the Security Engine. If you are running via `docker run` then you should launch the container within the same directory as the `appsec.yaml` file. If you are using `docker-compose` you can use a relative file mount to mount the `appsec.yaml` file.
7878

7979
Steps:
80-
1. Change to the location where you exectued the `docker run` or `docker compose` command.
80+
1. Change to the location where you executted the `docker run` or `docker compose` command.
8181
2. Create a `appsec.yaml` file at the base of the directory.
8282
3. Add the following content to the `appsec.yaml` file.
8383

@@ -96,11 +96,11 @@ Since CrowdSec is running inside a container you must set the `listen_addr` to `
9696

9797
<FormattedTabs
9898
docker={`# Note if you have a docker run already running you will need to stop it before running this command
99-
docker run -d --name crowdsec -v /path/to/orginal:/etc/crowdsec -v ./appsec.yaml:/etc/crowdsec/acquis.d/appsec.yaml crowdsecurity/crowdsec`}
99+
docker run -d --name crowdsec -v /path/to/original:/etc/crowdsec -v ./appsec.yaml:/etc/crowdsec/acquis.d/appsec.yaml crowdsecurity/crowdsec`}
100100
dockerCompose={`services:
101101
crowdsec:
102102
volumes:
103-
- /path/to/orginal:/etc/crowdsec ## or named volumes
103+
- /path/to/original:/etc/crowdsec ## or named volumes
104104
- ./appsec.yaml:/etc/crowdsec/acquis.d/appsec.yaml`}
105105
/>
106106

crowdsec-docs/docs/getting_started/crowdsec_tour.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -250,7 +250,7 @@ Those metrics are a great way to know if your configuration is correct:
250250
The `Acquisition Metrics` is a great way to know if your parsers are setup correctly:
251251

252252
- If you have 0 **LINES PARSED** for a source : You are probably *missing* a parser, or you have a custom log format that prevents the parser from understanding your logs.
253-
- However, it's perfectly OK to have a lot of **LINES UNPARSED** : Crowdsec is not a SIEM, and only parses the logs that are relevant to its scenarios. For example, [ssh parser](https://hub.crowdsec.net/author/crowdsecurity/configurations/sshd-logs), only cares about failed authentication events (at the time of writting).
253+
- However, it's perfectly OK to have a lot of **LINES UNPARSED** : Crowdsec is not a SIEM, and only parses the logs that are relevant to its scenarios. For example, [ssh parser](https://hub.crowdsec.net/author/crowdsecurity/configurations/sshd-logs), only cares about failed authentication events (at the time of writing).
254254
- **LINES POURED TO BUCKET** tell you that your scenarios are matching your log sources : it means that some events from this log source made all their way to an actual scenario
255255

256256

crowdsec-docs/docs/log_processor/data_sources/introduction.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Make sure the same data sources are not ingested more than once: duplicating inp
3434
Examples:
3535

3636
- If an application logs to both `journald` and `/var/log/*`, you usually only need one of them.
37-
- If an application writes to `/var/log/syslog` or `/var/log/messages`, it’s already acquired by `setup.linux.yaml` (since 1.7) or `acquis.yam`. You don’t need to add a separate acquisition for the same logs.
37+
- If an application writes to `/var/log/syslog` or `/var/log/messages`, it’s already acquired by `setup.linux.yaml` (since 1.7) or `acquis.yaml`. You don’t need to add a separate acquisition for the same logs.
3838

3939
:::
4040

@@ -56,7 +56,7 @@ Name | Type | Stream | One-shot
5656
-----|------|--------|----------
5757
[Appsec](/log_processor/data_sources/appsec) | expose HTTP service for the Appsec component | yes | no
5858
[AWS cloudwatch](/log_processor/data_sources/cloudwatch) | single stream or log group | yes | yes
59-
[AWS kinesis](/log_processor/data_sources/kinesis)| read logs from a kinesis strean | yes | no
59+
[AWS kinesis](/log_processor/data_sources/kinesis)| read logs from a kinesis stream | yes | no
6060
[AWS S3](/log_processor/data_sources/s3)| read logs from a S3 bucket | yes | yes
6161
[docker](/log_processor/data_sources/docker) | read logs from docker containers | yes | yes
6262
[file](/log_processor/data_sources/file) | single files, glob expressions and .gz files | yes | yes
@@ -105,7 +105,7 @@ By default, when reading logs in real-time, crowdsec will use the time at which
105105

106106
Setting this option to `true` will force crowdsec to use the timestamp from the log as the time of the event.
107107

108-
It is mandatory to set this if your application buffers logs before writting them (for example, IIS when writing to a log file, or logs written to S3 from almost any AWS service).<br/>
108+
It is mandatory to set this if your application buffers logs before writing them (for example, IIS when writing to a log file, or logs written to S3 from almost any AWS service).<br/>
109109
If not set, then crowdsec will think all logs happened at once, which can lead to some false positive detections.
110110

111111
### `labels`

crowdsec-docs/docs/log_processor/data_sources/syslog_service.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,6 @@ This module does not support command-line acquisition.
5151

5252
:::warning
5353
This syslog datasource is currently intended for small setups, and is at risk of losing messages over a few hundreds events/second.
54-
To process significant amounts of logs, rely on dedicated syslog server such as [rsyslog](https://www.rsyslog.com/), with this server writting logs to files that Security Engine will read from.
54+
To process significant amounts of logs, rely on dedicated syslog server such as [rsyslog](https://www.rsyslog.com/), with this server writing logs to files that Security Engine will read from.
5555
This page will be updated with further improvements of this data source.
56-
:::
56+
:::

crowdsec-docs/docs/log_processor/data_sources/troubleshoot.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ sidebar_position: 10
55
---
66

77
The [prometheus](/observability/prometheus.md) instrumentation exposes metrics about acquisition and data sources.
8-
Those can as well be view via `cscli metrics` :
8+
Those can as well be viewed via `cscli metrics` :
99

1010
```bash
1111
INFO[19-08-2021 06:33:31 PM] Acquisition Metrics:

crowdsec-docs/unversioned/bouncers/haproxy.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ This component is compatible with HAProxy version 2.5 and higher.
4343

4444
## How does it work ?
4545

46-
This component leverages haproxy lua's API to check e IP address against the local API.
46+
This component leverages haproxy lua's API to check the IP address against the local API.
4747

4848
Supported features:
4949

crowdsec-docs/unversioned/bouncers/ingress-nginx.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -312,7 +312,7 @@ CAPTCHA_PROVIDER=recaptcha
312312
```
313313

314314
:::info
315-
For backwards compatability reasons `recaptcha` is the default if no value is set.
315+
For backwards compatibility reasons `recaptcha` is the default if no value is set.
316316
:::
317317

318318
### `SECRET_KEY`

crowdsec-docs/unversioned/bouncers/nginx.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -515,7 +515,7 @@ CAPTCHA_PROVIDER=<recaptcha
515515
```
516516
517517
:::info
518-
For backwards compatability reasons `recaptcha` is the default if no value is set.
518+
For backwards compatibility reasons `recaptcha` is the default if no value is set.
519519
:::
520520
521521
### `SECRET_KEY`

0 commit comments

Comments
 (0)