docs(*): Add configurations docs

Author: julienloizelet

docs/USER_GUIDE.md

@@ -92,7 +92,96 @@ echo "\nResult: $remediation\n\n"; // "ban", "captcha" or "bypass"
 
 #### Configurations
 
-Please see the below [Standalone settings](#standalone-settings) paragraph or look at the [Settings example file](../scripts/auto-prepend/settings.example.php) for a description of each available parameter that you can pass to the `configure` method.
+You can pass an array of configurations in the `$bouncer->configure($configs)` method. 
+Please look at the [Settings example file](../scripts/auto-prepend/settings.example.php) for quick overview.
+
+Here is the list of available settings:
+
+##### LAPI Connection
+
+- `api_key`: Key generated by the cscli (CrowdSec cli) command like `cscli bouncers add bouncer-php-library`
+
+- `api_url`: Define the URL to your LAPI server, default to `http://localhost:8080`.
+
+- `api_timeout`: In seconds. The timeout when calling LAPI. Must be greater or equal than 1. Defaults to 1 sec.
+- `api_user_agent`: HTTP user agent used to call CLAPI. Default to this library name/current version.
+
+##### Debug
+- `debug_mode`:true to enable verbose debug log.
+
+
+- `log_directory_path`: Absolute path to store log files. Important note: be sur this path won't be publicly accessible
+
+- `display_errors`: true to stop the process and display errors on browser if any.
+
+- `forced_test_ip`: Only for test or debug purpose. Default to empty. If not empty, it will be used for all remediation and geolocation processes.
+##### Bouncer behavior
+
+- `bouncing_level`:  Select from `bouncing_disabled`, `normal_bouncing` or `flex_bouncing`. Choose if you want to apply CrowdSec directives (Normal bouncing) or be more permissive (Flex bouncing). With the `Flex mode`, it is impossible to accidentally block access to your site to people who don’t deserve it. This mode makes it possible to never ban an IP but only to offer a Captcha, in the worst-case scenario.
+
+- `fallback_remediation`: Select from `bypass` (minimum remediation), `captcha` or `ban` (maximum remediation). Default to 'captcha'. Handle unknown remediations as.
+
+- `max_remediation_level`: Select from `bypass`,`captcha` or `ban`. Default to 'ban'. Cap the 
+  remediation to the selected one.
+
+- `trust_ip_forward_array`:  If you use a CDN, a reverse proxy or a load balancer, set an array of IPs. For other IPs, the bouncer will not trust the X-Forwarded-For header.
+
+##### Cache
+
+- `cache_system`: Select from `phpfs` (File system cache), `redis` or `memcached`.
+
+- `fs_cache_path`: Will be used only if you choose File system as cache_system. Important note: be sur this path 
+  won't be publicly accessible.
+
+- `redis_dsn`:   Will be used only if you choose Redis cache as cache_system
+
+- `memcached_dsn`: Will be used only if you choose Memcached as cache_system
+
+- `cache_expiration_for_clean_ip`: Set the duration we keep in cache the fact that an IP is clean. In seconds. Defaults to 5.
+
+- `cache_expiration_for_bad_ip`: Set the duration we keep in cache the fact that an IP is bad. In seconds. Defaults to 20.
+
+- `stream_mode`: true to enable stream mode, false to enable the live mode. Default to false. By default, the `live mode` is enabled. The first time a stranger connects to your website, this mode means that the IP will be checked directly by the CrowdSec API. The rest of your user’s browsing will be even more transparent thanks to the fully customizable cache system. But you can also activate the `stream mode`. This mode allows you to constantly feed the bouncer with the malicious IP list via a background task (CRON), making it to be even faster when checking the IP of your visitors. Besides, if your site has a lot of unique visitors at the same time, this will not influence the traffic to the API of your CrowdSec instance.
+
+##### Geolocation
+
+- `geolocation`: Settings for geolocation remediation (i.e. country based remediation).
+- `geolocation[enabled]`: true to enable remediation based on country. Default to false.
+- `geolocation[type]`:  Geolocation system. Only 'maxmind' is available for the moment. Default to `maxmind`
+  
+- `geolocation[save_in_session]`: true to store the geolocalized country in session. Default to true. Setting true 
+  will avoid multiple call to the geolocalized system (e.g. maxmind database)
+- `geolocation[maxmind]`: MaxMind settings
+- `geolocation[maxmind][database_type]`: Select from `country` or `city`. Default to `country`. These are the two available MaxMind database types.
+- `geolocation[maxmind][database_path]`: Absolute path to the MaxMind database (mmdb 
+
+
+##### Captcha and ban wall settings
+
+- `hide_mentions`: true to hide CrowdSec mentions on ban and captcha walls.
+- Wording and css settings: 
+
+  `theme_color_text_primary`
+  `theme_color_text_secondary`
+  `theme_color_text_button`
+  `theme_color_text_error_message`
+  `theme_color_background_page`
+  `theme_color_background_container`
+  `theme_color_background_button`
+  `theme_color_background_button_hover`
+  `theme_custom_css`
+  `theme_text_captcha_wall_tab_title`
+  `theme_text_captcha_wall_title`
+  `theme_text_captcha_wall_subtitle`
+  `theme_text_captcha_wall_refresh_image_link`
+  `theme_text_captcha_wall_captcha_placeholder`
+  `theme_text_captcha_wall_send_button`
+  `theme_text_captcha_wall_error_message`
+  `theme_text_captcha_wall_footer`
+  `theme_text_ban_wall_tab_title`
+  `theme_text_ban_wall_title`
+  `theme_text_ban_wall_subtitle`
+  `theme_text_ban_wall_footer`
 
 
 #### The `Standalone` example
@@ -197,22 +286,22 @@ Once you have created the `scripts/auto-prepend/settings.php` file, you have to
 ```php
 use CrowdSecBouncer\Constants;
 $crowdSecStandaloneBouncerConfig = [
-    /** The bouncer api key to access LAPI or CAPI.
+    /** The bouncer api key to access LAPI.
      *
      * Key generated by the cscli (CrowdSec cli) command like "cscli bouncers add bouncer-php-library"
      */
     'api_key'=> 'YOUR_BOUNCER_API_KEY',
 
-    /** Define the URL to your LAPI server, default to CAPI URL.
+    /** Define the URL to your LAPI server, default to http://localhost:8080.
      *
      * If you have installed the CrowdSec agent on your server, it should be "http://localhost:8080"
      */
     'api_url'=> Constants::DEFAULT_LAPI_URL,
 
-    // In seconds. The timeout when calling CAPI/LAPI. Must be greater or equal than 1. Defaults to 1 sec.
+    // In seconds. The timeout when calling LAPI. Must be greater or equal than 1. Defaults to 1 sec.
     'api_timeout'=> 1,
 
-    // HTTP user agent used to call CAPI or LAPI. Default to this library name/current version.
+    // HTTP user agent used to call LAPI. Default to this library name/current version.
     'api_user_agent'=> 'CrowdSec PHP Library/x.x.x',
 
     // true to enable verbose debug log.

scripts/auto-prepend/settings.example.php

@@ -3,22 +3,22 @@
 use CrowdSecBouncer\Constants;
 
 $crowdSecStandaloneBouncerConfig = [
-    /** The bouncer api key to access LAPI or CAPI.
+    /** The bouncer api key to access LAPI.
      *
      * Key generated by the cscli (CrowdSec cli) command like "cscli bouncers add bouncer-php-library"
      */
     'api_key'=> 'YOUR_BOUNCER_API_KEY',
 
-    /** Define the URL to your LAPI server, default to CAPI URL.
+    /** Define the URL to your LAPI server, default to http://localhost:8080.
      *
      * If you have installed the CrowdSec agent on your server, it should be "http://localhost:8080"
      */
     'api_url'=> Constants::DEFAULT_LAPI_URL,
 
-    // In seconds. The timeout when calling CAPI/LAPI. Must be greater or equal than 1. Defaults to 1 sec.
+    // In seconds. The timeout when calling LAPI. Must be greater or equal than 1. Defaults to 1 sec.
     'api_timeout'=> 1,
 
-    // HTTP user agent used to call CAPI or LAPI. Default to this library name/current version.
+    // HTTP user agent used to call LAPI. Default to this library name/current version.
     'api_user_agent'=> 'CrowdSec PHP Library/x.x.x',
 
     // true to enable verbose debug log.