Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

chore(docs): update TOC (main) #116

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
julienloizelet merged 1 commit into main from toc-generator/update-toc-0
Jan 26, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 42 additions & 1 deletion docs/DEVELOPER.md
View file Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,48 @@

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- 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 -->

Expand Down
3 changes: 3 additions & 0 deletions docs/INSTALLATION_GUIDE.md
View file Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,10 @@

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents**

- [Requirements](#requirements)
- [Installation](#installation)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

Expand Down
25 changes: 24 additions & 1 deletion docs/USER_GUIDE.md
View file Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,30 @@

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->

**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)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

Expand Down

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