Merge branch 'main' of github.com:crowdsecurity/cs-standalone-php-bou…

…ncer into main

CHANGELOG.md

@@ -11,6 +11,6 @@ protected methods, properties and constants belonging to the `src` folder and of
 ---
 
 
-## [0.0.1](https://github.com/crowdsecurity/php-cs-bouncer/releases/tag/v0.0.1) - 2023-04-27
+## [0.0.1](https://github.com/crowdsecurity/cs-standalone-php-bouncer/releases/tag/v0.0.1) - 2023-04-27
 
 - Initial release

docs/DEVELOPER.md

@@ -8,6 +8,46 @@
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 **Table of Contents**
 
+- [Local development](#local-development)
+  - [DDEV setup](#ddev-setup)
+    - [DDEV installation](#ddev-installation)
+    - [Prepare DDEV PHP environment](#prepare-ddev-php-environment)
+  - [DDEV Usage](#ddev-usage)
+    - [Add CrowdSec bouncer and watcher](#add-crowdsec-bouncer-and-watcher)
+    - [Use composer to update or install the lib](#use-composer-to-update-or-install-the-lib)
+    - [Find IP of your docker services](#find-ip-of-your-docker-services)
+    - [Unit test](#unit-test)
+    - [Integration test](#integration-test)
+    - [Auto-prepend mode (standalone mode)](#auto-prepend-mode-standalone-mode)
+    - [End-to-end tests](#end-to-end-tests)
+    - [Coding standards](#coding-standards)
+      - [PHPCS Fixer](#phpcs-fixer)
+      - [PHPSTAN](#phpstan)
+      - [PHP Mess Detector](#php-mess-detector)
+      - [PHPCS and PHPCBF](#phpcs-and-phpcbf)
+      - [PSALM](#psalm)
+      - [PHP Unit Code coverage](#php-unit-code-coverage)
+    - [Generate CrowdSec tools and settings on start](#generate-crowdsec-tools-and-settings-on-start)
+    - [Redis debug](#redis-debug)
+    - [Memcached debug](#memcached-debug)
+- [Example scripts](#example-scripts)
+  - [Clear cache script](#clear-cache-script)
+  - [Full Live mode example](#full-live-mode-example)
+    - [Set up the context](#set-up-the-context)
+    - [Get the remediation the clean IP "1.2.3.4"](#get-the-remediation-the-clean-ip-1234)
+    - [Now ban range 1.2.3.4 to 1.2.3.7 for 12h](#now-ban-range-1234-to-1237-for-12h)
+    - [Clear cache and get the new remediation](#clear-cache-and-get-the-new-remediation)
+- [Discover the CrowdSec LAPI](#discover-the-crowdsec-lapi)
+  - [Use the CrowdSec cli (`cscli`)](#use-the-crowdsec-cli-cscli)
+    - [Add decision for an IP or a range of IPs](#add-decision-for-an-ip-or-a-range-of-ips)
+    - [Add decision to ban or captcha a country](#add-decision-to-ban-or-captcha-a-country)
+    - [Delete decisions](#delete-decisions)
+    - [Create a bouncer](#create-a-bouncer)
+    - [Create a watcher](#create-a-watcher)
+  - [Use the web container to call LAPI](#use-the-web-container-to-call-lapi)
+- [Commit message](#commit-message)
+  - [Allowed message `type` values](#allowed-message-type-values)
+- [Release process](#release-process)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 

docs/INSTALLATION_GUIDE.md

@@ -10,6 +10,23 @@
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 **Table of Contents**
 
+- [Requirements](#requirements)
+- [Installation](#installation)
+  - [Prerequisite](#prerequisite)
+    - [Install composer](#install-composer)
+    - [Install GIT](#install-git)
+    - [Install CrowdSec](#install-crowdsec)
+  - [Server and bouncer setup](#server-and-bouncer-setup)
+    - [Bouncer sources copy](#bouncer-sources-copy)
+    - [Files permission](#files-permission)
+    - [Settings file](#settings-file)
+    - [`auto_prepend_file` directive](#auto_prepend_file-directive)
+    - [Stream mode cron task](#stream-mode-cron-task)
+    - [Cache pruning cron task](#cache-pruning-cron-task)
+- [Upgrade](#upgrade)
+  - [Before upgrading](#before-upgrading)
+  - [Retrieve the last tag](#retrieve-the-last-tag)
+  - [Checkout to last tag and update sources](#checkout-to-last-tag-and-update-sources)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 

docs/USER_GUIDE.md

@@ -8,6 +8,18 @@
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 **Table of Contents**
 
+- [Description](#description)
+- [Features](#features)
+- [Usage](#usage)
+- [Configurations](#configurations)
+  - [Bouncer behavior](#bouncer-behavior)
+  - [Local API Connection](#local-api-connection)
+  - [Cache](#cache)
+  - [Geolocation](#geolocation)
+  - [Captcha and ban wall settings](#captcha-and-ban-wall-settings)
+  - [Debug](#debug)
+  - [Security note](#security-note)
+
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->