Skip to content

Commit 3f03e10

Browse files
enhance: make example clearer in whitelist (#875)
* enhance: make example clearer in whitelist * enhance: add note to say replace with WAN
1 parent 858ac18 commit 3f03e10

File tree

6 files changed

+17
-17
lines changed

6 files changed

+17
-17
lines changed

crowdsec-docs/docs/log_processor/whitelist/ip_based_whitelist.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ description: "Whitelist events from my ip addresses"
1313
whitelist:
1414
reason: "my ip ranges"
1515
ip:
16-
- "80.x.x.x"
16+
- "192.168.1.1" # Replace with your WAN IP
1717
cidr:
18-
- "80.x.x.x/24"
18+
- "192.168.1.0/24" # Replace with your WAN IP range
1919
```
2020
2121
```bash title="Reload CrowdSec"

crowdsec-docs/docs/log_processor/whitelist/postoverflow_based_whitelist.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,12 +47,12 @@ Tail the crowdsec log
4747
tail -f /var/log/crowdsec.log
4848
```
4949

50-
You should be able to see the following output:
50+
You should be able to see the following output (note: the IP shown will be your actual WAN IP, not the example):
5151

5252
```
53-
time="07-07-2020 17:11:09" level=info msg="Ban for 80.x.x.x whitelisted, reason [dont ban my ISP]" id=cold-sunset name=me/my_cool_whitelist stage=s01
54-
time="07-07-2020 17:11:09" level=info msg="node warning : no remediation" bucket_id=blue-cloud event_time="2020-07-07 17:11:09.175068053 +0200 CEST m=+2308.040825320" scenario=crowdsecurity/http-probing source_ip=80.x.x.x
55-
time="07-07-2020 17:11:09" level=info msg="Processing Overflow with no decisions 80.x.x.x performed 'crowdsecurity/http-probing' (11 events over 313.983994ms) at 2020-07-07 17:11:09.175068053 +0200 CEST m=+2308.040825320" bucket_id=blue-cloud event_time="2020-07-07 17:11:09.175068053 +0200 CEST m=+2308.040825320" scenario=crowdsecurity/http-probing source_ip=80.x.x.x
53+
time="07-07-2020 17:11:09" level=info msg="Ban for 192.168.1.1 whitelisted, reason [dont ban my ISP]" id=cold-sunset name=me/my_cool_whitelist stage=s01
54+
time="07-07-2020 17:11:09" level=info msg="node warning : no remediation" bucket_id=blue-cloud event_time="2020-07-07 17:11:09.175068053 +0200 CEST m=+2308.040825320" scenario=crowdsecurity/http-probing source_ip=192.168.1.1
55+
time="07-07-2020 17:11:09" level=info msg="Processing Overflow with no decisions 192.168.1.1 performed 'crowdsecurity/http-probing' (11 events over 313.983994ms) at 2020-07-07 17:11:09.175068053 +0200 CEST m=+2308.040825320" bucket_id=blue-cloud event_time="2020-07-07 17:11:09.175068053 +0200 CEST m=+2308.040825320" scenario=crowdsecurity/http-probing source_ip=192.168.1.1
5656
```
5757

5858
This time, we can see that logs are being produced when the event is discarded.

crowdsec-docs/versioned_docs/version-v1.6/log_processor/whitelist/ip_based_whitelist.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ description: "Whitelist events from my ip addresses"
1313
whitelist:
1414
reason: "my ip ranges"
1515
ip:
16-
- "80.x.x.x"
16+
- "192.168.1.1" # Replace with your WAN IP
1717
cidr:
18-
- "80.x.x.x/24"
18+
- "192.168.1.0/24" # Replace with your WAN IP range
1919
```
2020
2121
```bash title="Reload CrowdSec"

crowdsec-docs/versioned_docs/version-v1.6/log_processor/whitelist/postoverflow_based_whitelist.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,9 @@ tail -f /var/log/crowdsec.log
5050
You should be able to see the following output:
5151

5252
```
53-
time="07-07-2020 17:11:09" level=info msg="Ban for 80.x.x.x whitelisted, reason [dont ban my ISP]" id=cold-sunset name=me/my_cool_whitelist stage=s01
54-
time="07-07-2020 17:11:09" level=info msg="node warning : no remediation" bucket_id=blue-cloud event_time="2020-07-07 17:11:09.175068053 +0200 CEST m=+2308.040825320" scenario=crowdsecurity/http-probing source_ip=80.x.x.x
55-
time="07-07-2020 17:11:09" level=info msg="Processing Overflow with no decisions 80.x.x.x performed 'crowdsecurity/http-probing' (11 events over 313.983994ms) at 2020-07-07 17:11:09.175068053 +0200 CEST m=+2308.040825320" bucket_id=blue-cloud event_time="2020-07-07 17:11:09.175068053 +0200 CEST m=+2308.040825320" scenario=crowdsecurity/http-probing source_ip=80.x.x.x
53+
time="07-07-2020 17:11:09" level=info msg="Ban for 192.168.1.1 whitelisted, reason [dont ban my ISP]" id=cold-sunset name=me/my_cool_whitelist stage=s01
54+
time="07-07-2020 17:11:09" level=info msg="node warning : no remediation" bucket_id=blue-cloud event_time="2020-07-07 17:11:09.175068053 +0200 CEST m=+2308.040825320" scenario=crowdsecurity/http-probing source_ip=192.168.1.1
55+
time="07-07-2020 17:11:09" level=info msg="Processing Overflow with no decisions 192.168.1.1 performed 'crowdsecurity/http-probing' (11 events over 313.983994ms) at 2020-07-07 17:11:09.175068053 +0200 CEST m=+2308.040825320" bucket_id=blue-cloud event_time="2020-07-07 17:11:09.175068053 +0200 CEST m=+2308.040825320" scenario=crowdsecurity/http-probing source_ip=192.168.1.1
5656
```
5757

5858
This time, we can see that logs are being produced when the event is discarded.

crowdsec-docs/versioned_docs/version-v1.7/log_processor/whitelist/ip_based_whitelist.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ description: "Whitelist events from my ip addresses"
1313
whitelist:
1414
reason: "my ip ranges"
1515
ip:
16-
- "80.x.x.x"
16+
- "192.168.1.1" # Replace with your WAN IP
1717
cidr:
18-
- "80.x.x.x/24"
18+
- "192.168.1.0/24" # Replace with your WAN IP range
1919
```
2020
2121
```bash title="Reload CrowdSec"

crowdsec-docs/versioned_docs/version-v1.7/log_processor/whitelist/postoverflow_based_whitelist.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,12 +47,12 @@ Tail the crowdsec log
4747
tail -f /var/log/crowdsec.log
4848
```
4949

50-
You should be able to see the following output:
50+
You should be able to see the following output (note: the IP shown will be your actual WAN IP, not the example):
5151

5252
```
53-
time="07-07-2020 17:11:09" level=info msg="Ban for 80.x.x.x whitelisted, reason [dont ban my ISP]" id=cold-sunset name=me/my_cool_whitelist stage=s01
54-
time="07-07-2020 17:11:09" level=info msg="node warning : no remediation" bucket_id=blue-cloud event_time="2020-07-07 17:11:09.175068053 +0200 CEST m=+2308.040825320" scenario=crowdsecurity/http-probing source_ip=80.x.x.x
55-
time="07-07-2020 17:11:09" level=info msg="Processing Overflow with no decisions 80.x.x.x performed 'crowdsecurity/http-probing' (11 events over 313.983994ms) at 2020-07-07 17:11:09.175068053 +0200 CEST m=+2308.040825320" bucket_id=blue-cloud event_time="2020-07-07 17:11:09.175068053 +0200 CEST m=+2308.040825320" scenario=crowdsecurity/http-probing source_ip=80.x.x.x
53+
time="07-07-2020 17:11:09" level=info msg="Ban for 192.168.1.1 whitelisted, reason [dont ban my ISP]" id=cold-sunset name=me/my_cool_whitelist stage=s01
54+
time="07-07-2020 17:11:09" level=info msg="node warning : no remediation" bucket_id=blue-cloud event_time="2020-07-07 17:11:09.175068053 +0200 CEST m=+2308.040825320" scenario=crowdsecurity/http-probing source_ip=192.168.1.1
55+
time="07-07-2020 17:11:09" level=info msg="Processing Overflow with no decisions 192.168.1.1 performed 'crowdsecurity/http-probing' (11 events over 313.983994ms) at 2020-07-07 17:11:09.175068053 +0200 CEST m=+2308.040825320" bucket_id=blue-cloud event_time="2020-07-07 17:11:09.175068053 +0200 CEST m=+2308.040825320" scenario=crowdsecurity/http-probing source_ip=192.168.1.1
5656
```
5757

5858
This time, we can see that logs are being produced when the event is discarded.

0 commit comments

Comments
 (0)