docs(user): Add doc for custom user agent

Author: julienloizelet

.github/workflows/release-test.yml

@@ -127,7 +127,7 @@ jobs:
       - name: Copy needed tests files
         run : |
           cp -r raw_sources/tests wp-content/plugins/crowdsec
-          ls -al wp-content/plugins/crowdsec/tests/
+          cp -r raw_sources/.github wp-content/plugins/crowdsec
 
       - name: Prepare for playwright test
         run: |

.github/workflows/release.yml

@@ -125,7 +125,7 @@ jobs:
             -   name: WordPress Plugin Deploy
                 if: github.event.inputs.deploy_to_wordpress == 'true'
                 id: deploy
-                uses: 10up/action-wordpress-plugin-deploy@2.0.0
+                uses: 10up/action-wordpress-plugin-deploy@2.1.1
                 with:
                     generate-zip: true
                 env:
@@ -183,149 +183,151 @@ jobs:
 
         env:
             EXTENSION_NAME: "CrowdSec_Bouncer"
-            EXTENSION_PATH: "crowdsec-bouncer"
+            EXTENSION_PATH: "wp-content/plugins/crowdsec"
+            GITHUB_ORIGIN: "crowdsecurity/cs-wordpress-bouncer"
 
         steps:
 
-            - name: Clone DDEV files
-              uses: actions/checkout@v3
-              with:
-                  path: .ddev
-                  repository: julienloizelet/ddev-wp
-
             - name: Install DDEV
-              env:
-                  DDEV_VERSION: v1.21.4
+                # @see https://ddev.readthedocs.io/en/stable/#installationupgrade-script-linux-and-macos-armarm64-and-amd64-architectures
               run: |
-                  # @see https://ddev.readthedocs.io/en/stable/#installationupgrade-script-linux-and-macos-armarm64-and-amd64-architectures
-                  sudo apt-get -qq update
-                  sudo apt-get -qq -y install libnss3-tools
-                  curl -LO https://raw.githubusercontent.com/drud/ddev/master/scripts/install_ddev.sh
-                  bash install_ddev.sh ${{ env.DDEV_VERSION }}
+                  curl -fsSL https://apt.fury.io/drud/gpg.key | gpg --dearmor | sudo tee /etc/apt/trusted.gpg.d/ddev.gpg > /dev/null
+                  echo "deb [signed-by=/etc/apt/trusted.gpg.d/ddev.gpg] https://apt.fury.io/drud/ * *" | sudo tee /etc/apt/sources.list.d/ddev.list
+                  sudo apt-get -q update
+                  sudo apt-get -q -y install libnss3-tools ddev
+                  mkcert -install
                   ddev config global --instrumentation-opt-in=false --omit-containers=dba,ddev-ssh-agent
-                  rm install_ddev.sh
 
             - name: Set WP_VERSION_CODE env
                 # used in some directory path and conventional file naming
                 # Example : 5.6.5 => wp565
               run: |
                   echo "WP_VERSION_CODE=$(echo wp${{ matrix.wp-version }} | sed 's/\.//g' )" >> $GITHUB_ENV
 
-            - name: Start DDEV for ${{ matrix.wp-version }} with PHP ${{ matrix.php-version }}
-              run: |
-                  cp .ddev/config_overrides/config.${{ env.WP_VERSION_CODE }}.yaml .ddev/config.${{ env.WP_VERSION_CODE }}.yaml
-                  cp .ddev/additional_docker_compose/docker-compose.crowdsec-without-plugin.yaml .ddev/docker-compose.crowdsec.yaml
-                  cp .ddev/additional_docker_compose/docker-compose.playwright.yaml .ddev/docker-compose.playwright.yaml
-                  sed -i -e 's/^php_version:.*/php_version: ${{ matrix.php-version }}/g' .ddev/config.${{ env.WP_VERSION_CODE }}.yaml
-                  mkdir -p wp-content/plugins
-                  mkdir -p my-own-modules/${{ env.EXTENSION_PATH }}
-                  ddev start
-                  sudo chmod -R 777 ${{ github.workspace }}/wp-content
-                  sudo chmod -R 777 ${{ github.workspace }}/my-own-modules
+            - name: Create empty WordPress DDEV project
+              run: ddev config --project-type=wordpress --project-name=${{ env.WP_VERSION_CODE }}
 
