Skip to content

Commit 1f95eb8

Browse files
enhance: Whitelist change name key to not conflict with our official one (#648)
1 parent fb86358 commit 1f95eb8

File tree

10 files changed

+15
-15
lines changed

10 files changed

+15
-15
lines changed

crowdsec-docs/docs/whitelist/expr_based_whitelist.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Let's whitelist a **specific** user-agent (of course, it's just an example, don'
88
Since we are using data that is present from the parsing stage we can do this within `Parsing Whitelist` level. Please see [introduction](/whitelist/introduction.md) for your OS specific paths.
99

1010
```yaml
11-
name: crowdsecurity/whitelists
11+
name: "my/whitelist" ## Must be unique
1212
description: "Whitelist events from private ipv4 addresses"
1313
whitelist:
1414
reason: "private ipv4 ranges"
@@ -116,7 +116,7 @@ line: 5.5.8.5 - - [04/Jan/2020:07:25:02 +0000] "GET /.well-known/acme-challenge/
116116
| ├ create evt.Parsed.static_ressource : false
117117
| ├ create evt.Parsed.file_dir : /.well-known/acme-challenge/
118118
| ├ create evt.Meta.http_args_len : 0
119-
| └ 🟢 crowdsecurity/whitelists (unchanged)
119+
| └ 🟢 my/whitelist (unchanged)
120120
├-------- parser success 🟢
121121
├ Scenarios
122122
├ 🟢 crowdsecurity/http-crawl-non_statics

crowdsec-docs/docs/whitelist/format.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ sidebar_position: 2
77
## Whitelist configuration example
88

99
```yaml
10-
name: crowdsecurity/my-whitelists
10+
name: "my/whitelist" ## Must be unique
1111
description: "Whitelist events from my ipv4 addresses"
1212
#it's a normal parser, so we can restrict its scope with filter
1313
filter: "1 == 1"

crowdsec-docs/docs/whitelist/fqdn_based_whitelist.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ You might want to whitelist a fully qualified domain name (FQDN eg foo.com), in
1414
Let's create the following file `FQDN-whitelists.yaml` (See [introduction](/whitelist/introduction.md) for your OS specific path) :
1515

1616
```yaml
17-
name: me/FQDN-whitlists
17+
name: "my/FQDN-whitlists" ## Must be unique
1818
description: "Whitelist postoverflows from FQDN"
1919
whitelist:
2020
reason: "do whitelistings by FQDN"

crowdsec-docs/docs/whitelist/ip_based_whitelist.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ IP whitelists are best suited at `Parser whitelists` level because once the log
88
We will create the file `mywhitelist.yaml` please see [introduction](/whitelist/introduction.md) for your OS specific paths.
99

1010
```yaml
11-
name: crowdsecurity/whitelists
11+
name: "my/whitelist" ## Must be unique
1212
description: "Whitelist events from my ip addresses"
1313
whitelist:
1414
reason: "my ip ranges"

crowdsec-docs/docs/whitelist/postoverflow_based_whitelist.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ First of all, install the [crowdsecurity/rdns postoverflow](https://hub.crowdsec
2424
Let's create `mywhitelist.yaml` again but remember this is a postoverflow whitelist so the paths will be different to `Parsing whitelists` please see [introduction](/whitelist/introduction.md) for your OS specific path.
2525

2626
```yaml
27-
name: me/my_cool_whitelist
27+
name: "my/po_whitelist" ## Must be unique
2828
description: lets whitelist our own reverse dns
2929
whitelist:
3030
reason: dont ban my ISP

crowdsec-docs/versioned_docs/version-v1.3.4/whitelist/create.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ sudo cscli decisions list
4343
Let's create a `/etc/crowdsec/parsers/s02-enrich/mywhitelists.yaml` file with the following content :
4444

4545
```yaml
46-
name: crowdsecurity/whitelists
46+
name: my/whitelist
4747
description: "Whitelist events from my ip addresses"
4848
whitelist:
4949
reason: "my ip ranges"
@@ -85,7 +85,7 @@ Now, let's make something more tricky : let's whitelist a **specific** user-agen
8585
Let's change our whitelist to :
8686

8787
```yaml
88-
name: crowdsecurity/whitelists
88+
name: my/whitelist
8989
description: "Whitelist events from private ipv4 addresses"
9090
whitelist:
9191
reason: "private ipv4 ranges"

crowdsec-docs/versioned_docs/version-v1.4.0/whitelist/create.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ sudo cscli decisions list
4343
Let's create a `/etc/crowdsec/parsers/s02-enrich/mywhitelists.yaml` file with the following content :
4444

4545
```yaml
46-
name: crowdsecurity/whitelists
46+
name: my/whitelist
4747
description: "Whitelist events from my ip addresses"
4848
whitelist:
4949
reason: "my ip ranges"
@@ -85,7 +85,7 @@ Now, let's make something more tricky : let's whitelist a **specific** user-agen
8585
Let's change our whitelist to :
8686

8787
```yaml
88-
name: crowdsecurity/whitelists
88+
name: my/whitelist
8989
description: "Whitelist events from private ipv4 addresses"
9090
whitelist:
9191
reason: "private ipv4 ranges"

crowdsec-docs/versioned_docs/version-v1.5.0/whitelist/create.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ sudo cscli decisions list
4343
Let's create a `/etc/crowdsec/parsers/s02-enrich/mywhitelists.yaml` file with the following content :
4444

4545
```yaml
46-
name: crowdsecurity/whitelists
46+
name: my/whitelist
4747
description: "Whitelist events from my ip addresses"
4848
whitelist:
4949
reason: "my ip ranges"
@@ -85,7 +85,7 @@ Now, let's make something more tricky : let's whitelist a **specific** user-agen
8585
Let's change our whitelist to :
8686

8787
```yaml
88-
name: crowdsecurity/whitelists
88+
name: my/whitelist
8989
description: "Whitelist events from private ipv4 addresses"
9090
whitelist:
9191
reason: "private ipv4 ranges"

crowdsec-docs/versioned_docs/version-v1.6.0/whitelist/expr_based_whitelist.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Let's whitelist a **specific** user-agent (of course, it's just an example, don'
88
Since we are using data that is present from the parsing stage we can do this within `Parsing Whitelist` level. Please see [introduction](/whitelist/introduction.md) for your OS specific paths.
99

1010
```yaml
11-
name: crowdsecurity/whitelists
11+
name: my/whitelist
1212
description: "Whitelist events from private ipv4 addresses"
1313
whitelist:
1414
reason: "private ipv4 ranges"
@@ -116,7 +116,7 @@ line: 5.5.8.5 - - [04/Jan/2020:07:25:02 +0000] "GET /.well-known/acme-challenge/
116116
| ├ create evt.Parsed.static_ressource : false
117117
| ├ create evt.Parsed.file_dir : /.well-known/acme-challenge/
118118
| ├ create evt.Meta.http_args_len : 0
119-
| └ 🟢 crowdsecurity/whitelists (unchanged)
119+
| └ 🟢 my/whitelist (unchanged)
120120
├-------- parser success 🟢
121121
├ Scenarios
122122
├ 🟢 crowdsecurity/http-crawl-non_statics

crowdsec-docs/versioned_docs/version-v1.6.0/whitelist/ip_based_whitelist.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ IP whitelists are best suited at `Parser whitelists` level because once the log
88
We will create the file `mywhitelist.yaml` please see [introduction](/whitelist/introduction.md) for your OS specific paths.
99

1010
```yaml
11-
name: crowdsecurity/whitelists
11+
name: my/whitelist
1212
description: "Whitelist events from my ip addresses"
1313
whitelist:
1414
reason: "my ip ranges"

0 commit comments

Comments
 (0)