diff --git a/docs/DEVELOPER.md b/docs/DEVELOPER.md index 05edae6..2573b72 100644 --- a/docs/DEVELOPER.md +++ b/docs/DEVELOPER.md @@ -6,7 +6,48 @@ - +**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) diff --git a/docs/INSTALLATION_GUIDE.md b/docs/INSTALLATION_GUIDE.md index 4391f04..20ca40a 100644 --- a/docs/INSTALLATION_GUIDE.md +++ b/docs/INSTALLATION_GUIDE.md @@ -7,7 +7,10 @@ +**Table of Contents** +- [Requirements](#requirements) +- [Installation](#installation) diff --git a/docs/USER_GUIDE.md b/docs/USER_GUIDE.md index c0bebe9..8b7daab 100644 --- a/docs/USER_GUIDE.md +++ b/docs/USER_GUIDE.md @@ -6,7 +6,30 @@ - +**Table of Contents** + +- [Description](#description) +- [Prerequisites](#prerequisites) +- [Features](#features) +- [Usage](#usage) +- [Standalone bouncer set up](#standalone-bouncer-set-up) + - [Files permission](#files-permission) + - [Settings file](#settings-file) + - [`auto_prepend_file` directive](#auto_prepend_file-directive) + - [`.ini` file](#ini-file) + - [Nginx](#nginx) + - [Apache](#apache) +- [Create your own bouncer](#create-your-own-bouncer) + - [Implementation](#implementation) + - [Test your bouncer](#test-your-bouncer) +- [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) +- [Other ready to use PHP bouncers](#other-ready-to-use-php-bouncers)

AltStyle によって変換されたページ (->オリジナル) /