-            - name: Some DEBUG information
+            - name: Handle PHP version
               run: |
-                  ddev --version
-                  ddev exec php -v
-                  ddev exec -s crowdsec crowdsec -version
+                  sed -i -e 's/^php_version:.*/php_version: "${{ matrix.php-version }}"/g' .ddev/config.yaml  
 
-            - name: Install WordPress ${{ matrix.wp-version }} with PHP ${{ matrix.php-version }}
+            - name: Add Redis, Memcached, Crowdsec and Playwright
               run: |
-                  wget https://wordpress.org/wordpress-${{ matrix.wp-version }}.tar.gz
-                  tar -xf wordpress-${{ matrix.wp-version }}.tar.gz wordpress
-                  cp -r wordpress/. ${{ github.workspace }}
-                  rm -rf wordpress
-                  rm wordpress-${{ matrix.wp-version }}.tar.gz
+                  ddev get ddev/ddev-redis
+                  ddev get ddev/ddev-memcached
+                  ddev get julienloizelet/ddev-playwright
+                  # override redis.conf
+                  ddev get julienloizelet/ddev-tools
+                  ddev get julienloizelet/ddev-crowdsec-php
+
+            - name: Start DDEV
+              run: ddev start
+
+            - name: Download WordPress
+              run: ddev wp core download --version=${{ matrix.wp-version }}
 
             - name: Setup WordPress ${{ matrix.wp-version }} with PHP ${{ matrix.php-version }}
               run: |
-                  ddev exec wp core install --url='https://${{ env.WP_VERSION_CODE }}.ddev.site' --title='WordPress' --admin_user='admin' --admin_password='admin123' --admin_email='admin@admin.com'
+                  ddev exec wp core install --url='https://${{ env.WP_VERSION_CODE }}.ddev.site' --title='WordPress' --admin_user='admin' --admin_password='admin123' --admin_email='admin@admin.com' 
 
-            - name: Clone ${{ env.EXTENSION_NAME }} files
+            - name: Set LAST_TAG env
+              run: |
+                  echo "LAST_TAG=$(curl -Ls -o /dev/null -w %{url_effective} https://github.com/${{ env.GITHUB_ORIGIN }}/releases/latest | grep -oP "\/tag\/v\K(.*)$")" >> $GITHUB_ENV
+
+            - name: Clone files from last release
               uses: actions/checkout@v3
               with:
-                  path: my-own-modules/${{ env.EXTENSION_PATH }}
+                  path: raw_sources
+                  ref: "v${{ env.LAST_TAG }}"
+                  repository: "${{ env.GITHUB_ORIGIN }}"
 
             - name: Retrieve last stable release zip
-              run : |
-                  LAST_TAG=$(curl -Ls -o /dev/null -w %{url_effective} $GITHUB_SERVER_URL/$GITHUB_REPOSITORY/releases/latest | grep -oP "\/tag\/v\K(.*)$")
-                  curl -fL https://downloads.wordpress.org/plugin/crowdsec.$LAST_TAG.zip -o crowdsec.$LAST_TAG.zip
-                  unzip crowdsec.$LAST_TAG.zip -d ${{ github.workspace }}/wp-content/plugins
+              run: |
+                  curl -fL https://downloads.wordpress.org/plugin/crowdsec.${{ env.LAST_TAG }}.zip -o crowdsec.$LAST_TAG.zip
+                  unzip crowdsec.${{ env.LAST_TAG }}.zip -d ${{ github.workspace }}/wp-content/plugins
+
+            - name: Copy needed tests files
+              run: |
+                  cp -r raw_sources/tests wp-content/plugins/crowdsec
+                  cp -r raw_sources/.github wp-content/plugins/crowdsec
 
             - name: Prepare for playwright test
               run: |
