Skip to content

Commit 6d61b52

Browse files
docs(*): Update docs
1 parent 4faf574 commit 6d61b52

File tree

2 files changed

+18
-5
lines changed

2 files changed

+18
-5
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
> The official PHP bouncer library for the CrowdSec LAPI
66
7+
![project is maintained](https://img.shields.io/maintenance/yes/2023.svg)
78
![Version](https://img.shields.io/github/v/release/crowdsecurity/php-cs-bouncer?include_prereleases)
89
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=crowdsecurity_php-cs-bouncer&metric=alert_status)](https://sonarcloud.io/dashboard?id=crowdsecurity_php-cs-bouncer)
910
[![Test suite](https://github.com/crowdsecurity/php-cs-bouncer/actions/workflows/test-suite.yml/badge.svg)](https://github.com/crowdsecurity/php-cs-bouncer/actions/workflows/test-suite.yml)
@@ -16,6 +17,10 @@
1617
:speech_balloon: <a href="https://discourse.crowdsec.net">Discourse Forum</a>
1718

1819

20+
## Overview
21+
22+
This library allows you to create CrowdSec bouncers for PHP applications or frameworks like e-commerce, blog or other exposed applications.
23+
1924
## Usage
2025

2126
See [User Guide](https://github.com/crowdsecurity/php-cs-bouncer/blob/main/docs/USER_GUIDE.md)

docs/USER_GUIDE.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,13 +35,13 @@ exposed applications.
3535

3636
## Prerequisites
3737

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.
3939

4040
Please note that first and foremost a CrowdSec agent must be installed on a server that is accessible by this library.
4141

4242
## Features
4343

44-
- CrowdSec Local API Support
44+
- CrowdSec Local API support
4545
- Handle `ip`, `range` and `country` scoped decisions
4646
- `Live mode` or `Stream mode`
4747
- 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
183183

184184
## Configurations
185185

186-
Here is the list of available settings:
186+
The first parameter of the `AbstractBouncer` class constructor method is an array of settings.
187+
188+
Below is the list of available settings:
187189

188190
### Bouncer behavior
189191

@@ -398,10 +400,16 @@ Redirectmatch 403 crowdsec/tls/
398400
Redirectmatch 403 crowdsec/geolocation/
399401
```
400402

403+
**N.B.:**
404+
- There is no need to protect the `cache` folder if you are using Redis or Memcached cache systems.
405+
- There is no need to protect the `logs` folder if you disable debug and prod logging.
406+
- There is no need to protect the `tls` folder if you use Bouncer API key authentication type.
407+
- There is no need to protect the `geolocation` folder if you don't use the geolocation feature.
408+
401409
## Other ready to use PHP bouncers
402410

403-
To have a more concrete idea on how to develop a bouncer, you may look at the following bouncers :
411+
To have a more concrete idea on how to develop a bouncer from this library, you may look at the following bouncers :
404412
- [CrowdSec Bouncer extension for Magento 2](https://github.com/crowdsecurity/cs-magento-bouncer)
405413
- [CrowdSec Bouncer plugin for WordPress ](https://github.com/crowdsecurity/cs-wordpress-bouncer)
406-
- [CrowdSec Standalone Bouncer ](https://github.com/crowdsecurity/cs-php-bouncer)
414+
- [CrowdSec Standalone Bouncer ](https://github.com/crowdsecurity/cs-standalone-php-bouncer)
407415

0 commit comments

Comments
 (0)