You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/USER_GUIDE.md
+13-5Lines changed: 13 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -35,13 +35,13 @@ exposed applications.
35
35
36
36
## Prerequisites
37
37
38
-
To be able to use this bouncer, the first step is to install [CrowdSec v1](https://doc.crowdsec.net/docs/getting_started/install_crowdsec/). CrowdSec is only in charge of the "detection", and won't block anything on its own. You need to deploy a bouncer to "apply" decisions.
38
+
To be able to use a bouncer based on this library, the first step is to install [CrowdSec v1](https://doc.crowdsec.net/docs/getting_started/install_crowdsec/). CrowdSec is only in charge of the "detection", and won't block anything on its own. You need to deploy a bouncer to "apply" decisions.
39
39
40
40
Please note that first and foremost a CrowdSec agent must be installed on a server that is accessible by this library.
41
41
42
42
## Features
43
43
44
-
- CrowdSec Local API Support
44
+
- CrowdSec Local API support
45
45
- Handle `ip`, `range` and `country` scoped decisions
46
46
-`Live mode` or `Stream mode`
47
47
- Support IpV4 and Ipv6 (Ipv6 range decisions are yet only supported in `Live mode`)
@@ -183,7 +183,9 @@ To go further and learn how to include this library in your project, you should
183
183
184
184
## Configurations
185
185
186
-
Here is the list of available settings:
186
+
The first parameter of the `AbstractBouncer` class constructor method is an array of settings.
0 commit comments