Merge branch 'release/v0.1.0' into main

Author: mobula9

README.md

@@ -24,18 +24,18 @@ Features:
 - [x] Fast API client
 - [x] LAPI Support
 - [x] Built-in support for the most known cache systems: Redis, Memcached, PhpFiles
-- [x] Rupture mode
-- [ ] Stream mode (alpha version)
+- [x] Live mode
+- [x] Stream mode
+- [x] Log events using monolog
 - [ ] Cap remediation level (ex: for sensitives websites: ban will be capped to captcha)
-- [ ] Direct CAPI support
-- [ ] Log events using monolog
-- [ ] PHP 5.6 retro compatibility (currenly PHP 7.2+)
+- [ ] PHP 7.x+8.x compatibility (currenly only PHP 7.2+)
 - [ ] Retrieve cache items with pagination
+- [ ] Direct CAPI support
 - [ ] Release 1.0.0 version
 - [ ] Support more cache systems (Apcu, Couchbase, Doctrine, Pdo)
 
 Code:
-- [x] Docker dev environment (Dockerized Crowdsec, Redis, Memcached, Composer, PHPUnit)
+- [x] Docker dev environment (Dockerized Crowdsec, Redis, Memcached, PHP)
 - [x] Continuous Integration (CI, includes Integration Tests and Super Linter)
 - [x] Integration tests (with TDD)
 - [x] Documented (Static documentation, PHP Doc)

composer.json

@@ -11,14 +11,16 @@
     },
     "require-dev": {
         "symfony/var-dumper": "^5.1",
-        "phpunit/phpunit": "^8.5",
         "predis/predis": "^1.1",
+        "phpstan/phpstan": "^0.12.58",
+        "bramus/monolog-colored-line-formatter": "^3.0",
         "friendsofphp/php-cs-fixer": "^2.16",
-        "phpstan/phpstan": "^0.12.58"
+        "phpunit/phpunit": "^8.5"
     },
     "require": {
         "symfony/config": "^5.1",
-        "symfony/cache": "^5.1"
+        "symfony/cache": "^5.1",
+        "monolog/monolog": "^2.1"
     },
     "scripts": {
         "lintfix":"vendor/bin/php-cs-fixer fix --verbose --show-progress=estimating --config=.php_cs ./src",

composer.lock

@@ -6,12 +6,8 @@ services:
       - DISABLE_AGENT=true
     volumes:
       - ./var/docker-data:/var/lib/crowdsec/data
-  composer:
-    image: composer:latest
-    environment:
-      - COMPOSER_CACHE_DIR=/app/var/cache/composer
-    volumes:
-      - .:/app
+    ports: 
+      - 8085:8080
   redis:
     image: redis:6-alpine
   memcached:

docker-compose.yml

@@ -16,8 +16,8 @@ Full configuration reference
        // Optional. In seconds. The timeout when calling CAPI/LAPI. Defaults to 2 sec.
        'api_timeout'=> 2,
 
-       // Optional. true to enable rupture mode, false to enable the stream mode. Default to true.
-       'rupture_mode'=> true,
+       // Optional. true to enable live mode, false to enable the stream mode. Default to true.
+       'live_mode'=> true,
        
        // Optional. Cap the remediation to the selected one. Select from 'bypass' (minimum remediation), 'captcha' or 'ban' (maximum remediation). Defaults to 'ban'.
        'max_remediation'=> 'ban',

docs/configuration.rst

@@ -27,8 +27,8 @@ Lint code
 
 .. code-block:: sh
 
-   composer lintfix
-   composer phpstan
+   docker-composer run app composer lintfix
+   docker-composer run app composer phpstan
 
 Also, you can run "Super linter" locally:
 
@@ -42,6 +42,8 @@ Full details here: https://github.com/github/super-linter/blob/master/docs/run-l
 Git Flow
 --------
 
+More info here: https://danielkummer.github.io/git-flow-cheatsheet/
+
 To start a new feature:
 
 .. code-block:: sh
@@ -61,7 +63,12 @@ To pull the feature:
 
 Important: As we use pull requests, we just don't use `git flow feature finish <name>` and we just remove the local branch when the PR is merged.
 
+To create a release:
 
+.. code-block:: sh
+   git flow release start vx.x.x
+   git flow release publish vx.x.x
+   git flow release finish vx.x.x
 
 https://stackoverflow.com/questions/55706856/proper-way-to-use-gitflow-with-pull-requests
 

docs/core-development.rst

@@ -10,7 +10,7 @@ In your existing project, install the library:
 
    $ composer install crowdsec/bouncer-library
 
-Use the bouncer library (rupture mode)
+Use the bouncer library (live mode)
 --------------------------------------
 
 .. code-block:: php
@@ -31,7 +31,7 @@ Use the bouncer library (rupture mode)
 
    $remediation = $bouncer->getRemediationForIp($blockedIp);// Return "ban", "catpcha" or "bypass"
 
-Use the bouncer library (steam mode)
+Use the bouncer library (stream mode)
 ------------------------------------
 
 TODO P2

docs/getting-started.rst

@@ -26,14 +26,14 @@ The install composer dependencies:
 
 .. code-block:: sh
 
-   docker-compose run --rm composer install
+   docker-composer run app composer install
 
 .. _3-run-tests:
 
 3) Run tests
 ~~~~~~~~~~~~
 
-Finally, run the tests.sh file:
+Finally, run the tests-local.sh file:
 
 .. code-block:: sh