-                  cd ${{ github.workspace }}
-                  cp .ddev/custom_files/crowdsec/php/cache-actions-from-plugin-folder.php cache-actions.php
-                  cp -r .ddev/custom_files/crowdsec/cfssl/* wp-content/plugins/crowdsec/tls
-                  cd wp-content/plugins/crowdsec
-                  docker cp "tls" ddev-${{ env.WP_VERSION_CODE }}-playwright://var/www/html/wp-content/plugins/crowdsec
-                  ddev maxmind-download DEFAULT GeoLite2-City /var/www/html/wp-content/plugins/crowdsec/geolocation
-                  ddev maxmind-download DEFAULT GeoLite2-Country /var/www/html/wp-content/plugins/crowdsec/geolocation
-                  cd ${{ github.workspace }}/wp-content/plugins/crowdsec/geolocation
+                  cp .ddev/okaeli-add-on/wordpress/custom_files/crowdsec/php/cache-actions-from-plugin-folder.php cache-actions.php
+                  cp -r .ddev/okaeli-add-on/custom_files/crowdsec/cfssl/* ${{ env.EXTENSION_PATH }}/tls
+                  ddev maxmind-download DEFAULT GeoLite2-City /var/www/html/${{ env.EXTENSION_PATH }}/geolocation
+                  ddev maxmind-download DEFAULT GeoLite2-Country /var/www/html/${{ env.EXTENSION_PATH }}/geolocation
+                  cd ${{ github.workspace }}/${{ env.EXTENSION_PATH }}/geolocation
                   sha256sum -c GeoLite2-Country.tar.gz.sha256.txt
                   sha256sum -c GeoLite2-City.tar.gz.sha256.txt
                   tar -xf GeoLite2-Country.tar.gz
                   tar -xf GeoLite2-City.tar.gz
                   rm GeoLite2-Country.tar.gz GeoLite2-Country.tar.gz.sha256.txt GeoLite2-City.tar.gz GeoLite2-City.tar.gz.sha256.txt
-                  cd ${{ github.workspace }}/my-own-modules/${{ env.EXTENSION_PATH }}/tests/e2e-ddev/__scripts__
+                  cd ${{ github.workspace }}/${{ env.EXTENSION_PATH }}/tests/e2e-ddev/__scripts__
                   chmod +x test-init.sh
                   ./test-init.sh
-                  chmod +x run-tests.sh
+                  chmod +x run-tests.sh   
+
+            - name: Some DEBUG information
+              run: |
+                  ddev --version
+                  ddev exec php -v
+                  ddev exec -s crowdsec crowdsec -version
 
             - name: Run Plugin activation tests
-              uses: ./my-own-modules/crowdsec-bouncer/.github/workflows/end-to-end/run-single-test
+              uses: ./wp-content/plugins/crowdsec/.github/workflows/end-to-end/run-single-test
               with:
-                  test_path: ${{ github.workspace }}/my-own-modules/${{ env.EXTENSION_PATH }}/tests/e2e-ddev
+                  test_path: ${{ github.workspace }}/${{ env.EXTENSION_PATH }}/tests/e2e-ddev
                   file_path: 1-activate-plugin.js
 
             - name: Configure CrowdSec and Wordpress bouncer plugin
               run: |
                   ddev crowdsec-config
 
             - name: Run Live mode remediation tests
-              uses: ./my-own-modules/crowdsec-bouncer/.github/workflows/end-to-end/run-single-test
+              uses: ./wp-content/plugins/crowdsec/.github/workflows/end-to-end/run-single-test
               with:
-                  test_path: ${{ github.workspace }}/my-own-modules/${{ env.EXTENSION_PATH }}/tests/e2e-ddev
+                  test_path: ${{ github.workspace }}/${{ env.EXTENSION_PATH }}/tests/e2e-ddev
                   file_path: 2-live-mode-remediations.js
 
             - name: Run more Live mode remediation tests
-              uses: ./my-own-modules/crowdsec-bouncer/.github/workflows/end-to-end/run-single-test
+              uses: ./wp-content/plugins/crowdsec/.github/workflows/end-to-end/run-single-test
               with:
-                  test_path: ${{ github.workspace }}/my-own-modules/${{ env.EXTENSION_PATH }}/tests/e2e-ddev
+                  test_path: ${{ github.workspace }}/${{ env.EXTENSION_PATH }}/tests/e2e-ddev
                   file_path: 3-live-mode-more.js
 
             - name: Run Live mode cache tests
-              uses: ./my-own-modules/crowdsec-bouncer/.github/workflows/end-to-end/run-single-test
+              uses: ./wp-content/plugins/crowdsec/.github/workflows/end-to-end/run-single-test
               with:
-                  test_path: ${{ github.workspace }}/my-own-modules/${{ env.EXTENSION_PATH }}/tests/e2e-ddev
+                  test_path: ${{ github.workspace }}/${{ env.EXTENSION_PATH }}/tests/e2e-ddev
                   file_path: 4-live-mode-cache.js
 
             - name: Prepare cron usage
               run: |
                   sed -i  's/fastcgi_finish_request/\/\/fastcgi_finish_request/g' wp-cron.php
 
             - name: Run Stream mode tests
-              uses: ./my-own-modules/crowdsec-bouncer/.github/workflows/end-to-end/run-single-test
+              uses: ./wp-content/plugins/crowdsec/.github/workflows/end-to-end/run-single-test
               with:
-                  test_path: ${{ github.workspace }}/my-own-modules/${{ env.EXTENSION_PATH }}/tests/e2e-ddev
+                  test_path: ${{ github.workspace }}/${{ env.EXTENSION_PATH }}/tests/e2e-ddev
                   file_path: 5-stream-mode.js
 
             - name: Run Redis tests
-              uses: ./my-own-modules/crowdsec-bouncer/.github/workflows/end-to-end/run-single-test
+              uses: ./wp-content/plugins/crowdsec/.github/workflows/end-to-end/run-single-test
               with:
-                  test_path: ${{ github.workspace }}/my-own-modules/${{ env.EXTENSION_PATH }}/tests/e2e-ddev
+                  test_path: ${{ github.workspace }}/${{ env.EXTENSION_PATH }}/tests/e2e-ddev
                   file_path: 6-redis.js
 
             - name: Run Memcached tests
-              uses: ./my-own-modules/crowdsec-bouncer/.github/workflows/end-to-end/run-single-test
+              uses: ./wp-content/plugins/crowdsec/.github/workflows/end-to-end/run-single-test
               with:
-                  test_path: ${{ github.workspace }}/my-own-modules/${{ env.EXTENSION_PATH }}/tests/e2e-ddev
+                  test_path: ${{ github.workspace }}/${{ env.EXTENSION_PATH }}/tests/e2e-ddev
                   file_path: 7-memcached.js
 
             - name: Run Geolocation tests
-              uses: ./my-own-modules/crowdsec-bouncer/.github/workflows/end-to-end/run-single-test
+              uses: ./wp-content/plugins/crowdsec/.github/workflows/end-to-end/run-single-test
               with:
-                  test_path: ${{ github.workspace }}/my-own-modules/${{ env.EXTENSION_PATH }}/tests/e2e-ddev
+                  test_path: ${{ github.workspace }}/${{ env.EXTENSION_PATH }}/tests/e2e-ddev
                   file_path: 8-geolocation.js
 
             - name: tmate debugging session

docs/USER_GUIDE.md

@@ -366,6 +366,21 @@ By default, a `prod.log` file will be written in `wp-content/plugins/crowdsec/lo
 You can disable this log here.
 
 
+
+`Debug mode → Custom User-Agent`
+
+By default, User-Agent used to call LAPI has the following format: `csphplapi_WordPress`.
+
+You can use this field to add a custom suffix: `csphplapi_WordPress[custom-suffix]`.
+
+This can be useful to debug crowdsec logs when using multiple WordPress sites with multiple bouncer plugins.
+
+Only alphanumeric characters (`[A-Za-z0-9]`) are allowed with a maximum of 5 characters.
+
+
+***
+
+
 ***
 
 `Display errors → Enable errors display`

docs/images/screenshots/config-debug.jpg

@@ -391,7 +391,7 @@ function convertInlineIpRangesToComparableIpBounds(string $inlineIpRanges): arra
         }
 
         return $input;
-    }, '<p>By default, User-Agent used to call LAPI has the following format: <i>csphplapi_WordPress</i><br>You can use this field to add a custom suffix: <i>csphplapi_WordPress<b>[custom-suffix]</b></i><br>This can be usefull to debug crowdsec logs when using mutliple WordPress sites with multiple bouncer plugins.<br>Only alphanumeric characters ([A-Za-z0-9]) are allowed with a maximum of 5 characters.</p>',
+    }, '<p>By default, User-Agent used to call LAPI has the following format: <i>csphplapi_WordPress</i>.<br>You can use this field to add a custom suffix: <i>csphplapi_WordPress<b>[custom-suffix]</b></i>.<br>Only alphanumeric characters ([A-Za-z0-9]) are allowed with a maximum of 5 characters.</p>',
         'Site1', 'max-width:100px;');
 
 	/*******************************