add bunkerweb 1.6

.dockerignore

@@ -0,0 +1,6 @@
+.git
+.idea/
+.vscode/
+__pycache__
+env
+node_modules

.gitattributes

@@ -0,0 +1,21 @@
+* text=auto eol=lf
+
+# Folders
+src/deps/src/** -text -eol linguist-vendored=true
+src/common/core/modsecurity/files/** -text -eol linguist-vendored=true
+src/ui/static/js/editor/** -text -eol linguist-vendored=true
+src/ui/static/js/utils/purify/** -text -eol linguist-vendored=true
+src/ui/static/webfonts/** -text -eol linguist-vendored=true
+src/ui/templates/*.html -text -eol linguist-vendored=true
+src/common/core/antibot/files/*.html -text -eol linguist-vendored=true
+
+# Files
+src/deps/misc/lua-pack.Makefile -linguist-vendored=true
+src/deps/misc/ngx_http_modsecurity_access.c -linguist-vendored=true
+src/ui/static/css/datepicker-foundation.css -linguist-vendored=true
+src/ui/static/css/flatpickr.css -linguist-vendored=true
+src/ui/static/css/flatpickr.dark.css -linguist-vendored=true
+src/ui/static/js/tsparticles.bundle.min.js -linguist-vendored=true
+src/ui/static/js/utils/flatpickr.js -linguist-vendored=true
+src/common/core/errors/files/error.html -linguist-vendored=true
+src/common/core/misc/files/default.html -linguist-vendored=true

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,91 @@
+name: 🐛 Bug Report
+description: Create a report to help us reproduce and fix the bug
+title: "[BUG] "
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: >
+        #### Before submitting a bug, please make sure the issue hasn't been already addressed by searching through [the existing and past issues](https://github.com/bunkerity/bunkerweb/issues?q=is%3Aissue+sort%3Acreated-desc+).
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What happened?
+      description: Concise description of what you're trying to do, the expected behavior and the current bug.
+      placeholder: Describe the bug, the expected behavior and the current behavior
+    validations:
+      required: true
+  - type: textarea
+    id: how-to-reproduce
+    attributes:
+      label: How to reproduce?
+      description: Concise description of how to reproduce the issue.
+      placeholder: Describe how to reproduce the issue
+    validations:
+      required: true
+  - type: textarea
+    id: configuration-file
+    attributes:
+      label: Configuration file(s) (yaml or .env)
+      description: |
+        Please copy and paste your configuration file or the relevant part of it.
+        ⚠️ DON'T FORGET TO REMOVE PRIVATE DATA LIKE IP ADDRESSES ! ⚠️
+      placeholder: Configuration file
+      render: YAML
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant log output
+      description: |
+        Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+        ⚠️ DON'T FORGET TO REMOVE PRIVATE DATA LIKE IP ADDRESSES ! ⚠️
+      placeholder: Log output
+      render: shell
+  - type: input
+    id: version
+    attributes:
+      label: BunkerWeb version
+      description: What version of BunkerWeb are you running?
+      placeholder: Version
+      value: 1.6.0-beta
+    validations:
+      required: true
+  - type: dropdown
+    id: integration
+    attributes:
+      label: What integration are you using?
+      options:
+        - Docker
+        - Autoconf
+        - Swarm
+        - Kubernetes
+        - Linux
+        - Ansible
+        - Vagrant
+      default: 0
+    validations:
+      required: true
+  - type: input
+    id: linux-distribution
+    attributes:
+      label: Linux distribution (if applicable)
+      description: What Linux distribution are you using? (e.g. Ubuntu Server 18.04)
+      placeholder: Linux distribution
+  - type: checkboxes
+    id: removed-private-data
+    attributes:
+      label: Removed private data
+      description: |
+        We would like to emphasize that we are not responsible for any private data that may be inadvertently included in the logs or configuration files.
+        ⚠️ I have removed all private data from the configuration file and the logs ⚠️
+      options:
+        - label: I have removed all private data from the configuration file and the logs
+          required: true
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Code of Conduct
+      description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/bunkerity/bunkerweb/blob/master/CODE_OF_CONDUCT.md)
+      options:
+        - label: I agree to follow this project's Code of Conduct
+          required: true

.github/ISSUE_TEMPLATE/documentation.yml

@@ -0,0 +1,29 @@
+name: 📚 Documentation enhancement
+description: Suggest an idea that will improve BunkerWeb documentation or declare a bug in the documentation
+title: "[DOC] "
+labels: ["documentation"]
+body:
+  - type: markdown
+    attributes:
+      value: >
+        #### Before submitting a documentation enhancement request, please make sure the feature hasn't been already addressed by searching through [the existing and past documentation enhancement requests](https://github.com/bunkerity/bunkerweb/issues?q=is%3Aissue+sort%3Acreated-desc+%5BDOC%5D+in%3Atitle).
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: Concise description of the error or what is missing.
+    validations:
+      required: true
+  - type: textarea
+    id: proposed-solution
+    attributes:
+      label: Proposed solution (optional)
+      description: How it should be fixed or what should be added ?
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Code of Conduct
+      description: By submitting this documentation enhancement request, you agree to follow our [Code of Conduct](https://github.com/bunkerity/bunkerweb/blob/master/CODE_OF_CONDUCT.md)
+      options:
+        - label: I agree to follow this project's Code of Conduct
+          required: true

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,29 @@
+name: 🚀 Feature Request
+description: Suggest an idea that will improve BunkerWeb
+title: "[FEATURE] "
+labels: ["enhancement"]
+body:
+  - type: markdown
+    attributes:
+      value: >
+        #### Before submitting a feature request, please make sure the feature hasn't been already addressed by searching through [the existing and past feature requests](https://github.com/bunkerity/bunkerweb/issues?q=is%3Aissue+sort%3Acreated-desc+%5BFEATURE%5D+in%3Atitle).
+  - type: textarea
+    id: whats-needed-and-why
+    attributes:
+      label: What's needed and why?
+      description: Describe the feature you would like to see in the project and why it should be implemented.
+    validations:
+      required: true
+  - type: textarea
+    id: implementations-ideas
+    attributes:
+      label: Implementations ideas (optional)
+      description: How it should be used and integrated into the project ? List some posts, research papers or codes that we can use as implementation.
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Code of Conduct
+      description: By submitting this feature request, you agree to follow our [Code of Conduct](https://github.com/bunkerity/bunkerweb/blob/master/CODE_OF_CONDUCT.md)
+      options:
+        - label: I agree to follow this project's Code of Conduct
+          required: true

.github/codeql.yml

@@ -0,0 +1,13 @@
+name: "CodeQL config"
+
+paths:
+  - src/autoconf
+  - src/scheduler
+  - src/ui
+  - src/common
+paths-ignore:
+  - src/ui/static/js/tsparticles.bundle.min.js
+  - src/ui/static/js/editor
+  - src/ui/static/js/utils/flatpickr.js
+  - src/ui/static/js/utils/purify
+  - src/common/core/modsecurity/files

.github/dependabot.yml

@@ -0,0 +1,200 @@
+version: 2
+
+updates:
+  # GHA
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"
+      time: "09:00"
+      timezone: "Europe/Paris"
+    assignees:
+      - "TheophileDiot"
+    reviewers:
+      - "TheophileDiot"
+    commit-message:
+      prefix: "deps/gha"
+    target-branch: "dev"
+
+  # Linux
+  - package-ecosystem: "docker"
+    directory: "/src/linux"
+    schedule:
+      interval: "daily"
+      time: "09:00"
+      timezone: "Europe/Paris"
+    assignees:
+      - "TheophileDiot"
+    reviewers:
+      - "TheophileDiot"
+    commit-message:
+      prefix: "deps/linux"
+    target-branch: "dev"
+  - package-ecosystem: "docker"
+    directory: "/tests/linux"
+    schedule:
+      interval: "daily"
+      time: "09:00"
+      timezone: "Europe/Paris"
+    assignees:
+      - "TheophileDiot"
+    reviewers:
+      - "TheophileDiot"
+    commit-message:
+      prefix: "deps/tests/linux"
+    target-branch: "dev"
+
+  # BW
+  - package-ecosystem: "docker"
+    directory: "/src/bw"
+    schedule:
+      interval: "daily"
+      time: "09:00"
+      timezone: "Europe/Paris"
+    assignees:
+      - "TheophileDiot"
+    reviewers:
+      - "TheophileDiot"
+    commit-message:
+      prefix: "deps/bw"
+    target-branch: "dev"
+
+  # Scheduler
+  - package-ecosystem: "docker"
+    directory: "/src/scheduler"
+    schedule:
+      interval: "daily"
+      time: "09:00"
+      timezone: "Europe/Paris"
+    assignees:
+      - "TheophileDiot"
+    reviewers:
+      - "TheophileDiot"
+    commit-message:
+      prefix: "deps/scheduler"
+    target-branch: "dev"
+  - package-ecosystem: "pip"
+    directory: "/src/scheduler"
+    schedule:
+      interval: "daily"
+      time: "09:00"
+      timezone: "Europe/Paris"
+    assignees:
+      - "TheophileDiot"
+    reviewers:
+      - "TheophileDiot"
+    commit-message:
+      prefix: "deps/scheduler"
+    target-branch: "dev"
+
+  # Autoconf
+  - package-ecosystem: "docker"
+    directory: "/src/autoconf"
+    schedule:
+      interval: "daily"
+      time: "09:00"
+      timezone: "Europe/Paris"
+    assignees:
+      - "TheophileDiot"
+    reviewers:
+      - "TheophileDiot"
+    commit-message:
+      prefix: "deps/autoconf"
+    target-branch: "dev"
+  - package-ecosystem: "pip"
+    directory: "/src/autoconf"
+    schedule:
+      interval: "daily"
+      time: "09:00"
+      timezone: "Europe/Paris"
+    assignees:
+      - "TheophileDiot"
+    reviewers:
+      - "TheophileDiot"
+    commit-message:
+      prefix: "deps/autoconf"
+    target-branch: "dev"
+
+  # UI
+  - package-ecosystem: "docker"
+    directory: "/src/ui"
+    schedule:
+      interval: "daily"
+      time: "09:00"
+      timezone: "Europe/Paris"
+    assignees:
+      - "TheophileDiot"
+    reviewers:
+      - "TheophileDiot"
+    commit-message:
+      prefix: "deps/ui"
+    target-branch: "dev"
+  - package-ecosystem: "pip"
+    directory: "/src/ui"
+    schedule:
+      interval: "daily"
+      time: "09:00"
+      timezone: "Europe/Paris"
+    assignees:
+      - "TheophileDiot"
+    reviewers:
+      - "TheophileDiot"
+    commit-message:
+      prefix: "deps/ui"
+    target-branch: "dev"
+
+  # Misc
+  - package-ecosystem: "pip"
+    directory: "/src/deps"
+    schedule:
+      interval: "daily"
+      time: "09:00"
+      timezone: "Europe/Paris"
+    assignees:
+      - "TheophileDiot"
+    reviewers:
+      - "TheophileDiot"
+    commit-message:
+      prefix: "deps/deps"
+    target-branch: "dev"
+  - package-ecosystem: "pip"
+    directory: "/src/common/gen"
+    schedule:
+      interval: "daily"
+      time: "09:00"
+      timezone: "Europe/Paris"
+    assignees:
+      - "TheophileDiot"
+    reviewers:
+      - "TheophileDiot"
+    commit-message:
+      prefix: "deps/common/gen"
+    target-branch: "dev"
+  - package-ecosystem: "pip"
+    directory: "/src/common/db"
+    schedule:
+      interval: "daily"
+      time: "09:00"
+      timezone: "Europe/Paris"
+    assignees:
+      - "TheophileDiot"
+    reviewers:
+      - "TheophileDiot"
+    commit-message:
+      prefix: "deps/common/db"
+    target-branch: "dev"
+
+  # Terraform
+  - package-ecosystem: "terraform"
+    directory: "/tests/terraform"
+    schedule:
+      interval: "daily"
+      time: "09:00"
+      timezone: "Europe/Paris"
+    assignees:
+      - "fl0ppy-d1sk"
+    reviewers:
+      - "fl0ppy-d1sk"
+    commit-message:
+      prefix: "deps/terraform"
+    target-branch: "dev"

.github/workflows/1.6.yml

@@ -0,0 +1,243 @@
+name: Automatic tests (DEV)
+
+permissions: read-all
+
+on:
+  push:
+    branches: [1.6]
+
+jobs:
+  # Containers
+  build-containers:
+    permissions:
+      contents: read
+      packages: write
+    strategy:
+      fail-fast: false
+      matrix:
+        image: [bunkerweb, scheduler, autoconf, ui]
+        include:
+          - image: bunkerweb
+            dockerfile: src/bw/Dockerfile
+          - image: scheduler
+            dockerfile: src/scheduler/Dockerfile
+          - image: autoconf
+            dockerfile: src/autoconf/Dockerfile
+          - image: ui
+            dockerfile: src/ui/Dockerfile
+    uses: ./.github/workflows/container-build.yml
+    with:
+      RELEASE: 1.6
+      ARCH: linux/amd64
+      CACHE: true
+      IMAGE: ${{ matrix.image }}
+      DOCKERFILE: ${{ matrix.dockerfile }}
+    secrets:
+      DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
+      DOCKER_TOKEN: ${{ secrets.DOCKER_TOKEN }}
+
+  # Build Linux packages
+  build-packages:
+    permissions:
+      contents: read
+      packages: write
+    strategy:
+      matrix:
+        linux: [ubuntu, debian, fedora, rhel, rhel9, ubuntu-jammy]
+        include:
+          - linux: ubuntu
+            package: deb
+          - linux: ubuntu-jammy
+            package: deb
+          - linux: debian
+            package: deb
+          - linux: fedora
+            package: rpm
+          - linux: rhel
+            package: rpm
+          - linux: rhel9
+            package: rpm
+    uses: ./.github/workflows/linux-build.yml
+    with:
+      RELEASE: 1.6
+      LINUX: ${{ matrix.linux }}
+      PACKAGE: ${{ matrix.package }}
+      TEST: true
+      PLATFORMS: linux/amd64
+    secrets:
+      DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
+      DOCKER_TOKEN: ${{ secrets.DOCKER_TOKEN }}
+
+  codeql:
+    uses: ./.github/workflows/codeql.yml
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+  # UI tests
+  prepare-tests-ui:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+      - id: set-matrix
+        run: |
+          tests=$(find ./tests/ui/ -name "*_page.py" -type f -printf "%f\n" | jq -c --raw-input --slurp 'split("\n")| .[0:-1]')
+          echo "tests=$tests" >> $GITHUB_OUTPUT
+    outputs:
+      tests: ${{ steps.set-matrix.outputs.tests }}
+  tests-ui:
+    needs: [prepare-tests-ui, build-containers]
+    strategy:
+      fail-fast: false
+      matrix:
+        test: ${{ fromJson(needs.prepare-tests-ui.outputs.tests) }}
+    uses: ./.github/workflows/tests-ui.yml
+    with:
+      TEST: ${{ matrix.test }}
+      RELEASE: 1.6
+  tests-ui-linux:
+    needs: [prepare-tests-ui, build-packages]
+    strategy:
+      fail-fast: false
+      matrix:
+        test: ${{ fromJson(needs.prepare-tests-ui.outputs.tests) }}
+    uses: ./.github/workflows/tests-ui-linux.yml
+    with:
+      TEST: ${{ matrix.test }}
+      RELEASE: 1.6
+
+  # Core tests
+  prepare-tests-core:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+      - id: set-matrix
+        run: |
+          tests=$(find ./tests/core/ -maxdepth 1 -mindepth 1 -type d -printf "%f\n" | jq -c --raw-input --slurp 'split("\n")| .[0:-1]')
+          echo "tests=$tests" >> $GITHUB_OUTPUT
+    outputs:
+      tests: ${{ steps.set-matrix.outputs.tests }}
+  tests-core:
+    needs: [build-containers, prepare-tests-core]
+    strategy:
+      fail-fast: false
+      matrix:
+        test: ${{ fromJson(needs.prepare-tests-core.outputs.tests) }}
+    uses: ./.github/workflows/test-core.yml
+    with:
+      TEST: ${{ matrix.test }}
+      RELEASE: 1.6
+  tests-core-linux:
+    needs: [build-packages, prepare-tests-core]
+    strategy:
+      fail-fast: false
+      matrix:
+        test: ${{ fromJson(needs.prepare-tests-core.outputs.tests) }}
+    uses: ./.github/workflows/test-core-linux.yml
+    with:
+      TEST: ${{ matrix.test }}
+      RELEASE: 1.6
+    secrets: inherit
+
+  # Push with 1.6 tag
+  push-1_6:
+    needs: [tests-ui, tests-core]
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+    steps:
+      - name: Login to Docker Hub
+        uses: docker/login-action@0d4c9c5ea7693da7b068278f7b52bda2a190a446 # v3.2.0
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_TOKEN }}
+      - name: Login to ghcr
+        uses: docker/login-action@0d4c9c5ea7693da7b068278f7b52bda2a190a446 # v3.2.0
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - name: Push BW image
+        run: docker pull ghcr.io/bunkerity/$FROM-tests:1.6 && docker tag ghcr.io/bunkerity/$FROM-tests:1.6 bunkerity/$TO:1.6 && docker tag ghcr.io/bunkerity/$FROM-tests:1.6 ghcr.io/bunkerity/$TO:1.6 && docker push bunkerity/$TO:1.6 && docker push ghcr.io/bunkerity/$TO:1.6
+        env:
+          FROM: "bunkerweb"
+          TO: "bunkerweb"
+      - name: Push scheduler image
+        run: docker pull ghcr.io/bunkerity/$FROM-tests:1.6 && docker tag ghcr.io/bunkerity/$FROM-tests:1.6 bunkerity/$TO:1.6 && docker tag ghcr.io/bunkerity/$FROM-tests:1.6 ghcr.io/bunkerity/$TO:1.6 && docker push bunkerity/$TO:1.6 && docker push ghcr.io/bunkerity/$TO:1.6
+        env:
+          FROM: "scheduler"
+          TO: "bunkerweb-scheduler"
+      - name: Push UI image
+        run: docker pull ghcr.io/bunkerity/$FROM-tests:1.6 && docker tag ghcr.io/bunkerity/$FROM-tests:1.6 bunkerity/$TO:1.6 && docker tag ghcr.io/bunkerity/$FROM-tests:1.6 ghcr.io/bunkerity/$TO:1.6 && docker push bunkerity/$TO:1.6 && docker push ghcr.io/bunkerity/$TO:1.6
+        env:
+          FROM: "ui"
+          TO: "bunkerweb-ui"
+      - name: Push autoconf image
+        run: docker pull ghcr.io/bunkerity/$FROM-tests:1.6 && docker tag ghcr.io/bunkerity/$FROM-tests:1.6 bunkerity/$TO:1.6 && docker tag ghcr.io/bunkerity/$FROM-tests:1.6 ghcr.io/bunkerity/$TO:1.6 && docker push bunkerity/$TO:1.6 && docker push ghcr.io/bunkerity/$TO:1.6
+        env:
+          FROM: "autoconf"
+          TO: "bunkerweb-autoconf"
+
+  # Push Linux packages
+  push-packages:
+    needs: [tests-ui-linux, tests-core-linux]
+    strategy:
+      matrix:
+        linux: [ubuntu, debian, fedora, el, el9, ubuntu-jammy]
+        arch: [amd64]
+        include:
+          - release: 1.6
+            repo: bunkerweb
+          - linux: ubuntu
+            package_arch: amd64
+            separator: _
+            suffix: ""
+            version: noble
+            package: deb
+          - linux: debian
+            package_arch: amd64
+            separator: _
+            suffix: ""
+            version: bookworm
+            package: deb
+          - linux: fedora
+            package_arch: x86_64
+            separator: "-"
+            suffix: "1."
+            version: 40
+            package: rpm
+          - linux: el
+            package_arch: x86_64
+            separator: "-"
+            suffix: "1."
+            version: 8
+            package: rpm
+          - linux: el9
+            package_arch: x86_64
+            separator: "-"
+            suffix: "1."
+            version: 9
+            package: rpm
+          - linux: ubuntu-jammy
+            package_arch: amd64
+            separator: _
+            suffix: ""
+            version: jammy
+            package: deb
+    uses: ./.github/workflows/push-packagecloud.yml
+    with:
+      SEPARATOR: ${{ matrix.separator }}
+      SUFFIX: ${{ matrix.suffix }}
+      REPO: ${{ matrix.repo }}
+      LINUX: ${{ matrix.linux }}
+      VERSION: ${{ matrix.version }}
+      PACKAGE: ${{ matrix.package }}
+      BW_VERSION: ${{ matrix.release }}
+      PACKAGE_ARCH: ${{ matrix.package_arch }}
+      ARCH: ${{ matrix.arch }}
+    secrets:
+      PACKAGECLOUD_TOKEN: ${{ secrets.PACKAGECLOUD_TOKEN }}

.github/workflows/beta.yml

@@ -0,0 +1,296 @@
+name: Automatic push (BETA)
+
+permissions: read-all
+
+on:
+  push:
+    branches: [beta]
+
+jobs:
+  # Build amd64 + 386 containers images
+  build-containers:
+    strategy:
+      matrix:
+        image: [bunkerweb, scheduler, autoconf, ui]
+        arch: [linux/amd64, linux/386]
+        include:
+          - release: beta
+            cache: false
+            push: false
+          - image: bunkerweb
+            dockerfile: src/bw/Dockerfile
+          - image: scheduler
+            dockerfile: src/scheduler/Dockerfile
+          - image: autoconf
+            dockerfile: src/autoconf/Dockerfile
+          - image: ui
+            dockerfile: src/ui/Dockerfile
+          - arch: linux/amd64
+            cache_suffix: amd64
+          - arch: linux/386
+            cache_suffix: "386"
+    uses: ./.github/workflows/container-build.yml
+    with:
+      RELEASE: ${{ matrix.release }}
+      ARCH: ${{ matrix.arch }}
+      IMAGE: ${{ matrix.image }}
+      DOCKERFILE: ${{ matrix.dockerfile }}
+      CACHE: ${{ matrix.cache }}
+      PUSH: ${{ matrix.push }}
+      CACHE_SUFFIX: ${{ matrix.cache_suffix }}
+    secrets:
+      DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
+      DOCKER_TOKEN: ${{ secrets.DOCKER_TOKEN }}
+
+  # Create ARM environment
+  create-arm:
+    uses: ./.github/workflows/create-arm.yml
+    secrets:
+      SCW_ACCESS_KEY: ${{ secrets.SCW_ACCESS_KEY }}
+      SCW_SECRET_KEY: ${{ secrets.SCW_SECRET_KEY }}
+      SCW_DEFAULT_PROJECT_ID: ${{ secrets.SCW_DEFAULT_PROJECT_ID }}
+      SCW_DEFAULT_ORGANIZATION_ID: ${{ secrets.SCW_DEFAULT_ORGANIZATION_ID }}
+      ARM_SSH_KEY: ${{ secrets.ARM_SSH_KEY }}
+      ARM_SSH_CONFIG: ${{ secrets.ARM_SSH_CONFIG }}
+
+  # Build arm64 + arm/v7 images
+  build-containers-arm:
+    needs: [create-arm]
+    strategy:
+      matrix:
+        image: [bunkerweb, scheduler, autoconf, ui]
+        arch: ["linux/arm64,linux/arm/v7"]
+        include:
+          - release: beta
+            cache: false
+            push: false
+            cache_suffix: arm
+          - image: bunkerweb
+            dockerfile: src/bw/Dockerfile
+          - image: scheduler
+            dockerfile: src/scheduler/Dockerfile
+          - image: autoconf
+            dockerfile: src/autoconf/Dockerfile
+          - image: ui
+            dockerfile: src/ui/Dockerfile
+    uses: ./.github/workflows/container-build.yml
+    with:
+      RELEASE: ${{ matrix.release }}
+      ARCH: ${{ matrix.arch }}
+      IMAGE: ${{ matrix.image }}
+      DOCKERFILE: ${{ matrix.dockerfile }}
+      CACHE: ${{ matrix.cache }}
+      PUSH: ${{ matrix.push }}
+      CACHE_SUFFIX: ${{ matrix.cache_suffix }}
+    secrets:
+      DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
+      DOCKER_TOKEN: ${{ secrets.DOCKER_TOKEN }}
+      ARM_SSH_KEY: ${{ secrets.ARM_SSH_KEY }}
+      ARM_SSH_IP: ${{ needs.create-arm.outputs.ip }}
+      ARM_SSH_CONFIG: ${{ secrets.ARM_SSH_CONFIG }}
+
+  # Build Linux packages
+  build-packages:
+    needs: [create-arm]
+    strategy:
+      matrix:
+        linux: [ubuntu, debian, fedora, rhel, rhel9]
+        platforms: [linux/amd64, linux/arm64]
+        include:
+          - release: beta
+          - linux: ubuntu
+            package: deb
+          - linux: debian
+            package: deb
+          - linux: fedora
+            package: rpm
+          - linux: rhel
+            package: rpm
+          - linux: rhel9
+            package: rpm
+    uses: ./.github/workflows/linux-build.yml
+    with:
+      RELEASE: ${{ matrix.release }}
+      LINUX: ${{ matrix.linux }}
+      PACKAGE: ${{ matrix.package }}
+      TEST: false
+      PLATFORMS: ${{ matrix.platforms }}
+    secrets:
+      DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
+      DOCKER_TOKEN: ${{ secrets.DOCKER_TOKEN }}
+      PRIVATE_REGISTRY: ${{ secrets.PRIVATE_REGISTRY }}
+      PRIVATE_REGISTRY_TOKEN: ${{ secrets.PRIVATE_REGISTRY_TOKEN }}
+      ARM_SSH_KEY: ${{ secrets.ARM_SSH_KEY }}
+      ARM_SSH_IP: ${{ needs.create-arm.outputs.ip }}
+      ARM_SSH_CONFIG: ${{ secrets.ARM_SSH_CONFIG }}
+
+  # Wait for all builds and extract VERSION
+  wait-builds:
+    runs-on: ubuntu-latest
+    needs: [build-containers, build-containers-arm, build-packages]
+    outputs:
+      version: ${{ steps.getversion.outputs.version }}
+      versionrpm: ${{ steps.getversionrpm.outputs.versionrpm }}
+    steps:
+      - name: Checkout source code
+        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+      - name: Get VERSION
+        id: getversion
+        run: echo "version=$(cat src/VERSION | tr -d '\n')" >> "$GITHUB_OUTPUT"
+      - name: Get VERSION (for RPM based)
+        id: getversionrpm
+        run: echo "versionrpm=$(cat src/VERSION | tr -d '\n' | sed 's/-/_/g')" >> "$GITHUB_OUTPUT"
+
+  # Push Docker images
+  push-images:
+    needs: [create-arm, wait-builds]
+    strategy:
+      matrix:
+        image:
+          [bunkerweb, bunkerweb-scheduler, bunkerweb-autoconf, bunkerweb-ui]
+        include:
+          - release: beta
+          - image: bunkerweb
+            cache_from: bunkerweb
+            dockerfile: src/bw/Dockerfile
+          - image: bunkerweb-scheduler
+            cache_from: scheduler
+            dockerfile: src/scheduler/Dockerfile
+          - image: bunkerweb-autoconf
+            cache_from: autoconf
+            dockerfile: src/autoconf/Dockerfile
+          - image: bunkerweb-ui
+            cache_from: ui
+            dockerfile: src/ui/Dockerfile
+    uses: ./.github/workflows/push-docker.yml
+    with:
+      IMAGE: bunkerity/${{ matrix.image }}:${{ matrix.release }},bunkerity/${{ matrix.image }}:${{ needs.wait-builds.outputs.version }}
+      CACHE_FROM: ${{ matrix.cache_from }}-${{ matrix.release }}
+      DOCKERFILE: ${{ matrix.dockerfile }}
+    secrets:
+      DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
+      DOCKER_TOKEN: ${{ secrets.DOCKER_TOKEN }}
+      ARM_SSH_KEY: ${{ secrets.ARM_SSH_KEY }}
+      ARM_SSH_IP: ${{ needs.create-arm.outputs.ip }}
+      ARM_SSH_CONFIG: ${{ secrets.ARM_SSH_CONFIG }}
+
+  # Push Linux packages
+  push-packages:
+    needs: [wait-builds]
+    strategy:
+      matrix:
+        linux: [ubuntu, debian, fedora, el, el9]
+        arch: [amd64, arm64]
+        include:
+          - release: beta
+            repo: bunkerweb
+          - linux: ubuntu
+            separator: _
+            suffix: ""
+            version: noble
+            package: deb
+          - linux: debian
+            separator: _
+            suffix: ""
+            version: bookworm
+            package: deb
+          - linux: fedora
+            separator: "-"
+            suffix: "1."
+            version: 40
+            package: rpm
+          - linux: el
+            separator: "-"
+            suffix: "1."
+            version: 8
+            package: rpm
+          - linux: el9
+            separator: "-"
+            suffix: "1."
+            version: 9
+            package: rpm
+          - linux: ubuntu
+            arch: amd64
+            package_arch: amd64
+          - linux: debian
+            arch: amd64
+            package_arch: amd64
+          - linux: fedora
+            arch: amd64
+            package_arch: x86_64
+          - linux: el
+            arch: amd64
+            package_arch: x86_64
+          - linux: el9
+            arch: amd64
+            package_arch: x86_64
+          - linux: ubuntu
+            arch: arm64
+            package_arch: arm64
+          - linux: debian
+            arch: arm64
+            package_arch: arm64
+          - linux: fedora
+            arch: arm64
+            package_arch: aarch64
+          - linux: el
+            arch: arm64
+            package_arch: aarch64
+          - linux: el9
+            arch: arm64
+            package_arch: aarch64
+    uses: ./.github/workflows/push-packagecloud.yml
+    with:
+      SEPARATOR: ${{ matrix.separator }}
+      SUFFIX: ${{ matrix.suffix }}
+      REPO: ${{ matrix.repo }}
+      LINUX: ${{ matrix.linux }}
+      VERSION: ${{ matrix.version }}
+      PACKAGE: ${{ matrix.package }}
+      BW_VERSION: ${{ matrix.package == 'rpm' && needs.wait-builds.outputs.versionrpm || needs.wait-builds.outputs.version }}
+      PACKAGE_ARCH: ${{ matrix.package_arch }}
+      ARCH: ${{ matrix.arch }}
+    secrets:
+      PACKAGECLOUD_TOKEN: ${{ secrets.PACKAGECLOUD_TOKEN }}
+
+  # Create doc PDF
+  doc-pdf:
+    needs: [wait-builds, push-images, push-packages]
+    uses: ./.github/workflows/doc-to-pdf.yml
+    with:
+      VERSION: ${{ needs.wait-builds.outputs.version }}
+
+  # Push on GH
+  push-gh:
+    needs: [wait-builds, doc-pdf]
+    permissions:
+      contents: write
+      discussions: write
+    uses: ./.github/workflows/push-github.yml
+    with:
+      VERSION: ${{ needs.wait-builds.outputs.version }}
+      PRERELEASE: true
+
+  # Push doc
+  push-doc:
+    needs: [wait-builds, push-gh]
+    permissions:
+      contents: write
+    uses: ./.github/workflows/push-doc.yml
+    with:
+      VERSION: ${{ needs.wait-builds.outputs.version }}
+      ALIAS: beta
+    secrets:
+      BUNKERBOT_TOKEN: ${{ secrets.BUNKERBOT_TOKEN }}
+
+  # Remove ARM VM
+  rm-arm:
+    if: ${{ always() }}
+    needs: [create-arm, push-images, build-packages]
+    uses: ./.github/workflows/rm-arm.yml
+    secrets:
+      ARM_ID: ${{ needs.create-arm.outputs.id }}
+      SCW_ACCESS_KEY: ${{ secrets.SCW_ACCESS_KEY }}
+      SCW_SECRET_KEY: ${{ secrets.SCW_SECRET_KEY }}
+      SCW_DEFAULT_PROJECT_ID: ${{ secrets.SCW_DEFAULT_PROJECT_ID }}
+      SCW_DEFAULT_ORGANIZATION_ID: ${{ secrets.SCW_DEFAULT_ORGANIZATION_ID }}

.github/workflows/codeql.yml

@@ -0,0 +1,46 @@
+name: CodeQL Analysis
+
+on:
+  schedule:
+    # Weekly on Saturdays.
+    - cron: "30 1 * * 6"
+  workflow_call:
+
+jobs:
+  code-security:
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+    strategy:
+      fail-fast: false
+      matrix:
+        language: ["python", "javascript"]
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+      - name: Set up Python 3.9
+        uses: actions/setup-python@82c7e631bb3cdc910f68e0081d67478d79c6982d # v5.1.0
+        if: matrix.language == 'python'
+        with:
+          python-version: "3.9"
+      - name: Install python dependencies
+        if: matrix.language == 'python'
+        run: |
+          python -m pip install --no-cache-dir --ignore-installed --require-hashes -r src/deps/requirements.txt
+          python -m pip install --no-cache-dir --require-hashes -r src/scheduler/requirements.txt
+          python -m pip install --no-cache-dir --require-hashes -r src/ui/requirements.txt
+          python -m pip install --no-cache-dir --require-hashes -r src/common/gen/requirements.txt
+          python -m pip install --no-cache-dir --require-hashes -r src/common/db/requirements.txt
+          echo "CODEQL_PYTHON=$(which python)" >> $GITHUB_ENV
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@23acc5c183826b7a8a97bce3cecc52db901f8251 # v3.25.10
+        with:
+          languages: ${{ matrix.language }}
+          config-file: ./.github/codeql.yml
+          setup-python-dependencies: false
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@23acc5c183826b7a8a97bce3cecc52db901f8251 # v3.25.10
+        with:
+          category: "/language:${{matrix.language}}"

.github/workflows/container-build.yml

@@ -0,0 +1,139 @@
+name: Build container (REUSABLE)
+
+on:
+  workflow_call:
+    inputs:
+      RELEASE:
+        required: true
+        type: string
+      ARCH:
+        required: true
+        type: string
+      IMAGE:
+        required: true
+        type: string
+      DOCKERFILE:
+        required: true
+        type: string
+      CACHE:
+        required: false
+        type: boolean
+        default: true
+      PUSH:
+        required: false
+        type: boolean
+        default: true
+      CACHE_SUFFIX:
+        required: false
+        type: string
+        default: ""
+    secrets:
+      DOCKER_USERNAME:
+        required: true
+      DOCKER_TOKEN:
+        required: true
+      ARM_SSH_KEY:
+        required: false
+      ARM_SSH_IP:
+        required: false
+      ARM_SSH_CONFIG:
+        required: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      # Prepare
+      - name: Checkout source code
+        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+      - name: Replace VERSION
+        if: inputs.RELEASE == 'testing' || inputs.RELEASE == 'dev'
+        run: ./misc/update-version.sh ${{ inputs.RELEASE }}
+      - name: Replace VERSION 1.6
+        if: inputs.RELEASE == '1.6'
+        run: ./misc/update-version.sh dev
+      - name: Setup SSH for ARM node
+        if: inputs.CACHE_SUFFIX == 'arm'
+        run: |
+          mkdir -p ~/.ssh
+          echo "$SSH_KEY" > ~/.ssh/id_rsa_arm
+          chmod 600 ~/.ssh/id_rsa_arm
+          echo "$SSH_CONFIG" | sed "s/SSH_IP/$SSH_IP/g" > ~/.ssh/config
+          echo "ServerAliveInterval 60" >> ~/.ssh/config
+          echo "ServerAliveCountMax 10" >> ~/.ssh/config
+        env:
+          SSH_KEY: ${{ secrets.ARM_SSH_KEY }}
+          SSH_IP: ${{ secrets.ARM_SSH_IP }}
+          SSH_CONFIG: ${{ secrets.ARM_SSH_CONFIG }}
+      - name: Setup Buildx
+        uses: docker/setup-buildx-action@d70bba72b1f3fd22344832f00baa16ece964efeb # v3.3.0
+        if: inputs.CACHE_SUFFIX != 'arm'
+      - name: Setup Buildx (ARM)
+        uses: docker/setup-buildx-action@d70bba72b1f3fd22344832f00baa16ece964efeb # v3.3.0
+        if: inputs.CACHE_SUFFIX == 'arm'
+        with:
+          endpoint: ssh://root@arm
+          platforms: linux/arm64,linux/arm/v7,linux/arm/v6
+      - name: Login to Docker Hub
+        uses: docker/login-action@0d4c9c5ea7693da7b068278f7b52bda2a190a446 # v3.2.0
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_TOKEN }}
+      - name: Login to ghcr
+        if: inputs.PUSH == true
+        uses: docker/login-action@0d4c9c5ea7693da7b068278f7b52bda2a190a446 # v3.2.0
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      # Compute metadata
+      - name: Extract metadata
+        id: meta
+        uses: docker/metadata-action@8e5442c4ef9f78752691e2d8f8d19755c6f78e81 # v5.5.1
+        with:
+          images: bunkerity/${{ inputs.IMAGE }}
+      # Build cached image
+      - name: Build image
+        if: inputs.CACHE == true
+        uses: docker/build-push-action@15560696de535e4014efeff63c48f16952e52dd1 # v6.2.0
+        with:
+          context: .
+          file: ${{ inputs.DOCKERFILE }}
+          platforms: ${{ inputs.ARCH }}
+          load: true
+          tags: local/${{ inputs.IMAGE }}
+          cache-from: type=gha,scope=${{ inputs.IMAGE }}-${{ inputs.RELEASE }}
+          cache-to: type=gha,scope=${{ inputs.IMAGE }}-${{ inputs.RELEASE }},mode=min
+          labels: ${{ steps.meta.outputs.labels }}
+      # Build non-cached image
+      - name: Build image
+        if: inputs.CACHE != true
+        uses: docker/build-push-action@15560696de535e4014efeff63c48f16952e52dd1 # v6.2.0
+        with:
+          context: .
+          file: ${{ inputs.DOCKERFILE }}
+          platforms: ${{ inputs.ARCH }}
+          load: ${{ inputs.CACHE_SUFFIX != 'arm' }}
+          tags: local/${{ inputs.IMAGE }}
+          cache-to: type=gha,scope=${{ inputs.IMAGE }}-${{ inputs.RELEASE }}-${{ inputs.CACHE_SUFFIX }},mode=min
+          labels: ${{ steps.meta.outputs.labels }}
+      # Check OS vulnerabilities
+      - name: Check OS vulnerabilities
+        if: ${{ inputs.CACHE_SUFFIX != 'arm' }}
+        uses: aquasecurity/trivy-action@7c2007bcb556501da015201bcba5aa14069b74e2 # v0.23.0
+        with:
+          vuln-type: os
+          skip-dirs: /root/.cargo
+          image-ref: local/${{ inputs.IMAGE }}
+          format: table
+          exit-code: 1
+          ignore-unfixed: false
+          severity: UNKNOWN,LOW,MEDIUM,HIGH,CRITICAL
+          trivyignores: .trivyignore
+      # Push image
+      - name: Push image
+        if: inputs.PUSH == true
+        run: docker tag local/$IMAGE ghcr.io/bunkerity/$IMAGE-tests:$TAG && docker push ghcr.io/bunkerity/$IMAGE-tests:$TAG
+        env:
+          IMAGE: "${{ inputs.IMAGE }}"
+          TAG: "${{ inputs.RELEASE }}"

.github/workflows/create-arm.yml

@@ -0,0 +1,86 @@
+name: Create ARM node (REUSABLE)
+
+on:
+  workflow_call:
+    outputs:
+      id:
+        description: "ARM ID"
+        value: ${{ jobs.build.outputs.id }}
+      ip:
+        description: "ARM IP"
+        value: ${{ jobs.build.outputs.ip }}
+
+    secrets:
+      SCW_ACCESS_KEY:
+        required: true
+      SCW_SECRET_KEY:
+        required: true
+      SCW_DEFAULT_PROJECT_ID:
+        required: true
+      SCW_DEFAULT_ORGANIZATION_ID:
+        required: true
+      ARM_SSH_KEY:
+        required: true
+      ARM_SSH_CONFIG:
+        required: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    outputs:
+      id: ${{ steps.getinfo.outputs.id }}
+      ip: ${{ steps.getinfo.outputs.ip }}
+    steps:
+      # Prepare
+      - name: Checkout source code
+        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+      - name: Get ARM availabilities
+        id: availabilities
+        uses: scaleway/action-scw@be2696f261325a78354eda14988c80405f33e082
+        with:
+          args: instance server-type get zone=fr-par-2
+          export-config: true
+          access-key: ${{ secrets.SCW_ACCESS_KEY }}
+          secret-key: ${{ secrets.SCW_SECRET_KEY }}
+          default-project-id: ${{ secrets.SCW_DEFAULT_PROJECT_ID }}
+          default-organization-id: ${{ secrets.SCW_DEFAULT_ORGANIZATION_ID }}
+      - name: Extract ARM type
+        run: |
+          TYPE=$(echo "$JSON" | jq '.servers | with_entries(select(.key | contains("COPARM1-"))) | with_entries(select(.value.availability != "shortage")) | keys[] | select(. | test("^COPARM1-[0-9]+C-[0-9]+G$"))' | sed 's/"//g' | cut -d '-' -f 2,3 | sort -g | tail -n 1 | xargs -I {} echo "COPARM1-{}")
+          echo "Type is $TYPE"
+          echo "TYPE=$TYPE" >> "$GITHUB_ENV"
+        env:
+          JSON: ${{ steps.availabilities.outputs.json }}
+      - name: Create ARM VM
+        id: scw
+        uses: scaleway/action-scw@be2696f261325a78354eda14988c80405f33e082
+        with:
+          args: instance server create zone=fr-par-2 type=${{ env.TYPE }} root-volume=block:50GB
+      - name: Get info
+        id: getinfo
+        run: |
+          echo "id=${{ fromJson(steps.scw.outputs.json).id }}" >> "$GITHUB_OUTPUT"
+          echo "ip=${{ fromJson(steps.scw.outputs.json).public_ip.address }}" >> "$GITHUB_OUTPUT"
+      - name: Wait for VM
+        uses: scaleway/action-scw@be2696f261325a78354eda14988c80405f33e082
+        with:
+          args: instance server wait ${{ fromJson(steps.scw.outputs.json).ID }} zone=fr-par-2
+      - name: Wait for SSH
+        uses: iFaxity/wait-on-action@a7d13170ec542bdca4ef8ac4b15e9c6aa00a6866
+        with:
+          resource: tcp:${{ fromJson(steps.scw.outputs.json).public_ip.address }}:22
+          timeout: 300000
+      - name: Setup SSH for ARM node
+        run: |
+          mkdir -p ~/.ssh
+          echo "$SSH_KEY" > ~/.ssh/id_rsa_arm
+          chmod 600 ~/.ssh/id_rsa_arm
+          echo "$SSH_CONFIG" | sed "s/SSH_IP/$SSH_IP/g" > ~/.ssh/config
+        env:
+          SSH_KEY: ${{ secrets.ARM_SSH_KEY }}
+          SSH_IP: ${{ fromJson(steps.scw.outputs.json).public_ip.address }}
+          SSH_CONFIG: ${{ secrets.ARM_SSH_CONFIG }}
+      - name: Install Docker
+        run: ssh root@$SSH_IP "curl -fsSL https://test.docker.com -o test-docker.sh ; sh test-docker.sh ; echo 'ClientAliveInterval 60' >> /etc/ssh/sshd_config ; echo 'ClientAliveCountMax 0' >> /etc/ssh/sshd_config ; systemctl restart ssh"
+        env:
+          SSH_IP: ${{ fromJson(steps.scw.outputs.json).public_ip.address }}

.github/workflows/dev-update-mmdb.yml

@@ -0,0 +1,61 @@
+name: Update cached mmdb files
+
+permissions:
+  contents: write
+
+on:
+  schedule:
+    - cron: "0 12 5 * *"
+
+jobs:
+  mmdb-update:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout source code
+        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+        with:
+          fetch-depth: 0
+          token: ${{ secrets.BUNKERBOT_TOKEN }}
+          ref: dev
+      - name: Download mmdb files
+        run: |
+          mkdir -p src/bw/misc/
+          cd src/bw/misc/
+          CURL_RETURN_CODE=0
+          CURL_OUTPUT=`curl -w httpcode=%{http_code} -s -o asn.mmdb.gz https://download.db-ip.com/free/dbip-asn-lite-$(date +%Y-%m).mmdb.gz 2> /dev/null` || CURL_RETURN_CODE=$?
+          if [ ${CURL_RETURN_CODE} -ne 0 ]; then
+            echo "Curl connection failed when downloading asn-lite mmdb file with return code - ${CURL_RETURN_CODE}"
+            exit 1
+          else
+              echo "Curl connection success"
+              # Check http code for curl operation/response in  CURL_OUTPUT
+              httpCode=$(echo "${CURL_OUTPUT}" | sed -e 's/.*\httpcode=//')
+              if [ ${httpCode} -ne 200 ]; then
+                  echo "Curl operation/command failed due to server return code - ${httpCode}"
+                  exit 1
+              fi
+          fi
+          CURL_RETURN_CODE=0
+          CURL_OUTPUT=`curl -w httpcode=%{http_code} -s -o country.mmdb.gz https://download.db-ip.com/free/dbip-country-lite-$(date +%Y-%m).mmdb.gz 2> /dev/null` || CURL_RETURN_CODE=$?
+          if [ ${CURL_RETURN_CODE} -ne 0 ]; then
+            echo "Curl connection failed when downloading country-lite mmdb file with return code - ${CURL_RETURN_CODE}"
+            exit 1
+          else
+              echo "Curl connection success"
+              # Check http code for curl operation/response in  CURL_OUTPUT
+              httpCode=$(echo "${CURL_OUTPUT}" | sed -e 's/.*\httpcode=//')
+              if [ ${httpCode} -ne 200 ]; then
+                  echo "Curl operation/command failed due to server return code - ${httpCode}"
+                  exit 1
+              fi
+          fi
+          rm -f asn.mmdb country.mmdb
+          gunzip asn.mmdb.gz country.mmdb.gz
+      - name: Commit and push changes
+        uses: stefanzweifel/git-auto-commit-action@8621497c8c39c72f3e2a999a26b4ca1b5058a842 # v5.0.1
+        with:
+          branch: dev
+          commit_message: "Monthly mmdb update"
+          commit_options: "--no-verify"
+          commit_user_name: "BunkerBot"
+          commit_user_email: "bunkerbot@bunkerity.com"

.github/workflows/dev.yml

@@ -0,0 +1,243 @@
+name: Automatic tests (DEV)
+
+permissions: read-all
+
+on:
+  push:
+    branches: [dev]
+
+jobs:
+  # Containers
+  build-containers:
+    permissions:
+      contents: read
+      packages: write
+    strategy:
+      fail-fast: false
+      matrix:
+        image: [bunkerweb, scheduler, autoconf, ui]
+        include:
+          - image: bunkerweb
+            dockerfile: src/bw/Dockerfile
+          - image: scheduler
+            dockerfile: src/scheduler/Dockerfile
+          - image: autoconf
+            dockerfile: src/autoconf/Dockerfile
+          - image: ui
+            dockerfile: src/ui/Dockerfile
+    uses: ./.github/workflows/container-build.yml
+    with:
+      RELEASE: dev
+      ARCH: linux/amd64
+      CACHE: true
+      IMAGE: ${{ matrix.image }}
+      DOCKERFILE: ${{ matrix.dockerfile }}
+    secrets:
+      DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
+      DOCKER_TOKEN: ${{ secrets.DOCKER_TOKEN }}
+
+  # Build Linux packages
+  build-packages:
+    permissions:
+      contents: read
+      packages: write
+    strategy:
+      matrix:
+        linux: [ubuntu, debian, fedora, rhel, rhel9, ubuntu-jammy]
+        include:
+          - linux: ubuntu
+            package: deb
+          - linux: ubuntu-jammy
+            package: deb
+          - linux: debian
+            package: deb
+          - linux: fedora
+            package: rpm
+          - linux: rhel
+            package: rpm
+          - linux: rhel9
+            package: rpm
+    uses: ./.github/workflows/linux-build.yml
+    with:
+      RELEASE: dev
+      LINUX: ${{ matrix.linux }}
+      PACKAGE: ${{ matrix.package }}
+      TEST: true
+      PLATFORMS: linux/amd64
+    secrets:
+      DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
+      DOCKER_TOKEN: ${{ secrets.DOCKER_TOKEN }}
+
+  codeql:
+    uses: ./.github/workflows/codeql.yml
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+  # UI tests
+  prepare-tests-ui:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+      - id: set-matrix
+        run: |
+          tests=$(find ./tests/ui/ -name "*_page.py" -type f -printf "%f\n" | jq -c --raw-input --slurp 'split("\n")| .[0:-1]')
+          echo "tests=$tests" >> $GITHUB_OUTPUT
+    outputs:
+      tests: ${{ steps.set-matrix.outputs.tests }}
+  tests-ui:
+    needs: [prepare-tests-ui, build-containers]
+    strategy:
+      fail-fast: false
+      matrix:
+        test: ${{ fromJson(needs.prepare-tests-ui.outputs.tests) }}
+    uses: ./.github/workflows/tests-ui.yml
+    with:
+      TEST: ${{ matrix.test }}
+      RELEASE: dev
+  tests-ui-linux:
+    needs: [prepare-tests-ui, build-packages]
+    strategy:
+      fail-fast: false
+      matrix:
+        test: ${{ fromJson(needs.prepare-tests-ui.outputs.tests) }}
+    uses: ./.github/workflows/tests-ui-linux.yml
+    with:
+      TEST: ${{ matrix.test }}
+      RELEASE: dev
+
+  # Core tests
+  prepare-tests-core:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+      - id: set-matrix
+        run: |
+          tests=$(find ./tests/core/ -maxdepth 1 -mindepth 1 -type d -printf "%f\n" | jq -c --raw-input --slurp 'split("\n")| .[0:-1]')
+          echo "tests=$tests" >> $GITHUB_OUTPUT
+    outputs:
+      tests: ${{ steps.set-matrix.outputs.tests }}
+  tests-core:
+    needs: [build-containers, prepare-tests-core]
+    strategy:
+      fail-fast: false
+      matrix:
+        test: ${{ fromJson(needs.prepare-tests-core.outputs.tests) }}
+    uses: ./.github/workflows/test-core.yml
+    with:
+      TEST: ${{ matrix.test }}
+      RELEASE: dev
+  tests-core-linux:
+    needs: [build-packages, prepare-tests-core]
+    strategy:
+      fail-fast: false
+      matrix:
+        test: ${{ fromJson(needs.prepare-tests-core.outputs.tests) }}
+    uses: ./.github/workflows/test-core-linux.yml
+    with:
+      TEST: ${{ matrix.test }}
+      RELEASE: dev
+    secrets: inherit
+
+  # Push with dev tag
+  push-dev:
+    needs: [tests-ui, tests-core]
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+    steps:
+      - name: Login to Docker Hub
+        uses: docker/login-action@0d4c9c5ea7693da7b068278f7b52bda2a190a446 # v3.2.0
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_TOKEN }}
+      - name: Login to ghcr
+        uses: docker/login-action@0d4c9c5ea7693da7b068278f7b52bda2a190a446 # v3.2.0
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - name: Push BW image
+        run: docker pull ghcr.io/bunkerity/$FROM-tests:dev && docker tag ghcr.io/bunkerity/$FROM-tests:dev bunkerity/$TO:dev && docker tag ghcr.io/bunkerity/$FROM-tests:dev ghcr.io/bunkerity/$TO:dev && docker push bunkerity/$TO:dev && docker push ghcr.io/bunkerity/$TO:dev
+        env:
+          FROM: "bunkerweb"
+          TO: "bunkerweb"
+      - name: Push scheduler image
+        run: docker pull ghcr.io/bunkerity/$FROM-tests:dev && docker tag ghcr.io/bunkerity/$FROM-tests:dev bunkerity/$TO:dev && docker tag ghcr.io/bunkerity/$FROM-tests:dev ghcr.io/bunkerity/$TO:dev && docker push bunkerity/$TO:dev && docker push ghcr.io/bunkerity/$TO:dev
+        env:
+          FROM: "scheduler"
+          TO: "bunkerweb-scheduler"
+      - name: Push UI image
+        run: docker pull ghcr.io/bunkerity/$FROM-tests:dev && docker tag ghcr.io/bunkerity/$FROM-tests:dev bunkerity/$TO:dev && docker tag ghcr.io/bunkerity/$FROM-tests:dev ghcr.io/bunkerity/$TO:dev && docker push bunkerity/$TO:dev && docker push ghcr.io/bunkerity/$TO:dev
+        env:
+          FROM: "ui"
+          TO: "bunkerweb-ui"
+      - name: Push autoconf image
+        run: docker pull ghcr.io/bunkerity/$FROM-tests:dev && docker tag ghcr.io/bunkerity/$FROM-tests:dev bunkerity/$TO:dev && docker tag ghcr.io/bunkerity/$FROM-tests:dev ghcr.io/bunkerity/$TO:dev && docker push bunkerity/$TO:dev && docker push ghcr.io/bunkerity/$TO:dev
+        env:
+          FROM: "autoconf"
+          TO: "bunkerweb-autoconf"
+
+  # Push Linux packages
+  push-packages:
+    needs: [tests-ui-linux, tests-core-linux]
+    strategy:
+      matrix:
+        linux: [ubuntu, debian, fedora, el, el9, ubuntu-jammy]
+        arch: [amd64]
+        include:
+          - release: dev
+            repo: bunkerweb
+          - linux: ubuntu
+            package_arch: amd64
+            separator: _
+            suffix: ""
+            version: noble
+            package: deb
+          - linux: debian
+            package_arch: amd64
+            separator: _
+            suffix: ""
+            version: bookworm
+            package: deb
+          - linux: fedora
+            package_arch: x86_64
+            separator: "-"
+            suffix: "1."
+            version: 40
+            package: rpm
+          - linux: el
+            package_arch: x86_64
+            separator: "-"
+            suffix: "1."
+            version: 8
+            package: rpm
+          - linux: el9
+            package_arch: x86_64
+            separator: "-"
+            suffix: "1."
+            version: 9
+            package: rpm
+          - linux: ubuntu-jammy
+            package_arch: amd64
+            separator: _
+            suffix: ""
+            version: jammy
+            package: deb
+    uses: ./.github/workflows/push-packagecloud.yml
+    with:
+      SEPARATOR: ${{ matrix.separator }}
+      SUFFIX: ${{ matrix.suffix }}
+      REPO: ${{ matrix.repo }}
+      LINUX: ${{ matrix.linux }}
+      VERSION: ${{ matrix.version }}
+      PACKAGE: ${{ matrix.package }}
+      BW_VERSION: ${{ matrix.release }}
+      PACKAGE_ARCH: ${{ matrix.package_arch }}
+      ARCH: ${{ matrix.arch }}
+    secrets:
+      PACKAGECLOUD_TOKEN: ${{ secrets.PACKAGECLOUD_TOKEN }}

.github/workflows/doc-to-pdf.yml

@@ -0,0 +1,38 @@
+name: Generate documentation PDF (REUSABLE)
+
+on:
+  workflow_call:
+    inputs:
+      VERSION:
+        required: true
+        type: string
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      # Prepare
+      - name: Checkout source code
+        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+      - name: Install Python
+        uses: actions/setup-python@82c7e631bb3cdc910f68e0081d67478d79c6982d # v5.1.0
+        with:
+          python-version: "3.10"
+      - name: Install doc dependencies
+        run: pip install --no-cache-dir --require-hashes -r docs/requirements.txt && sudo apt install -y libcairo2-dev libfreetype6-dev libffi-dev libjpeg-dev libpng-dev libz-dev
+      - name: Install chromium
+        run: sudo apt install chromium-browser
+      - name: Install node
+        uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2
+        with:
+          node-version: 18
+      - name: Install puppeteer
+        run: cd docs && npm install
+      - name: Run mkdocs serve in background
+        run: mkdocs serve & sleep 10
+      - name: Run pdf script
+        run: node docs/misc/pdf.js http://localhost:8000/print_page/ BunkerWeb_documentation_v${{ inputs.VERSION }}.pdf 'BunkerWeb documentation v${{ inputs.VERSION }}'
+      - uses: actions/upload-artifact@65462800fd760344b1a7b4382951275a0abb4808 # v4.3.3
+        with:
+          name: BunkerWeb_documentation_v${{ inputs.VERSION }}.pdf
+          path: BunkerWeb_documentation_v${{ inputs.VERSION }}.pdf

.github/workflows/linux-build.yml

@@ -0,0 +1,157 @@
+name: Build Linux package (REUSABLE)
+
+on:
+  workflow_call:
+    inputs:
+      RELEASE:
+        required: true
+        type: string
+      LINUX:
+        required: true
+        type: string
+      PACKAGE:
+        required: true
+        type: string
+      PLATFORMS:
+        required: true
+        type: string
+      TEST:
+        required: false
+        type: boolean
+        default: false
+    secrets:
+      DOCKER_USERNAME:
+        required: true
+      DOCKER_TOKEN:
+        required: true
+      ARM_SSH_KEY:
+        required: false
+      ARM_SSH_IP:
+        required: false
+      ARM_SSH_CONFIG:
+        required: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      # Prepare
+      - name: Checkout source code
+        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+      - name: Replace VERSION
+        if: inputs.RELEASE == 'testing' || inputs.RELEASE == 'dev' || inputs.RELEASE == 'ui'
+        run: ./misc/update-version.sh ${{ inputs.RELEASE }}
+      - name: Replace VERSION 1.6
+        if: inputs.RELEASE == '1.6'
+        run: ./misc/update-version.sh dev
+      - name: Extract arch
+        run: |
+          echo "ARCH=${{ env.PLATFORMS }}" | sed 's/linux//g' | sed 's@/@@g' >> "$GITHUB_ENV"
+        env:
+          PLATFORMS: ${{ inputs.PLATFORMS }}
+      - name: Extract linux arch
+        if: inputs.PACKAGE == 'rpm'
+        run: |
+          echo "LARCH=${{ env.ARCH }}" | sed 's/amd64/x86_64/g' | sed 's/arm64/aarch64/g' >> "$GITHUB_ENV"
+        env:
+          ARCH: ${{ env.ARCH }}
+      - name: Extract linux arch
+        if: inputs.PACKAGE == 'deb'
+        run: |
+          echo "LARCH=${{ env.ARCH }}" >> "$GITHUB_ENV"
+        env:
+          ARCH: ${{ env.ARCH }}
+      - name: Setup SSH for ARM node
+        if: startsWith(env.ARCH, 'arm') == true
+        run: |
+          mkdir -p ~/.ssh
+          echo "$SSH_KEY" > ~/.ssh/id_rsa_arm
+          chmod 600 ~/.ssh/id_rsa_arm
+          echo "$SSH_CONFIG" | sed "s/SSH_IP/$SSH_IP/g" > ~/.ssh/config
+          echo "ServerAliveInterval 60" >> ~/.ssh/config
+          echo "ServerAliveCountMax 10" >> ~/.ssh/config
+        env:
+          SSH_KEY: ${{ secrets.ARM_SSH_KEY }}
+          SSH_IP: ${{ secrets.ARM_SSH_IP }}
+          SSH_CONFIG: ${{ secrets.ARM_SSH_CONFIG }}
+      - name: Setup Buildx
+        uses: docker/setup-buildx-action@d70bba72b1f3fd22344832f00baa16ece964efeb # v3.3.0
+        if: startsWith(env.ARCH, 'arm') == false
+      - name: Setup Buildx (ARM)
+        uses: docker/setup-buildx-action@d70bba72b1f3fd22344832f00baa16ece964efeb # v3.3.0
+        if: startsWith(env.ARCH, 'arm') == true
+        with:
+          endpoint: ssh://root@arm
+          platforms: linux/arm64,linux/arm/v7,linux/arm/v6
+      - name: Login to Docker Hub
+        uses: docker/login-action@0d4c9c5ea7693da7b068278f7b52bda2a190a446 # v3.2.0
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_TOKEN }}
+      - name: Login to ghcr
+        uses: docker/login-action@0d4c9c5ea7693da7b068278f7b52bda2a190a446 # v3.2.0
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      # Build testing package image
+      - name: Build package image
+        if: inputs.RELEASE == 'testing' || inputs.RELEASE == 'dev' || inputs.RELEASE == 'ui' || inputs.RELEASE == '1.6'
+        uses: docker/build-push-action@15560696de535e4014efeff63c48f16952e52dd1 # v6.2.0
+        with:
+          context: .
+          load: true
+          file: src/linux/Dockerfile-${{ inputs.LINUX }}
+          platforms: ${{ inputs.PLATFORMS }}
+          tags: local/bunkerweb-${{ inputs.LINUX }}:latest
+          cache-from: type=gha,scope=${{ inputs.LINUX }}-${{ inputs.RELEASE }}
+          cache-to: type=gha,scope=${{ inputs.LINUX }}-${{ inputs.RELEASE }},mode=min
+      # Build non-testing package image
+      - name: Build package image
+        if: inputs.RELEASE != 'testing' && inputs.RELEASE != 'dev' && inputs.RELEASE != 'ui' && inputs.RELEASE != '1.6'
+        uses: docker/build-push-action@15560696de535e4014efeff63c48f16952e52dd1 # v6.2.0
+        with:
+          context: .
+          load: true
+          file: src/linux/Dockerfile-${{ inputs.LINUX }}
+          platforms: ${{ inputs.PLATFORMS }}
+          tags: local/bunkerweb-${{ inputs.LINUX }}:latest
+      # Generate package
+      - name: Generate package
+        if: startsWith(env.ARCH, 'arm') == false
+        run: ./src/linux/package.sh ${{ inputs.LINUX }} ${{ env.LARCH }}
+        env:
+          LARCH: ${{ env.LARCH }}
+      - name: Generate package (ARM)
+        if: startsWith(env.ARCH, 'arm') == true
+        run: |
+          docker save local/bunkerweb-${{ inputs.LINUX }}:latest | ssh -C root@arm docker load
+          scp ./src/linux/package.sh root@arm:/opt
+          ssh root@arm chmod +x /opt/package.sh
+          ssh root@arm /opt/package.sh ${{ inputs.LINUX }} ${{ env.LARCH }} "$(cat src/VERSION | tr -d '\n')"
+          scp -r root@arm:/root/package-${{ inputs.LINUX }} ./package-${{ inputs.LINUX }}
+        env:
+          LARCH: ${{ env.LARCH }}
+      - uses: actions/upload-artifact@65462800fd760344b1a7b4382951275a0abb4808 # v4.3.3
+        with:
+          name: package-${{ inputs.LINUX }}-${{ env.LARCH }}
+          path: package-${{ inputs.LINUX }}/*.${{ inputs.PACKAGE }}
+      # Build test image
+      - name: Extract metadata
+        if: inputs.TEST == true
+        id: meta
+        uses: docker/metadata-action@8e5442c4ef9f78752691e2d8f8d19755c6f78e81 # v5.5.1
+        with:
+          images: ghcr.io/bunkerity/${{ inputs.LINUX }}-tests:${{ inputs.RELEASE }}
+      - name: Build test image
+        if: inputs.TEST == true
+        uses: docker/build-push-action@15560696de535e4014efeff63c48f16952e52dd1 # v6.2.0
+        with:
+          context: .
+          file: tests/linux/Dockerfile-${{ inputs.LINUX }}
+          platforms: ${{ inputs.PLATFORMS }}
+          push: true
+          tags: ghcr.io/bunkerity/${{ inputs.LINUX }}-tests:${{ inputs.RELEASE }}
+          labels: ${{ steps.meta.outputs.labels }}
+          cache-from: type=gha,scope=${{ inputs.LINUX }}-${{ inputs.RELEASE }}-tests
+          cache-to: type=gha,scope=${{ inputs.LINUX }}-${{ inputs.RELEASE }}-tests,mode=min

.github/workflows/push-doc.yml

@@ -0,0 +1,41 @@
+name: Push documentation (REUSABLE)
+
+on:
+  workflow_call:
+    inputs:
+      VERSION:
+        required: true
+        type: string
+      ALIAS:
+        required: true
+        type: string
+    secrets:
+      BUNKERBOT_TOKEN:
+        required: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout source code
+        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+        with:
+          fetch-depth: 0
+          token: ${{ secrets.BUNKERBOT_TOKEN }}
+      - name: Replace VERSION
+        if: inputs.VERSION == 'testing'
+        run: ./misc/update-version.sh testing
+      - name: Setup git user
+        run: |
+          git config --global user.name "BunkerBot"
+          git config --global user.email "bunkerbot@bunkerity.com"
+      - uses: actions/setup-python@82c7e631bb3cdc910f68e0081d67478d79c6982d # v5.1.0
+        with:
+          python-version: "3.10"
+      - name: Install doc dependencies
+        run: pip install --no-cache-dir --require-hashes -r docs/requirements.txt && sudo apt install -y libcairo2-dev libfreetype6-dev libffi-dev libjpeg-dev libpng-dev libz-dev
+      - name: Push doc
+        run: mike deploy --update-aliases --push --alias-type=copy ${{ inputs.VERSION }} ${{ inputs.ALIAS }}
+      - name: Set default doc
+        if: inputs.ALIAS == 'latest'
+        run: mike set-default --push latest

.github/workflows/push-docker.yml

@@ -0,0 +1,84 @@
+name: Push image (REUSABLE)
+
+on:
+  workflow_call:
+    inputs:
+      IMAGE:
+        required: true
+        type: string
+      TAGS:
+        required: true
+        type: string
+      CACHE_FROM:
+        required: true
+        type: string
+      DOCKERFILE:
+        required: true
+        type: string
+    secrets:
+      DOCKER_USERNAME:
+        required: true
+      DOCKER_TOKEN:
+        required: true
+      ARM_SSH_KEY:
+        required: true
+      ARM_SSH_CONFIG:
+        required: true
+      ARM_SSH_IP:
+        required: true
+
+jobs:
+  push:
+    runs-on: ubuntu-latest
+    steps:
+      # Prepare
+      - name: Check out repository code
+        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+      - name: Login to Docker Hub
+        uses: docker/login-action@0d4c9c5ea7693da7b068278f7b52bda2a190a446 # v3.2.0
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_TOKEN }}
+      - name: Login to ghcr
+        uses: docker/login-action@0d4c9c5ea7693da7b068278f7b52bda2a190a446 # v3.2.0
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - name: Setup SSH for ARM node
+        run: |
+          mkdir -p ~/.ssh
+          echo "$SSH_KEY" > ~/.ssh/id_rsa_arm
+          chmod 600 ~/.ssh/id_rsa_arm
+          echo "$SSH_CONFIG" | sed "s/SSH_IP/$SSH_IP/g" > ~/.ssh/config
+          echo "ServerAliveInterval 60" >> ~/.ssh/config
+          echo "ServerAliveCountMax 10" >> ~/.ssh/config
+        env:
+          SSH_KEY: ${{ secrets.ARM_SSH_KEY }}
+          SSH_IP: ${{ secrets.ARM_SSH_IP }}
+          SSH_CONFIG: ${{ secrets.ARM_SSH_CONFIG }}
+      - name: Setup Buildx (ARM)
+        uses: docker/setup-buildx-action@d70bba72b1f3fd22344832f00baa16ece964efeb # v3.3.0
+        with:
+          endpoint: ssh://root@arm
+          platforms: linux/arm64,linux/arm/v7,linux/arm/v6
+      # Compute metadata
+      - name: Extract metadata
+        id: meta
+        uses: docker/metadata-action@8e5442c4ef9f78752691e2d8f8d19755c6f78e81 # v5.5.1
+        with:
+          images: bunkerity/${{ inputs.IMAGE }}
+      # Build and push
+      - name: Build and push
+        uses: docker/build-push-action@15560696de535e4014efeff63c48f16952e52dd1 # v6.2.0
+        with:
+          context: .
+          file: ${{ inputs.DOCKERFILE }}
+          platforms: linux/amd64,linux/386,linux/arm64,linux/arm/v7
+          push: true
+          tags: ${{ inputs.TAGS }}
+          labels: ${{ steps.meta.outputs.labels }}
+          cache-from: |
+            type=gha,scope=${{ inputs.CACHE_FROM }}-amd64
+            type=gha,scope=${{ inputs.CACHE_FROM }}-386
+            type=gha,scope=${{ inputs.CACHE_FROM }}-arm

.github/workflows/push-github.yml

@@ -0,0 +1,97 @@
+name: Push on GitHub (REUSABLE)
+
+on:
+  workflow_call:
+    inputs:
+      VERSION:
+        required: true
+        type: string
+      PRERELEASE:
+        required: true
+        type: boolean
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      # Checkout
+      - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+      # Get PDF doc
+      - name: Get documentation
+        if: inputs.VERSION != 'testing'
+        uses: actions/download-artifact@65a9edc5881444af0b9093a5e628f2fe47ea3b2e # v4.1.7
+        with:
+          name: BunkerWeb_documentation_v${{ inputs.VERSION }}.pdf
+      # Create tag
+      - uses: rickstaa/action-create-tag@a1c7777fcb2fee4f19b0f283ba888afa11678b72 # v1.7.2
+        name: Create tag
+        if: inputs.VERSION != 'testing'
+        with:
+          tag: "v${{ inputs.VERSION }}"
+          message: "v${{ inputs.VERSION }}"
+          force_push_tag: true
+      # Create tag
+      - uses: rickstaa/action-create-tag@a1c7777fcb2fee4f19b0f283ba888afa11678b72 # v1.7.2
+        name: Create tag
+        if: inputs.VERSION == 'testing'
+        with:
+          tag: "${{ inputs.VERSION }}"
+          message: "${{ inputs.VERSION }}"
+          force_push_tag: true
+      # Extract changelog
+      - name: Extract changelog
+        if: inputs.VERSION != 'testing'
+        id: getchangelog
+        run: |
+          content=$(awk -v n=2 '/##/{n--}; n > 0' CHANGELOG.md | grep -v '# Changelog' | grep -v '##' | sed '/^$/d')
+          content="${content//'%'/'%25'}"
+          content="${content//$'\n'/'%0A'}"
+          content="${content//$'\r'/'%0D'}"
+          echo "content=$content" >> $GITHUB_OUTPUT
+      # Create release
+      - name: Create release
+        if: inputs.VERSION != 'testing'
+        uses: softprops/action-gh-release@a74c6b72af54cfa997e81df42d94703d6313a2d0 # v2.0.6
+        with:
+          body: |
+            Documentation : https://docs.bunkerweb.io/${{ inputs.VERSION }}/
+
+            Docker tags :
+            - BunkerWeb : `bunkerity/bunkerweb:${{ inputs.VERSION }}` or `ghcr.io/bunkerity/bunkerweb:${{ inputs.VERSION }}`
+            - Scheduler : `bunkerity/bunkerweb-scheduler:${{ inputs.VERSION }}` or `ghcr.io/bunkerity/bunkerweb-scheduler:${{ inputs.VERSION }}`
+            - Autoconf : `bunkerity/bunkerweb-autoconf:${{ inputs.VERSION }}` or `ghcr.io/bunkerity/bunkerweb-autoconf:${{ inputs.VERSION }}`
+            - UI : `bunkerity/bunkerweb-ui:${{ inputs.VERSION }}` or `ghcr.io/bunkerity/bunkerweb-ui:${{ inputs.VERSION }}`
+
+            Linux packages : https://packagecloud.io/app/bunkerity/bunkerweb/search?q=${{ inputs.VERSION }}&filter=all&dist=
+
+            Changelog :
+            ${{ steps.getchangelog.outputs.content }}
+          draft: true
+          prerelease: ${{ inputs.PRERELEASE }}
+          name: v${{ inputs.VERSION }}
+          tag_name: v${{ inputs.VERSION }}
+          discussion_category_name: Announcements
+          files: BunkerWeb_documentation_v${{ inputs.VERSION }}.pdf
+      # Create release
+      - name: Create release
+        if: inputs.VERSION == 'testing'
+        uses: softprops/action-gh-release@a74c6b72af54cfa997e81df42d94703d6313a2d0 # v2.0.6
+        with:
+          body: |
+            **The testing version of BunkerWeb should not be used in production, please use the latest stable version instead.**
+
+            Documentation : https://docs.bunkerweb.io/${{ inputs.VERSION }}/
+
+            Docker tags :
+            - BunkerWeb : `bunkerity/bunkerweb:${{ inputs.VERSION }}` or `ghcr.io/bunkerity/bunkerweb:${{ inputs.VERSION }}`
+            - Scheduler : `bunkerity/bunkerweb-scheduler:${{ inputs.VERSION }}` or `ghcr.io/bunkerity/bunkerweb-scheduler:${{ inputs.VERSION }}`
+            - Autoconf : `bunkerity/bunkerweb-autoconf:${{ inputs.VERSION }}` or `ghcr.io/bunkerity/bunkerweb-autoconf:${{ inputs.VERSION }}`
+            - UI : `bunkerity/bunkerweb-ui:${{ inputs.VERSION }}` or `ghcr.io/bunkerity/bunkerweb-ui:${{ inputs.VERSION }}`
+
+            Linux packages : https://packagecloud.io/app/bunkerity/bunkerweb/search?q=${{ inputs.VERSION }}&filter=all&dist=
+
+            Please note that when using Linux Debian or Ubuntu integration, you will need to add the `force-bad-version` directive to your `/etc/dpkg/dpkg.cfg` file before installing the testing version of BunkerWeb.
+          draft: false
+          prerelease: ${{ inputs.PRERELEASE }}
+          name: Testing
+          tag_name: ${{ inputs.VERSION }}

.github/workflows/push-packagecloud.yml

@@ -0,0 +1,111 @@
+name: Push packagecloud (REUSABLE)
+
+on:
+  workflow_call:
+    inputs:
+      SEPARATOR:
+        required: true
+        type: string
+      SUFFIX:
+        required: true
+        type: string
+      REPO:
+        required: true
+        type: string
+      LINUX:
+        required: true
+        type: string
+      VERSION:
+        required: true
+        type: string
+      PACKAGE:
+        required: true
+        type: string
+      BW_VERSION:
+        required: true
+        type: string
+      ARCH:
+        required: true
+        type: string
+      PACKAGE_ARCH:
+        required: true
+        type: string
+    secrets:
+      PACKAGECLOUD_TOKEN:
+        required: true
+
+jobs:
+  push:
+    runs-on: ubuntu-latest
+    steps:
+      # Prepare
+      - name: Check out repository code
+        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+      - name: Install ruby
+        uses: ruby/setup-ruby@3783f195e29b74ae398d7caca108814bbafde90e # v1.180.1
+        with:
+          ruby-version: "3.0"
+      - name: Install packagecloud
+        run: gem install package_cloud
+      # Download packages
+      - uses: actions/download-artifact@65a9edc5881444af0b9093a5e628f2fe47ea3b2e # v4.1.7
+        if: inputs.LINUX != 'el' && inputs.LINUX != 'el9'
+        with:
+          name: package-${{ inputs.LINUX }}-${{ inputs.PACKAGE_ARCH }}
+          path: /tmp/${{ inputs.LINUX }}
+      - uses: actions/download-artifact@65a9edc5881444af0b9093a5e628f2fe47ea3b2e # v4.1.7
+        if: inputs.LINUX == 'el' || inputs.LINUX == 'el9'
+        with:
+          name: package-rh${{ inputs.LINUX }}-${{ inputs.PACKAGE_ARCH }}
+          path: /tmp/${{ inputs.LINUX }}
+      # Remove existing packages
+      - name: Remove existing package
+        if: inputs.LINUX != 'el9' && inputs.LINUX != 'ubuntu-jammy'
+        run: package_cloud yank bunkerity/${{ inputs.REPO }}/${{ inputs.LINUX }}/${{ inputs.VERSION }} bunkerweb${{ inputs.SEPARATOR }}${{ inputs.BW_VERSION }}${{ inputs.SEPARATOR }}${{ inputs.SUFFIX }}${{ inputs.PACKAGE_ARCH }}.${{ inputs.PACKAGE }}
+        continue-on-error: true
+        env:
+          PACKAGECLOUD_TOKEN: ${{ secrets.PACKAGECLOUD_TOKEN }}
+      - name: Remove existing package el9
+        if: inputs.LINUX == 'el9'
+        run: package_cloud yank bunkerity/${{ inputs.REPO }}/el/9 bunkerweb${{ inputs.SEPARATOR }}${{ inputs.BW_VERSION }}${{ inputs.SEPARATOR }}${{ inputs.SUFFIX }}${{ inputs.PACKAGE_ARCH }}.${{ inputs.PACKAGE }}
+        continue-on-error: true
+        env:
+          PACKAGECLOUD_TOKEN: ${{ secrets.PACKAGECLOUD_TOKEN }}
+      - name: Remove existing package ubuntu-jammy
+        if: inputs.LINUX == 'ubuntu-jammy'
+        run: package_cloud yank bunkerity/${{ inputs.REPO }}/ubuntu/jammy bunkerweb${{ inputs.SEPARATOR }}${{ inputs.BW_VERSION }}${{ inputs.SEPARATOR }}${{ inputs.SUFFIX }}${{ inputs.PACKAGE_ARCH }}.${{ inputs.PACKAGE }}
+        continue-on-error: true
+        env:
+          PACKAGECLOUD_TOKEN: ${{ secrets.PACKAGECLOUD_TOKEN }}
+      # Update name
+      # - name: Rename package
+      #   if: inputs.BW_VERSION == 'testing'
+      #   run: sudo apt install -y rename && rename 's/[0-9]\.[0-9]\.[0-9]/testing/' /tmp/${{ inputs.LINUX }}/*.${{ inputs.PACKAGE }}
+      # Push package
+      - name: Push package to packagecloud
+        if: inputs.LINUX != 'el9' && inputs.LINUX != 'ubuntu-jammy'
+        uses: danielmundi/upload-packagecloud@46cd0e61152bf952dbc0d1759e609d3d22649030 # v1
+        with:
+          PACKAGE-NAME: /tmp/${{ inputs.LINUX }}/*.${{ inputs.PACKAGE }}
+          PACKAGECLOUD-USERNAME: bunkerity
+          PACKAGECLOUD-REPO: ${{ inputs.REPO }}
+          PACKAGECLOUD-DISTRIB: ${{ inputs.LINUX }}/${{ inputs.VERSION }}
+          PACKAGECLOUD-TOKEN: ${{ secrets.PACKAGECLOUD_TOKEN }}
+      - name: Push package to packagecloud for el9
+        if: inputs.LINUX == 'el9'
+        uses: danielmundi/upload-packagecloud@46cd0e61152bf952dbc0d1759e609d3d22649030 # v1
+        with:
+          PACKAGE-NAME: /tmp/${{ inputs.LINUX }}/*.${{ inputs.PACKAGE }}
+          PACKAGECLOUD-USERNAME: bunkerity
+          PACKAGECLOUD-REPO: ${{ inputs.REPO }}
+          PACKAGECLOUD-DISTRIB: el/9
+          PACKAGECLOUD-TOKEN: ${{ secrets.PACKAGECLOUD_TOKEN }}
+      - name: Push package to packagecloud for ubuntu-jammy
+        if: inputs.LINUX == 'ubuntu-jammy'
+        uses: danielmundi/upload-packagecloud@46cd0e61152bf952dbc0d1759e609d3d22649030 # v1
+        with:
+          PACKAGE-NAME: /tmp/${{ inputs.LINUX }}/*.${{ inputs.PACKAGE }}
+          PACKAGECLOUD-USERNAME: bunkerity
+          PACKAGECLOUD-REPO: ${{ inputs.REPO }}
+          PACKAGECLOUD-DISTRIB: ubuntu/jammy
+          PACKAGECLOUD-TOKEN: ${{ secrets.PACKAGECLOUD_TOKEN }}

.github/workflows/release.yml

@@ -0,0 +1,321 @@
+name: Automatic push (RELEASE)
+
+permissions: read-all
+
+on:
+  push:
+    branches: [master]
+
+jobs:
+  # scorecards-analysis:
+  #   uses: ./.github/workflows/scorecards-analysis.yml
+
+  codeql:
+    uses: ./.github/workflows/codeql.yml
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+  # Build amd64 + 386 containers images
+  build-containers:
+    strategy:
+      matrix:
+        image: [bunkerweb, scheduler, autoconf, ui]
+        arch: [linux/amd64, linux/386]
+        include:
+          - release: latest
+            cache: false
+            push: false
+          - image: bunkerweb
+            dockerfile: src/bw/Dockerfile
+          - image: scheduler
+            dockerfile: src/scheduler/Dockerfile
+          - image: autoconf
+            dockerfile: src/autoconf/Dockerfile
+          - image: ui
+            dockerfile: src/ui/Dockerfile
+          - arch: linux/amd64
+            cache_suffix: amd64
+          - arch: linux/386
+            cache_suffix: "386"
+    uses: ./.github/workflows/container-build.yml
+    with:
+      RELEASE: ${{ matrix.release }}
+      ARCH: ${{ matrix.arch }}
+      IMAGE: ${{ matrix.image }}
+      DOCKERFILE: ${{ matrix.dockerfile }}
+      CACHE: ${{ matrix.cache }}
+      PUSH: ${{ matrix.push }}
+      CACHE_SUFFIX: ${{ matrix.cache_suffix }}
+    secrets:
+      DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
+      DOCKER_TOKEN: ${{ secrets.DOCKER_TOKEN }}
+
+  # Create ARM environment
+  create-arm:
+    uses: ./.github/workflows/create-arm.yml
+    secrets:
+      SCW_ACCESS_KEY: ${{ secrets.SCW_ACCESS_KEY }}
+      SCW_SECRET_KEY: ${{ secrets.SCW_SECRET_KEY }}
+      SCW_DEFAULT_PROJECT_ID: ${{ secrets.SCW_DEFAULT_PROJECT_ID }}
+      SCW_DEFAULT_ORGANIZATION_ID: ${{ secrets.SCW_DEFAULT_ORGANIZATION_ID }}
+      ARM_SSH_KEY: ${{ secrets.ARM_SSH_KEY }}
+      ARM_SSH_CONFIG: ${{ secrets.ARM_SSH_CONFIG }}
+
+  # Build arm64 + arm/v7 images
+  build-containers-arm:
+    needs: [create-arm]
+    strategy:
+      matrix:
+        image: [bunkerweb, scheduler, autoconf, ui]
+        arch: ["linux/arm64,linux/arm/v7"]
+        include:
+          - release: latest
+            cache: false
+            push: false
+            cache_suffix: arm
+          - image: bunkerweb
+            dockerfile: src/bw/Dockerfile
+          - image: scheduler
+            dockerfile: src/scheduler/Dockerfile
+          - image: autoconf
+            dockerfile: src/autoconf/Dockerfile
+          - image: ui
+            dockerfile: src/ui/Dockerfile
+    uses: ./.github/workflows/container-build.yml
+    with:
+      RELEASE: ${{ matrix.release }}
+      ARCH: ${{ matrix.arch }}
+      IMAGE: ${{ matrix.image }}
+      DOCKERFILE: ${{ matrix.dockerfile }}
+      CACHE: ${{ matrix.cache }}
+      PUSH: ${{ matrix.push }}
+      CACHE_SUFFIX: ${{ matrix.cache_suffix }}
+    secrets:
+      DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
+      DOCKER_TOKEN: ${{ secrets.DOCKER_TOKEN }}
+      ARM_SSH_KEY: ${{ secrets.ARM_SSH_KEY }}
+      ARM_SSH_IP: ${{ needs.create-arm.outputs.ip }}
+      ARM_SSH_CONFIG: ${{ secrets.ARM_SSH_CONFIG }}
+
+  # Build Linux packages
+  build-packages:
+    needs: [create-arm]
+    strategy:
+      matrix:
+        linux: [ubuntu, debian, fedora, rhel, rhel9, ubuntu-jammy]
+        platforms: [linux/amd64, linux/arm64]
+        include:
+          - release: latest
+          - linux: ubuntu
+            package: deb
+          - linux: debian
+            package: deb
+          - linux: fedora
+            package: rpm
+          - linux: rhel
+            package: rpm
+          - linux: rhel9
+            package: rpm
+          - linux: ubuntu-jammy
+            package: deb
+    uses: ./.github/workflows/linux-build.yml
+    with:
+      RELEASE: ${{ matrix.release }}
+      LINUX: ${{ matrix.linux }}
+      PACKAGE: ${{ matrix.package }}
+      TEST: false
+      PLATFORMS: ${{ matrix.platforms }}
+    secrets:
+      DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
+      DOCKER_TOKEN: ${{ secrets.DOCKER_TOKEN }}
+      ARM_SSH_KEY: ${{ secrets.ARM_SSH_KEY }}
+      ARM_SSH_IP: ${{ needs.create-arm.outputs.ip }}
+      ARM_SSH_CONFIG: ${{ secrets.ARM_SSH_CONFIG }}
+
+  # Wait for all builds and extract VERSION
+  wait-builds:
+    runs-on: ubuntu-latest
+    needs: [codeql, build-containers, build-containers-arm, build-packages]
+    outputs:
+      version: ${{ steps.getversion.outputs.version }}
+      versionrpm: ${{ steps.getversionrpm.outputs.versionrpm }}
+    steps:
+      - name: Checkout source code
+        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+      - name: Get VERSION
+        id: getversion
+        run: echo "version=$(cat src/VERSION | tr -d '\n')" >> "$GITHUB_OUTPUT"
+      - name: Get VERSION (for RPM based)
+        id: getversionrpm
+        run: echo "versionrpm=$(cat src/VERSION | tr -d '\n' | sed 's/-/_/g')" >> "$GITHUB_OUTPUT"
+
+  # Push Docker images
+  push-images:
+    permissions:
+      contents: read
+      packages: write
+    needs: [create-arm, wait-builds]
+    strategy:
+      matrix:
+        image:
+          [bunkerweb, bunkerweb-scheduler, bunkerweb-autoconf, bunkerweb-ui]
+        include:
+          - release: latest
+          - image: bunkerweb
+            cache_from: bunkerweb
+            dockerfile: src/bw/Dockerfile
+          - image: bunkerweb-scheduler
+            cache_from: scheduler
+            dockerfile: src/scheduler/Dockerfile
+          - image: bunkerweb-autoconf
+            cache_from: autoconf
+            dockerfile: src/autoconf/Dockerfile
+          - image: bunkerweb-ui
+            cache_from: ui
+            dockerfile: src/ui/Dockerfile
+    uses: ./.github/workflows/push-docker.yml
+    with:
+      IMAGE: ${{ matrix.image }}
+      TAGS: bunkerity/${{ matrix.image }}:${{ matrix.release }},bunkerity/${{ matrix.image }}:${{ needs.wait-builds.outputs.version }},ghcr.io/bunkerity/${{ matrix.image }}:${{ matrix.release }},ghcr.io/bunkerity/${{ matrix.image }}:${{ needs.wait-builds.outputs.version }}
+      CACHE_FROM: ${{ matrix.cache_from }}-${{ matrix.release }}
+      DOCKERFILE: ${{ matrix.dockerfile }}
+    secrets:
+      DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
+      DOCKER_TOKEN: ${{ secrets.DOCKER_TOKEN }}
+      ARM_SSH_KEY: ${{ secrets.ARM_SSH_KEY }}
+      ARM_SSH_IP: ${{ needs.create-arm.outputs.ip }}
+      ARM_SSH_CONFIG: ${{ secrets.ARM_SSH_CONFIG }}
+
+  # Push Linux packages
+  push-packages:
+    needs: [wait-builds]
+    strategy:
+      matrix:
+        linux: [ubuntu, debian, fedora, el, el9, ubuntu-jammy]
+        arch: [amd64, arm64]
+        include:
+          - release: latest
+            repo: bunkerweb
+          - linux: ubuntu
+            separator: _
+            suffix: ""
+            version: noble
+            package: deb
+          - linux: debian
+            separator: _
+            suffix: ""
+            version: bookworm
+            package: deb
+          - linux: fedora
+            separator: "-"
+            suffix: "1."
+            version: 40
+            package: rpm
+          - linux: el
+            separator: "-"
+            suffix: "1."
+            version: 8
+            package: rpm
+          - linux: el9
+            separator: "-"
+            suffix: "1."
+            version: 9
+            package: rpm
+          - linux: ubuntu-jammy
+            separator: _
+            suffix: ""
+            version: jammy
+            package: deb
+          - linux: ubuntu
+            arch: amd64
+            package_arch: amd64
+          - linux: debian
+            arch: amd64
+            package_arch: amd64
+          - linux: fedora
+            arch: amd64
+            package_arch: x86_64
+          - linux: el
+            arch: amd64
+            package_arch: x86_64
+          - linux: el9
+            arch: amd64
+            package_arch: x86_64
+          - linux: ubuntu-jammy
+            arch: amd64
+            package_arch: amd64
+          - linux: ubuntu
+            arch: arm64
+            package_arch: arm64
+          - linux: debian
+            arch: arm64
+            package_arch: arm64
+          - linux: fedora
+            arch: arm64
+            package_arch: aarch64
+          - linux: el
+            arch: arm64
+            package_arch: aarch64
+          - linux: el9
+            arch: arm64
+            package_arch: aarch64
+          - linux: ubuntu-jammy
+            arch: arm64
+            package_arch: arm64
+    uses: ./.github/workflows/push-packagecloud.yml
+    with:
+      SEPARATOR: ${{ matrix.separator }}
+      SUFFIX: ${{ matrix.suffix }}
+      REPO: ${{ matrix.repo }}
+      LINUX: ${{ matrix.linux }}
+      VERSION: ${{ matrix.version }}
+      PACKAGE: ${{ matrix.package }}
+      BW_VERSION: ${{ matrix.package == 'rpm' && needs.wait-builds.outputs.versionrpm || needs.wait-builds.outputs.version }}
+      PACKAGE_ARCH: ${{ matrix.package_arch }}
+      ARCH: ${{ matrix.arch }}
+    secrets:
+      PACKAGECLOUD_TOKEN: ${{ secrets.PACKAGECLOUD_TOKEN }}
+
+  # Create doc PDF
+  doc-pdf:
+    needs: [wait-builds, push-images, push-packages]
+    uses: ./.github/workflows/doc-to-pdf.yml
+    with:
+      VERSION: ${{ needs.wait-builds.outputs.version }}
+
+  # Push on GH
+  push-gh:
+    needs: [wait-builds, doc-pdf]
+    permissions:
+      contents: write
+      discussions: write
+    uses: ./.github/workflows/push-github.yml
+    with:
+      VERSION: ${{ needs.wait-builds.outputs.version }}
+      PRERELEASE: false
+
+  # Push doc
+  push-doc:
+    needs: [wait-builds, push-gh]
+    permissions:
+      contents: write
+    uses: ./.github/workflows/push-doc.yml
+    with:
+      VERSION: ${{ needs.wait-builds.outputs.version }}
+      ALIAS: latest
+    secrets:
+      BUNKERBOT_TOKEN: ${{ secrets.BUNKERBOT_TOKEN }}
+
+  # Remove ARM VM
+  rm-arm:
+    if: ${{ always() }}
+    needs: [create-arm, push-images, build-packages]
+    uses: ./.github/workflows/rm-arm.yml
+    secrets:
+      ARM_ID: ${{ needs.create-arm.outputs.id }}
+      SCW_ACCESS_KEY: ${{ secrets.SCW_ACCESS_KEY }}
+      SCW_SECRET_KEY: ${{ secrets.SCW_SECRET_KEY }}
+      SCW_DEFAULT_PROJECT_ID: ${{ secrets.SCW_DEFAULT_PROJECT_ID }}
+      SCW_DEFAULT_ORGANIZATION_ID: ${{ secrets.SCW_DEFAULT_ORGANIZATION_ID }}

.github/workflows/rm-arm.yml

@@ -0,0 +1,32 @@
+name: Create ARM node (REUSABLE)
+
+on:
+  workflow_call:
+    secrets:
+      SCW_ACCESS_KEY:
+        required: true
+      SCW_SECRET_KEY:
+        required: true
+      SCW_DEFAULT_PROJECT_ID:
+        required: true
+      SCW_DEFAULT_ORGANIZATION_ID:
+        required: true
+      ARM_ID:
+        required: true
+
+jobs:
+  rm:
+    if: ${{ always() }}
+    runs-on: ubuntu-latest
+    steps:
+      # Prepare
+      - name: Checkout source code
+        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+      - name: Delete ARM VM
+        uses: scaleway/action-scw@be2696f261325a78354eda14988c80405f33e082
+        with:
+          args: instance server delete ${{ secrets.ARM_ID }} zone=fr-par-2 with-ip=true with-volumes=all force-shutdown=true
+          access-key: ${{ secrets.SCW_ACCESS_KEY }}
+          secret-key: ${{ secrets.SCW_SECRET_KEY }}
+          default-project-id: ${{ secrets.SCW_DEFAULT_PROJECT_ID }}
+          default-organization-id: ${{ secrets.SCW_DEFAULT_ORGANIZATION_ID }}

.github/workflows/scorecards-analysis.yml

@@ -0,0 +1,30 @@
+name: Scorecard analysis workflow
+
+on:
+  branch_protection_rule:
+  schedule:
+    # Weekly on Saturdays.
+    - cron: "30 1 * * 6"
+  workflow_call:
+
+permissions: read-all
+
+jobs:
+  analysis:
+    name: Scorecard analysis
+    runs-on: ubuntu-latest
+    steps:
+      - name: "Checkout code"
+        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+        with:
+          persist-credentials: false
+      - name: "Run analysis"
+        uses: ossf/scorecard-action@dc50aa9510b46c811795eb24b2f1ba02a914e534 # v2.3.3
+        with:
+          results_file: results.sarif
+          results_format: sarif
+          publish_results: true
+      - name: "Upload SARIF results to code scanning"
+        uses: github/codeql-action/upload-sarif@23acc5c183826b7a8a97bce3cecc52db901f8251 # v3.25.10
+        with:
+          sarif_file: results.sarif

.github/workflows/staging-create-infra.yml

@@ -0,0 +1,59 @@
+name: Create staging infra (REUSABLE)
+
+on:
+  workflow_call:
+    inputs:
+      TYPE:
+        required: true
+        type: string
+    secrets:
+      CICD_SECRETS:
+        required: true
+      SECRET_KEY:
+        required: true
+
+jobs:
+  create:
+    runs-on: ubuntu-latest
+    steps:
+      # Prepare
+      - name: Generate SSH keypair
+        run: ssh-keygen -b 2048 -t rsa -f ~/.ssh/id_rsa -q -N "" && ssh-keygen -f ~/.ssh/id_rsa -y > ~/.ssh/id_rsa.pub && echo -e "Host *\n  StrictHostKeyChecking no" > ~/.ssh/ssh_config
+        if: inputs.TYPE != 'k8s'
+      - name: Checkout source code
+        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+      - name: Install terraform
+        uses: hashicorp/setup-terraform@651471c36a6092792c552e8b1bef71e592b462d8 # v3.1.1
+      - name: Install kubectl
+        uses: azure/setup-kubectl@3e0aec4d80787158d308d7b364cb1b702e7feb7f # v4.0.0
+        if: inputs.TYPE == 'k8s'
+        with:
+          version: "v1.29.1"
+      - name: Set up Python 3.12
+        uses: actions/setup-python@82c7e631bb3cdc910f68e0081d67478d79c6982d # v5.1.0
+        if: inputs.TYPE != 'k8s'
+        with:
+          python-version: "3.12"
+      - name: Install ansible
+        run: pip install --no-cache-dir --require-hashes -r misc/requirements-ansible.txt
+        if: inputs.TYPE != 'k8s'
+      - name: Install ansible libs
+        run: ansible-galaxy install --timeout 120 monolithprojects.github_actions_runner,1.18.7 && ansible-galaxy collection install --timeout 120 community.general && ansible-galaxy collection install --timeout 120 community.docker
+        if: inputs.TYPE != 'k8s'
+      # Create infra
+      - run: ./tests/create.sh ${{ inputs.TYPE }}
+        env:
+          CICD_SECRETS: ${{ secrets.CICD_SECRETS }}
+      - run: |
+          tar -cf terraform.tar /tmp/${{ inputs.TYPE }}
+          echo "$SECRET_KEY" > /tmp/.secret_key
+          openssl enc -in terraform.tar -aes-256-cbc -pbkdf2 -iter 100000 -md sha256 -pass file:/tmp/.secret_key -out terraform.tar.enc
+          rm -f /tmp/.secret_key
+        if: always()
+        env:
+          SECRET_KEY: ${{ secrets.SECRET_KEY }}
+      - uses: actions/upload-artifact@65462800fd760344b1a7b4382951275a0abb4808 # v4.3.3
+        if: always()
+        with:
+          name: tf-${{ inputs.TYPE }}
+          path: terraform.tar.enc

.github/workflows/staging-delete-infra.yml

@@ -0,0 +1,49 @@
+name: Delete staging infra (REUSABLE)
+
+on:
+  workflow_call:
+    inputs:
+      TYPE:
+        required: true
+        type: string
+    secrets:
+      CICD_SECRETS:
+        required: true
+      SECRET_KEY:
+        required: true
+
+jobs:
+  delete:
+    if: ${{ always() }}
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+    steps:
+      # Prepare
+      - name: Checkout source code
+        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+      - name: Install terraform
+        uses: hashicorp/setup-terraform@651471c36a6092792c552e8b1bef71e592b462d8 # v3.1.1
+      - uses: actions/download-artifact@65a9edc5881444af0b9093a5e628f2fe47ea3b2e # v4.1.7
+        with:
+          name: tf-${{ inputs.TYPE }}
+          path: /tmp
+      - run: |
+          echo "$SECRET_KEY" > /tmp/.secret_key
+          openssl enc -d -in /tmp/terraform.tar.enc -aes-256-cbc -pbkdf2 -iter 100000 -md sha256 -pass file:/tmp/.secret_key -out /tmp/terraform.tar
+          rm -f /tmp/.secret_key
+          tar xf /tmp/terraform.tar -C / && mkdir ~/.ssh && touch ~/.ssh/id_rsa.pub
+        env:
+          SECRET_KEY: ${{ secrets.SECRET_KEY }}
+      - uses: azure/setup-kubectl@3e0aec4d80787158d308d7b364cb1b702e7feb7f # v4.0.0
+        if: inputs.TYPE == 'k8s'
+        with:
+          version: "v1.29.1"
+      # Remove infra
+      - run: kubectl delete daemonsets,replicasets,services,deployments,pods,rc,ingress,statefulsets --all --all-namespaces --timeout=60s ; kubectl delete pvc --all --timeout=60s ; kubectl delete pv --all --timeout=60s
+        if: inputs.TYPE == 'k8s'
+        continue-on-error: true
+        env:
+          KUBECONFIG: /tmp/k8s/kubeconfig
+      - run: ./tests/rm.sh ${{ inputs.TYPE }}
+        env:
+          CICD_SECRETS: ${{ secrets.CICD_SECRETS }}

.github/workflows/staging-tests.yml

@@ -0,0 +1,156 @@
+name: Perform staging tests (REUSABLE)
+
+on:
+  workflow_call:
+    inputs:
+      TYPE:
+        required: true
+        type: string
+      RUNS_ON:
+        required: true
+        type: string
+    # secrets:
+    #   PRIVATE_REGISTRY:
+    #     required: true
+    #   PRIVATE_REGISTRY_TOKEN:
+    #     required: true
+    #   TEST_DOMAINS:
+    #     required: true
+    #   ROOT_DOMAIN:
+    #     required: true
+
+jobs:
+  tests:
+    runs-on: ${{ fromJSON(inputs.RUNS_ON) }}
+    steps:
+      # Prepare
+      - name: Checkout source code
+        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+      - name: Login to ghcr
+        uses: docker/login-action@0d4c9c5ea7693da7b068278f7b52bda2a190a446 # v3.2.0
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - run: docker pull ghcr.io/bunkerity/bunkerweb-tests:testing && docker tag ghcr.io/bunkerity/bunkerweb-tests:testing local/bunkerweb-tests:latest
+        if: contains(fromJSON('["linux", "k8s"]'), inputs.TYPE) != true
+      - run: docker pull ghcr.io/bunkerity/scheduler-tests:testing && docker tag ghcr.io/bunkerity/scheduler-tests:testing local/scheduler-tests:latest
+        if: contains(fromJSON('["linux", "k8s"]'), inputs.TYPE) != true
+      - run: docker pull ghcr.io/bunkerity/autoconf-tests:testing && docker tag ghcr.io/bunkerity/autoconf-tests:testing local/autoconf-tests:latest
+        if: contains(fromJSON('["autoconf", "swarm"]'), inputs.TYPE)
+      - name: Push images to local repo
+        run: docker tag local/bunkerweb-tests:latest manager:5000/bunkerweb-tests:latest && docker push manager:5000/bunkerweb-tests:latest && docker tag local/scheduler-tests:latest manager:5000/scheduler-tests:latest && docker push manager:5000/scheduler-tests:latest && docker tag local/autoconf-tests:latest manager:5000/autoconf-tests:latest && docker push manager:5000/autoconf-tests:latest
+        if: inputs.TYPE == 'swarm'
+      - name: Install test dependencies
+        run: PIP_BREAK_SYSTEM_PACKAGES=1 pip3 install --no-cache-dir --require-hashes --no-deps -r tests/requirements.txt
+      - uses: actions/download-artifact@65a9edc5881444af0b9093a5e628f2fe47ea3b2e # v4.1.7
+        with:
+          name: tf-k8s
+          path: /tmp
+        if: inputs.TYPE == 'k8s'
+      - run: |
+          echo "$SECRET_KEY" > /tmp/.secret_key
+          openssl enc -d -in /tmp/terraform.tar.enc -aes-256-cbc -pbkdf2 -iter 100000 -md sha256 -pass file:/tmp/.secret_key -out /tmp/terraform.tar
+          rm -f /tmp/.secret_key
+          tar xf /tmp/terraform.tar -C /
+          mkdir /tmp/reg
+          cp tests/terraform/k8s-reg.tf /tmp/reg
+          cp tests/terraform/providers.tf /tmp/reg
+          cd /tmp/reg
+          export TF_VAR_k8s_reg_user=${REG_USER}
+          export TF_VAR_k8s_reg_token=${REG_TOKEN}
+          terraform init
+          terraform apply -auto-approve
+        env:
+          SECRET_KEY: ${{ secrets.SECRET_KEY }}
+          REG_USER: ${{ github.actor }}
+          REG_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        if: inputs.TYPE == 'k8s'
+      - uses: azure/setup-kubectl@3e0aec4d80787158d308d7b364cb1b702e7feb7f # v4.0.0
+        if: inputs.TYPE == 'k8s'
+        with:
+          version: "v1.29.1"
+      - uses: azure/setup-helm@fe7b79cd5ee1e45176fcad797de68ecaf3ca4814 # v4.2.0
+        if: inputs.TYPE == 'k8s'
+      - name: Pull BW linux ubuntu test image
+        if: inputs.TYPE == 'linux'
+        run: docker pull ghcr.io/bunkerity/ubuntu-tests:testing && docker tag ghcr.io/bunkerity/ubuntu-tests:testing local/ubuntu:latest
+      - name: Pull BW linux debian test image
+        if: inputs.TYPE == 'linux'
+        run: docker pull ghcr.io/bunkerity/debian-tests:testing && docker tag ghcr.io/bunkerity/debian-tests:testing local/debian:latest
+      - name: Pull BW linux fedora test image
+        if: inputs.TYPE == 'linux'
+        run: docker pull ghcr.io/bunkerity/fedora-tests:testing && docker tag ghcr.io/bunkerity/fedora-tests:testing local/fedora:latest
+      - name: Pull BW linux rhel test image
+        if: inputs.TYPE == 'linux'
+        run: docker pull ghcr.io/bunkerity/rhel-tests:testing && docker tag ghcr.io/bunkerity/rhel-tests:testing local/rhel:latest
+      - name: Pull BW linux rhel9 test image
+        if: inputs.TYPE == 'linux'
+        run: docker pull ghcr.io/bunkerity/rhel9-tests:testing && docker tag ghcr.io/bunkerity/rhel9-tests:testing local/rhel9:latest
+      - name: Pull BW linux ubuntu jammy test image
+        if: inputs.TYPE == 'linux'
+        run: docker pull ghcr.io/bunkerity/ubuntu-jammy-tests:testing && docker tag ghcr.io/bunkerity/ubuntu-jammy-tests:testing local/ubuntu-jammy:latest
+      # Do tests
+      - name: Run tests
+        if: inputs.TYPE == 'docker'
+        run: export $(echo "$TEST_DOMAINS" | xargs) && ./tests/main.py "${{ inputs.TYPE }}"
+        env:
+          TEST_DOMAINS: ${{ secrets.TEST_DOMAINS_DOCKER }}
+          ROOT_DOMAIN: ${{ secrets.ROOT_DOMAIN }}
+      - name: Run tests
+        if: inputs.TYPE == 'autoconf'
+        run: export $(echo "$TEST_DOMAINS" | xargs) && ./tests/main.py "${{ inputs.TYPE }}"
+        env:
+          TEST_DOMAINS: ${{ secrets.TEST_DOMAINS_AUTOCONF }}
+          ROOT_DOMAIN: ${{ secrets.ROOT_DOMAIN }}
+      - name: Run tests
+        if: inputs.TYPE == 'swarm'
+        run: export $(echo "$TEST_DOMAINS" | xargs) && ./tests/main.py "${{ inputs.TYPE }}"
+        env:
+          TEST_DOMAINS: ${{ secrets.TEST_DOMAINS_SWARM }}
+          ROOT_DOMAIN: ${{ secrets.ROOT_DOMAIN }}
+      - name: Run tests
+        if: inputs.TYPE == 'k8s'
+        run: export $(echo "$TEST_DOMAINS" | xargs) && ./tests/main.py "kubernetes"
+        env:
+          TEST_DOMAINS: ${{ secrets.TEST_DOMAINS_KUBERNETES }}
+          ROOT_DOMAIN: ${{ secrets.ROOT_DOMAIN }}
+          KUBECONFIG: "/tmp/k8s/kubeconfig"
+          PRIVATE_REGISTRY: ${{ secrets.PRIVATE_REGISTRY }}
+          IMAGE_TAG: "testing"
+      - name: Run Linux ubuntu tests
+        if: inputs.TYPE == 'linux'
+        run: export $(echo "$TEST_DOMAINS" | xargs) && ./tests/main.py "linux" "ubuntu"
+        env:
+          TEST_DOMAINS: ${{ secrets.TEST_DOMAINS_LINUX }}
+          ROOT_DOMAIN: ${{ secrets.ROOT_DOMAIN }}
+      - name: Run Linux debian tests
+        if: inputs.TYPE == 'linux'
+        run: export $(echo "$TEST_DOMAINS" | xargs) && ./tests/main.py "linux" "debian"
+        env:
+          TEST_DOMAINS: ${{ secrets.TEST_DOMAINS_LINUX }}
+          ROOT_DOMAIN: ${{ secrets.ROOT_DOMAIN }}
+      - name: Run Linux fedora tests
+        if: inputs.TYPE == 'linux'
+        run: export $(echo "$TEST_DOMAINS" | xargs) && ./tests/main.py "linux" "fedora"
+        env:
+          TEST_DOMAINS: ${{ secrets.TEST_DOMAINS_LINUX }}
+          ROOT_DOMAIN: ${{ secrets.ROOT_DOMAIN }}
+      - name: Run Linux rhel tests
+        if: inputs.TYPE == 'linux'
+        run: export $(echo "$TEST_DOMAINS" | xargs) && ./tests/main.py "linux" "rhel"
+        env:
+          TEST_DOMAINS: ${{ secrets.TEST_DOMAINS_LINUX }}
+          ROOT_DOMAIN: ${{ secrets.ROOT_DOMAIN }}
+      - name: Run Linux rhel9 tests
+        if: inputs.TYPE == 'linux'
+        run: export $(echo "$TEST_DOMAINS" | xargs) && ./tests/main.py "linux" "rhel9"
+        env:
+          TEST_DOMAINS: ${{ secrets.TEST_DOMAINS_LINUX }}
+          ROOT_DOMAIN: ${{ secrets.ROOT_DOMAIN }}
+      - name: Run Linux ubuntu-jammy tests
+        if: inputs.TYPE == 'linux'
+        run: export $(echo "$TEST_DOMAINS" | xargs) && ./tests/main.py "linux" "ubuntu-jammy"
+        env:
+          TEST_DOMAINS: ${{ secrets.TEST_DOMAINS_LINUX }}
+          ROOT_DOMAIN: ${{ secrets.ROOT_DOMAIN }}

.github/workflows/staging.yml

@@ -0,0 +1,302 @@
+name: Automatic tests (STAGING)
+
+permissions: read-all
+
+on:
+  push:
+    branches: [staging]
+
+jobs:
+  # Build Docker images
+  build-containers:
+    permissions:
+      contents: read
+      packages: write
+    strategy:
+      matrix:
+        image: [bunkerweb, scheduler, autoconf, ui]
+        include:
+          - image: bunkerweb
+            dockerfile: src/bw/Dockerfile
+          - image: scheduler
+            dockerfile: src/scheduler/Dockerfile
+          - image: autoconf
+            dockerfile: src/autoconf/Dockerfile
+          - image: ui
+            dockerfile: src/ui/Dockerfile
+    uses: ./.github/workflows/container-build.yml
+    with:
+      RELEASE: testing
+      ARCH: linux/amd64
+      CACHE: true
+      PUSH: true
+      IMAGE: ${{ matrix.image }}
+      DOCKERFILE: ${{ matrix.dockerfile }}
+    secrets:
+      DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
+      DOCKER_TOKEN: ${{ secrets.DOCKER_TOKEN }}
+
+  # Build Linux packages
+  build-packages:
+    permissions:
+      contents: read
+      packages: write
+    strategy:
+      matrix:
+        linux: [ubuntu, debian, fedora, rhel, rhel9, ubuntu-jammy]
+        include:
+          - linux: ubuntu
+            package: deb
+          - linux: debian
+            package: deb
+          - linux: fedora
+            package: rpm
+          - linux: rhel
+            package: rpm
+          - linux: rhel9
+            package: rpm
+          - linux: ubuntu-jammy
+            package: deb
+    uses: ./.github/workflows/linux-build.yml
+    with:
+      RELEASE: testing
+      LINUX: ${{ matrix.linux }}
+      PACKAGE: ${{ matrix.package }}
+      TEST: true
+      PLATFORMS: linux/amd64
+    secrets:
+      DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
+      DOCKER_TOKEN: ${{ secrets.DOCKER_TOKEN }}
+
+  codeql:
+    uses: ./.github/workflows/codeql.yml
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+  # Create infrastructures and prepare tests
+  create-infras:
+    needs: [codeql, build-containers, build-packages]
+    strategy:
+      matrix:
+        type: [docker, autoconf, swarm, k8s, linux]
+    uses: ./.github/workflows/staging-create-infra.yml
+    with:
+      TYPE: ${{ matrix.type }}
+    secrets:
+      CICD_SECRETS: ${{ secrets.CICD_SECRETS }}
+      SECRET_KEY: ${{ secrets.SECRET_KEY }}
+  prepare-tests-core:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+      - id: set-matrix
+        run: |
+          tests=$(find ./tests/core/ -maxdepth 1 -mindepth 1 -type d -printf "%f\n" | jq -c --raw-input --slurp 'split("\n")| .[0:-1]')
+          echo "tests=$tests" >> $GITHUB_OUTPUT
+    outputs:
+      tests: ${{ steps.set-matrix.outputs.tests }}
+  prepare-tests-ui:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+      - id: set-matrix
+        run: |
+          tests=$(find ./tests/ui/ -name "*_page.py" -type f -printf "%f\n" | jq -c --raw-input --slurp 'split("\n")| .[0:-1]')
+          echo "tests=$tests" >> $GITHUB_OUTPUT
+    outputs:
+      tests: ${{ steps.set-matrix.outputs.tests }}
+
+  # Perform tests
+  tests-ui:
+    needs: [prepare-tests-ui, build-containers]
+    strategy:
+      fail-fast: false
+      matrix:
+        test: ${{ fromJson(needs.prepare-tests-ui.outputs.tests) }}
+    uses: ./.github/workflows/tests-ui.yml
+    with:
+      TEST: ${{ matrix.test }}
+      RELEASE: testing
+  tests-ui-linux:
+    needs: [prepare-tests-ui, build-packages]
+    strategy:
+      fail-fast: false
+      matrix:
+        test: ${{ fromJson(needs.prepare-tests-ui.outputs.tests) }}
+    uses: ./.github/workflows/tests-ui-linux.yml
+    with:
+      TEST: ${{ matrix.test }}
+      RELEASE: testing
+
+  staging-tests:
+    needs: [create-infras]
+    strategy:
+      matrix:
+        type: [docker, autoconf, swarm, k8s, linux]
+        include:
+          - type: docker
+            runs_on: "['self-hosted', 'bw-docker']"
+          - type: autoconf
+            runs_on: "['self-hosted', 'bw-autoconf']"
+          - type: swarm
+            runs_on: "['self-hosted', 'bw-swarm']"
+          - type: k8s
+            runs_on: "['ubuntu-latest']"
+          - type: linux
+            runs_on: "['self-hosted', 'bw-linux']"
+    uses: ./.github/workflows/staging-tests.yml
+    with:
+      TYPE: ${{ matrix.type }}
+      RUNS_ON: ${{ matrix.runs_on }}
+    secrets: inherit
+
+  tests-core:
+    needs: [build-containers, prepare-tests-core]
+    strategy:
+      fail-fast: false
+      matrix:
+        test: ${{ fromJson(needs.prepare-tests-core.outputs.tests) }}
+    uses: ./.github/workflows/test-core.yml
+    with:
+      TEST: ${{ matrix.test }}
+      RELEASE: testing
+  tests-core-linux:
+    needs: [build-packages, prepare-tests-core]
+    strategy:
+      fail-fast: false
+      matrix:
+        test: ${{ fromJson(needs.prepare-tests-core.outputs.tests) }}
+    uses: ./.github/workflows/test-core-linux.yml
+    with:
+      TEST: ${{ matrix.test }}
+      RELEASE: testing
+    secrets: inherit
+
+  # Delete infrastructures
+  delete-infras:
+    if: ${{ always() }}
+    needs: [staging-tests]
+    strategy:
+      matrix:
+        type: [docker, autoconf, swarm, k8s, linux]
+    uses: ./.github/workflows/staging-delete-infra.yml
+    with:
+      TYPE: ${{ matrix.type }}
+    secrets:
+      CICD_SECRETS: ${{ secrets.CICD_SECRETS }}
+      SECRET_KEY: ${{ secrets.SECRET_KEY }}
+
+  # Push Docker images
+  push-images:
+    needs: [staging-tests, tests-ui, tests-core]
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+    steps:
+      - name: Login to Docker Hub
+        uses: docker/login-action@0d4c9c5ea7693da7b068278f7b52bda2a190a446 # v3.2.0
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_TOKEN }}
+      - name: Login to ghcr
+        uses: docker/login-action@0d4c9c5ea7693da7b068278f7b52bda2a190a446 # v3.2.0
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - name: Push BW image
+        run: docker pull ghcr.io/bunkerity/bunkerweb-tests:testing && docker tag ghcr.io/bunkerity/bunkerweb-tests:testing bunkerity/bunkerweb:testing && docker push bunkerity/bunkerweb:testing && docker tag bunkerity/bunkerweb:testing ghcr.io/bunkerity/bunkerweb:testing && docker push ghcr.io/bunkerity/bunkerweb:testing
+      - name: Push scheduler image
+        run: docker pull ghcr.io/bunkerity/scheduler-tests:testing && docker tag ghcr.io/bunkerity/scheduler-tests:testing bunkerity/bunkerweb-scheduler:testing && docker push bunkerity/bunkerweb-scheduler:testing && docker tag bunkerity/bunkerweb-scheduler:testing ghcr.io/bunkerity/bunkerweb-scheduler:testing && docker push ghcr.io/bunkerity/bunkerweb-scheduler:testing
+      - name: Push UI image
+        run: docker pull ghcr.io/bunkerity/ui-tests:testing && docker tag ghcr.io/bunkerity/ui-tests:testing bunkerity/bunkerweb-ui:testing && docker push bunkerity/bunkerweb-ui:testing && docker tag bunkerity/bunkerweb-ui:testing ghcr.io/bunkerity/bunkerweb-ui:testing && docker push ghcr.io/bunkerity/bunkerweb-ui:testing
+      - name: Push autoconf image
+        run: docker pull ghcr.io/bunkerity/autoconf-tests:testing && docker tag ghcr.io/bunkerity/autoconf-tests:testing bunkerity/bunkerweb-autoconf:testing && docker push bunkerity/bunkerweb-autoconf:testing && docker tag bunkerity/bunkerweb-autoconf:testing ghcr.io/bunkerity/bunkerweb-autoconf:testing && docker push ghcr.io/bunkerity/bunkerweb-autoconf:testing
+
+  # Push Linux packages
+  push-packages:
+    needs: [staging-tests, tests-ui-linux, tests-core-linux]
+    strategy:
+      matrix:
+        linux: [ubuntu, debian, fedora, el, el9, ubuntu-jammy]
+        arch: [amd64]
+        include:
+          - release: testing
+            repo: bunkerweb
+          - linux: ubuntu
+            package_arch: amd64
+            separator: _
+            suffix: ""
+            version: noble
+            package: deb
+          - linux: debian
+            package_arch: amd64
+            separator: _
+            suffix: ""
+            version: bookworm
+            package: deb
+          - linux: fedora
+            package_arch: x86_64
+            separator: "-"
+            suffix: "1."
+            version: 40
+            package: rpm
+          - linux: el
+            package_arch: x86_64
+            separator: "-"
+            suffix: "1."
+            version: 8
+            package: rpm
+          - linux: el9
+            package_arch: x86_64
+            separator: "-"
+            suffix: "1."
+            version: 9
+            package: rpm
+          - linux: ubuntu-jammy
+            package_arch: amd64
+            separator: _
+            suffix: ""
+            version: jammy
+            package: deb
+    uses: ./.github/workflows/push-packagecloud.yml
+    with:
+      SEPARATOR: ${{ matrix.separator }}
+      SUFFIX: ${{ matrix.suffix }}
+      REPO: ${{ matrix.repo }}
+      LINUX: ${{ matrix.linux }}
+      VERSION: ${{ matrix.version }}
+      PACKAGE: ${{ matrix.package }}
+      BW_VERSION: ${{ matrix.release }}
+      PACKAGE_ARCH: ${{ matrix.package_arch }}
+      ARCH: ${{ matrix.arch }}
+    secrets:
+      PACKAGECLOUD_TOKEN: ${{ secrets.PACKAGECLOUD_TOKEN }}
+
+  # Push doc
+  push-doc:
+    needs: [push-images, push-packages]
+    permissions:
+      contents: write
+    uses: ./.github/workflows/push-doc.yml
+    with:
+      VERSION: testing
+      ALIAS: unstable
+    secrets:
+      BUNKERBOT_TOKEN: ${{ secrets.BUNKERBOT_TOKEN }}
+
+  # Push on GH
+  push-gh:
+    needs: [push-doc]
+    permissions:
+      contents: write
+      discussions: write
+    uses: ./.github/workflows/push-github.yml
+    with:
+      VERSION: testing
+      PRERELEASE: true

.github/workflows/test-core-linux.yml

@@ -0,0 +1,118 @@
+name: Core test Linux (REUSABLE)
+
+on:
+  workflow_call:
+    inputs:
+      TEST:
+        required: true
+        type: string
+      RELEASE:
+        required: true
+        type: string
+
+jobs:
+  tests:
+    runs-on: ubuntu-24.04
+    steps:
+      # Prepare
+      - name: Checkout source code
+        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+      - name: Set up Python 3.12
+        uses: actions/setup-python@82c7e631bb3cdc910f68e0081d67478d79c6982d # v5.1.0
+        with:
+          python-version: "3.12"
+      - name: Install Firefox manually and dependencies
+        run: |
+          sudo add-apt-repository ppa:mozillateam/ppa -y
+          sudo apt purge -y firefox
+          echo '
+          Package: *
+          Pin: release o=LP-PPA-mozillateam
+          Pin-Priority: 1001
+
+          Package: firefox
+          Pin: version 1:1snap1-0ubuntu5
+          Pin-Priority: -1
+          ' | sudo tee /etc/apt/preferences.d/mozilla-firefox
+          export NEEDRESTART_SUSPEND=1
+          export DEBIAN_FRONTEND=noninteractive
+          sudo -E apt install --no-install-recommends -y openssl git nodejs tar bzip2 wget curl grep libx11-xcb1 libappindicator3-1 libasound2t64 libdbus-glib-1-2 libxtst6 libxt6 php-fpm unzip firefox
+      - name: Download geckodriver
+        uses: nick-fields/retry@7152eba30c6575329ac0576536151aca5a72780e # v3.0.0
+        with:
+          max_attempts: 3
+          timeout_minutes: 20
+          command: |
+            GECKODRIVER_VERSION=`curl -i https://github.com/mozilla/geckodriver/releases/latest | grep -Po 'v[0-9]+\.[0-9]+\.[0-9]+'` && \
+            wget -O geckodriver.tar.gz -w 5 https://github.com/mozilla/geckodriver/releases/download/$GECKODRIVER_VERSION/geckodriver-$GECKODRIVER_VERSION-linux64.tar.gz
+            sudo tar -xzf geckodriver.tar.gz -C /usr/local/bin
+            sudo chmod +x /usr/local/bin/geckodriver
+            rm -f geckodriver.tar.gz
+      - name: Login to ghcr
+        uses: docker/login-action@0d4c9c5ea7693da7b068278f7b52bda2a190a446 # v3.2.0
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - name: Pull BW linux ubuntu test image
+        run: docker pull ghcr.io/bunkerity/ubuntu-tests:${{ inputs.RELEASE }}
+      - name: Copy deb file to host
+        if: inputs.RELEASE != '1.6'
+        run: |
+          container_id=$(docker create "ghcr.io/bunkerity/ubuntu-tests:${{ inputs.RELEASE }}")
+          docker cp "$container_id:/opt/bunkerweb_${{ inputs.RELEASE }}-1_amd64.deb" "/tmp/bunkerweb.deb"
+          docker rm "$container_id"
+      - name: Copy deb file to host 1.6
+        if: inputs.RELEASE == '1.6'
+        run: |
+          container_id=$(docker create "ghcr.io/bunkerity/ubuntu-tests:${{ inputs.RELEASE }}")
+          docker cp "$container_id:/opt/bunkerweb_dev-1_amd64.deb" "/tmp/bunkerweb.deb"
+          docker rm "$container_id"
+      - name: Install NGINX
+        run: |
+          export NEEDRESTART_SUSPEND=1
+          export DEBIAN_FRONTEND=noninteractive
+          sudo -E apt install -y gnupg2 ca-certificates lsb-release ubuntu-keyring
+          curl https://nginx.org/keys/nginx_signing.key | gpg --dearmor | sudo tee /usr/share/keyrings/nginx-archive-keyring.gpg >/dev/null
+          echo "deb [signed-by=/usr/share/keyrings/nginx-archive-keyring.gpg] http://nginx.org/packages/ubuntu `lsb_release -cs` nginx" | sudo tee /etc/apt/sources.list.d/nginx.list
+          sudo apt update
+          sudo -E apt install -y nginx=1.26.1-2~noble
+      - name: Fix version without a starting number
+        if: inputs.RELEASE == 'testing' || inputs.RELEASE == 'dev' || inputs.RELEASE == '1.6'
+        run: echo "force-bad-version" | sudo tee -a /etc/dpkg/dpkg.cfg
+      - name: Edit configuration files
+        run: |
+          # Misc
+          echo "127.0.0.1 www.example.com" | sudo tee -a /etc/hosts
+          echo "127.0.0.1 app1.example.com" | sudo tee -a /etc/hosts
+          echo "127.0.0.1 bwadm.example.com" | sudo tee -a /etc/hosts
+          sudo cp ./tests/www-deb.conf /etc/php/8.3/fpm/pool.d/www.conf
+          sudo systemctl stop php8.3-fpm
+          sudo systemctl start php8.3-fpm
+          # BunkerWeb
+          sudo mkdir -p /etc/bunkerweb
+          echo "BUNKERWEB_INSTANCES=127.0.0.1" | sudo tee /etc/bunkerweb/variables.env
+          echo "SERVER_NAME=www.example.com" | sudo tee -a /etc/bunkerweb/variables.env
+          echo "HTTP_PORT=80" | sudo tee -a /etc/bunkerweb/variables.env
+          echo "HTTPS_PORT=443" | sudo tee -a /etc/bunkerweb/variables.env
+          echo 'DNS_RESOLVERS=9.9.9.9 8.8.8.8 8.8.4.4' | sudo tee -a /etc/bunkerweb/variables.env
+          echo 'API_LISTEN_IP=127.0.0.1' | sudo tee -a /etc/bunkerweb/variables.env
+          echo "USE_BUNKERNET=no" | sudo tee -a /etc/bunkerweb/variables.env
+          echo "USE_BLACKLIST=no" | sudo tee -a /etc/bunkerweb/variables.env
+          echo "SEND_ANONYMOUS_REPORT=no" | sudo tee -a /etc/bunkerweb/variables.env
+          echo "LOG_LEVEL=debug" | sudo tee -a /etc/bunkerweb/variables.env
+          sudo chown nginx:nginx /etc/bunkerweb/variables.env
+          sudo chmod 777 /etc/bunkerweb/variables.env
+      - name: Install BunkerWeb
+        run: |
+          export NEEDRESTART_SUSPEND=1
+          export DEBIAN_FRONTEND=noninteractive
+          sudo -E apt install -fy /tmp/bunkerweb.deb
+      - name: Run tests
+        run: |
+          export MAKEFLAGS="-j $(nproc)"
+          pip install --break-system-packages --no-cache-dir --ignore-installed --require-hashes -r src/deps/requirements-deps.txt
+          cd tests/core/${{ inputs.TEST }}
+          find . -name "requirements.txt" -exec pip install --break-system-packages --no-cache-dir --require-hashes --no-deps -r {} \;
+          sudo truncate -s 0 /var/log/bunkerweb/error.log
+          ./test.sh "linux"

.github/workflows/test-core.yml

@@ -0,0 +1,36 @@
+name: Core test (REUSABLE)
+
+on:
+  workflow_call:
+    inputs:
+      TEST:
+        required: true
+        type: string
+      RELEASE:
+        required: true
+        type: string
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      # Prepare
+      - name: Checkout source code
+        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+      - name: Login to ghcr
+        uses: docker/login-action@0d4c9c5ea7693da7b068278f7b52bda2a190a446 # v3.2.0
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - name: Pull BW image
+        run: docker pull ghcr.io/bunkerity/bunkerweb-tests:${{ inputs.RELEASE }} && docker tag ghcr.io/bunkerity/bunkerweb-tests:${{ inputs.RELEASE }} bunkerweb-tests
+      - name: Pull Scheduler image
+        run: docker pull ghcr.io/bunkerity/scheduler-tests:${{ inputs.RELEASE }} && docker tag ghcr.io/bunkerity/scheduler-tests:${{ inputs.RELEASE }} scheduler-tests
+      # Run test
+      - name: Run test
+        run: |
+          cd ./tests/core/${{ inputs.TEST }}
+          find . -type f -name 'docker-compose.*' -exec sed -i "s@bunkerity/bunkerweb:.*@bunkerweb-tests@" {} \;
+          find . -type f -name 'docker-compose.*' -exec sed -i "s@bunkerity/bunkerweb-scheduler:.*@scheduler-tests@" {} \;
+          ./test.sh "docker" "${{ inputs.TEST }}"

.github/workflows/tests-ui-linux.yml

@@ -0,0 +1,139 @@
+name: Core test Linux (REUSABLE)
+
+on:
+  workflow_call:
+    inputs:
+      TEST:
+        required: true
+        type: string
+      RELEASE:
+        required: true
+        type: string
+
+jobs:
+  tests:
+    runs-on: ubuntu-24.04
+    steps:
+      # Prepare
+      - name: Checkout source code
+        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+      - name: Set up Python 3.12
+        uses: actions/setup-python@82c7e631bb3cdc910f68e0081d67478d79c6982d # v5.1.0
+        with:
+          python-version: "3.12"
+      - name: Install Firefox manually and dependencies
+        run: |
+          sudo add-apt-repository ppa:mozillateam/ppa -y
+          sudo apt purge -y firefox
+          echo '
+          Package: *
+          Pin: release o=LP-PPA-mozillateam
+          Pin-Priority: 1001
+
+          Package: firefox
+          Pin: version 1:1snap1-0ubuntu5
+          Pin-Priority: -1
+          ' | sudo tee /etc/apt/preferences.d/mozilla-firefox
+          export NEEDRESTART_SUSPEND=1
+          export DEBIAN_FRONTEND=noninteractive
+          sudo -E apt install --no-install-recommends -y openssl git nodejs tar bzip2 wget curl grep libx11-xcb1 libappindicator3-1 libasound2t64 libdbus-glib-1-2 libxtst6 libxt6 php-fpm unzip firefox
+      - name: Download geckodriver
+        uses: nick-fields/retry@7152eba30c6575329ac0576536151aca5a72780e # v3.0.0
+        with:
+          max_attempts: 3
+          timeout_minutes: 20
+          command: |
+            GECKODRIVER_VERSION=`curl -i https://github.com/mozilla/geckodriver/releases/latest | grep -Po 'v[0-9]+\.[0-9]+\.[0-9]+'` && \
+            wget -O geckodriver.tar.gz -w 5 https://github.com/mozilla/geckodriver/releases/download/$GECKODRIVER_VERSION/geckodriver-$GECKODRIVER_VERSION-linux64.tar.gz
+            sudo tar -xzf geckodriver.tar.gz -C /usr/local/bin
+            sudo chmod +x /usr/local/bin/geckodriver
+            rm -f geckodriver.tar.gz
+      - name: Login to ghcr
+        uses: docker/login-action@0d4c9c5ea7693da7b068278f7b52bda2a190a446 # v3.2.0
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - name: Pull BW linux ubuntu test image
+        run: docker pull ghcr.io/bunkerity/ubuntu-tests:${{ inputs.RELEASE }}
+      - name: Copy deb file to host
+        if: inputs.RELEASE != '1.6'
+        run: |
+          container_id=$(docker create "ghcr.io/bunkerity/ubuntu-tests:${{ inputs.RELEASE }}")
+          docker cp "$container_id:/opt/bunkerweb_${{ inputs.RELEASE }}-1_amd64.deb" "/tmp/bunkerweb.deb"
+          docker rm "$container_id"
+      - name: Copy deb file to host 1.6
+        if: inputs.RELEASE == '1.6'
+        run: |
+          container_id=$(docker create "ghcr.io/bunkerity/ubuntu-tests:${{ inputs.RELEASE }}")
+          docker cp "$container_id:/opt/bunkerweb_dev-1_amd64.deb" "/tmp/bunkerweb.deb"
+          docker rm "$container_id"
+      - name: Install NGINX
+        run: |
+          export NEEDRESTART_SUSPEND=1
+          export DEBIAN_FRONTEND=noninteractive
+          sudo -E apt install -y gnupg2 ca-certificates lsb-release ubuntu-keyring
+          curl https://nginx.org/keys/nginx_signing.key | gpg --dearmor | sudo tee /usr/share/keyrings/nginx-archive-keyring.gpg >/dev/null
+          echo "deb [signed-by=/usr/share/keyrings/nginx-archive-keyring.gpg] http://nginx.org/packages/ubuntu `lsb_release -cs` nginx" | sudo tee /etc/apt/sources.list.d/nginx.list
+          sudo apt update
+          sudo -E apt install -y nginx=1.26.1-2~noble
+      - name: Fix version without a starting number
+        if: inputs.RELEASE == 'testing' || inputs.RELEASE == 'dev' || inputs.RELEASE == 'ui' || inputs.RELEASE == '1.6'
+        run: echo "force-bad-version" | sudo tee -a /etc/dpkg/dpkg.cfg
+      - name: Edit configuration files
+        run: |
+          # Misc
+          echo "127.0.0.1 www.example.com" | sudo tee -a /etc/hosts
+          echo "127.0.0.1 app1.example.com" | sudo tee -a /etc/hosts
+          echo "127.0.0.1 app2.example.com" | sudo tee -a /etc/hosts
+          echo "127.0.0.1 app3.example.com" | sudo tee -a /etc/hosts
+          # BunkerWeb
+          sudo mkdir -p /etc/bunkerweb
+          echo "BUNKERWEB_INSTANCES=127.0.0.1" | sudo tee /etc/bunkerweb/variables.env
+          echo "SERVER_NAME=" | sudo tee -a /etc/bunkerweb/variables.env
+          echo "HTTP_PORT=80" | sudo tee -a /etc/bunkerweb/variables.env
+          echo "HTTPS_PORT=443" | sudo tee -a /etc/bunkerweb/variables.env
+          echo "BAD_BEHAVIOR_THRESHOLD=20" | sudo tee -a /etc/bunkerweb/variables.env
+          echo 'DNS_RESOLVERS=9.9.9.9 8.8.8.8 8.8.4.4' | sudo tee -a /etc/bunkerweb/variables.env
+          echo 'API_LISTEN_IP=127.0.0.1' | sudo tee -a /etc/bunkerweb/variables.env
+          echo "MULTISITE=yes" | sudo tee -a /etc/bunkerweb/variables.env
+          echo "LOG_LEVEL=debug" | sudo tee -a /etc/bunkerweb/variables.env
+          echo "USE_BUNKERNET=no" | sudo tee -a /etc/bunkerweb/variables.env
+          echo "USE_BLACKLIST=no" | sudo tee -a /etc/bunkerweb/variables.env
+          echo "SEND_ANONYMOUS_REPORT=no" | sudo tee -a /etc/bunkerweb/variables.env
+          echo "USE_CLIENT_CACHE=yes" | sudo tee -a /etc/bunkerweb/variables.env
+          echo "USE_GZIP=yes" | sudo tee -a /etc/bunkerweb/variables.env
+          echo "DATASTORE_MEMORY_SIZE=384m" | sudo tee -a /etc/bunkerweb/variables.env
+          echo "UI_HOST=http://127.0.0.1:7000" | sudo tee -a /etc/bunkerweb/variables.env
+          sudo touch /etc/bunkerweb/ui.env
+
+          sudo chown nginx:nginx /etc/bunkerweb/variables.env /etc/bunkerweb/ui.env
+          sudo chmod 777 /etc/bunkerweb/variables.env /etc/bunkerweb/ui.env
+      - name: Install BunkerWeb
+        run: |
+          export NEEDRESTART_SUSPEND=1
+          export DEBIAN_FRONTEND=noninteractive
+          sudo -E apt install -fy /tmp/bunkerweb.deb
+      - name: Run tests
+        run: |
+          export MAKEFLAGS="-j $(nproc)"
+          pip install --break-system-packages --no-cache-dir --ignore-installed --require-hashes -r src/deps/requirements-deps.txt
+          pip install --break-system-packages --no-cache-dir --require-hashes -r tests/ui/requirements.txt
+          cd ./tests/ui
+          touch test.txt
+          zip test.zip test.txt
+          rm test.txt
+          echo '{
+            "id": "discord",
+            "name": "Discord",
+            "description": "Send alerts to a Discord channel (using webhooks).",
+            "version": "0.1",
+            "stream": "no",
+            "settings": {}
+            }' | tee plugin.json
+          zip discord.zip plugin.json
+          rm plugin.json
+          sudo truncate -s 0 /var/log/bunkerweb/error.log
+          ./tests.sh "linux" ${{ inputs.TEST }}
+        env:
+          MODE: ${{ inputs.RELEASE }}

.github/workflows/tests-ui.yml

@@ -0,0 +1,37 @@
+name: Perform tests for UI (REUSABLE)
+
+on:
+  workflow_call:
+    inputs:
+      TEST:
+        required: true
+        type: string
+      RELEASE:
+        required: true
+        type: string
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    steps:
+      # Prepare
+      - name: Checkout source code
+        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+      - name: Login to ghcr
+        uses: docker/login-action@0d4c9c5ea7693da7b068278f7b52bda2a190a446 # v3.2.0
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - name: Pull BW image
+        run: docker pull ghcr.io/bunkerity/bunkerweb-tests:${{ inputs.RELEASE }} && docker tag ghcr.io/bunkerity/bunkerweb-tests:${{ inputs.RELEASE }} bunkerweb-tests
+      - name: Pull Scheduler image
+        run: docker pull ghcr.io/bunkerity/scheduler-tests:${{ inputs.RELEASE }} && docker tag ghcr.io/bunkerity/scheduler-tests:${{ inputs.RELEASE }} scheduler-tests
+      - name: Pull UI image
+        run: docker pull ghcr.io/bunkerity/ui-tests:${{ inputs.RELEASE }} && docker tag ghcr.io/bunkerity/ui-tests:${{ inputs.RELEASE }} ui-tests
+      # Do tests
+      - name: Run tests
+        run: |
+          cd ./tests/ui
+          ./tests.sh "docker" ${{ inputs.TEST }}
+        env:
+          MODE: ${{ inputs.RELEASE }}

.github/workflows/ui.yml

@@ -0,0 +1,96 @@
+name: Automatic tests (UI)
+
+permissions: read-all
+
+on:
+  push:
+    branches: [ui]
+
+jobs:
+  # Containers
+  build-containers:
+    permissions:
+      contents: read
+      packages: write
+    strategy:
+      matrix:
+        image: [bunkerweb, scheduler, ui]
+        include:
+          - image: bunkerweb
+            dockerfile: src/bw/Dockerfile
+          - image: scheduler
+            dockerfile: src/scheduler/Dockerfile
+          - image: ui
+            dockerfile: src/ui/Dockerfile
+    uses: ./.github/workflows/container-build.yml
+    with:
+      RELEASE: ui
+      CACHE: true
+      ARCH: linux/amd64
+      IMAGE: ${{ matrix.image }}
+      DOCKERFILE: ${{ matrix.dockerfile }}
+    secrets:
+      DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
+      DOCKER_TOKEN: ${{ secrets.DOCKER_TOKEN }}
+
+  # Build Linux packages
+  build-packages:
+    permissions:
+      contents: read
+      packages: write
+    strategy:
+      matrix:
+        linux: [ubuntu]
+        include:
+          - linux: ubuntu
+            package: deb
+    uses: ./.github/workflows/linux-build.yml
+    with:
+      RELEASE: ui
+      LINUX: ${{ matrix.linux }}
+      PACKAGE: ${{ matrix.package }}
+      TEST: true
+      PLATFORMS: linux/amd64
+    secrets:
+      DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
+      DOCKER_TOKEN: ${{ secrets.DOCKER_TOKEN }}
+
+  codeql:
+    uses: ./.github/workflows/codeql.yml
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+  # UI tests
+  prepare-tests-ui:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
+      - id: set-matrix
+        run: |
+          tests=$(find ./tests/ui/ -name "*_page.py" -type f -printf "%f\n" | jq -c --raw-input --slurp 'split("\n")| .[0:-1]')
+          echo "tests=$tests" >> $GITHUB_OUTPUT
+    outputs:
+      tests: ${{ steps.set-matrix.outputs.tests }}
+  tests-ui:
+    needs: [prepare-tests-ui, build-containers]
+    strategy:
+      fail-fast: false
+      matrix:
+        test: ${{ fromJson(needs.prepare-tests-ui.outputs.tests) }}
+    uses: ./.github/workflows/tests-ui.yml
+    with:
+      TEST: ${{ matrix.test }}
+      RELEASE: ui
+  tests-ui-linux:
+    needs: [prepare-tests-ui, build-packages]
+    strategy:
+      fail-fast: false
+      matrix:
+        test: ${{ fromJson(needs.prepare-tests-ui.outputs.tests) }}
+    uses: ./.github/workflows/tests-ui-linux.yml
+    with:
+      TEST: ${{ matrix.test }}
+      RELEASE: ui

.gitignore

@@ -0,0 +1,11 @@
+site/
+.idea/
+.vscode/
+__pycache__
+env/
+tmp_venv/
+node_modules
+/src/ui/*.txt
+.mypy_cache
+.cache/
+/package*.json

.gitleaksignore

@@ -0,0 +1,79 @@
+src/ui/templates/profile.html:hashicorp-tf-password:343
+src/ui/templates/account.html:hashicorp-tf-password:194
+src/ui/templates/account.html:hashicorp-tf-password:255
+src/ui/templates/account.html:hashicorp-tf-password:292
+src/ui/templates/account.html:hashicorp-tf-password:329
+src/ui/templates/account.html:hashicorp-tf-password:417
+src/ui/templates/account.html:hashicorp-tf-password:470
+src/ui/templates/settings_plugins.html:hashicorp-tf-password:87
+src/ui/templates/settings_plugins.html:hashicorp-tf-password:297
+src/ui/templates/settings_plugins.html:hashicorp-tf-password:106
+src/ui/templates/account.html:hashicorp-tf-password:154
+src/ui/templates/account.html:hashicorp-tf-password:162
+src/ui/templates/setup_loading.html:aws-access-token:14
+src/common/core/errors/files/error.html:aws-access-token:20
+src/deps/src/nginx/src/event/quic/ngx_event_quic_protection.c:generic-api-key:164
+src/deps/src/nginx/src/event/quic/ngx_event_quic_protection.c:generic-api-key:165
+src/deps/src/lua-resty-openssl/lib/resty/openssl/pkey.lua:generic-api-key:438
+src/deps/src/lua-resty-openssl/lib/resty/openssl/pkey.lua:generic-api-key:439
+src/deps/src/lua-resty-openssl/lib/resty/openssl/pkey.lua:generic-api-key:440
+src/deps/src/lua-resty-openssl/lib/resty/openssl/pkey.lua:generic-api-key:441
+misc/integrations/autoconf.mariadb.ui.yml:hashicorp-tf-password:57
+misc/integrations/autoconf.mariadb.ui.yml:hashicorp-tf-password:73
+misc/integrations/autoconf.mariadb.yml:hashicorp-tf-password:55
+misc/integrations/autoconf.mysql.ui.yml:hashicorp-tf-password:57
+misc/integrations/autoconf.mysql.ui.yml:hashicorp-tf-password:73
+misc/integrations/autoconf.mysql.yml:hashicorp-tf-password:50
+misc/integrations/autoconf.mysql.yml:hashicorp-tf-password:55
+misc/integrations/autoconf.postgres.ui.yml:hashicorp-tf-password:57
+misc/integrations/autoconf.postgres.ui.yml:hashicorp-tf-password:71
+misc/integrations/autoconf.postgres.yml:hashicorp-tf-password:53
+misc/integrations/docker.mariadb.ui.yml:hashicorp-tf-password:50
+misc/integrations/docker.mariadb.ui.yml:hashicorp-tf-password:61
+misc/integrations/docker.mariadb.yml:hashicorp-tf-password:39
+misc/integrations/docker.mysql.ui.yml:hashicorp-tf-password:50
+misc/integrations/docker.mysql.ui.yml:hashicorp-tf-password:61
+misc/integrations/docker.mysql.yml:hashicorp-tf-password:39
+misc/integrations/docker.postgres.ui.yml:hashicorp-tf-password:49
+misc/integrations/docker.postgres.ui.yml:hashicorp-tf-password:58
+misc/integrations/docker.postgres.yml:hashicorp-tf-password:37
+misc/integrations/swarm.mariadb.ui.yml:hashicorp-tf-password:68
+misc/integrations/swarm.mariadb.ui.yml:hashicorp-tf-password:88
+misc/integrations/swarm.mariadb.yml:hashicorp-tf-password:69
+misc/integrations/swarm.mysql.ui.yml:hashicorp-tf-password:68
+misc/integrations/swarm.mysql.ui.yml:hashicorp-tf-password:88
+misc/integrations/swarm.mysql.yml:hashicorp-tf-password:69
+misc/integrations/swarm.postgres.ui.yml:hashicorp-tf-password:68
+misc/integrations/swarm.postgres.ui.yml:hashicorp-tf-password:86
+misc/integrations/swarm.postgres.yml:hashicorp-tf-password:67
+examples/drupal/docker-compose.yml:hashicorp-tf-password:57
+examples/drupal/docker-compose.yml:hashicorp-tf-password:60
+examples/joomla/docker-compose.yml:hashicorp-tf-password:50
+examples/joomla/docker-compose.yml:hashicorp-tf-password:59
+examples/joomla/docker-compose.yml:hashicorp-tf-password:62
+examples/magento/docker-compose.yml:hashicorp-tf-password:48
+examples/magento/docker-compose.yml:hashicorp-tf-password:56
+examples/magento/docker-compose.yml:hashicorp-tf-password:76
+examples/magento/docker-compose.yml:hashicorp-tf-password:79
+examples/moodle/docker-compose.yml:hashicorp-tf-password:48
+examples/moodle/docker-compose.yml:hashicorp-tf-password:54
+examples/moodle/docker-compose.yml:hashicorp-tf-password:65
+examples/moodle/docker-compose.yml:hashicorp-tf-password:68
+examples/nextcloud/docker-compose.yml:hashicorp-tf-password:72
+examples/nextcloud/docker-compose.yml:hashicorp-tf-password:79
+examples/nextcloud/docker-compose.yml:hashicorp-tf-password:90
+examples/nextcloud/docker-compose.yml:hashicorp-tf-password:93
+examples/passbolt/docker-compose.yml:hashicorp-tf-password:60
+examples/passbolt/docker-compose.yml:hashicorp-tf-password:80
+examples/passbolt/docker-compose.yml:hashicorp-tf-password:83
+examples/prestashop/docker-compose.yml:hashicorp-tf-password:65
+examples/prestashop/docker-compose.yml:hashicorp-tf-password:68
+examples/redmine/docker-compose.yml:hashicorp-tf-password:47
+examples/redmine/docker-compose.yml:hashicorp-tf-password:57
+examples/redmine/docker-compose.yml:hashicorp-tf-password:60
+examples/web-ui/docker-compose.wizard.yml:hashicorp-tf-password:57
+examples/wordpress/docker-compose.yml:hashicorp-tf-password:62
+examples/web-ui/docker-compose.yml:hashicorp-tf-password:52
+examples/wordpress/docker-compose.yml:hashicorp-tf-password:72
+examples/wordpress/docker-compose.yml:hashicorp-tf-password:75
+examples/web-ui/docker-compose.yml:hashicorp-tf-password:64

.luacheckrc

@@ -0,0 +1,2 @@
+globals = {"ngx", "delay", "unpack"}
+ignore = {"411"}

.pre-commit-config.yaml

@@ -0,0 +1,77 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+exclude: (^LICENSE.md$|^src/VERSION$|^env/|^src/(bw/misc/root-ca.pem$|deps/src/|common/core/modsecurity/files|ui/static/(js/(editor/|utils/purify/|tsparticles\.bundle\.min\.js)|css/dashboard\.css))|\.(svg|drawio|patch\d?|ascii|tf|tftpl|key)$)
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: 2c9f875913ee60ca25ce70243dc24d5b6415598c # frozen: v4.6.0
+    hooks:
+      - id: requirements-txt-fixer
+        name: Fix requirements.txt and requirements.in files
+        description: Sorts entries in requirements.txt and requirements.in files.
+        files: (requirements|constraints).*\.(txt|in)$
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+        exclude: ^(mkdocs.yml|examples/bigbluebutton/docker-compose.yml)$
+        args: ["--allow-multiple-documents"]
+      - id: check-case-conflict
+
+  - repo: https://github.com/psf/black
+    rev: 3702ba224ecffbcec30af640c149f231d90aebdb # frozen: 24.4.2
+    hooks:
+      - id: black
+        name: Black Python Formatter
+        language_version: python3.9
+
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: ffb6a759a979008c0e6dff86e39f4745a2d9eac4 # frozen: v3.1.0
+    hooks:
+      - id: prettier
+        name: Prettier Code Formatter
+
+  - repo: https://github.com/JohnnyMorganz/StyLua
+    rev: 84c370104d6a8d1eef00c80a3ebd42f7033aaaad # frozen: v0.20.0
+    hooks:
+      - id: stylua-github
+        exclude: ^src/(bw/lua/middleclass.lua|common/core/antibot/captcha.lua)$
+
+  - repo: https://github.com/lunarmodules/luacheck
+    rev: cc089e3f65acdd1ef8716cc73a3eca24a6b845e4 # frozen: v1.2.0
+    hooks:
+      - id: luacheck
+        exclude: ^src/(bw/lua/middleclass.lua|common/core/antibot/captcha.lua)$
+        args: ["--std", "min", "--codes", "--ranges", "--no-cache"]
+
+  - repo: https://github.com/pycqa/flake8
+    rev: 7d37d9032d0d161634be4554273c30efd4dea0b3 # frozen: 7.0.0
+    hooks:
+      - id: flake8
+        name: Flake8 Python Linter
+        args: ["--max-line-length=160", "--ignore=E266,E402,E501,E722,W503"]
+
+  - repo: https://github.com/dosisod/refurb
+    rev: 2e31f0033b6c00bf99912fc6a8b5fd00460c9ba0 # frozen: v2.0.0
+    hooks:
+      - id: refurb
+        name: Refurb Python Refactoring Tool
+        exclude: ^tests/
+
+  - repo: https://github.com/codespell-project/codespell
+    rev: 193cd7d27cd571f79358af09a8fb8997e54f8fff # frozen: v2.3.0
+    hooks:
+      - id: codespell
+        name: Codespell Spell Checker
+        exclude: (^src/(ui/templates|common/core/.+/files|bw/loading)/.+.html|modsecurity-rules.conf.*|src/ui/static/js/lottie-web.min.js)$
+        entry: codespell --ignore-regex="(tabEl|Widgits)" --skip src/ui/static/js/utils/flatpickr.js,src/ui/static/css/style.css,CHANGELOG.md
+        language: python
+        types: [text]
+
+  - repo: https://github.com/gitleaks/gitleaks
+    rev: 145400593c178304246371bc45290588bc72f43e # frozen: v8.18.2
+    hooks:
+      - id: gitleaks
+
+  - repo: https://github.com/koalaman/shellcheck-precommit
+    rev: 2491238703a5d3415bb2b7ff11388bf775372f29 # frozen: v0.10.0
+    hooks:
+      - id: shellcheck

.prettierignore

@@ -0,0 +1,23 @@
+docs/
+env/
+*/env/
+*.min*
+src/common/core/modsecurity/files/
+src/deps/src/
+mkdocs.yml
+CHANGELOG.md
+CONTRIBUTING.md
+CODE_OF_CONDUCT.md
+LICENSE.md
+README.md
+SECURITY.md
+tsparticles.bundle.min.js
+flatpickr.*
+src/ui/static/js/lottie-web.min.js
+src/ui/static/js/editor/*
+src/ui/static/js/utils/purify/*
+src/ui/static/json/particles.json
+src/ui/templates/*
+src/common/core/*/ui/*
+datepicker-foundation.css
+examples/

.trivyignore

@@ -0,0 +1 @@
+CVE-2023-6129

CHANGELOG.md

@@ -0,0 +1,496 @@
+# Changelog
+
+## v1.5.9 - ????/??/??
+
+- [BUGFIX] Fix compatibility issues with mysql 8.4+ version and the `backup` plugin by adding the `mariadb-connector-c` dependency to the scheduler Dockerfile (on alpine)
+- [DEPS] Updated LuaJIT version to v2.1-20240626
+- [DEPS] Updated coreruleset-v4 version to v4.4.0
+
+## v1.5.8 - 2024/06/19
+
+- [LINUX] Support Fedora 40 and drop support of Fedora 39
+- [BUGFIX] Fix potential errors when upgrading from a previous version
+- [BUGFIX] Fix rare bug on the web UI when editing the SERVER_NAME setting of a service
+- [BUGFIX] Fix potential race conditions between the autoconf and the scheduler waiting for each other indefinitely
+- [BUGFIX] Fix Let's Encrypt certificate renewal when a certificate date changes by forcing the renewal
+- [BUGFIX] Fix issues with k8s integration and the save_config.py script
+- [FEATURE] Add nightly build of the OWASP coreruleset that are automatically downloaded and updated
+- [FEATURE] Enhance security on error pages, default server page and loading page by adding a custom `Content-Security-Policy` header with nonces and removing the `Server` header
+- [FEATURE] Add new DATABASE_URI_READONLY setting to allow setting up a fallback read-only database URI in case the main database URI is not available
+- [FEATURE] Add automatic fallback to either read-only on the primary database or to the read-only database URI when the main database URI is not available and automatically switch back to the main database URI when it becomes available again
+- [FEATURE] Add experimental support of HTTP/3 (QUIC)
+- [FEATURE] Optimize the way the scheduler handles jobs and the way the jobs are executed
+- [FEATURE] Optimize the way the cache files are being refreshed from the database
+- [FEATURE] Add failover logic in case the NGINX configuration is not valid to fallback to the previous configuration and log the error to prevent the service from being stopped
+- [UI] Force HTTPS on setup wizard
+- [UI] Fallback to self-signed certificate when UI is installed with setup wizard and let's encrypt is not used
+- [UI] Force HTTPS even if UI is installed in advanced mode
+- [UI] Add OVERRIDE_ADMIN_CREDS environment variable to allow overriding the default admin credentials even if an admin user already exists
+- [UI] Optimize the way the UI handles the requests and the responses
+- [AUTOCONF] Refactor Autoconf config parsing and saving logic so that it doesn't override the scheduler or UI config every time
+- [MISC] Update logger format and datefmt for better readability
+- [DEPS] Updated NGINX version to v1.26.1
+- [DEPS] Updated stream-lua-nginx-module version to the latest commit to incorporate the latest changes and fixes for NGINX v1.26
+- [DEPS] Updated coreruleset-v4 version to v4.3.0
+- [DEPS] Updated lua-resty-openssl version to v1.4.0
+
+## v1.5.7 - 2024/05/14
+
+- [LINUX] Support Ubuntu 24.04 (Noble)
+- [LINUX] Support RHEL 9.4 instead of 9.3
+- [LINUX] Support hot reload with systemctl reload
+- [BUGFIX] Fix rare error when the cache is not properly initialized and jobs are executed
+- [BUGFIX] Fix bug when downloading new mmdb files
+- [BUGFIX] Remove potential false positives with ModSecurity on the jobs page of the web UI
+- [BUGFIX] Fix bwcli not working with Redis sentinel
+- [BUGFIX] Fix potential issues when removing the bunkerweb Linux package
+- [BUGFIX] Fix bug when antibot is enabled and User-Agent or IP address has changed
+- [FEATURE] Add backup plugin to backup and restore easily the database
+- [FEATURE] Add LETS_ENCRYPT_CLEAR_OLD_CERTS setting to control if old certificates should be removed when generating Let's Encrypt certificates (default is no)
+- [FEATURE] Add DISABLE_DEFAULT_SERVER_STRICT_SNI setting to allow/block requests when SNI is unknown or unset (default is no)
+- [UI] General : fix tooltip crop because of overflow
+- [UI] General : fix select setting crop because of overflow and check if select is out of viewport to determine visible position
+- [UI] General : show logs on UI when pre rendering issue
+- [UI] General : Improve UI performance by using multiple workers for the web server and reducing the number of times we prompt a loading page
+- [UI] General : handle word breaks on dynamic text content
+- [UI] General : fix overflow issue with tables on Safari
+- [UI] General : fix static resources issue with firefox leading to loop requests
+- [UI] Global config : fix script error while fragment relate to a missing plugin
+- [UI] Global config / services page : filtering settings now open plugin select to highlight remaining plugin
+- [UI] Global config / services page : add combobox on plugin select open to search a plugin quick
+- [UI] Global config / services page : add order for settings to always respect the order defined in the plugin
+- [UI] Services page : show any invalid setting value on setting modal and disabled save if case
+- [UI] Reporting page : fix missing data and add new ones
+- [UI] Account page : keep license key form even if pro register to easy update
+- [UI] Wizard : Add the possibility to still configure reverse proxy even if an admin user already exists
+- [AUTOCONF] Speedup autoconf process when we have multiple events in short period of time
+- [DOCUMENTATION] Add upgrade procedure for 1.5.7+
+- [DOCUMENTATION] Rename Migrating section to Upgrading
+- [MISC] Drop support of ansible and vagrant integrations
+- [MISC] Support custom bwcli commands using plugins
+- [MISC] Add Docker labels in autoconf, bw, scheduler, and ui Dockerfiles
+- [DEPS] Update Python base Docker image to version 3.12.3-alpine3.19
+- [DEPS] Updated LuaJIT version to v2.1-20240314
+- [DEPS] Updated lua-resty-openssl version to 1.3.1
+- [DEPS] Updated coreruleset-v4 version to v4.2.0
+
+## v1.5.6 - 2024/03/25
+
+- [LINUX] Support RHEL 9.3
+- [BUGFIX] Fix issues with the antibot feature ([#866](https://github.com/bunkerity/bunkerweb/issues/866), [#870](https://github.com/bunkerity/bunkerweb/issues/870))
+- [BUGFIX] Fix Bad behavior whitelist check in access phase
+- [BUGFIX] Fix ModSecurity FP on antibot page
+- [BUGFIX] Fix Whitelist core plugin missing a check for empty server_name in multisite mode
+- [BUGFIX] Fix Templator missing some common configs
+- [BUGFIX] Database update with external plugins reupload
+- [BUGFIX] UI delete or edit multiple setting
+- [LINUX] Add logrotate support for the logs
+- [UI] New : add bans management page in the web UI
+- [UI] New : add blocked requests page in the web UI
+- [UI] New : some core plugins pages in the web UI
+- [UI] General : enhance the Content-Security-Policy header in the web UI
+- [UI] General : dark mode enhancement
+- [UI] General : add visual feedback when filtering is matching nothing
+- [UI] General : blog news working and add dynamic banner news
+- [UI] Global config page : Add multisite edit, add context filter
+- [UI] Global config / Service page : remove tabs for select and enhance filtering (plugin name, multiple settings and context now includes)
+- [UI] Service page : add the possibility to clone a service in the web UI
+- [UI] Service page : add the possibility to set a service as draft in the web UI
+- [UI] Service page : add services filter when at least 4 services
+- [UI] Configs page : add path filtering related to config presence, remove service when config is root only
+- [UI] Pro license : add home card, show pro plugins on menu and plugins page, resume in account page, alert in case issue with license usage
+- [UI] Log page : enhance UX
+- [FEATURE] Add setting REDIS_SSL_VERIFY to activate/disable the SSL certificate verification when using Redis
+- [FEATURE] Add Redis Sentinel fallback to master automatically if no slaves are available
+- [FEATURE] Add Redis Sentinel support for bwcli
+- [FEATURE] Add new Metrics core plugin that will allow metrics collection and retrieval of internal metrics
+- [FEATURE] Add setting DATABASE_LOG_LEVEL to control SQLAlchemy loggers separately from the main one
+- [FEATURE] Add whitelist check for the default-server as well
+- [FEATURE] Add the possibility to choose between the coreruleset v3 and v4 that will be used by ModSecurity (default is v3)
+- [FEATURE] Add the TIMERS_LOG_LEVEL setting to control the log level of the lua timers
+- [FEATURE] Add pro version management to core plugins, the scheduler and the web UI
+- [FEATURE] Add REVERSE_PROXY_CUSTOM_HOST setting to set a custom Host header when using reverse proxy
+- [MISC] Add a better custom certificate cache handling
+- [MISC] Updated Linux base images in Dockerfiles
+- [MISC] Add recommended dialects to databases string
+- [MISC] Refine the data sent in the anonymous reporting feature and move the setting and the job to the "jobs" plugin
+- [MISC] BunkerWeb will now load the default loading page even on 404 errors when generating the configuration
+- [MISC] Update database schema to support the new pro version and optimize it
+- [MISC] Refactor SSL/TLS logics to make it more consistent
+- [MISC] Use ECDSA key instead of RSA for selfsigned/default/fallback certificates
+- [MISC] Refactor certbot-new job to optimize the certbot requests
+- [MISC] Refactor jobs utils to make it more consistent
+- [MISC] Review jobs and utils to make it more consistent and better in general
+- [MISC] Change BunkerWeb base Docker image to nginx:1.24.0-alpine-slim
+- [DOCUMENTATION] Update web UI's setup wizard instructions in the documentation
+- [DOCUMENTATION] Update plugins documentation to reflect the new plugin system
+- [DOCUMENTATION] Update ModSecurity documentation to reflect the new changes in the Security Tuning section
+- [DOCUMENTATION] Add pro version documentation
+- [DEPS] Updated stream-lua-nginx-module to v0.0.14
+- [DEPS] Updated lua-nginx-module version to v0.10.26
+- [DEPS] Updated libmaxminddb version to v1.9.1
+- [DEPS] Updated lua-resty-core to v0.1.28
+- [DEPS] Updated zlib version to v1.3.1
+- [DEPS] Updated ModSecurity version to v3.0.12
+- [DEPS] Updated coreruleset version to v3.3.5
+- [DEPS] Added coreruleset version v4.1.0
+- [DEPS] Updated lua-resty-mlcache version to v2.7.0
+- [DEPS] Updated lua-resty-openssl version to v1.2.1
+- [DEPS] Updated lua-resty-http version to v0.17.2
+
+## v1.5.5 - 2024/01/12
+
+- [BUGFIX] Fix issues with the database when upgrading from one version to a newer one
+- [BUGFIX] Fix ModSecurity-nginx to make it work with brotli
+- [BUGFIX] Remove certbot renew delay causing errors on k8s
+- [BUGFIX] Fix missing custom modsec files when BW instances change
+- [BUGFIX] Fix inconsistency on config changes when using Redis
+- [BUGFIX] Fix web UI not working when using / URL
+- [FEATURE] Add Anonymous reporting feature
+- [FEATURE] Add support for fallback Referrer-Policies
+- [FEATURE] Add 2FA support to web UI
+- [FEATURE] Add username and password management to web UI
+- [FEATURE] Add setting REVERSE_PROXY_INCLUDES to manually add "include" directives in the reverse proxies
+- [FEATURE] Add support for Redis Sentinel
+- [FEATURE] Add support for tls in Ingress definition
+- [MISC] Fallback to default HTTPS certificate to prevent errors
+- [MISC] Various internal improvements in LUA code
+- [MISC] Check nginx configuration before reload
+- [MISC] Updated Python Docker image to 3.12.1-alpine3.18 in Dockerfiles
+- [DEPS] Updated ModSecurity to v3.0.11
+
+## v1.5.4 - 2023/12/04
+
+- [UI] Add an optional setup wizard for the web UI
+- [BUGFIX] Fix issues with the Linux integration and external databases
+- [BUGFIX] Fix scheduler trying to connect to Docker socket in k8s and swarm
+- [LINUX] Support Debian 12, Fedora 39 and RHEL 8.9
+- [DOCKER] Handle start and stop event of BunkerWeb with the scheduler
+- [MISC] Refactor database session handling to make it more stable with SQLite
+- [MISC] Add conditional block for open file cache in nginx config
+- [MISC] Updated core dependencies
+- [MISC] Updated python dependencies
+- [MISC] Updated Python Docker image to 3.12.0-alpine3.18 in Dockerfiles
+
+## v1.5.3 - 2023/10/31
+
+- [BUGFIX] Fix BunkerWeb not loading his own settings after a docker restart
+- [BUGFIX] Fix Custom configs not following the service name after an update on the UI
+- [BUGFIX] Fix UI clearing configs folder at startup
+- [BUGFIX] Fix Database not clearing old services when not using multisite
+- [BUGFIX] Fix UI using the wrong database when generating the new config when using an external database
+- [BUGFIX] Small fixes on linux paths creating unnecessary folders
+- [BUGFIX] Fix ACME renewal fails on redirection enabled Service
+- [BUGFIX] Fix errors when using a server name with multiple values in web UI
+- [BUGFIX] Fix error when deleting a service that have custom configs on web UI
+- [BUGFIX] Fix rare bug where database is locked
+- [MISC] Updated core dependencies
+- [MISC] Updated self-signed job to regenerate the cert if the subject or the expiration date has changed
+- [MISC] Jobs that download files from urls will now remove old cached files if urls are empty
+- [MISC] Replaced gevent with gthread in UI for security reasons
+- [MISC] Add HTML sanitization when injecting code in pages in the UI
+- [MISC] Optimize the way the UI handles services creation and edition
+- [MISC] Optimize certbot renew script to renew all domains in one command
+- [MISC] Use capability instead of sudo in Linux
+- [SECURITY] Init work on OpenSSF best practices
+
+## v1.5.2 - 2023/09/10
+
+- [BUGFIX] Fix UI fetching only default values from the database (fixes no trash button too)
+- [BUGFIX] Fix infinite loop when using autoconf
+- [BUGFIX] Fix BunkerWeb fails to start after reboot on Fedora and Rhel
+- [BUGFIX] Fix logs page not working in UI on Linux integrations
+- [BUGFIX] Fix settings regex that had issues in general and with the UI
+- [BUGFIX] Fix scheduler error with external plugins when reloading
+- [BUGFIX] Fix permissions with folders in linux integrations
+- [MISC] Push Docker images to GitHub packages (ghcr.io repository)
+- [MISC] Improved CI/CD
+- [MISC] Updated python dependencies
+- [MISC] Updated Python Docker image to 3.11.5-alpine in Dockerfiles
+- [MISC] Add support for ModSecurity JSON LogFormat
+- [MISC] Updated OWASP coreruleset to 3.3.5
+
+## v1.5.1 - 2023/08/08
+
+- [BUGFIX] New version checker in logs displays "404 not found"
+- [BUGFIX] New version checker in UI
+- [BUGFIX] Only get the right keys from plugin.json files when importing plugins
+- [BUGFIX] Remove external resources for Google fonts in UI
+- [BUGFIX] Support multiple plugin uploads in one zip when using the UI
+- [BUGFIX] Variable being ignored instead of saved in the database when value is empty
+- [BUGFIX] ALLOWED_METHODS regex working with LOCK/UNLOCK methods
+- [BUGFIX] Custom certificate bug after the refactoring
+- [BUGFIX] Wrong variables in header phase (fix CORS feature too)
+- [BUGFIX] UI not working in Ubuntu (python zope module)
+- [BUGFIX] Patch ModSecurity to run it after LUA code (should fix whitelist problems)
+- [BUGFIX] Custom configurations from env were not being deleted properly
+- [BUGFIX] Missing concepts image not displayed in the documentation
+- [BUGFIX] Scheduler not picking up new instances IPs in autoconf modes
+- [BUGFIX] Autoconf deadlock in k8s
+- [BUGFIX] Missing HTTP and HTTPS ports for temp nginx
+- [BUGFIX] Infinite loop when sessions is not valid
+- [BUGFIX] Missing valid LE certificates in edge cases
+- [BUGFIX] Wrong service namespace in k8s
+- [BUGFIX] DNS_RESOLVERS regex not accepting hostnames
+- [PERFORMANCE] Reduce CPU and RAM usage of scheduler
+- [PERFORMANCE] Cache ngx.ctx instead of loading it each time
+- [PERFORMANCE] Use per-worker LRU cache for common RO LUA values
+- [FEATURE] Add Turnstile antibot mode
+- [FEATURE] Add more CORS headers
+- [FEATURE] Add KEEP_UPSTREAM_HEADERS to preserve headers when using reverse proxy
+- [FEATURE] Add the possibility to download the different lists and plugins from a local file (like the blacklist)
+- [FEATURE] External plugins can now be downloaded from a tar.gz and tar.xz file as well as zip
+- [FEATURE] Add X-Forwarded-Prefix header when using reverse proxy
+- [FEATURE] Add REDIRECT_TO_STATUS_CODE to choose status code 301 or 302 when redirecting
+- [DOCUMENTATION] Add timezone information
+- [DOCUMENTATION] Add timezone informat
+- [MISC] Add LOG_LEVEL=warning for docker socket proxy in docs, examples and boilerplates
+- [MISC] Temp remove VMWare provider for Vagrant integration
+- [MISC] Remove X-Script-Name header and ABSOLUTE_URI variable when using UI
+- [MISC] Move logs to /var/log/bunkerweb folder
+- [MISC] Reduce "Got an error reading communication packets" warnings in mariadb/mysql
+
+## v1.5.0 - 2023/05/23
+
+- Refactoring of almost all the components of the project
+- Dedicated scheduler service to manage jobs and configuration
+- Store configuration in a database backend
+- Improved web UI and make it working with all integrations
+- Improved internal LUA code
+- Improved internal cache of BW
+- Add Redis support when using clustered integrations
+- Add RHEL integration
+- Add Vagrant integration
+- Init support of generic TCP/UDP (stream)
+- Init support of IPv6
+- Improved CI/CD : UI tests, core tests and release automation
+- Reduce Docker images size
+- Fix and improved core plugins : antibot, cors, dnsbl, ...
+- Use PCRE regex instead of LUA patterns
+- Connectivity tests at startup/reload with logging
+
+## v1.5.0-beta - 2023/05/02
+
+- Refactoring of almost all the components of the project
+- Dedicated scheduler service to manage jobs and configuration
+- Store configuration in a database backend
+- Improved web UI and make it working with all integrations
+- Improved internal LUA code
+- Improved internal cache of BW
+- Add Redis support when using clustered integrations
+- Add RHEL integration
+- Add Vagrant integration
+- Init support of generic TCP/UDP (stream)
+- Init support of IPv6
+- Improved CI/CD : UI tests, core tests and release automation
+- Reduce Docker images size
+- Fix and improved core plugins : antibot, cors, dnsbl, ...
+- Use PCRE regex instead of LUA patterns
+- Connectivity tests at startup/reload with logging
+
+## v1.4.8 - 2023/04/05
+
+- Fix UI bug related to multiple settings
+- Increase check reload interval in UI to avoid rate limit
+- Fix Let's Encrypt error when using auth basic
+- Fix wrong setting name in realip job (again)
+- Fix blog posts retrieval in the UI
+- Fix missing logs for UI
+- Fix error log if BunkerNet ip list is empty
+- Updated python dependencies
+- Gunicorn will now show the logs in the console for the UI
+- BunkerNet job will now create the ip list file at the beginning of the job to avoid errors
+
+## v1.4.7 - 2023/02/27
+
+- Fix DISABLE_DEFAULT_SERVER=yes not working with HTTPS (again)
+- Fix wrong setting name in realip job
+- Fix whitelisting not working with modsecurity
+
+## v1.4.6 - 2023/02/14
+
+- Fix error in the UI when a service have multiple domains
+- Fix bwcli bans command
+- Fix documentation about Linux Fedora install
+- Fix DISABLE_DEFAULT_SERVER=yes not working with HTTPS
+- Add INTERCEPTED_ERROR_CODES setting
+
+## v1.4.5 - 2022/11/26
+
+- Fix bwcli syntax error
+- Fix UI not working using Linux integration
+- Fix missing openssl dep in autoconf
+- Fix typo in selfsigned job
+
+## v1.4.4 - 2022/11/10
+
+- Fix k8s controller not watching the events when there is an exception
+- Fix python dependencies bug in CentOS and Fedora
+- Fix incorrect log when reloading nginx using Linux integration
+- Fix UI dev mode, production mode is now the default
+- Fix wrong exposed port in the UI container
+- Fix endless loading in the UI
+- Fix \*_CUSTOM_CONF_\* dissapear when jobs are executed
+- Fix various typos in documentation
+- Fix warning about StartLimitIntervalSec directive when using Linux
+- Fix incorrect log when issuing certbot renew
+- Fix certbot renew error when using Linux or Docker integration
+- Add greylist core feature
+- Add BLACKLIST_IGNORE_\* settings
+- Add automatic change of SecRequestBodyLimit modsec directive based on MAX_CLIENT_SIZE setting
+- Add MODSECURITY_SEC_RULE_ENGINE and MODSECURITY_SEC_AUDIT_LOG_PARTS settings
+- Add manual ban and get bans to the API/CLI
+- Add Brawdunoir community example
+- Improve core plugins order and add documentation about it
+- Improve overall documentation
+- Improve CI/CD
+
+## v1.4.3 - 2022/08/26
+
+- Fix various documentation errors/typos and add various enhancements
+- Fix ui.env not read when using Linux integration
+- Fix wrong variables.env path when using Linux integration
+- Fix missing default server when TEMP_NGINX=yes
+- Fix check if BunkerNet is activated on default server
+- Fix request crash when mmdb lookup fails
+- Fix bad behavior trigger when request is whitelisted
+- Fix bad behavior not triggered when request is on default server
+- Fix BW overriding config when config is already present
+- Add Ansible integration in beta
+- Add \*_CUSTOM_CONF_\* setting to automatically add custom config files from setting value
+- Add DENY_HTTP_STATUS setting to choose standard 403 error page (default) or 444 to close connection when access is denied
+- Add CORS (Cross-Origin Resource Sharing) core plugin
+- Add documentation about Docker in rootless mode and podman
+- Improve automatic tests setup
+- Migrate CI/CD infrastructure to another provider
+
+## v1.4.2 - 2022/06/28
+
+- Fix "too old resource version" exceptions when using k8s integration
+- Fix missing bwcli command with Linux integration
+- Fix various bugs with jobs scheduler when using autoconf/swarm/k8s
+- Fix bwcli unban command when using Linux integration
+- Fix permissions check when filename has a space
+- Fix static config (SERVER_NAME not empty) support when using autoconf/swarm/k8s
+- Fix config files overwrite when using Docker autoconf
+- Add EXTERNAL_PLUGIN_URLS setting to automatically download and install external plugins
+- Add log_default() plugin hook
+- Add various certbot-dns examples
+- Add mattermost example
+- Add radarr example
+- Add Discord and Slack to list of official plugins
+- Force NGINX version dependencies in Linux packages DEB/RPM
+
+## v1.4.1 - 2022/06/16
+
+- Fix sending local IPs to BunkerNet when DISABLE_DEFAULT_SERVER=yes
+- Fix certbot bug when AUTOCONF_MODE=yes
+- Fix certbot bug when MULTISITE=no
+- Add reverse proxy timeouts settings
+- Add auth_request settings
+- Add authentik and authelia examples
+- Prebuilt Docker images for arm64 and armv7
+- Improve documentation for Linux integration
+- Various fixes in the documentation
+
+## v1.4.0 - 2022/06/06
+
+- Project renamed to BunkerWeb
+- Internal architecture fully revised with a modular approach
+- Improved CI/CD with automatic tests for multiple integrations
+- Plugin improvement
+- Volume improvement for container-based integrations
+- Web UI improvement with various new features
+- Web tool to generate settings from a user-friendly UI
+- Linux packages
+- Various bug fixes
+
+## v1.3.2 - 2021/10/24
+
+- Use API instead of a shared folder for Swarm and Kubernetes integrations
+- Beta integration of distributed bad IPs database through a remote API
+- Improvement of the request limiting feature : hour/day rate and multiple URL support
+- Various bug fixes related to antibot feature
+- Init support of Arch Linux
+- Fix Moodle example
+- Fix ROOT_FOLDER bug in serve-files.conf when using the UI
+- Update default values for PERMISSIONS_POLICY and FEATURE_POLICY
+- Disable COUNTRY ban if IP is local
+
+## v1.3.1 - 2021/09/02
+
+- Use ModSecurity v3.0.4 instead of v3.0.5 to fix memory leak
+- Fix ignored variables to control jobs
+- Fix bug when LISTEN_HTTP=no and MULTISITE=yes
+- Add CUSTOM_HEADER variable
+- Add REVERSE_PROXY_BUFFERING variable
+- Add REVERSE_PROXY_KEEPALIVE variable
+- Fix documentation for modsec and modsec-crs special folders
+
+## v1.3.0 - 2021/08/23
+
+- Kubernetes integration in beta
+- Linux integration in beta
+- autoconf refactoring
+- jobs refactoring
+- UI refactoring
+- UI security : login/password authentication and CRSF protection
+- various dependencies updates
+- move CrowdSec as an external plugin
+- Authelia support
+- improve various regexes
+- add INJECT_BODY variable
+- add WORKER_PROCESSES variable
+- add USE_LETS_ENCRYPT_STAGING variable
+- add LOCAL_PHP and LOCAL_PHP_PATH variables
+- add REDIRECT_TO variable
+
+## v1.2.8 - 2021/07/22
+
+- Fix broken links in README
+- Fix regex for EMAIL_LETS_ENCRYPT
+- Fix regex for REMOTE_PHP and REMOTE_PHP_PATH
+- Fix regex for SELF_SIGNED_*
+- Fix various bugs related to web UI
+- Fix bug in autoconf (missing instances parameter to reload function)
+- Remove old .env files when generating a new configuration
+
+## v1.2.7 - 2021/06/14
+
+- Add custom robots.txt and sitemap to RTD
+- Fix missing GeoIP DB bug when using BLACKLIST/WHITELIST_COUNTRY
+- Add underscore "_" to allowed chars for CUSTOM_HTTPS_CERT/KEY
+- Fix bug when using automatic self-signed certificate
+- Build and push images from GitHub actions instead of Docker Hub autobuild
+- Display the reason when generator is ignoring a variable
+- Various bug fixes related to certbot and jobs
+- Split jobs into pre and post jobs
+- Add HEALTHCHECK to image
+- Fix race condition when using autoconf without Swarm by checking healthy state
+- Bump modsecurity-nginx to v1.0.2
+- Community chat with bridged platforms
+
+## v1.2.6 - 2021/06/06
+
+- Move from "ghetto-style" shell scripts to generic jinja2 templating
+- Init work on a basic plugins system
+- Move ClamAV to external plugin
+- Reduce image size by removing unnecessary dependencies
+- Fix CrowdSec example
+- Change some global variables to multisite
+- Add LOG_LEVEL environment variable
+- Read-only container support
+- Improved antibot javascript with a basic proof of work
+- Update nginx to 1.20.1
+- Support of docker-socket-proxy with web UI
+- Add certbot-cloudflare example
+- Disable DNSBL checks when IP is local
+
+## v1.2.5 - 2021/05/14
+
+- Performance improvement : move some nginx security checks to LUA and external blacklist parsing enhancement
+- Init work on official documentation on readthedocs
+- Fix default value for CONTENT_SECURITY_POLICY to allow file downloads
+- Add ROOT_SITE_SUBFOLDER environment variable
+
+## TODO - retrospective changelog

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+contact@bunkerity.com.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -0,0 +1,21 @@
+# Contributing to bunkerweb
+
+First off all, thanks for being here and showing your support to the project !
+
+We accept many types of contributions whether they are technical or not. Every community feedback, work or help is, and will always be, appreciated.
+
+## Talk about the project
+
+The first thing you can do is to talk about the project. You can share it on social media (by the way, you can can also follow us on [LinkedIn](https://www.linkedin.com/company/bunkerity/), [Twitter](https://twitter.com/bunkerity) and [GitHub](https://github.com/bunkerity)), make a blog post about it or simply tell your friends/colleagues that's an awesome project..
+
+## Join the community
+
+You can join the [Discord server](https://discord.com/invite/fTf46FmtyD), the [GitHub discussions](https://github.com/bunkerity/bunkerweb/discussions) and the [/r/BunkerWeb](https://www.reddit.com/r/BunkerWeb) subreddit to talk about the project and help others.
+
+## Reporting bugs / ask for features
+
+The preferred way to report bugs and asking for features is using [issues](https://github.com/bunkerity/bunkerweb/issues). Before opening a new one, please check if a related issue is already opened using the "filters" bar. When creating a new issue please select and fill the "Bug report" or "Feature request" template.
+
+## Code contribution
+
+The preferred way to contribute code is using [pull requests](https://github.com/bunkerity/bunkerweb/pulls). Before creating a pull request, please check if your code is related to an opened issue. If that's not the case, you should first create an issue so we can discuss about it. This procedure is here to avoid wasting your time in case the PR will be rejected. For minor changes (e.g. : typo, quick fix, ...), opening an issue might be facultative. **Don't forget to edit the documentations when needed !**

LICENSE.md

@@ -0,0 +1,660 @@
+### GNU AFFERO GENERAL PUBLIC LICENSE
+
+Version 3, 19 November 2007
+
+Copyright (C) 2007 Free Software Foundation, Inc.
+<https://fsf.org/>
+
+Everyone is permitted to copy and distribute verbatim copies of this
+license document, but changing it is not allowed.
+
+### Preamble
+
+The GNU Affero General Public License is a free, copyleft license for
+software and other kinds of works, specifically designed to ensure
+cooperation with the community in the case of network server software.
+
+The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+our General Public Licenses are intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains
+free software for all its users.
+
+When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+Developers that use our General Public Licenses protect your rights
+with two steps: (1) assert copyright on the software, and (2) offer
+you this License which gives you legal permission to copy, distribute
+and/or modify the software.
+
+A secondary benefit of defending all users' freedom is that
+improvements made in alternate versions of the program, if they
+receive widespread use, become available for other developers to
+incorporate. Many developers of free software are heartened and
+encouraged by the resulting cooperation. However, in the case of
+software used on network servers, this result may fail to come about.
+The GNU General Public License permits making a modified version and
+letting the public access it on a server without ever releasing its
+source code to the public.
+
+The GNU Affero General Public License is designed specifically to
+ensure that, in such cases, the modified source code becomes available
+to the community. It requires the operator of a network server to
+provide the source code of the modified version running there to the
+users of that server. Therefore, public use of a modified version, on
+a publicly accessible server, gives the public access to the source
+code of the modified version.
+
+An older license, called the Affero General Public License and
+published by Affero, was designed to accomplish similar goals. This is
+a different license, not a version of the Affero GPL, but Affero has
+released a new version of the Affero GPL which permits relicensing
+under this license.
+
+The precise terms and conditions for copying, distribution and
+modification follow.
+
+### TERMS AND CONDITIONS
+
+#### 0. Definitions.
+
+"This License" refers to version 3 of the GNU Affero General Public
+License.
+
+"Copyright" also means copyright-like laws that apply to other kinds
+of works, such as semiconductor masks.
+
+"The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
+"recipients" may be individuals or organizations.
+
+To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of
+an exact copy. The resulting work is called a "modified version" of
+the earlier work or a work "based on" the earlier work.
+
+A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user
+through a computer network, with no transfer of a copy, is not
+conveying.
+
+An interactive user interface displays "Appropriate Legal Notices" to
+the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License. If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+#### 1. Source Code.
+
+The "source code" for a work means the preferred form of the work for
+making modifications to it. "Object code" means any non-source form of
+a work.
+
+A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form. A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities. However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work. For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+The Corresponding Source need not include anything that users can
+regenerate automatically from other parts of the Corresponding Source.
+
+The Corresponding Source for a work in source code form is that same
+work.
+
+#### 2. Basic Permissions.
+
+All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met. This License explicitly affirms your unlimited
+permission to run the unmodified Program. The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work. This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+You may make, run and propagate covered works that you do not convey,
+without conditions so long as your license otherwise remains in force.
+You may convey covered works to others for the sole purpose of having
+them make modifications exclusively for you, or provide you with
+facilities for running those works, provided that you comply with the
+terms of this License in conveying all material for which you do not
+control copyright. Those thus making or running the covered works for
+you must do so exclusively on your behalf, under your direction and
+control, on terms that prohibit them from making any copies of your
+copyrighted material outside their relationship with you.
+
+Conveying under any other circumstances is permitted solely under the
+conditions stated below. Sublicensing is not allowed; section 10 makes
+it unnecessary.
+
+#### 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such
+circumvention is effected by exercising rights under this License with
+respect to the covered work, and you disclaim any intention to limit
+operation or modification of the work as a means of enforcing, against
+the work's users, your or third parties' legal rights to forbid
+circumvention of technological measures.
+
+#### 4. Conveying Verbatim Copies.
+
+You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+#### 5. Conveying Modified Source Versions.
+
+You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these
+conditions:
+
+-   a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+-   b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under
+    section 7. This requirement modifies the requirement in section 4
+    to "keep intact all notices".
+-   c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy. This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged. This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+-   d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit. Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+#### 6. Conveying Non-Source Forms.
+
+You may convey a covered work in object code form under the terms of
+sections 4 and 5, provided that you also convey the machine-readable
+Corresponding Source under the terms of this License, in one of these
+ways:
+
+-   a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+-   b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the Corresponding
+    Source from a network server at no charge.
+-   c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source. This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+-   d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge. You need not require recipients to copy the
+    Corresponding Source along with the object code. If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source. Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+-   e) Convey the object code using peer-to-peer transmission,
+    provided you inform other peers where the object code and
+    Corresponding Source of the work are being offered to the general
+    public at no charge under subsection 6d.
+
+A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal,
+family, or household purposes, or (2) anything designed or sold for
+incorporation into a dwelling. In determining whether a product is a
+consumer product, doubtful cases shall be resolved in favor of
+coverage. For a particular product received by a particular user,
+"normally used" refers to a typical or common use of that class of
+product, regardless of the status of the particular user or of the way
+in which the particular user actually uses, or expects or is expected
+to use, the product. A product is a consumer product regardless of
+whether the product has substantial commercial, industrial or
+non-consumer uses, unless such uses represent the only significant
+mode of use of the product.
+
+"Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to
+install and execute modified versions of a covered work in that User
+Product from a modified version of its Corresponding Source. The
+information must suffice to ensure that the continued functioning of
+the modified object code is in no case prevented or interfered with
+solely because modification has been made.
+
+If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information. But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or
+updates for a work that has been modified or installed by the
+recipient, or for the User Product in which it has been modified or
+installed. Access to a network may be denied when the modification
+itself materially and adversely affects the operation of the network
+or violates the rules and protocols for communication across the
+network.
+
+Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+#### 7. Additional Terms.
+
+"Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law. If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it. (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.) You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders
+of that material) supplement the terms of this License with terms:
+
+-   a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+-   b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+-   c) Prohibiting misrepresentation of the origin of that material,
+    or requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+-   d) Limiting the use for publicity purposes of names of licensors
+    or authors of the material; or
+-   e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+-   f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions
+    of it) with contractual assumptions of liability to the recipient,
+    for any liability that these contractual assumptions directly
+    impose on those licensors and authors.
+
+All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10. If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term. If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions; the
+above requirements apply either way.
+
+#### 8. Termination.
+
+You may not propagate or modify a covered work except as expressly
+provided under this License. Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+However, if you cease all violation of this License, then your license
+from a particular copyright holder is reinstated (a) provisionally,
+unless and until the copyright holder explicitly and finally
+terminates your license, and (b) permanently, if the copyright holder
+fails to notify you of the violation by some reasonable means prior to
+60 days after the cessation.
+
+Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License. If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+#### 9. Acceptance Not Required for Having Copies.
+
+You are not required to accept this License in order to receive or run
+a copy of the Program. Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance. However,
+nothing other than this License grants you permission to propagate or
+modify any covered work. These actions infringe copyright if you do
+not accept this License. Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+#### 10. Automatic Licensing of Downstream Recipients.
+
+Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License. You are not responsible
+for enforcing compliance by third parties with this License.
+
+An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations. If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License. For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+#### 11. Patents.
+
+A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based. The
+work thus licensed is called the contributor's "contributor version".
+
+A contributor's "essential patent claims" are all patent claims owned
+or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version. For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement). To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients. "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+A patent license is "discriminatory" if it does not include within the
+scope of its coverage, prohibits the exercise of, or is conditioned on
+the non-exercise of one or more of the rights that are specifically
+granted under this License. You may not convey a covered work if you
+are a party to an arrangement with a third party that is in the
+business of distributing software, under which you make payment to the
+third party based on the extent of your activity of conveying the
+work, and under which the third party grants, to any of the parties
+who would receive the covered work from you, a discriminatory patent
+license (a) in connection with copies of the covered work conveyed by
+you (or copies made from those copies), or (b) primarily for and in
+connection with specific products or compilations that contain the
+covered work, unless you entered into that arrangement, or that patent
+license was granted, prior to 28 March 2007.
+
+Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+#### 12. No Surrender of Others' Freedom.
+
+If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under
+this License and any other pertinent obligations, then as a
+consequence you may not convey it at all. For example, if you agree to
+terms that obligate you to collect a royalty for further conveying
+from those to whom you convey the Program, the only way you could
+satisfy both those terms and this License would be to refrain entirely
+from conveying the Program.
+
+#### 13. Remote Network Interaction; Use with the GNU General Public License.
+
+Notwithstanding any other provision of this License, if you modify the
+Program, your modified version must prominently offer all users
+interacting with it remotely through a computer network (if your
+version supports such interaction) an opportunity to receive the
+Corresponding Source of your version by providing access to the
+Corresponding Source from a network server at no charge, through some
+standard or customary means of facilitating copying of software. This
+Corresponding Source shall include the Corresponding Source for any
+work covered by version 3 of the GNU General Public License that is
+incorporated pursuant to the following paragraph.
+
+Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU General Public License into a single
+combined work, and to convey the resulting work. The terms of this
+License will continue to apply to the part which is the covered work,
+but the work with which it is combined will remain governed by version
+3 of the GNU General Public License.
+
+#### 14. Revised Versions of this License.
+
+The Free Software Foundation may publish revised and/or new versions
+of the GNU Affero General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Program
+specifies that a certain numbered version of the GNU Affero General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation. If the Program does not specify a version number of the
+GNU Affero General Public License, you may choose any version ever
+published by the Free Software Foundation.
+
+If the Program specifies that a proxy can decide which future versions
+of the GNU Affero General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+Later license versions may give you additional or different
+permissions. However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+#### 15. Disclaimer of Warranty.
+
+THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT
+WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND
+PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE
+DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
+CORRECTION.
+
+#### 16. Limitation of Liability.
+
+IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR
+CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
+ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT
+NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR
+LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM
+TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER
+PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+
+#### 17. Interpretation of Sections 15 and 16.
+
+If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+END OF TERMS AND CONDITIONS
+
+### How to Apply These Terms to Your New Programs
+
+If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these
+terms.
+
+To do so, attach the following notices to the program. It is safest to
+attach them to the start of each source file to most effectively state
+the exclusion of warranty; and each file should have at least the
+"copyright" line and a pointer to where the full notice is found.
+
+        <one line to give the program's name and a brief idea of what it does.>
+        Copyright (C) <year>  <name of author>
+
+        This program is free software: you can redistribute it and/or modify
+        it under the terms of the GNU Affero General Public License as
+        published by the Free Software Foundation, either version 3 of the
+        License, or (at your option) any later version.
+
+        This program is distributed in the hope that it will be useful,
+        but WITHOUT ANY WARRANTY; without even the implied warranty of
+        MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+        GNU Affero General Public License for more details.
+
+        You should have received a copy of the GNU Affero General Public License
+        along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper
+mail.
+
+If your software can interact with users remotely through a computer
+network, you should also make sure that it provides a way for users to
+get its source. For example, if your program is a web application, its
+interface could display a "Source" link that leads users to an archive
+of the code. There are many ways you could offer source, and different
+solutions will be better for different programs; see section 13 for
+the specific requirements.
+
+You should also get your employer (if you work as a programmer) or
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary. For more information on this, and how to apply and follow
+the GNU AGPL, see <https://www.gnu.org/licenses/>.

README.md

@@ -0,0 +1,417 @@
+<p align="center">
+	<img alt="BunkerWeb logo" src="https://github.com/bunkerity/bunkerweb/raw/v1.6.0-beta/misc/logo.png" height=100 width=350 />
+</p>
+
+<p align="center">
+	<img src="https://img.shields.io/github/v/release/bunkerity/bunkerweb?label=stable" />
+	<img src="https://img.shields.io/github/v/release/bunkerity/bunkerweb?include_prereleases&label=latest" />
+	<br />
+	<img src="https://img.shields.io/github/last-commit/bunkerity/bunkerweb" />
+	<img src="https://img.shields.io/github/issues/bunkerity/bunkerweb">
+	<img src="https://img.shields.io/github/issues-pr/bunkerity/bunkerweb">
+	<br />
+	<img src="https://img.shields.io/github/actions/workflow/status/bunkerity/bunkerweb/dev.yml?branch=dev&label=CI%2FCD%20dev" />
+	<img src="https://img.shields.io/github/actions/workflow/status/bunkerity/bunkerweb/staging.yml?branch=staging&label=CI%2FCD%20staging" />
+	<a href="https://www.bestpractices.dev/projects/8001">
+		<img src="https://www.bestpractices.dev/projects/8001/badge">
+	</a>
+</p>
+
+<p align="center">
+	🌐 <a href="https://www.bunkerweb.io/?utm_campaign=self&utm_source=github">Website</a>
+	 &#124;
+	🤝 <a href="https://panel.bunkerweb.io/?utm_campaign=self&utm_source=github">Panel</a>
+	 &#124;
+	📓 <a href="https://docs.bunkerweb.io/?utm_campaign=self&utm_source=github">Documentation</a>
+	 &#124;
+	👨‍💻 <a href="https://demo.bunkerweb.io/?utm_campaign=self&utm_source=github">Demo</a>
+	 &#124;
+	🛡️ <a href="https://github.com/bunkerity/bunkerweb/raw/v1.6.0-beta/examples">Examples</a>
+	 &#124;
+	💬 <a href="https://discord.com/invite/fTf46FmtyD">Chat</a>
+	 &#124;
+	📝 <a href="https://github.com/bunkerity/bunkerweb/discussions">Forum</a>
+	<br/>
+	⚙️ <a href="https://config.bunkerweb.io/?utm_campaign=self&utm_source=github">Configurator</a>
+	 &#124;
+	🗺️ <a href="https://threatmap.bunkerweb.io/?utm_campaign=self&utm_source=github">Threatmap</a>
+	 &#124;
+	🔎 <a href="https://forms.gle/e3VgymAteYPnwM1j9">Feedbacks</a>
+</p>
+
+> 🛡️ Make security by default great again !
+
+# BunkerWeb
+
+<p align="center">
+	<img alt="Overview banner" src="https://github.com/bunkerity/bunkerweb/raw/v1.6.0-beta/docs/assets/img/intro-overview.svg" />
+</p>
+
+BunkerWeb is a next-generation and open-source Web Application Firewall (WAF).
+
+Being a full-featured web server (based on [NGINX](https://nginx.org/) under the hood), it will protect your web services to make them "secure by default". BunkerWeb integrates seamlessly into your existing environments ([Linux](https://docs.bunkerweb.io/1.6.0-beta/integrations/?utm_campaign=self&utm_source=github#linux), [Docker](https://docs.bunkerweb.io/1.6.0-beta/integrations/?utm_campaign=self&utm_source=github#docker), [Swarm](https://docs.bunkerweb.io/1.6.0-beta/integrations/?utm_campaign=self&utm_source=github#swarm), [Kubernetes](https://docs.bunkerweb.io/1.6.0-beta/integrations/?utm_campaign=self&utm_source=github#kubernetes), …) and is fully configurable (don't panic, there is an [awesome web UI](https://docs.bunkerweb.io/1.6.0-beta/web-ui/?utm_campaign=self&utm_source=github) if you don't like the CLI) to meet your own use-cases . In other words, cybersecurity is no more a hassle.
+
+BunkerWeb contains primary [security features](https://docs.bunkerweb.io/1.6.0-beta/security-tuning/?utm_campaign=self&utm_source=github) as part of the core but can be easily extended with additional ones thanks to a [plugin system](https://docs.bunkerweb.io/1.6.0-beta/plugins/?utm_campaign=self&utm_source=github).
+
+## Why BunkerWeb ?
+
+- **Easy integration into existing environments** : Seamlessly integrate BunkerWeb into various environments such as Linux, Docker, Swarm, Kubernetes and more. Enjoy a smooth transition and hassle-free implementation.
+- **Highly customizable** : Tailor BunkerWeb to your specific requirements with ease. Enable, disable, and configure features effortlessly, allowing you to customize the security settings according to your unique use case.
+- **Secure by default** : BunkerWeb provides out-of-the-box, hassle-free minimal security for your web services. Experience peace of mind and enhanced protection right from the start.
+- **Awesome web UI** : Take control of BunkerWeb more efficiently with the exceptional web user interface (UI). Navigate settings and configurations effortlessly through a user-friendly graphical interface, eliminating the need for the command-line interface (CLI).
+- **Plugin system** : Extend the capabilities of BunkerWeb to meet your own use cases. Seamlessly integrate additional security measures and customize the functionality of BunkerWeb according to your specific requirements.
+- **Free as in "freedom"** : BunkerWeb is licensed under the free [AGPLv3 license](https://www.gnu.org/licenses/agpl-3.0.en.html), embracing the principles of freedom and openness. Enjoy the freedom to use, modify, and distribute the software, backed by a supportive community.
+- **Professional services** : Get technical support, tailored consulting and custom development directly from the maintainers of BunkerWeb. Visit the [Bunker Panel](https://panel.bunkerweb.io/?utm_campaign=self&utm_source=github) for more information.
+
+## Security features
+
+A non-exhaustive list of security features :
+
+- **HTTPS** support with transparent **Let's Encrypt** automation
+- **State-of-the-art web security** : HTTP security headers, prevent leaks, TLS hardening, ...
+- Integrated **ModSecurity WAF** with the **OWASP Core Rule Set**
+- **Automatic ban** of strange behaviors based on HTTP status code
+- Apply **connections and requests limit** for clients
+- **Block bots** by asking them to solve a **challenge** (e.g. : cookie, javascript, captcha, hCaptcha or reCAPTCHA)
+- **Block known bad IPs** with external blacklists and DNSBL
+- And much more ...
+
+Learn more about the core security features in the [security tuning](https://docs.bunkerweb.io/1.6.0-beta/security-tuning/?utm_campaign=self&utm_source=github) section of the documentation.
+
+## Demo
+
+<p align="center">
+	<a href="https://www.youtube.com/watch?v=ZhYV-QELzA4" target="_blank"><img alt="BunkerWeb demo" src="https://img.youtube.com/vi/ZhYV-QELzA4/0.jpg" /></a>
+</p>
+
+A demo website protected with BunkerWeb is available at [demo.bunkerweb.io](https://demo.bunkerweb.io/?utm_campaign=self&utm_source=github). Feel free to visit it and perform some security tests.
+
+## BunkerWeb Cloud
+
+Don't want to self-host and manage your own BunkerWeb instance(s) ? You might be interested into BunkerWeb Cloud, our fully managed SaaS offer for BunkerWeb.
+
+Try our [BunkerWeb Cloud beta offer for free](https://panel.bunkerweb.io/order/bunkerweb-cloud/14?utm_source=github&utm_campaign=self) and get access to :
+
+- Fully managed BunkerWeb instance hosted in our cloud
+- All BunkerWeb features including PRO ones
+- Monitoring platform including dashboards and alerts
+- Technical support to assist you in the configuration
+
+You will find more information about BunkerWeb Cloud in the [FAQ page](https://panel.bunkerweb.io/knowledgebase/55/BunkerWeb-Cloud?utm_source=github&utm_campaign=self) of the BunkerWeb panel.
+
+## PRO version
+
+When using BunkerWeb you have the choice of the version you want to use : open-source or PRO.
+
+Whether it's enhanced security, an enriched user experience, or technical supervision, the BunkerWeb PRO version will allow you to fully benefit from BunkerWeb and respond to your professional needs.
+
+Be it in the documentation or the user interface, the PRO features are annotated with a crown <img src="https://docs.bunkerweb.io/1.6.0-beta/assets/img/pro-icon.svg" alt="crow pro icon" height="24px" width="24px"> to distinguish them from those integrated into the open-source version.
+
+You can upgrade from the open-source version to the PRO one easily and at any time you want. The process is pretty straightforward :
+
+- Claim your [free trial on the BunkerWeb panel](https://panel.bunkerweb.io/?utm_campaign=self&utm_source=doc)
+- Once connected to the client area, copy your PRO license key
+- Paste your private key into BunkerWeb using the [web UI](https://docs.bunkerweb.io/1.6.0-beta/web-ui/#upgrade-to-pro) or [specific setting](https://docs.bunkerweb.io/1.6.0-beta/settings/#pro)
+
+Do not hesitate to visit the [BunkerWeb panel](https://panel.bunkerweb.io/knowledgebase?utm_campaign=self&utm_source=doc) or [contact us](https://panel.bunkerweb.io/contact.php?utm_campaign=self&utm_source=doc) if you have any question regarding the PRO version.
+
+## Professional services
+
+Get the most of BunkerWeb by getting professional services directly from the maintainers of the project. From technical support to tailored consulting and development, we are here to assist you in the security of your web services.
+
+You will find more information by visiting the [BunkerWeb Panel](https://panel.bunkerweb.io/?utm_campaign=self&utm_source=doc), our dedicated platform for professional services.
+
+Don't hesitate to [contact us](https://panel.bunkerweb.io/contact.php?utm_campaign=self&utm_source=doc) if you have any question, we will be more than happy to respond to your needs.
+
+## Ecosystem, community and resources
+
+Official websites, tools and resources about BunkerWeb :
+
+- [**Website**](https://www.bunkerweb.io/?utm_campaign=self&utm_source=github) : get more information, news and articles about BunkerWeb
+- [**Panel**](https://panel.bunkerweb.io/?utm_campaign=self&utm_source=github) : dedicated platform to order and manage professional services (e.g. technical support) around BunkerWeb
+- [**Documentation**](https://docs.bunkerweb.io/?utm_campaign=self&utm_source=github) : technical documentation of the BunkerWeb solution
+- [**Demo**](https://demo.bunkerweb.io/?utm_campaign=self&utm_source=github) : demonstration website of BunkerWeb, don't hesitate to attempt attacks to test the robustness of the solution
+- [**Configurator**](https://config.bunkerweb.io/?utm_campaign=self&utm_source=github) : user-friendly tool to help you configure BunkerWeb
+- [**Threatmap**](https://threatmap.bunkerweb.io/?utm_campaign=self&utm_source=github) : live cyber attack blocked by BunkerWeb instances all around the world
+
+Community and social networks :
+
+- [**Discord**](https://discord.com/invite/fTf46FmtyD)
+- [**LinkedIn**](https://www.linkedin.com/company/bunkerity/)
+- [**Twitter**](https://twitter.com/bunkerity)
+- [**Reddit**](https://www.reddit.com/r/BunkerWeb/)
+
+# Concepts
+
+<p align="center">
+	<img alt="Concepts banner" src="https://github.com/bunkerity/bunkerweb/raw/v1.6.0-beta/docs/assets/img/concepts.svg" />
+</p>
+
+You will find more information about the key concepts of BunkerWeb in the [documentation](https://docs.bunkerweb.io/1.6.0-beta/concepts/?utm_campaign=self&utm_source=github).
+
+## Integrations
+
+The first concept is the integration of BunkerWeb into the target environment. We prefer to use the word "integration" instead of "installation" because one of the goals of BunkerWeb is to integrate seamlessly into existing environments.
+
+The following integrations are officially supported :
+
+- [Docker](https://docs.bunkerweb.io/1.6.0-beta/integrations/?utm_campaign=self&utm_source=github#docker)
+- [Linux](https://docs.bunkerweb.io/1.6.0-beta/integrations/?utm_campaign=self&utm_source=github#linux)
+- [Docker autoconf](https://docs.bunkerweb.io/1.6.0-beta/integrations/?utm_campaign=self&utm_source=github#docker-autoconf)
+- [Kubernetes](https://docs.bunkerweb.io/1.6.0-beta/integrations/?utm_campaign=self&utm_source=github#kubernetes)
+- [Swarm](https://docs.bunkerweb.io/1.6.0-beta/integrations/?utm_campaign=self&utm_source=github#swarm)
+- [Microsoft Azure](https://docs.bunkerweb.io/1.6.0-beta/integrations/?utm_campaign=self&utm_source=github#microsoft-azure)
+
+## Settings
+
+Once BunkerWeb is integrated into your environment, you will need to configure it to serve and protect your web applications.
+
+The configuration of BunkerWeb is done by using what we call the "settings" or "variables". Each setting is identified by a name such as `AUTO_LETS_ENCRYPT` or `USE_ANTIBOT`. You can assign values to the settings to configure BunkerWeb.
+
+Here is a dummy example of a BunkerWeb configuration :
+
+```conf
+SERVER_NAME=www.example.com
+AUTO_LETS_ENCRYPT=yes
+USE_ANTIBOT=captcha
+REFERRER_POLICY=no-referrer
+USE_MODSECURITY=no
+USE_GZIP=yes
+USE_BROTLI=no
+```
+
+You will find an easy to use settings generator at [config.bunkerweb.io](https://config.bunkerweb.io/?utm_campaign=self&utm_source=github).
+
+## Multisite mode
+
+The multisite mode is a crucial concept to understand when using BunkerWeb. Because the goal is to protect web applications, we intrinsically inherit the concept of "virtual host" or "vhost" (more info [here](https://en.wikipedia.org/wiki/Virtual_hosting)) which makes it possible to serve multiple web applications from a single (or a cluster of) instance.
+
+By default, the multisite mode of BunkerWeb is disabled which means that only one web application will be served and all the settings will be applied to it. The typical use case is when you have a single application to protect : you don't have to worry about the multisite and the default behavior should be the right one for you.
+
+When multisite mode is enabled, BunkerWeb will serve and protect multiple web applications. Each web application is identified by a unique server name and have its own set of settings. The typical use case is when you have multiple applications to protect and you want to use a single (or a cluster depending of the integration) instance of BunkerWeb.
+
+## Custom configurations
+
+Because meeting all the use cases only using the settings is not an option (even with [external plugins](https://docs.bunkerweb.io/1.6.0-beta/plugins/?utm_campaign=self&utm_source=github)), you can use custom configurations to solve your specific challenges.
+
+Under the hood, BunkerWeb uses the notorious NGINX web server, that's why you can leverage its configuration system for your specific needs. Custom NGINX configurations can be included in different [contexts](https://docs.nginx.com/nginx/admin-guide/basic-functionality/managing-configuration-files/#contexts) like HTTP or server (all servers and/or specific server block).
+
+Another core component of BunkerWeb is the ModSecurity Web Application Firewall : you can also use custom configurations to fix some false positives or add custom rules for example.
+
+## Database
+
+<p align="center">
+	<img alt="Database model" src="https://github.com/bunkerity/bunkerweb/raw/v1.6.0-beta/docs/assets/img/bunkerweb_db.svg" />
+</p>
+
+State of the current configuration of BunkerWeb is stored in a backend database which contains the following data :
+
+- Settings defined for all the services
+- Custom configurations
+- BunkerWeb instances
+- Metadata about jobs execution
+- Cached files
+
+The following backend database are supported : SQLite, MariaDB, MySQL and PostgreSQL
+
+## Scheduler
+
+To make things automagically work together, a dedicated service called the scheduler is in charge of :
+
+- Storing the settings and custom configurations inside the database
+- Executing various tasks (called jobs)
+- Generating a configuration which is understood by BunkerWeb
+- Being the intermediary for other services (like web UI or autoconf)
+
+In other words, the scheduler is the brain of BunkerWeb.
+
+# Setup
+
+## BunkerWeb Cloud
+
+<p align="center">
+	<img alt="Docker banner" src="https://github.com/bunkerity/bunkerweb/raw/v1.6.0-beta/docs/assets/img/bunkerweb-cloud.webp" />
+</p>
+
+BunkerWeb Cloud is the easiest way to get started with BunkerWeb. It offers you a fully managed BunkerWeb service with no hassle. Think of a like a BunkerWeb-as-a-Service !
+
+You will find more information about BunkerWeb Cloud beta [here](https://www.bunkerweb.io/cloud?utm_campaign=self&utm_source=docs) and you can apply for free [in the BunkerWeb panel](https://panel.bunkerweb.io/order/bunkerweb-cloud/14?utm_campaign=self&utm_source=docs).
+
+## Docker
+
+<p align="center">
+	<img alt="Docker banner" src="https://github.com/bunkerity/bunkerweb/raw/v1.6.0-beta/docs/assets/img/integration-docker.svg" />
+</p>
+
+We provide ready to use prebuilt images for x64, x86, armv7 and arm64 platforms on [Docker Hub](https://hub.docker.com/u/bunkerity).
+
+Docker integration key concepts are :
+
+- **Environment variables** to configure BunkerWeb
+- **Scheduler** container to store configuration and execute jobs
+- **Networks** to expose ports for clients and connect to upstream web services
+
+You will find more information in the [Docker integration section](https://docs.bunkerweb.io/1.6.0-beta/integrations/?utm_campaign=self&utm_source=github#docker) of the documentation.
+
+## Docker autoconf
+
+<p align="center">
+	<img alt="Docker autoconf banner" src="https://github.com/bunkerity/bunkerweb/raw/v1.6.0-beta/docs/assets/img/integration-autoconf.svg" />
+</p>
+
+The downside of using environment variables is that the container needs to be recreated each time there is an update which is not very convenient. To counter that issue, you can use another image called **autoconf** which will listen for Docker events and automatically reconfigure BunkerWeb in real-time without recreating the container.
+
+Instead of defining environment variables for the BunkerWeb container, you simply add **labels** to your web applications containers and the **autoconf** will "automagically" take care of the rest.
+
+You will find more information in the [Docker autoconf section](https://docs.bunkerweb.io/1.6.0-beta/integrations/?utm_campaign=self&utm_source=github#docker-autoconf) of the documentation.
+
+## Swarm
+
+<p align="center">
+	<img alt="Swarm banner" src="https://github.com/bunkerity/bunkerweb/raw/v1.6.0-beta/docs/assets/img/integration-swarm.svg" />
+</p>
+
+To automatically configure BunkerWeb instances, a special service, called **autoconf** will listen for Docker Swarm events like service creation or deletion and automatically configure the **BunkerWeb instances** in real-time without downtime.
+
+Like the [Docker autoconf integration](https://docs.bunkerweb.io/1.6.0-beta/integrations/?utm_campaign=self&utm_source=github#docker-autoconf), configuration for web services is defined using labels starting with the special **bunkerweb.** prefix.
+
+You will find more information in the [Swarm section](https://docs.bunkerweb.io/1.6.0-beta/integrations/?utm_campaign=self&utm_source=github#swarm) of the documentation.
+
+## Kubernetes
+
+<p align="center">
+	<img alt="Kubernetes banner" src="https://github.com/bunkerity/bunkerweb/raw/v1.6.0-beta/docs/assets/img/integration-kubernetes.svg" />
+</p>
+
+The autoconf acts as an [Ingress controller](https://kubernetes.io/docs/concepts/services-networking/ingress-controllers/) and will configure the BunkerWeb instances according to the [Ingress resources](https://kubernetes.io/docs/concepts/services-networking/ingress/). It also monitors other Kubernetes objects like [ConfigMap](https://kubernetes.io/docs/concepts/configuration/configmap/) for custom configurations.
+
+You will find more information in the [Kubernetes section](https://docs.bunkerweb.io/1.6.0-beta/integrations/?utm_campaign=self&utm_source=github#kubernetes) of the documentation.
+
+## Linux
+
+<p align="center">
+	<img alt="Linux banner" src="https://github.com/bunkerity/bunkerweb/raw/v1.6.0-beta/docs/assets/img/integration-linux.svg" />
+</p>
+
+List of supported Linux distros :
+
+- Debian 12 "Bookworm"
+- Ubuntu 22.04 "Noble"
+- Ubuntu 24.04 "Jammy"
+- Fedora 40
+- RHEL 8.9
+- RHEL 9.4
+
+Repositories of Linux packages for BunkerWeb are available on [PackageCloud](https://packagecloud.io/bunkerity/bunkerweb), they provide a bash script to automatically add and trust the repository (but you can also follow the [manual installation](https://packagecloud.io/bunkerity/bunkerweb/install) instructions if you prefer).
+
+You will find more information in the [Linux section](https://docs.bunkerweb.io/1.6.0-beta/integrations/?utm_campaign=self&utm_source=github#linux) of the documentation.
+
+## Microsoft Azure
+
+<p align="center">
+	<img alt="Azure banner" src="https://github.com/bunkerity/bunkerweb/raw/v1.6.0-beta/docs/assets/img/integration-azure.webp" />
+</p>
+
+BunkerWeb is referenced in the [Azure Marketplace](https://azuremarketplace.microsoft.com/fr-fr/marketplace/apps/bunkerity.bunkerweb?tab=Overview) and a ARM template is available in the [misc folder](https://github.com/bunkerity/bunkerweb/raw/v1.6.0-beta/misc/integrations/azure-arm-template.json).
+
+You will find more information in the [Microsoft Azure section](https://docs.bunkerweb.io/1.6.0-beta/integrations/?utm_campaign=self&utm_source=github#microsoft-azure) of the documentation.
+
+# Quickstart guide
+
+Once you have setup BunkerWeb with the integration of your choice, you can follow the [quickstart guide](https://docs.bunkerweb.io/1.6.0-beta/quickstart-guide/?utm_campaign=self&utm_source=github) that will cover the following common use cases :
+
+- Protecting a single HTTP application
+- Protecting multiple HTTP application
+- Retrieving the real IP of clients when operating behind a load balancer
+- Adding custom configurations
+- Protecting generic TCP/UDP applications
+- In combination with PHP
+
+# Security tuning
+
+BunkerWeb offers many security features that you can configure with [settings](https://docs.bunkerweb.io/1.6.0-beta/settings/?utm_campaign=self&utm_source=github). Even if the default values of settings ensure a minimal "security by default", we strongly recommend you to tune them. By doing so you will be able to ensure a security level of your choice but also manage false positives.
+
+You will find more information in the [security tuning section](https://docs.bunkerweb.io/1.6.0-beta/security-tuning/?utm_campaign=self&utm_source=github) of the documentation.
+
+# Settings
+
+To help you tuning BunkerWeb we have made an easy to use settings generator tool available at [config.bunkerweb.io](https://config.bunkerweb.io/?utm_campaign=self&utm_source=github).
+
+As a general rule when multisite mode is enabled, if you want to apply settings with multisite context to a specific server you will need to add the primary (first) server name as a prefix like `www.example.com_USE_ANTIBOT=captcha` or `myapp.example.com_USE_GZIP=yes` for example.
+
+When settings are considered as "multiple", it means that you can have multiple groups of settings for the same feature by adding numbers as suffix like `REVERSE_PROXY_URL_1=/subdir`, `REVERSE_PROXY_HOST_1=http://myhost1`, `REVERSE_PROXY_URL_2=/anotherdir`, `REVERSE_PROXY_HOST_2=http://myhost2`, ... for example.
+
+Check the [settings section](https://docs.bunkerweb.io/1.6.0-beta/settings/?utm_campaign=self&utm_source=github) of the documentation to get the full list.
+
+# Web UI
+
+<p align="center">
+	<a href="https://www.youtube.com/watch?v=Ao20SfvQyr4">
+		<img src="https://github.com/bunkerity/bunkerweb/raw/v1.6.0-beta/docs/assets/img/user_interface_demo.webp" height="300" />
+	</a>
+</p>
+
+The "Web UI" is a web application that helps you manage your BunkerWeb instance using a user-friendly interface instead of the command-line one.
+
+- Start, stop, restart and reload your BunkerWeb instance
+- Add, edit and delete settings for your web applications
+- Add, edit and delete custom configurations for NGINX and ModSecurity
+- Install and uninstall external plugins
+- Explore the cached files
+- Monitor jobs execution
+- View the logs and search pattern
+
+You will find more information in the [Web UI section](https://docs.bunkerweb.io/1.6.0-beta/web-ui/?utm_campaign=self&utm_source=github) of the documentation.
+
+# Plugins
+
+BunkerWeb comes with a plugin system to make it possible to easily add new features. Once a plugin is installed, you can manage it using additional settings defined by the plugin.
+
+Here is the list of "official" plugins that we maintain (see the [bunkerweb-plugins](https://github.com/bunkerity/bunkerweb-plugins/?utm_campaign=self&utm_source=github) repository for more information) :
+
+|      Name      | Version | Description                                                                                                                      |                                                Link                                                 |
+| :------------: | :-----: | :------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------: |
+|   **ClamAV**   |   1.5   | Automatically scans uploaded files with the ClamAV antivirus engine and denies the request when a file is detected as malicious. |     [bunkerweb-plugins/clamav](https://github.com/bunkerity/bunkerweb-plugins/tree/main/clamav)     |
+|   **Coraza**   |   1.5   | Inspect requests using a the Coraza WAF (alternative of ModSecurity).                                                            |     [bunkerweb-plugins/coraza](https://github.com/bunkerity/bunkerweb-plugins/tree/main/coraza)     |
+|  **CrowdSec**  |   1.5   | CrowdSec bouncer for BunkerWeb.                                                                                                  |   [bunkerweb-plugins/crowdsec](https://github.com/bunkerity/bunkerweb-plugins/tree/main/crowdsec)   |
+|  **Discord**   |   1.5   | Send security notifications to a Discord channel using a Webhook.                                                                |    [bunkerweb-plugins/discord](https://github.com/bunkerity/bunkerweb-plugins/tree/main/discord)    |
+|   **Slack**    |   1.5   | Send security notifications to a Slack channel using a Webhook.                                                                  |      [bunkerweb-plugins/slack](https://github.com/bunkerity/bunkerweb-plugins/tree/main/slack)      |
+| **VirusTotal** |   1.5   | Automatically scans uploaded files with the VirusTotal API and denies the request when a file is detected as malicious.          | [bunkerweb-plugins/virustotal](https://github.com/bunkerity/bunkerweb-plugins/tree/main/virustotal) |
+|  **WebHook**   |   1.5   | Send security notifications to a custom HTTP endpoint using a Webhook.                                                           |     [bunkerweb-plugins/slack](https://github.com/bunkerity/bunkerweb-plugins/tree/main/webhook)     |
+
+You will find more information in the [plugins section](https://docs.bunkerweb.io/1.6.0-beta/plugins/?utm_campaign=self&utm_source=github) of the documentation.
+
+# Support
+
+## Professional
+
+Get technical support directly from the BunkerWeb maintainers. You will find more information by visiting the [BunkerWeb Panel](https://panel.bunkerweb.io/?utm_campaign=self&utm_source=github), our dedicated platform for professional services.
+
+Don't hesitate to [contact us](https://panel.bunkerweb.io/contact.php?utm_campaign=self&utm_source=github) if you have any question, we will be more than happy to respond to your needs.
+
+## Community
+
+To get free community support you can use the following media :
+
+- The #help channel of BunkerWeb in the [Discord server](https://discord.com/invite/fTf46FmtyD)
+- The help category of [GitHub discussions](https://github.com/bunkerity/bunkerweb/discussions)
+- The [/r/BunkerWeb](https://www.reddit.com/r/BunkerWeb) subreddit
+- The [Server Fault](https://serverfault.com/) and [Super User](https://superuser.com/) forums
+
+Please don't use [GitHub issues](https://github.com/bunkerity/bunkerweb/issues) to ask for help, use it only for bug reports and feature requests.
+
+# License
+
+This project is licensed under the terms of the [GNU Affero General Public License (AGPL) version 3](https://github.com/bunkerity/bunkerweb/raw/v1.6.0-beta/LICENSE.md).
+
+# Contribute
+
+If you would like to contribute to the plugins you can read the [contributing guidelines](https://github.com/bunkerity/bunkerweb/raw/v1.6.0-beta/CONTRIBUTING.md) to get started.
+
+# Security policy
+
+We take security bugs as serious issues and encourage responsible disclosure, see our [security policy](https://github.com/bunkerity/bunkerweb/raw/v1.6.0-beta/SECURITY.md) for more information.
+
+# Stargazers over time
+
+[![Stargazers over time](https://starchart.cc/bunkerity/bunkerweb.svg)](https://starchart.cc/bunkerity/bunkerweb)

SECURITY.md

@@ -0,0 +1,17 @@
+# Security policy
+
+Even though this project is focused on security, it is still prone to possible vulnerabilities. We consider every security bug as a serious issue and will try our best to address it.
+
+## Responsible disclosure
+
+If you have found a security bug, please send us an email at security \[@\] bunkerity.com (using a ProtonMail if possible) with technical details so we can resolve it as soon as possible.
+
+Here is a non-exhaustive list of issues we consider as high risk :
+- Vulnerability in the code
+- Bypass of a security feature
+- Vulnerability in a third-party dependency
+- Risk in the supply chain
+
+## Bounty
+
+To encourage responsible disclosure, we may reward you with a bounty at the sole discretion of the maintainers.

docs/Dockerfile

@@ -0,0 +1,4 @@
+FROM squidfunk/mkdocs-material@sha256:e5f28aa0c3ac8206f93e44a0c52ea85616b0d6c674319cd1d87a241594788355
+
+COPY mkdocs.yml /docs
+COPY docs /docs/docs

docs/about.md

@@ -0,0 +1,115 @@
+# About
+
+## Who maintains BunkerWeb ?
+
+BunkerWeb is maintained by [Bunkerity](https://www.bunkerity.com/?utm_campaign=self&utm_source=doc), a French 🇫🇷 company specialized in Cybersecurity 🛡️.
+
+## Do you have a professional version ?
+
+Yes, we do offer a professional version of BunkerWeb called "BunkerWeb PRO".
+
+Here are the main benefits of BunkerWeb PRO :
+
+- Unlock all features of BunkerWeb
+- Pay per protected services
+- Respond to professional needs
+- Free trial with no credit card
+- Best effort support included
+
+You can go the [BunkerWeb panel](https://panel.bunkerweb.io/?utm_campaign=self&utm_source=doc) to get more information and claim your free trial.
+
+## Do you offer professional services ?
+
+Yes, we offer professional services related to BunkerWeb.
+
+You can get in touch with us about any of the following :
+
+- Consulting
+- Support
+- Custom development
+- Partnership
+
+We have a [dedicated panel](https://panel.bunkerweb.io/?utm_campaign=self&utm_source=doc) to centralize all professional requests.
+
+You can also contact use at [contact@bunkerity.com](mailto:contact@bunkerity.com) if you are interested.
+
+## Where to get community support ?
+
+To get free community support, you can use the following media :
+
+- The #help channel of BunkerWeb in the [Discord server](https://discord.com/invite/fTf46FmtyD)
+- The help category of [GitHub discussions](https://github.com/bunkerity/bunkerweb/discussions)
+- The [/r/BunkerWeb](https://www.reddit.com/r/BunkerWeb) subreddit
+- The [Server Fault](https://serverfault.com/) and [Super User](https://superuser.com/) forums
+
+Please don't use [GitHub issues](https://github.com/bunkerity/bunkerweb/issues) to ask for help, use it only for bug reports and feature requests.
+
+## How can I contribute ?
+
+Here is a non-exhaustive list of what you can do :
+
+- Join the [Discord server](https://discord.com/invite/fTf46FmtyD), [/r/BunkerWeb](https://www.reddit.com/r/BunkerWeb) subreddit and [GitHub discussions](https://github.com/bunkerity/bunkerweb/discussions) to talk about the project and help others
+- Follow us on [LinkedIn](https://www.linkedin.com/company/bunkerity/), [Twitter](https://twitter.com/bunkerity) and [GitHub](https://github.com/bunkerity)
+- Report bugs and propose new features using [issues](https://github.com/bunkerity/bunkerweb/issues)
+- Contribute to the code using [pull requests](https://github.com/bunkerity/bunkerweb/pulls)
+- Write an awesome [plugin](plugins.md)
+- Talk about BunkerWeb to your friends/colleagues, on social media, on your blog, ...
+
+## How to report security issue ?
+
+Please contact us at [security@bunkerity.com](mailto:security@bunkerity.com) using the following PGP key :
+
+```conf
+-----BEGIN PGP PUBLIC KEY BLOCK-----
+
+mQINBGCEMiMBEACtXJBDbF86qjC/Q1cfmJfYcYrbk6eE5czknG294XObC97wAgDf
+/MbX6bnti4kDRpflGDqQtwOXudcEzledTD4bdDUKvZwqPoYQGa24uCuUxSINTLXr
+RuoMaKfpvs7trsFXp5iYUqf4Org2aaJE7Tk/9sOvxgdqsT22jEgCZXTRU1qG494U
+u6XRQN8hKlw6aa6njjX9vUk6Jpl46/kwwO9mpXBZX6iFKYnBlUWs2k8d6D6cO5aZ
+KLoYyz5v3Gw2hHSqj4qbVQPTIT7qrrcfd8nblYK7Dh3IM+vQq7a7lB0AudIyBNPd
+rsypi9ZYgwI3lv/rmQnDc32Ua5cLvTvgg/XoaNK9ogc3kei1+hXODEgRA/zvSKqq
+20i/1Y0OnIGv89LOI6urWpOgDAhQUV5xvANll2lm3Bkmy29UOzNadUc/yImxrM06
+HwX82ju6PFAqOaxMW6SEE71ylGOSlikAGNcmmc5Ihd1J/VRZA4PBiQ31gQxFRpUC
+3NTw2QNAD1kjni5PuQD10Q1Ognvb6uJh/MtqsoX6r1t+Oly9MblFSuyqFkqNO3F0
+QAJqprhJlQ3YOcJdJ1EZR7qs0xJm5h+lw0Z/UINqkwiZUW3PCO8BKxfq6sfdwM8L
+5hPhyUzy2gIJ0J/4NGYEBH1ojoYODGU8OCSmyjSTY9SoVMeWDfqYP4ZTvQARAQAB
+tCVidW5rZXJpdHktcGdwIDxjb250YWN0QGJ1bmtlcml0eS5jb20+iQJUBBMBCAA+
+FiEEw78SjkcVxXCq7hStPYCAbxJgKnwFAmCEMiMCGwMFCQPCIP0FCwkIBwIGFQoJ
+CAsCBBYCAwECHgECF4AACgkQPYCAbxJgKnzvYhAAnNqGB6ce2eZzwk1EiNlNaXaA
+hFWLq/s/J1IOAP+0V5jKJxA6zTX01HyIfIIHQy6nrxxEXzYsIUHdJ+HBPCNswCqn
+2d/aDkkfoEUc1bUD0c2bXfoSCsAeIoK+eOf6iSr4IENVoIUYFQTUKFNu+Y7eDL0I
+J8Xadg53G+fkK9LE6TeYpBs3hDT4w7vlDfIwWa1NC9HoLzSmZ2fqZ7SnihLGsLmp
+98VqDrDjhRPzrz5/tVYgvPCQQU5ED/TayCCYvrGpw9gP8qmEOabIUz0ppGwEfQVs
+Wycilm1/Js/qjdbxUFMipBIzDu7bI3kMLmENhI+16Xtub9dUrvkW2SdDngYhtWj8
+IzVOe6N/XDuiRGpaYFpEuXbrnDFexe1ygZwnVHt3fukPfa7W8mhMs2kY1ishIA0O
+WElKO1Q6N0ZWEad0PwM8NCDjaDUNWQC36ZF/MS+ipHWx9joPUjImY2AXDjN+L+Si
+ABQIe4Fo6Jx6S6Bi8YvPq8idYZvaWFJjBvmaPjxdUMPbIsMRiEjvlrhvqhLuVBpE
+lGA+M4UJGw5yBl+yiiLDuws/Fppv9HwNqw6Uq1m1XaW859Om1GGBKYfphyn+fHjR
+7ftOuT7Ss4zioXT4mscOZgkfzDAqgpZiHjYhe7tLUu7iD6UEsZmey/gRV0hCxng3
+N7yaRrBu0+3sIQV4jYC5Ag0EYIQyIwEQALSurJGOx7At5mRFjvhXd4/JHuBZZOSI
+M45LSJ+mKYnAGmwsL0AneZMIf6Yc0Vcn32oqlIXN5aB8jIt91pChLre8tl/lFZZP
+xY3WIEBJhZF0FIUqSQLjg4HD0S70REii7Om1kgtZueid8V6T5F1JDcO2mDoh8oc9
+h9nRQ1Ld6dblEuwBzbFkI1K6OUk1+ec7+mQc7orHdBVgelmqwG7fGZnPiN3XfklF
+dnwSkFIX/qkAsKQmmx1VSzaGFoPLajf4wrkzZdA3iEafsHyvdEFlezZCZ7TsoHBh
+tNg1Psg6MbBVgiMfHyRHSEBJZ7r5Awj2MpFUFMOd1IPcor1I254mx0VYfCvof4Km
+Ri1F/86kHc23A77pd4HFYZWiZjaWhh12L+wz5fDL5/sSFXVGSCtSWIKx6FjysZ+v
+szk3lItHoomZhA7M+FjU/cOjq9hae9uwZeU39DQk0/npln2RcHitoqgUIzII5woO
+S3SlMSc910tHf40D2cBr1iFKC0jQICjkDexB9CtNx/N25SJmLfiimYtk6/NHlPq4
+HXdq6ZfLZ7xQmuGcyWv4f0pwA2CK3twISpsIxIKe456WYTDtQu9d1s987dvmw6F/
+qURC6m2WPGroHb8COQTKzbshjpGUmLpyR3FXki4wNXeI1KaQLL7NpZmK6yJlWviO
+1sCjh4m7VS+zABEBAAGJAjwEGAEIACYWIQTDvxKORxXFcKruFK09gIBvEmAqfAUC
+YIQyIwIbDAUJA8Ig/QAKCRA9gIBvEmAqfP2WEACqmXEhu4ARl2yT9bay0+W3F1q1
+MrLQkcVOau2ihXx3PhYsXRUoEFj72VDAar41WIlHsPJfB14WtSlYcX2XdjHLHMpC
+dL2eGhqIcHzFChR0vGjtvm2wae/rJTChWf8WXiHrRnRcfFFfhpCvkNi43fQeH4yp
+cel2a35WV+IRbnkCkaly2NG3XO0t83Siok8Ku+OJGPatUMxJmaEVQeeXVPDzVRva
+rtvyd9Sclkd9QDPBLZyWHC1vsPKGRJpi5uDZjGxhaFRkimw/SYtFHj7AUrMKAIHB
+GfEcwC3Eq4rF0FeCOPfBd2vwGGrRflx76jK9rj288ta9Oq6u6ev8PCVzt0E7jrSf
+AX88vfVRcxihNfj/9i5xmY596jpgbvNA2aJX2hAO3Q8pD6AunVXPUyc3RlFHt7jC
+tL+9Xv7Qwjz7OToWqj+9cM6T+6oZLxYNVPT72Z/KOFW+mzGb87qjcsDMb/hu2fNq
+tSWyZk2AAgHQyG1y8vCQQzsDnUDM6NIPwYG5XMP+11WAsPk5fP1ksixpUqIWgjhY
+M22YUsjLeaRtgSmhAGIkbBgecs1EHSZZ6sf2lB8gSom1wW0UCBPSifP0DwYFizS5
+SOk62kZ0lqEctwgKDe3MNQnPxt9+tU9L1pIkyXgXihcOLiCMl434K0djJXxIbiX0
+JvbFAfI3qteepvnjBQ==
+=g1tf
+-----END PGP PUBLIC KEY BLOCK-----
+```

docs/assets/extra.css

@@ -0,0 +1,55 @@
+/* avoid font to pop on family change */
+* {
+  font-display: swap;
+}
+
+:root {
+  --md-primary-fg-color: #125678;
+  --md-text-font: "Roboto";
+}
+
+.md-footer {
+  background-color: #125678;
+}
+
+/* better link contrast */
+article a {
+  color: #2388bb;
+}
+
+/* highlight content links */
+article a,
+article p > a {
+  text-decoration: underline;
+}
+
+/* header list links and config tabs stay default  */
+article li > a,
+article label > a {
+  text-decoration: none;
+}
+
+/* lighter base tab color */
+nav.md-tabs ul li a {
+  opacity: 0.9;
+}
+
+/* active desktop tabs nav */
+nav.md-tabs ul li.md-tabs__item--active a {
+  color: #36ce7a;
+  font-weight: bold;
+}
+
+nav.md-tabs ul li.md-tabs__item--active a:hover {
+  filter: brightness(0.9);
+}
+/*
+@font-face {
+	font-family: Consolas, monaco, monospace;
+}
+
+@font-face {
+	font-family: "TitleFont";
+	src: "assets/font-title.woff";
+}
+*/

docs/assets/img/pro-icon.svg

@@ -0,0 +1,7 @@
+<svg style="height:1.5rem; width:1.5rem;" 
+      viewBox="0 0 48 46"
+        fill="none"
+        xmlns="http://www.w3.org/2000/svg">
+    <path style="fill:#eab308"  d="M43.218 28.2327L43.6765 23.971C43.921 21.6973 44.0825 20.1957 43.9557 19.2497L44 19.25C46.071 19.25 47.75 17.5711 47.75 15.5C47.75 13.4289 46.071 11.75 44 11.75C41.929 11.75 40.25 13.4289 40.25 15.5C40.25 16.4366 40.5935 17.2931 41.1613 17.9503C40.346 18.4535 39.2805 19.515 37.6763 21.1128C36.4405 22.3438 35.8225 22.9593 35.1333 23.0548C34.7513 23.1075 34.3622 23.0532 34.0095 22.898C33.373 22.6175 32.9485 21.8567 32.0997 20.335L27.6262 12.3135C27.1025 11.3747 26.6642 10.5889 26.2692 9.95662C27.89 9.12967 29 7.44445 29 5.5C29 2.73857 26.7615 0.5 24 0.5C21.2385 0.5 19 2.73857 19 5.5C19 7.44445 20.11 9.12967 21.7308 9.95662C21.3358 10.589 20.8975 11.3746 20.3738 12.3135L15.9002 20.335C15.0514 21.8567 14.627 22.6175 13.9905 22.898C13.6379 23.0532 13.2487 23.1075 12.8668 23.0548C12.1774 22.9593 11.5595 22.3438 10.3238 21.1128C8.71968 19.515 7.6539 18.4535 6.83882 17.9503C7.4066 17.2931 7.75 16.4366 7.75 15.5C7.75 13.4289 6.07107 11.75 4 11.75C1.92893 11.75 0.25 13.4289 0.25 15.5C0.25 17.5711 1.92893 19.25 4 19.25L4.04428 19.2497C3.91755 20.1957 4.07905 21.6973 4.32362 23.971L4.782 28.2327C5.03645 30.5982 5.24802 32.849 5.50717 34.875H42.4928C42.752 32.849 42.9635 30.5982 43.218 28.2327Z" fill="#1C274C" />
+    <path style="fill:#eab308"  d="M21.2803 45.5H26.7198C33.8098 45.5 37.3545 45.5 39.7198 43.383C40.7523 42.4588 41.4057 40.793 41.8775 38.625H6.1224C6.59413 40.793 7.24783 42.4588 8.2802 43.383C10.6454 45.5 14.1903 45.5 21.2803 45.5Z" fill="#1C274C" />
+</svg>

docs/concepts.md

@@ -0,0 +1,148 @@
+# Concepts
+
+<figure markdown>
+  ![Overview](assets/img/concepts.svg){ align=center, width="600" }
+</figure>
+
+## Integrations
+
+The first concept is the integration of BunkerWeb into the target environment. We prefer to use the word "integration" instead of "installation" because one of the goals of BunkerWeb is to integrate seamlessly into existing environments.
+
+The following integrations are officially supported :
+
+- [Docker](integrations.md#docker)
+- [Linux](integrations.md#linux)
+- [Docker autoconf](integrations.md#docker-autoconf)
+- [Kubernetes](integrations.md#kubernetes)
+- [Swarm](integrations.md#swarm)
+
+If you think that a new integration should be supported, do not hesitate to open a [new issue](https://github.com/bunkerity/bunkerweb/issues) on the GitHub repository.
+
+!!! info "Going further"
+
+    The technical details of all BunkerWeb integrations are available in the [integrations section](integrations.md) of the documentation.
+
+## Settings
+
+!!! tip "Pro settings"
+
+    Some plugins are reserved for the **pro version**. [Find out more about the pro version here.](https://panel.bunkerweb.io/?utm_campaign=self&utm_source=doc#pro)
+
+Once BunkerWeb is integrated into your environment, you will need to configure it to serve and protect your web applications.
+
+The configuration of BunkerWeb is done by using what we call the "settings" or "variables". Each setting is identified by a name such as `AUTO_LETS_ENCRYPT` or `USE_ANTIBOT`. You can assign values to the settings to configure BunkerWeb.
+
+Here is a dummy example of a BunkerWeb configuration :
+
+```conf
+SERVER_NAME=www.example.com
+AUTO_LETS_ENCRYPT=yes
+USE_ANTIBOT=captcha
+REFERRER_POLICY=no-referrer
+USE_MODSECURITY=no
+USE_GZIP=yes
+USE_BROTLI=no
+```
+
+!!! info "Going further"
+
+    The complete list of available settings with descriptions and possible values is available in the [settings section](settings.md) of the documentation.
+
+!!! info "Settings generator tool"
+
+    To help you tune BunkerWeb, we offer an easy-to-use settings generator tool available at [config.bunkerweb.io](https://config.bunkerweb.io/?utm_campaign=self&utm_source=doc).
+
+## Multisite mode
+
+Understanding the multisite mode is essential when utilizing BunkerWeb. As our primary focus is safeguarding web applications, our solution is intricately linked to the concept of "virtual hosts" or "vhosts" (more info [here](https://en.wikipedia.org/wiki/Virtual_hosting)). These virtual hosts enable the serving of multiple web applications from a single instance or cluster.
+
+By default, BunkerWeb has the multisite mode disabled. This means that only one web application will be served, and all settings will be applied to it. This setup is ideal when you have a single application to protect, as you don't need to concern yourself with multisite configurations.
+
+However, when the multisite mode is enabled, BunkerWeb becomes capable of serving and protecting multiple web applications. Each web application is identified by a unique server name and has its own set of settings. This mode proves beneficial when you have multiple applications to secure, and you prefer to utilize a single instance (or a cluster) of BunkerWeb.
+
+The activation of the multisite mode is controlled by the `MULTISITE` setting, which can be set to `yes` to enable it or `no` to keep it disabled (which is the default value).
+
+Each setting within BunkerWeb has a specific context that determines where it can be applied. If the context is set to "global," the setting can't be applied per server or site but is instead applied to the entire configuration as a whole. On the other hand, if the context is "multisite," the setting can be applied globally and per server. To define a multisite setting for a specific server, simply add the server name as a prefix to the setting name. For example, `app1.example.com_AUTO_LETS_ENCRYPT` or `app2.example.com_USE_ANTIBOT` are examples of setting names with server name prefixes. When a multisite setting is defined globally without a server prefix, all servers inherit that setting. However, individual servers can still override the setting if the same setting is defined with a server name prefix.
+
+Understanding the intricacies of multisite mode and its associated settings allows you to tailor BunkerWeb's behavior to suit your specific requirements, ensuring optimal protection for your web applications.
+
+Here's a dummy example of a multisite BunkerWeb configuration :
+
+```conf
+MULTISITE=yes
+SERVER_NAME=app1.example.com app2.example.com app3.example.com
+AUTO_LETS_ENCRYPT=yes
+USE_GZIP=yes
+USE_BROTLI=yes
+app1.example.com_USE_ANTIBOT=javascript
+app1.example.com_USE_MODSECURITY=no
+app2.example.com_USE_ANTIBOT=cookie
+app2.example.com_WHITELIST_COUNTRY=FR
+app3.example.com_USE_BAD_BEHAVIOR=no
+```
+
+!!! info "Going further"
+
+    You will find concrete examples of multisite mode in the [quickstart guide](quickstart-guide.md) of the documentation and the [examples](https://github.com/bunkerity/bunkerweb/tree/v1.6.0-beta/examples) directory of the repository.
+
+## Custom configurations
+
+To address unique challenges and cater to specific use cases, BunkerWeb offers the flexibility of custom configurations. While the provided settings and [external plugins](plugins.md) cover a wide range of scenarios, there may be situations that require additional customization.
+
+BunkerWeb is built on the renowned NGINX web server, which provides a powerful configuration system. This means you can leverage NGINX's configuration capabilities to meet your specific needs. Custom NGINX configurations can be included in various [contexts](https://docs.nginx.com/nginx/admin-guide/basic-functionality/managing-configuration-files/#contexts) such as HTTP or server, allowing you to fine-tune the behavior of BunkerWeb according to your requirements. Whether you need to customize global settings or apply configurations to specific server blocks, BunkerWeb empowers you to optimize its behavior to align perfectly with your use case.
+
+Another integral component of BunkerWeb is the ModSecurity Web Application Firewall. With custom configurations, you have the flexibility to address false positives or add custom rules to further enhance the protection provided by ModSecurity. These custom configurations allow you to fine-tune the behavior of the firewall and ensure that it aligns with the specific requirements of your web applications.
+
+By leveraging custom configurations, you unlock a world of possibilities to tailor BunkerWeb's behavior and security measures precisely to your needs. Whether it's adjusting NGINX configurations or fine-tuning ModSecurity, BunkerWeb provides the flexibility to meet your unique challenges effectively.
+
+!!! info "Going further"
+
+    You will find concrete examples of custom configurations in the [quickstart guide](quickstart-guide.md) of the documentation and the [examples](https://github.com/bunkerity/bunkerweb/tree/v1.6.0-beta/examples) directory of the repository.
+
+## Database
+
+BunkerWeb securely stores its current configuration in a backend database, which contains essential data for smooth operation. The following information is stored in the database:
+
+- **Settings for all services**: The database holds the defined settings for all the services provided by BunkerWeb. This ensures that your configurations and preferences are preserved and readily accessible.
+
+- **Custom configurations**: Any custom configurations you create are also stored in the backend database. This includes personalized settings and modifications tailored to your specific requirements.
+
+- **BunkerWeb instances**: Information about BunkerWeb instances, including their setup and relevant details, is stored in the database. This allows for easy management and monitoring of multiple instances if applicable.
+
+- **Metadata about job execution**: The database stores metadata related to the execution of various jobs within BunkerWeb. This includes information about scheduled tasks, maintenance processes, and other automated activities.
+
+- **Cached files**: BunkerWeb utilizes caching mechanisms for improved performance. The database holds cached files, ensuring efficient retrieval and delivery of frequently accessed resources.
+
+Under the hood, whenever you edit a setting or add a new configuration, BunkerWeb automatically stores the changes in the database, ensuring data persistence and consistency. BunkerWeb supports multiple backend database options, including SQLite, MariaDB, MySQL, and PostgreSQL.
+
+Configuring the database is straightforward using the `DATABASE_URI` setting, which follows the specified formats for each supported database:
+
+- **SQLite**: `sqlite:///var/lib/bunkerweb/db.sqlite3`
+- **MariaDB**: `mariadb+pymysql://bunkerweb:changeme@bw-db:3306/db`
+- **MySQL**: `mysql+pymysql://bunkerweb:changeme@bw-db:3306/db`
+- **PostgreSQL**: `postgresql://bunkerweb:changeme@bw-db:5432/db`
+
+By specifying the appropriate database URI in the configuration, you can seamlessly integrate BunkerWeb with your preferred database backend, ensuring efficient and reliable storage of your configuration data.
+
+<figure markdown>
+  ![Overview](assets/img/bunkerweb_db.svg){ align=center, width="800" }
+  <figcaption>Database Schema</figcaption>
+</figure>
+
+## Scheduler
+
+For seamless coordination and automation, BunkerWeb employs a specialized service known as the scheduler. The scheduler plays a vital role in ensuring smooth operation by performing the following tasks:
+
+- **Storing settings and custom configurations**: The scheduler is responsible for storing all the settings and custom configurations within the backend database. This centralizes the configuration data, making it easily accessible and manageable.
+
+- **Executing various tasks (jobs)**: The scheduler handles the execution of various tasks, referred to as jobs. These jobs encompass a range of activities, such as periodic maintenance, scheduled updates, or any other automated tasks required by BunkerWeb.
+
+- **Generating BunkerWeb configuration**: The scheduler generates a configuration that is readily understood by BunkerWeb. This configuration is derived from the stored settings and custom configurations, ensuring that the entire system operates cohesively.
+
+- **Acting as an intermediary for other services**: The scheduler acts as an intermediary, facilitating communication and coordination between different components of BunkerWeb. It interfaces with services such as the web UI or autoconf, ensuring a seamless flow of information and data exchange.
+
+In essence, the scheduler serves as the brain of BunkerWeb, orchestrating various operations and ensuring the smooth functioning of the system.
+
+Depending on the integration approach, the execution environment of the scheduler may differ. In container-based integrations, the scheduler is executed within its dedicated container, providing isolation and flexibility. On the other hand, for Linux-based integrations, the scheduler is self-contained within the bunkerweb service, simplifying the deployment and management process.
+
+By employing the scheduler, BunkerWeb streamlines the automation and coordination of essential tasks, enabling efficient and reliable operation of the entire system.

docs/diagrams/core-order.drawio

@@ -0,0 +1 @@
+<mxfile host="app.diagrams.net" modified="2022-10-13T12:11:36.746Z" agent="5.0 (Windows)" etag="qIM9S_K3KBWfpHSqmD4a" version="20.4.0"><diagram id="C5RBs43oDa-KdzZeNtuy" name="Page-1">7Z1df6I4FIc/jZfdHxDevFSkrVuHzqjdrntHlVF20HQR2zqffkMhAglqtEJoYW4Gjrz/z3OScxJoCxjLtxvffl58gzPHa0nC7K0Fei1JkkRdR/+Flm1sAWo7ssx9dxbZxMQwcn87sVGIrRt35qwzGwYQeoH7nDVO4WrlTIOMzfZ9+Jrd7Cf0smd9tucOZRhNbY+2PrqzYBFZdUlL7LeOO1/gM4v4/pY23ji+k/XCnsHXlAmYLWD4EAbR0vLNcLzw6eHn8tjfPnqDX+rNnz/W/9kP3bux9ddVdLDrU3bZ3YLvrIKzD73a2Lf9lfFyfbUdXc2DjvjPuH8lg+jYL7a3iR9YfLPBFj9BZ4YeaLwK/WAB53Ble2Zi7fpws5o54XkEtJZsM4DwGRlFZPzXCYJt7B32JoDItAiWXvxrdM7wRIRoR+443m4NN/7UOXCbsYKB7c+d4NDjkHa6IiIcuHQCf4t29B3PDtyX7NXZsWfOd9slTx8txAKcIIaQo4XqoevtztwXtDgPFzuGYY5G+Ad0ntRvOZt3zZu+he1PPrkluT8pvechTkOJXxdu4Iye7ffH/IpiRZ6AL44fOG9nSEg/cRyA2nJ0nDj8KNHaa0KyiPFcpCjWhYIkwnh8cV5kRl6kPeqVw4tMafF42x+bg/5obKI19GyvKXH8BVw+bdbHPfqn63kG9KD/vh8QRUXVtNAOV0HKfv3+r0ACVFXIEHCF/T3NgJLDgAgKg4B+8F8Rgl135SgFgCcF+MBHmo3B0Oz0JiEVzI0B3Zh0LCsh68w2hZ3APaTtI7MoAvV29QhU60EgYCVQ4Uog3YnuDjrG3YUaoopgIO56WhXiQK8HBworBxpXDhRKjZuhOfliGAClehhoLF0A4/7BGg8nTWt/WF9Fr5y+oB5Zp9RmDHOAa9qJL/Mwbbuol5RfjhLXs0bdQe2BE9v8gatHhgtYM1zANcMFTBnuOcB1H6w7c2iZ49pBR/ZiqgBdXi+mfOjQY/W3f6dXJuHB/lDwau8tPni0to3XCoeVNRkG+gdhjXf9Dl104YnLCHLWZSRFyR4jurJ4N8IZdtfxAf/IG6uikB52xiYz/4P+t/64hn1cMpWvAv108niQfsd7gq9p8N8N6IfwcblT23sHdNYJh5CRderZ67U7zeqRjRXngu+8ucFuN7Sc2gutJTuFK2UFC5wRHq8YtPM9JeUIeX6AbR+NKaqWdUSF9K/oTqmYQh9JI1xaJscA90Qn5CD2NrXZc7jB+sAla8SAjKhmxt3RQnTIi8Y+WWmaQrKFYxnP55oogrzqJD0yY4373fuwB2rcmsYdc9tlmWavfk2X1q5cy4W7RRedt2Fava8zawMpQotU6rwNWW3iJxkWWeKnkK9zSfM7mPL+UQqVo1gZt53BwLRu9qYIZHzcuYDIECOzsRB1BAxVPxA7i8JPJgpqzNOm1MLwk7niJ1QMP4kVP670SSz0fR/en9SuDc0fD+ZofH6H5SsAydocFscj04Bhz7TYRwsbYdMq8lP2xBkRBZZRUoF2komzh8soeLkKZRSZtYyyr6NUThll97JF7IaA7EezVlEkorYByKTpQkUUmaw/KmXUUPLGbT9VhTHBYdJK6o2cKozMOcSeOUnloLErKOKyIBl5WdEgR6llsRg0qAJHGWgoeSWMBo2ip63yRUMjau9y+0w0dLL0LheDRlvggUZeEaJBo+iZrJxbDeFSrYZSTqshCjx6VEpeiaBho+gxW85skEO2pEuzsqGSzQYJ2aXYEAEPNk58s7rqbAh82WCdGsyZDfVIT4iZDTKjJ/tmn5uNE6fXNmwcYoN5Fi/ndIPwtLOn+mhkJl7UTB8+fapPPw+uUmx8jlScDPfntxtkAbegdqMt8kCDbT7VYHD/2Axb5XrznmErgN2N27CV0tTmecyPVPa8KlBSb5kojijnDlupwpGuxYWiHjlbGWglRD3MXAXQIEZ0RVY00t0BziO6CvPUYa4juoB412ZXkDwVDUAMJ8lKMWjIZMJaBhpasXnkCq6cg1yc0eFFh792w7ssZ/4CTx/WyfB+bqFQJI+EneviGR8gP7ZVxrsdGkvGV0pf5oPuWPHuxnE3Yq5AENGZtXJ9MY+hEyHrnvIZlDQEWS9ZBz785eBMIw5v6aQkNtmeO1+FroZkd5C9i+NjJ/5h6c5m7wE0L+HJ+mKroByGHHSmp1SqOa5U2EsgGp3A1E4SUSAjPl9NdLrnXD9NJL1amtDTKSbmqG6iKGK1RJEaUChN8mbpl6sKPYJcP1U08jslgLcqdM5ZP1XIRoU/K3QOVT9VBKFqqtCfqa1fY08WjfmrQr/8VTtWdLJcib+ozE0UOqWvISrkpzfxRCFeqrTpDLJ+qlBj/XidmypNDhmqIFdNliaLROmJVjVV6CyyhrAoxBdp+MtCp5GNLLtvqfGThc4jaygLFcS4y9IkknktfnGyoNXkDxtGw5bJ34cE5v8=</diagram></mxfile>

docs/diagrams/integration-kubernetes.drawio

@@ -0,0 +1 @@
+<mxfile host="app.diagrams.net" modified="2022-04-18T18:09:08.815Z" agent="5.0 (Windows)" etag="uCmxwbMvDXNNCQliGYIF" version="17.4.5"><diagram id="To2Da4PRRWEcok_Ws3eM" name="Page-1">7Vxtd6I4FP41fqyHFwP40aLOetrRbtvZmf2IEJEtEhdia/fXb4IBIYnjS8XiDJ6eCjchyM3zPCT3Blq6vVh/iZ3l/CvyYNjSFG/d0vstTVMV3SJf1PK+sQDT2Bj8OPBYpa3hKfgPZkcy6yrwYFKqiBEKcbAsG10URdDFJZsTx+itXG2GwvJZl44PBcOT64Si9Xvg4TmzqoqyLfgDBv6cndoCrGDhZJWZIZk7HnormPRBS7djhPBma7G2YUidl/llc9xwR2n+w2IY4UMOGGkTy5v/dzddjpcunPQj95+7G9YZr064Yhfc0oyQtHc7JRs+3bAn4+fHyT2p9XDfGw+ycnKivAq7QPyeeS1Gq8iD9MQqKX6bBxg+LR2Xlr4RnBDbHC9CVjwLwtBGIYrJfoQiUuk2wTF6gZmxpemqBgzTopVRhIfOIggpnmwUJSh0EmZ/Qqs4PcccYwIPDeg98o84hP6jFZK2j5AfQmcZJG0XLdICN0mrDmebVskm367sd7zCGAcEJr0w8CNShtEyd0SxT1g30epwXTCxPvoC0QLimJxWYaUdk+Hlndt/28IvZ8e8gDzVYEaHQd7P296igmwwYBwBEnU/SMaTPkGGQj3UAKRagKigDJBcYPYCpFMVQDrHAERrAHJZBakBQMAxABk3AKkWIGa3dgAxJQDhOpyMn5Z0cxbCdY+O7IgzYOSxzb5LnJkEbrnftyBROBQQRw+HBvkIUGD4uDQK5L0dOlMYPqAkwAGiVpf0OowL1e+5ClOEMTmffuuwdvIjyHf8/oO6og2y3b+ZZ9Kd/rq09872dgIOO7EP8f5xA/RKQ2wRlgXYAQnqMlsMQwcHr+WBuQyJ7AwPKCC/OEe9BkAJ9cJ4KUl7lR1VHEjzDell+phcOxu/CO2kvMiv+nSqWAJVRmN78nU0/kKsz4+94XBkC+QhyoDL1JCDXtRJAUc8UBeB59HTSDWYI+AOpbs0186goUAFbbVbwkFXVFFV7bYNTYS0DirS0e6HdZR1eyOiO0TUGwa0S34ujbWRvLJSqcA4TfK6yp6GKta8bDDSjA9+pfFBp1ZkASY3PtBPHB8A0GmrWrmtC48RVFnIpuHLlfMF1IovVvdM42lL3zEdvRRZtE8giweg5XV+G7IkpA9x5q1piNwX6sB1gH8wZ9HtlD1tDbDdLX/oTkafLe1KpGOHncK7JHPoToBc5f1MN8r81Exu0nEoPzvmnoaq5qcu8HM0fh48jnv3zYz3cjNe3VDaSvFjlFGR7X/m9FeVZSIaKW+knJPoKxtqGRY3QrK67RPFXIj9i01VLediMqiR88vLOcFUSc7VGqq5LCu0SQ1Sv21Tg0Wb4jnYuaHbN0nspkcZ/67QBjy0A6j7ifN3uD51fO72gtPzVrLT3n4b3w0evw9uC+lK2c8SzByyT05kFgH482xmaZJOP9cJWY2LQubyWgKpRIYrS1uqYjLm4mhUZg675WW23ZhN0ao8DR7/GtmDmgO0AsDo6qcDRpagqYGkHQOiKxe+M+AKaHUTIk1MkOTddNP79jyxJ+NhXXrgCm89fI9/vpJoshB/oyRXpiRWp3ZKIouG1xhDv9mQhgdMDYRIDM8K/t4Tc8uiSIdG3HZ0wa8acTs107grWlGK4DGnlRe2pDUOWeiyN5DGwgg1CaQBs9PmlgHqp6YtJW11ANdWxaE0bfdswgteM/W7W01hHEEMCYiV3sMoX3odS+6zheMEFjcxuOoXEQLTkuj5hQNvujibeISOR3n8Sq6WeMWmTUR+DKmLFCeiZS6KZoG/IF12fuCEcIYb2GSw4WL4epaQLWJGpqLneEJsqdg3nRvjTw9ptjdA7y8+nEufEDtuCHDkstPfbARwRM7NPC3nZu7LuclWvnJ39Qusrvi8xRQc5bSTM3D841mSps43bJCyVZzh9d8jAmwCSYptxYcRjB0Mc01fkT0K0WZAsF/ZBRmXsOLUNRZ6RzbZq25wIEXPx6d7jdafrPWZnh+n9WpdtB5chdbzAs1T6WClt/Y0VLHOi4uhGp2vh84bplY/YZc9pM0L+wvE7pz1RwEOnpPM835KezIp9yQn6ZplgoEmi6HO0g8pWVJWpJcIbskfvS+SH2grbUOnXy3Qp7NQWqCmZo2zdqXWtAm+ZndHw2Z6NCmXNKJyNs3i6pI/cnnsRrhY+/T1OO2XPBTTDlx6H7hdxqN0o08AeJ1YBlxEGkgi0qZsMmpVhOPd77RhCQw3h9s2mZDJiZBfGGVRjsMyCw1DKmNIEPm/4njvDBS0uOc8gXIYBa2q4kHisig7HWB8lQQHG8ZUxhh38QmEOe51JvUikqYCjkhiZNWSEIl/vPNsRPr48/xNbvWnoNkVD903RT53bvWQ6fVhydZPmzZziy0Bnww9OLFqcVlV/jZV8bT5DC8baEh3GOnUhnQffAibn3ydSjo+VgX4XGHVpBNTiH04CyIanIpXYbp2YUY6njgWTikXYfwauNTcxKqqnd+bahkZnQu/50gOF0kOK4OLu0qo7jRBzUsnrzSlnb3u+TJYIbvb9ydvlGj7Fmp98D8=</diagram></mxfile>

docs/index.md

@@ -0,0 +1,115 @@
+# Introduction
+
+## Overview
+
+<figure markdown>
+  ![Overview](assets/img/intro-overview.svg){ align=center, width="800" }
+  <figcaption>Make your web services secure by default !</figcaption>
+</figure>
+
+BunkerWeb is a next-generation and open-source Web Application Firewall (WAF).
+
+Being a full-featured web server (based on [NGINX](https://nginx.org/) under the hood), it will protect your web services to make them "secure by default". BunkerWeb integrates seamlessly into your existing environments ([Linux](integrations.md#linux), [Docker](integrations.md#docker), [Swarm](integrations.md#swarm), [Kubernetes](integrations.md#kubernetes), …) and is fully configurable (don't panic, there is an [awesome web UI](web-ui.md) if you don't like the CLI) to meet your own use-cases . In other words, cybersecurity is no more a hassle.
+
+BunkerWeb contains primary [security features](security-tuning.md) as part of the core but can be easily extended with additional ones thanks to a [plugin system](plugins.md).
+
+## Why BunkerWeb ?
+
+- **Easy integration into existing environments** : Seamlessly integrate BunkerWeb into various environments such as Linux, Docker, Swarm, Kubernetes and more. Enjoy a smooth transition and hassle-free implementation.
+
+- **Highly customizable** : Tailor BunkerWeb to your specific requirements with ease. Enable, disable, and configure features effortlessly, allowing you to customize the security settings according to your unique use case.
+
+- **Secure by default** : BunkerWeb provides out-of-the-box, hassle-free minimal security for your web services. Experience peace of mind and enhanced protection right from the start.
+
+- **Awesome web UI** : Take control of BunkerWeb more efficiently with the exceptional web user interface (UI). Navigate settings and configurations effortlessly through a user-friendly graphical interface, eliminating the need for the command-line interface (CLI).
+
+- **Plugin system** : Extend the capabilities of BunkerWeb to meet your own use cases. Seamlessly integrate additional security measures and customize the functionality of BunkerWeb according to your specific requirements.
+
+- **Free as in "freedom"** : BunkerWeb is licensed under the free [AGPLv3 license](https://www.gnu.org/licenses/agpl-3.0.en.html), embracing the principles of freedom and openness. Enjoy the freedom to use, modify, and distribute the software, backed by a supportive community.
+
+- **Professional services** : Get technical support, tailored consulting and custom development directly from the maintainers of BunkerWeb. Visit the [BunkerWeb Panel](https://panel.bunkerweb.io/?utm_campaign=self&utm_source=doc#pro) for more information.
+
+## Security features
+
+Explore the impressive array of security features offered by BunkerWeb. While not exhaustive, here are some notable highlights:
+
+- **HTTPS** support with transparent **Let's Encrypt** automation : Easily secure your web services with automated Let's Encrypt integration, ensuring encrypted communication between clients and your server.
+
+- **State-of-the-art web security** : Benefit from cutting-edge web security measures, including comprehensive HTTP security headers, prevention of data leaks, and TLS hardening techniques.
+
+- Integrated **ModSecurity WAF** with the **OWASP Core Rule Set** : Enjoy enhanced protection against web application attacks with the integration of ModSecurity, fortified by the renowned OWASP Core Rule Set.
+
+- **Automatic ban** of strange behaviors based on HTTP status code : BunkerWeb intelligently identifies and blocks suspicious activities by automatically banning behaviors that trigger abnormal HTTP status codes.
+
+- Apply **connections and requests limit** for clients : Set limits on the number of connections and requests from clients, preventing resource exhaustion and ensuring fair usage of server resources.
+
+- **Block bots** with **challenge-based verification** : Keep malicious bots at bay by challenging them to solve puzzles such as cookies, JavaScript tests, captcha, hCaptcha, reCAPTCHA or Turnstile, effectively blocking unauthorized access.
+
+- **Block known bad IPs** with external blacklists and DNSBL : Utilize external blacklists and DNS-based blackhole lists (DNSBL) to proactively block known malicious IP addresses, bolstering your defense against potential threats.
+
+- **And much more...** : BunkerWeb is packed with a plethora of additional security features that go beyond this list, providing you with comprehensive protection and peace of mind.
+
+To delve deeper into the core security features, we invite you to explore the [security tuning](security-tuning.md) section of the documentation. Discover how BunkerWeb empowers you to fine-tune and optimize security measures according to your specific needs.
+
+## Demo
+
+<p align="center">
+    <iframe style="display: block;" width="560" height="315" data-src="https://www.youtube-nocookie.com/embed/ZhYV-QELzA4" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
+</p>
+
+A demo website protected with BunkerWeb is available at [demo.bunkerweb.io](https://demo.bunkerweb.io/?utm_campaign=self&utm_source=doc). Feel free to visit it and perform some security tests.
+
+## BunkerWeb Cloud
+
+Don't want to self-host and manage your own BunkerWeb instance(s) ? You might be interested into BunkerWeb Cloud, our fully managed SaaS offer for BunkerWeb.
+
+Try our [BunkerWeb Cloud beta offer for free](https://panel.bunkerweb.io/order/bunkerweb-cloud/14?utm_source=doc&utm_campaign=self) and get access to :
+
+- Fully managed BunkerWeb instance hosted in our cloud
+- All BunkerWeb features including PRO ones
+- Monitoring platform including dashboards and alerts
+- Technical support to assist you in the configuration
+
+You will find more information about BunkerWeb Cloud in the [FAQ page](https://panel.bunkerweb.io/knowledgebase/55/BunkerWeb-Cloud?utm_source=doc&utm_campaign=self) of the BunkerWeb panel.
+
+## PRO version
+
+When using BunkerWeb you have the choice of the version you want to use : open-source or PRO.
+
+Whether it's enhanced security, an enriched user experience, or technical monitoring, the BunkerWeb PRO version will allow you to fully benefit from BunkerWeb and respond to your professional needs.
+
+Be it in the documentation or the user interface, the PRO features are annotated with a crown <img src="assets/img/pro-icon.svg" alt="crow pro icon" height="32px" width="32px"> to distinguish them from those integrated into the open-source version.
+
+You can upgrade from the open-source version to the PRO one easily and at any time you want. The process is pretty straightforward :
+
+- Claim your [free trial on the BunkerWeb panel](https://panel.bunkerweb.io/?utm_campaign=self&utm_source=doc)
+- Once connected to the client area, copy your PRO license key
+- Paste your private key into BunkerWeb using the [web UI](web-ui.md#upgrade-to-pro) or [specific setting](settings.md#pro)
+
+Do not hesitate to visit the [BunkerWeb panel](https://panel.bunkerweb.io/knowledgebase?utm_campaign=self&utm_source=doc) or [contact us](https://panel.bunkerweb.io/contact.php?utm_campaign=self&utm_source=doc) if you have any question regarding the PRO version.
+
+## Professional services
+
+Get the most of BunkerWeb by getting professional services directly from the maintainers of the project. From technical support to tailored consulting and development, we are here to assist you in the security of your web services.
+
+You will find more information by visiting the [BunkerWeb Panel](https://panel.bunkerweb.io/?utm_campaign=self&utm_source=doc), our dedicated platform for professional services.
+
+Don't hesitate to [contact us](https://panel.bunkerweb.io/contact.php?utm_campaign=self&utm_source=doc) if you have any question, we will be more than happy to respond to your needs.
+
+## Ecosystem, community and resources
+
+Official websites, tools and resources about BunkerWeb :
+
+- [**Website**](https://www.bunkerweb.io/?utm_campaign=self&utm_source=doc) : get more information, news and articles about BunkerWeb
+- [**Panel**](https://panel.bunkerweb.io/?utm_campaign=self&utm_source=doc) : dedicated platform to order and manage professional services (e.g. technical support) around BunkerWeb
+- [**Documentation**](https://docs.bunkerweb.io) : technical documentation of the BunkerWeb solution
+- [**Demo**](https://demo.bunkerweb.io/?utm_campaign=self&utm_source=doc) : demonstration website of BunkerWeb, don't hesitate to attempt attacks to test the robustness of the solution
+- [**Configurator**](https://config.bunkerweb.io/?utm_campaign=self&utm_source=doc) : user-friendly tool to help you configure BunkerWeb
+- [**Threatmap**](https://threatmap.bunkerweb.io/?utm_campaign=self&utm_source=doc) : live cyber attack blocked by BunkerWeb instances all around the world
+
+Community and social networks :
+
+- [**Discord**](https://discord.com/invite/fTf46FmtyD)
+- [**LinkedIn**](https://www.linkedin.com/company/bunkerity/)
+- [**Twitter**](https://twitter.com/bunkerity)
+- [**Reddit**](https://www.reddit.com/r/BunkerWeb/)

docs/json2md.py

@@ -0,0 +1,129 @@
+#!/usr/bin/env python3
+
+from io import StringIO
+from json import loads
+from glob import glob
+from pathlib import Path
+from pytablewriter import MarkdownTableWriter
+import requests
+import zipfile
+import shutil
+from contextlib import suppress
+
+from os import getenv
+
+
+def print_md_table(settings) -> MarkdownTableWriter:
+    writer = MarkdownTableWriter(
+        headers=["Setting", "Default", "Context", "Multiple", "Description"],
+        value_matrix=[
+            [
+                f"`{setting}`",
+                "" if data["default"] == "" else f"`{data['default']}`",
+                data["context"],
+                "no" if "multiple" not in data else "yes",
+                data["help"],
+            ]
+            for setting, data in settings.items()
+        ],
+    )
+    return writer
+
+
+def stream_support(support) -> str:
+    md = "STREAM support "
+    if support == "no":
+        md += ":x:"
+    elif support == "yes":
+        md += ":white_check_mark:"
+    else:
+        md += ":warning:"
+    return md
+
+
+def pro_title(title: str) -> str:
+    return f"## {title} <img src='../assets/img/pro-icon.svg' alt='crow pro icon' height='24px' width='24px' style='transform : translateY(3px);'>\n"
+
+
+doc = StringIO()
+
+print("# Settings\n", file=doc)
+print(
+    '!!! info "Settings generator tool"\n\n    To help you tune BunkerWeb, we have made an easy-to-use settings generator tool available at [config.bunkerweb.io](https://config.bunkerweb.io/?utm_campaign=self&utm_source=doc).\n',
+    file=doc,
+)
+print(
+    "This section contains the full list of settings supported by BunkerWeb."
+    + " If you are not yet familiar with BunkerWeb, you should first read the [concepts](concepts.md) section of the documentation."
+    + " Please follow the instructions for your own [integration](integrations.md) on how to apply the settings.\n",
+    file=doc,
+)
+print(
+    "As a general rule when multisite mode is enabled, if you want to apply settings with multisite context to a specific server, you will need to add the primary"
+    + " (first) server name as a prefix like `www.example.com_USE_ANTIBOT=captcha` or `myapp.example.com_USE_GZIP=yes` for example.\n",
+    file=doc,
+)
+print(
+    'When settings are considered as "multiple", it means that you can have multiple groups of settings for the same feature by adding numbers as suffix like `REVERSE_PROXY_URL_1=/subdir`,'
+    + " `REVERSE_PROXY_HOST_1=http://myhost1`, `REVERSE_PROXY_URL_2=/anotherdir`, `REVERSE_PROXY_HOST_2=http://myhost2`, ... for example.\n",
+    file=doc,
+)
+
+# Print global settings
+print("## Global settings\n", file=doc)
+print(f"\n{stream_support('partial')}\n", file=doc)
+with open("src/common/settings.json", "r") as f:
+    print(print_md_table(loads(f.read())), file=doc)
+    print(file=doc)
+
+# Get core plugins
+core_settings = {}
+for core in glob("src/common/core/*/plugin.json"):
+    with open(core, "r") as f:
+        with suppress(Exception):
+            core_plugin = loads(f.read())
+            if len(core_plugin["settings"]) > 0:
+                core_settings[core_plugin["name"]] = core_plugin
+
+# Get PRO plugins
+if getenv("VERSION"):
+    version = getenv("VERSION")
+else:
+    with open("src/VERSION", "r") as f:
+        version = f.read().strip()
+url = f"https://assets.bunkerity.com/bw-pro/preview/v{version}.zip"
+response = requests.get(url)
+response.raise_for_status()
+Path(f"v{version}.zip").write_bytes(response.content)
+with zipfile.ZipFile(f"v{version}.zip", "r") as zip_ref:
+    zip_ref.extractall(f"v{version}")
+pro_settings = {}
+for pro in glob(f"v{version}/*/plugin.json"):
+    with open(pro, "r") as f:
+        with suppress(Exception):
+            pro_plugin = loads(f.read())
+            core_settings[pro_plugin["name"]] = pro_plugin
+            core_settings[pro_plugin["name"]]["is_pro"] = True
+
+# Print plugins and their settings
+for data in dict(sorted(core_settings.items())).values():
+    pro_crown = ""
+    if "is_pro" in data:
+        pro_crown = " <img src='../assets/img/pro-icon.svg' alt='crow pro icon' height='24px' width='24px' style='transform : translateY(3px);'> (PRO)\n"
+    print(f"## {data['name']}{pro_crown}\n", file=doc)
+    print(f"{stream_support(data['stream'])}\n", file=doc)
+    print(f"{data['description']}\n", file=doc)
+    if data["settings"]:
+        print(print_md_table(data["settings"]), file=doc)
+
+# Remove zip file
+Path(f"v{version}.zip").unlink()
+# Remove folder using shutil
+shutil.rmtree(f"v{version}")
+
+doc.seek(0)
+content = doc.read()
+doc = StringIO(content.replace("\\|", "|"))
+doc.seek(0)
+
+Path("docs", "settings.md").write_text(doc.read(), encoding="utf-8")

docs/misc/pdf.js

@@ -0,0 +1,49 @@
+const puppeteer = require('puppeteer');
+var args = process.argv.slice(2);
+var url = args[0];
+var pdfPath = args[1];
+var title = args[2];
+
+console.log('Saving', url, 'to', pdfPath);
+
+// date –  formatted print date
+// title – document title
+// url  – document location
+// pageNumber – current page number
+// totalPages – total pages in the document
+headerHtml = `
+<div style="font-size: 10px; text-align: center; width: 100%;">
+    <span>${title}</span>
+</div>`;
+
+footerHtml = `<div style="font-size: 10px; text-align: center; width: 100%;"><span class="pageNumber"></span> / <span class="totalPages"></span></div>`;
+
+
+(async() => {
+    const browser = await puppeteer.launch({
+        headless: true,
+        executablePath: process.env.CHROME_BIN || null,
+        args: ['--no-sandbox', '--headless', '--disable-gpu', '--disable-dev-shm-usage']
+    });
+
+    const page = await browser.newPage();
+    await page.goto(url, { waitUntil: 'networkidle2' });
+    await page.pdf({
+        path: pdfPath, // path to save pdf file
+        format: 'A4', // page format
+        displayHeaderFooter: true, // display header and footer (in this example, required!)
+        printBackground: true, // print background
+        landscape: false, // use horizontal page layout
+        headerTemplate: headerHtml, // indicate html template for header
+        footerTemplate: footerHtml,
+        scale: 1, //Scale amount must be between 0.1 and 2
+        margin: { // increase margins (in this example, required!)
+            top: 80,
+            bottom: 80,
+            left: 30,
+            right: 30
+        }
+    });
+
+    await browser.close();
+})();

docs/overrides/main.html

@@ -0,0 +1,123 @@
+{% extends "base.html" %}
+{% block outdated %}
+    You're not viewing the
+    documentation of the latest version.
+    <a href="{{ '../' ~ base_url }}">
+        <strong>Click here to view latest.</strong>
+    </a>
+{% endblock %}
+{% block announce %}
+    📢 Looking for BunkerWeb PRO version, technical support or tailored services ? Visit the
+    <a href="https://panel.bunkerweb.io/?utm_campaign=self&utm_source=doc"
+       style="color: #3f6ec6;
+              text-decoration: underline">BunkerWeb Panel</a>
+    for more information on our enterprise offers.
+{% endblock %}
+{% block libs %}
+    <script async
+            defer
+            data-domain="docs.bunkerweb.io"
+            src="https://data.bunkerity.com/js/script.js"></script>
+
+    <script defer>
+      window.addEventListener('DOMContentLoaded', (e) => {
+
+        const customHeaders = document.querySelectorAll('[data-custom-header]')
+        customHeaders.forEach(header => {
+          const getHeaders = document.querySelectorAll(`#${header.getAttribute('id')}`);
+          getHeaders.forEach(el => {
+
+            if(!el.hasAttribute('data-custom-header')) el.remove()
+        })})
+      })
+    </script>
+
+
+    <script defer>
+  // Lazy load images and embed youtube videos
+  window.addEventListener("load", () => {
+    document.querySelectorAll("[data-src]").forEach((el) => {
+      el.setAttribute("src", el.getAttribute("data-src"));
+    });
+  });
+  // Add missing label
+  try {
+    document
+      .querySelector('div.md-search[data-md-component="search"][role="dialog"]')
+      .setAttribute("aria-label", "Search in documentation");
+  } catch (err) {}
+    </script>
+
+    <script defer>
+      window.addEventListener('DOMContentLoaded', () => {
+        const bannerEl = document.querySelector('aside.md-banner');
+        let defaultContent = [{ "content" : '<p>Get the most of BunkerWeb by upgrading to the PRO version. More info and free trial <a style="text-decoration:underline; color :  white;" href="https://panel.bunkerweb.io/?utm_campaign=self&utm_source=doc#pro">here</a>.</p>'},
+        { "content" : '<p>Need premium support or tailored consulting around BunkerWeb ? Check out our <a style="text-decoration:underline; color :  white;" href="https://panel.bunkerweb.io/?utm_campaign=self&utm_source=doc#services">professional services</a>.</p>'},
+        { "content" : '<p>Be part of the Bunker community by joining the <a style="text-decoration:underline; color: white;" href="https://discord.bunkerweb.io">Discord chat</a> and following us on <a style="text-decoration:underline; color: white;" href="https://www.linkedin.com/company/bunkerity/">LinkedIn</a>.</p>'}
+        ]
+
+      function setBannerStyle() {
+        const bannerItem = bannerEl.querySelector('.md-banner__inner');
+        bannerEl.style.backgroundColor = "#2eac68";
+        bannerItem.style.textAlign = "center";
+        bannerItem.style.transition = "all 0.5s ease-out";
+      }
+
+      function setDefault() {
+        const bannerItem = bannerEl.querySelector('.md-banner__inner');
+        const clone = bannerItem.cloneNode(true);
+        clone.innerHTML = defaultContent[0]["content"];
+        bannerEl.replaceChild(clone, bannerItem);
+      }
+
+      function startBannerLoop() {
+        const switchDelay = 7000;
+        let i = 0;
+
+        setInterval(() => {
+          // Update or reset index
+          if(i + 1 === defaultContent.length) {
+            i = 0;
+          } else {
+            i++;
+          }
+
+          // Prepare data with next el with opacity 0 too
+          const currItem = bannerEl.querySelector('.md-banner__inner');
+          currItem.style.opacity = 0;
+          const clone = currItem.cloneNode(true);
+          clone.innerHTML = defaultContent[i]["content"];
+          setTimeout(() => {
+            bannerEl.replaceChild(clone, currItem);
+            setTimeout(() => {
+              const newItem = bannerEl.querySelector('.md-banner__inner');
+              newItem.style.opacity = 1;
+            }, 20);
+          }, 600);
+
+        }, switchDelay);
+      }
+
+      function runBanner() {
+        // Try to get dynamic content
+        // Else keep static ones
+        fetch("https://www.bunkerweb.io/api/bw-ui-news")
+        .then((res) => {
+          return res.json();
+        })
+        .then((res) => {
+          defaultContent = res.data[0].data;
+          startBannerLoop();
+        })
+        .catch((e) => {
+          startBannerLoop();
+});
+      }
+
+        setBannerStyle();
+        setDefault();
+        runBanner()
+
+      })
+    </script>
+{% endblock %}

docs/package.json

@@ -0,0 +1,5 @@
+{
+    "dependencies": {
+      "puppeteer": "^21.3.6"
+    }
+}

docs/plugins.md

@@ -0,0 +1,642 @@
+# Plugins
+
+BunkerWeb comes with a plugin system making it possible to easily add new features. Once a plugin is installed, you can manage it using additional settings defined by the plugin.
+
+## Official plugins
+
+Here is the list of "official" plugins that we maintain (see the [bunkerweb-plugins](https://github.com/bunkerity/bunkerweb-plugins) repository for more information) :
+
+|      Name      | Version | Description                                                                                                                      |                                                Link                                                 |
+| :------------: | :-----: | :------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------: |
+|   **ClamAV**   |   1.5   | Automatically scans uploaded files with the ClamAV antivirus engine and denies the request when a file is detected as malicious. |     [bunkerweb-plugins/clamav](https://github.com/bunkerity/bunkerweb-plugins/tree/main/clamav)     |
+|   **Coraza**   |   1.5   | Inspect requests using a the Coraza WAF (alternative of ModSecurity).                                                            |     [bunkerweb-plugins/coraza](https://github.com/bunkerity/bunkerweb-plugins/tree/main/coraza)     |
+|  **CrowdSec**  |   1.5   | CrowdSec bouncer for BunkerWeb.                                                                                                  |   [bunkerweb-plugins/crowdsec](https://github.com/bunkerity/bunkerweb-plugins/tree/main/crowdsec)   |
+|  **Discord**   |   1.5   | Send security notifications to a Discord channel using a Webhook.                                                                |    [bunkerweb-plugins/discord](https://github.com/bunkerity/bunkerweb-plugins/tree/main/discord)    |
+|   **Slack**    |   1.5   | Send security notifications to a Slack channel using a Webhook.                                                                  |      [bunkerweb-plugins/slack](https://github.com/bunkerity/bunkerweb-plugins/tree/main/slack)      |
+| **VirusTotal** |   1.5   | Automatically scans uploaded files with the VirusTotal API and denies the request when a file is detected as malicious.          | [bunkerweb-plugins/virustotal](https://github.com/bunkerity/bunkerweb-plugins/tree/main/virustotal) |
+|  **WebHook**   |   1.5   | Send security notifications to a custom HTTP endpoint using a	Webhook.                                                           |    [bunkerweb-plugins/webhook](https://github.com/bunkerity/bunkerweb-plugins/tree/main/webhook)    |
+
+## How to use a plugin
+
+### Automatic
+
+If you want to quickly install external plugins, you can use the `EXTERNAL_PLUGIN_URLS` setting. It takes a list of URLs, separated with space, pointing to compressed (zip format) archive containing one or more plugin(s).
+
+You can use the following value if you want to automatically install the official plugins : `EXTERNAL_PLUGIN_URLS=https://github.com/bunkerity/bunkerweb-plugins/archive/refs/tags/v1.5.zip`
+
+### Manual
+
+The first step is to install the plugin by putting the plugin files inside the corresponding `plugins` data folder, the procedure depends on your integration :
+
+=== "Docker"
+
+    When using the [Docker integration](integrations.md#docker), plugins must be written to the volume mounted on `/data/plugins` into the scheduler container.
+
+    The first thing to do is to create the plugins folder :
+
+    ```shell
+    mkdir -p ./bw-data/plugins
+    ```
+
+    Then, you can drop the plugins of your choice into that folder :
+
+    ```shell
+    git clone https://github.com/bunkerity/bunkerweb-plugins && \
+    cp -rp ./bunkerweb-plugins/* ./bw-data/plugins
+    ```
+
+    !!! warning "Using local folder for persistent data"
+        The scheduler runs as an **unprivileged user with UID 101 and GID 101** inside the container. The reason behind this is security : in case a vulnerability is exploited, the attacker won't have full root (UID/GID 0) privileges.
+        But there is a downside : if you use a **local folder for the persistent data**, you will need to **set the correct permissions** so the unprivileged user can write data to it. Something like that should do the trick :
+
+        ```shell
+        mkdir bw-data && \
+        chown root:101 bw-data && \
+        chmod 770 bw-data
+        ```
+
+        Alternatively, if the folder already exists :
+
+        ```shell
+        chown -R root:101 bw-data && \
+        chmod -R 770 bw-data
+        ```
+
+        If you are using [Docker in rootless mode](https://docs.docker.com/engine/security/rootless) or [podman](https://podman.io/), UIDs and GIDs in the container will be mapped to different ones in the host. You will first need to check your initial subuid and subgid :
+
+        ```shell
+        grep ^$(whoami): /etc/subuid && \
+        grep ^$(whoami): /etc/subgid
+        ```
+
+        For example, if you have a value of **100000**, the mapped UID/GID will be **100100** (100000 + 100) :
+
+        ```shell
+        mkdir bw-data && \
+        sudo chgrp 100100 bw-data && \
+        chmod 770 bw-data
+        ```
+
+        Or if the folder already exists :
+
+        ```shell
+        sudo chgrp -R 100100 bw-data && \
+        chmod -R 770 bw-data
+        ```
+
+    Then you can mount the volume when starting your Docker stack :
+
+    ```yaml
+    version: '3.5'
+    services:
+    ...
+      bw-scheduler:
+        image: bunkerity/bunkerweb-scheduler:1.6.0-beta
+        volumes:
+          - ./bw-data:/data
+    ...
+    ```
+
+=== "Docker autoconf"
+
+    When using the [Docker autoconf integration](integrations.md#docker-autoconf), plugins must be written to the volume mounted on `/data/plugins` into the scheduler container.
+
+
+    The first thing to do is to create the plugins folder :
+
+    ```shell
+    mkdir -p ./bw-data/plugins
+    ```
+
+    Then, you can drop the plugins of your choice into that folder :
+
+    ```shell
+    git clone https://github.com/bunkerity/bunkerweb-plugins && \
+    cp -rp ./bunkerweb-plugins/* ./bw-data/plugins
+    ```
+
+    Because the scheduler runs as an unprivileged user with UID and GID 101, you will need to edit the permissions :
+
+    ```shell
+    chown -R 101:101 ./bw-data
+    ```
+
+    Then you can mount the volume when starting your Docker stack :
+
+    ```yaml
+    version: '3.5'
+    services:
+    ...
+      bw-scheduler:
+        image: bunkerity/bunkerweb-scheduler:1.6.0-beta
+        volumes:
+          - ./bw-data:/data
+    ...
+    ```
+
+=== "Swarm"
+
+    When using the [Swarm integration](integrations.md#swarm), plugins must be written to the volume mounted on `/data/plugins` into the scheduler container.
+
+    !!! info "Swarm volume"
+        Configuring a Swarm volume that will persist when the scheduler service is running on different nodes is not covered is in this documentation. We will assume that you have a shared folder mounted on `/shared` across all nodes.
+
+    The first thing to do is to create the plugins folder :
+
+    ```shell
+    mkdir -p /shared/bw-plugins
+    ```
+
+    Then, you can drop the plugins of your choice into that folder :
+
+    ```shell
+    git clone https://github.com/bunkerity/bunkerweb-plugins && \
+    cp -rp ./bunkerweb-plugins/* /shared/bw-plugins
+    ```
+
+    Because the scheduler runs as an unprivileged user with UID and GID 101, you will need to edit the permissions :
+
+    ```shell
+    chown -R 101:101 /shared/bw-plugins
+    ```
+
+    Then you can mount the volume when starting your Swarm stack :
+
+    ```yaml
+    version: '3.5'
+    services:
+    ...
+      bw-scheduler:
+        image: bunkerity/bunkerweb-scheduler:1.6.0-beta
+        volumes:
+          - /shared/bw-plugins:/data/plugins
+    ...
+    ```
+
+=== "Kubernetes"
+
+    When using the [Kubernetes integration](integrations.md#kubernetes), plugins must be written to the volume mounted on `/data/plugins` into the scheduler container.
+
+    The fist thing to do is to declare a [PersistentVolumeClaim](https://kubernetes.io/docs/concepts/storage/persistent-volumes/) that will contain our plugins data :
+
+    ```yaml
+    apiVersion: v1
+    kind: PersistentVolumeClaim
+    metadata:
+      name: pvc-bunkerweb-plugins
+    spec:
+      accessModes:
+        - ReadWriteOnce
+    resources:
+      requests:
+        storage: 5Gi
+    ```
+
+    You can now add the volume mount and an init containers to automatically provision the volume :
+
+    ```yaml
+    apiVersion: apps/v1
+    kind: Deployment
+    metadata:
+      name: bunkerweb-scheduler
+    spec:
+      replicas: 1
+      strategy:
+        type: Recreate
+      selector:
+        matchLabels:
+          app: bunkerweb-scheduler
+      template:
+        metadata:
+          labels:
+            app: bunkerweb-scheduler
+        spec:
+          serviceAccountName: sa-bunkerweb
+          containers:
+            - name: bunkerweb-scheduler
+              image: bunkerity/bunkerweb-scheduler:1.6.0-beta
+              imagePullPolicy: Always
+              env:
+                - name: KUBERNETES_MODE
+                  value: "yes"
+                - name: "DATABASE_URI"
+                  value: "mariadb+pymysql://bunkerweb:changeme@svc-bunkerweb-db:3306/db"
+              volumeMounts:
+                - mountPath: "/data/plugins"
+                  name: vol-plugins
+          initContainers:
+            - name: bunkerweb-scheduler-init
+              image: alpine/git
+              command: ["/bin/sh", "-c"]
+              args: ["git clone https://github.com/bunkerity/bunkerweb-plugins /data/plugins && chown -R 101:101 /data/plugins"]
+              volumeMounts:
+                - mountPath: "/data/plugins"
+                  name: vol-plugins
+          volumes:
+            - name: vol-plugins
+              persistentVolumeClaim:
+                claimName: pvc-bunkerweb-plugins
+    ```
+
+=== "Linux"
+
+    When using the [Linux integration](integrations.md#linux), plugins must be written to the `/etc/bunkerweb/plugins` folder :
+
+    ```shell
+    git clone https://github.com/bunkerity/bunkerweb-plugins && \
+    cp -rp ./bunkerweb-plugins/* /etc/bunkerweb/plugins && \
+    chown -R nginx:nginx /etc/bunkerweb/plugins
+    ```
+
+## Writing a plugin
+
+### Structure
+
+!!! tip "Existing plugins"
+
+    If the documentation is not enough, you can have a look at the existing source code of [official plugins](https://github.com/bunkerity/bunkerweb-plugins) and the [core plugins](https://github.com/bunkerity/bunkerweb/tree/v1.6.0-beta/src/common/core) (already included in BunkerWeb but they are plugins, technically speaking).
+
+What a plugin structure looks like :
+```
+plugin /
+        confs / conf_type / conf_name.conf
+        ui / actions.py
+             template.html
+        jobs / my-job.py
+        plugin.lua
+        plugin.json
+```
+
+- **conf_name.conf** : add [custom NGINX configurations](quickstart-guide.md#custom-configurations) (as jinja2 templates)
+
+- **actions.py** : script to execute on flask server, this script is running on flask context, you have access to lib and utils like `jinja2`, `requests`, etc...
+
+- **template.html** : custom plugin page you can access from ui
+
+- **jobs py file** : custom python files executed as jobs by the scheduler
+
+- **plugin.lua** : code to execute on NGINX using [NGINX LUA module](https://github.com/openresty/lua-nginx-module)
+
+- **plugin.json** : metadata, settings and jobs for your settings
+
+### Getting started
+
+The first step is to create a folder that will contain the plugin :
+
+```shell
+mkdir myplugin && \
+cd myplugin
+```
+
+### Metadata
+
+A file named **plugin.json** and written at the root of the plugin folder must contain metadata about the plugin. Here is an example :
+
+```json
+{
+  "id": "myplugin",
+  "name": "My Plugin",
+  "description": "Just an example plugin.",
+  "version": "1.0",
+  "stream": "partial",
+  "settings": {
+    "DUMMY_SETTING": {
+      "context": "multisite",
+      "default": "1234",
+      "help": "Here is the help of the setting.",
+      "id": "dummy-id",
+      "label": "Dummy setting",
+      "regex": "^.*$",
+      "type": "text"
+    }
+  },
+  "jobs": [
+    {
+      "name": "my-job",
+      "file": "my-job.py",
+      "every": "hour"
+    }
+  ]
+}
+```
+
+Here are the details of the fields :
+
+|     Field     | Mandatory |  Type  | Description                                                                                                               |
+| :-----------: | :-------: | :----: | :------------------------------------------------------------------------------------------------------------------------ |
+|     `id`      |    yes    | string | Internal ID for the plugin : must be unique among other plugins (including "core" ones) and contain only lowercase chars. |
+|    `name`     |    yes    | string | Name of your plugin.                                                                                                      |
+| `description` |    yes    | string | Description of your plugin.                                                                                               |
+|   `version`   |    yes    | string | Version of your plugin.                                                                                                   |
+|   `stream`    |    yes    | string | Information about stream support : `no`, `yes` or `partial`.                                                              |
+|  `settings`   |    yes    |  dict  | List of the settings of your plugin.                                                                                      |
+|    `jobs`     |    no     |  list  | List of the jobs of your plugin.                                                                                          |
+
+Each setting has the following fields (the key is the ID of the settings used in a configuration) :
+
+|   Field    | Mandatory |  Type  | Description                                                      |
+| :--------: | :-------: | :----: | :--------------------------------------------------------------- |
+| `context`  |    yes    | string | Context of the setting : `multisite` or `global`.                |
+| `default`  |    yes    | string | The default value of the setting.                                |
+|   `help`   |    yes    | string | Help text about the plugin (shown in web UI).                    |
+|    `id`    |    yes    | string | Internal ID used by the web UI for HTML elements.                |
+|  `label`   |    yes    | string | Label shown by the web UI.                                       |
+|  `regex`   |    yes    | string | The regex used to validate the value provided by the user.       |
+|   `type`   |    yes    | string | The type of the field : `text`, `check`, `select` or `password`. |
+| `multiple` |    no     | string | Unique ID to group multiple settings with numbers as suffix.     |
+|  `select`  |    no     |  list  | List of possible string values when `type` is `select`.          |
+
+Each job has the following fields :
+
+|  Field  | Mandatory |  Type  | Description                                                                                                                             |
+| :-----: | :-------: | :----: | :-------------------------------------------------------------------------------------------------------------------------------------- |
+| `name`  |    yes    | string | Name of the job.                                                                                                                        |
+| `file`  |    yes    | string | Name of the file inside the jobs folder.                                                                                                |
+| `every` |    yes    | string | Job scheduling frequency : `minute`, `hour`, `day`, `week` or `once` (no frequency, only once before (re)generating the configuration). |
+
+### Configurations
+
+You can add custom NGINX configurations by adding a folder named **confs** with content similar to the [custom configurations](quickstart-guide.md#custom-configurations). Each subfolder inside the **confs** will contain [jinja2](https://jinja.palletsprojects.com) templates that will be generated and loaded at the corresponding context (`http`, `server-http`, `default-server-http`, `stream`, `server-stream`, `modsec`, `modsec-crs`, `crs-plugins-before` and `crs-plugins-after`).
+
+Here is an example for a configuration template file inside the **confs/server-http** folder named **example.conf** :
+
+```conf
+location /setting {
+	default_type 'text/plain';
+    content_by_lua_block {
+        ngx.say('{{ DUMMY_SETTING }}')
+    }
+}
+```
+
+`{{ DUMMY_SETTING }}` will be replaced by the value of the `DUMMY_SETTING` chosen by the user of the plugin.
+
+### LUA
+
+#### Main script
+
+Under the hood, BunkerWeb is using the [NGINX LUA module](https://github.com/openresty/lua-nginx-module) to execute code within NGINX. Plugins that need to execute code must provide a lua file at the root directory of the plugin folder using the `id` value of **plugin.json** as its name. Here is an example named **myplugin.lua** :
+
+```lua
+local class     = require "middleclass"
+local plugin    = require "bunkerweb.plugin"
+local utils     = require "bunkerweb.utils"
+
+
+local myplugin = class("myplugin", plugin)
+
+
+function myplugin:initialize(ctx)
+    plugin.initialize(self, "myplugin", ctx)
+    self.dummy = "dummy"
+end
+
+function myplugin:init()
+    self.logger:log(ngx.NOTICE, "init called")
+    return self:ret(true, "success")
+end
+
+function myplugin:set()
+    self.logger:log(ngx.NOTICE, "set called")
+    return self:ret(true, "success")
+end
+
+function myplugin:access()
+    self.logger:log(ngx.NOTICE, "access called")
+    return self:ret(true, "success")
+end
+
+function myplugin:log()
+    self.logger:log(ngx.NOTICE, "log called")
+    return self:ret(true, "success")
+end
+
+function myplugin:log_default()
+    self.logger:log(ngx.NOTICE, "log_default called")
+    return self:ret(true, "success")
+end
+
+function myplugin:preread()
+    self.logger:log(ngx.NOTICE, "preread called")
+    return self:ret(true, "success")
+end
+
+function myplugin:log_stream()
+    self.logger:log(ngx.NOTICE, "log_stream called")
+    return self:ret(true, "success")
+end
+
+return myplugin
+```
+
+The declared functions are automatically called during specific contexts. Here are the details of each function :
+
+|   Function    |                                           Context                                           | Description                                                                                                                                               | Return value                                                                                                                                                                                                                                                                                                                                                          |
+| :-----------: | :-----------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+|    `init`     |          [init_by_lua](https://github.com/openresty/lua-nginx-module#init_by_lua)           | Called when NGINX just started or received a reload order. the typical use case is to prepare any data that will be used by your plugin.                  | `ret`, `msg`<ul><li>`ret` (boolean) : true if no error or else false</li><li>`msg` (string) : success or error message</li></ul>                                                                                                                                                                                                                                      |
+|     `set`     |           [set_by_lua](https://github.com/openresty/lua-nginx-module#set_by_lua)            | Called before each request received by the server.The typical use case is for computing before access phase.                                              | `ret`, `msg`<ul><li>`ret` (boolean) : true if no error or else false</li><li>`msg` (string) : success or error message</li></ul>                                                                                                                                                                                                                                      |
+|   `access`    |        [access_by_lua](https://github.com/openresty/lua-nginx-module#access_by_lua)         | Called on each request received by the server. The typical use case is to do the security checks here and deny the request if needed.                     | `ret`, `msg`,`status`,`redirect`<ul><li>`ret` (boolean) : true if no error or else false</li><li>`msg` (string) : success or error message</li><li>`status` (number) : interrupt current process and return [HTTP status](https://github.com/openresty/lua-nginx-module#http-status-constants)</li><li>`redirect` (URL) : if set will redirect to given URL</li></ul> |
+|     `log`     |           [log_by_lua](https://github.com/openresty/lua-nginx-module#log_by_lua)            | Called when a request has finished (and before it gets logged to the access logs). The typical use case is to make stats or compute counters for example. | `ret`, `msg`<ul><li>`ret` (boolean) : true if no error or else false</li><li>`msg` (string) : success or error message</li></ul>                                                                                                                                                                                                                                      |
+| `log_default` |           [log_by_lua](https://github.com/openresty/lua-nginx-module#log_by_lua)            | Same as `log` but only called on the default server.                                                                                                      | `ret`, `msg`<ul><li>`ret` (boolean) : true if no error or else false</li><li>`msg` (string) : success or error message</li></ul>                                                                                                                                                                                                                                      |
+|   `preread`   | [preread_by_lua](https://github.com/openresty/stream-lua-nginx-module#preread_by_lua_block) | Similar to the `access` function but for stream mode.                                                                                                     | `ret`, `msg`,`status`<ul><li>`ret` (boolean) : true if no error or else false</li><li>`msg` (string) : success or error message</li><li>`status` (number) : interrupt current process and return [status](https://github.com/openresty/lua-nginx-module#http-status-constants)</li></ul>                                                                              |
+| `log_stream`  |     [log_by_lua](https://github.com/openresty/stream-lua-nginx-module#log_by_lua_block)     | Similar to the `log` function but for stream mode.                                                                                                        | `ret`, `msg`<ul><li>`ret` (boolean) : true if no error or else false</li><li>`msg` (string) : success or error message</li></ul>                                                                                                                                                                                                                                      |
+
+#### Libraries
+
+All directives from [NGINX LUA module](https://github.com/openresty/lua-nginx-module) and are available and [NGINX stream LUA module](https://github.com/openresty/stream-lua-nginx-module). On top of that, you can use the LUA libraries included within BunkerWeb : see [this script](https://github.com/bunkerity/bunkerweb/blobsrc/deps/clone.sh) for the complete list.
+
+If you need additional libraries, you can put them in the root folder of the plugin and access them by prefixing them with your plugin ID. Here is an example file named **mylibrary.lua** :
+
+```lua
+local _M = {}
+
+_M.dummy = function ()
+	return "dummy"
+end
+
+return _M
+```
+
+And here is how you can use it from the **myplugin.lua** file :
+
+```lua
+local mylibrary = require "myplugin.mylibrary"
+
+...
+
+mylibrary.dummy()
+
+...
+```
+
+#### Helpers
+
+Some helpers modules provide common helpful helpers :
+
+- `self.variables` : allows to access and store plugins' attributes
+- `self.logger` : print logs
+- `bunkerweb.utils` : various useful functions
+- `bunkerweb.datastore` : access the global shared data on one instance (key/value store)
+- `bunkerweb.clusterstore` : access a Redis data store shared between BunkerWeb instances (key/value store)
+
+To access the functions, you first need to **require** the modules :
+
+```lua
+local utils       = require "bunkerweb.utils"
+local datastore   = require "bunkerweb.datastore"
+local clustestore = require "bunkerweb.clustertore"
+```
+
+Retrieve a setting value :
+
+```lua
+local myvar = self.variables["DUMMY_SETTING"]
+if not myvar then
+    self.logger:log(ngx.ERR, "can't retrieve setting DUMMY_SETTING")
+else
+    self.logger:log(ngx.NOTICE, "DUMMY_SETTING = " .. value)
+end
+```
+
+Store something in the local cache :
+
+```lua
+local ok, err = self.datastore:set("plugin_myplugin_something", "somevalue")
+if not ok then
+    self.logger:log(ngx.ERR, "can't save plugin_myplugin_something into datastore : " .. err)
+else
+    self.logger:log(ngx.NOTICE, "successfully saved plugin_myplugin_something into datastore")
+end
+```
+
+Check if an IP address is global :
+
+```lua
+local ret, err = utils.ip_is_global(ngx.ctx.bw.remote_addr)
+if ret == nil then
+    self.logger:log(ngx.ERR, "error while checking if IP " .. ngx.ctx.bw.remote_addr .. " is global or not : " .. err)
+elseif not ret then
+    self.logger:log(ngx.NOTICE, "IP " .. ngx.ctx.bw.remote_addr .. " is not global")
+else
+    self.logger:log(ngx.NOTICE, "IP " .. ngx.ctx.bw.remote_addr .. " is global")
+end
+```
+
+!!! tip "More examples"
+
+    If you want to see the full list of available functions, you can have a look at the files present in the [lua directory](https://github.com/bunkerity/bunkerweb/tree/v1.6.0-beta/src/bw/lua/bunkerweb) of the repository.
+
+### Jobs
+
+BunkerWeb uses an internal job scheduler for periodic tasks like renewing certificates with certbot, downloading blacklists, downloading MMDB files, ... You can add tasks of your choice by putting them inside a subfolder named **jobs** and listing them in the **plugin.json** metadata file. Don't forget to add the execution permissions for everyone to avoid any problems when a user is cloning and installing your plugin.
+
+### Plugin page
+
+Everything related to the web UI is located inside the subfolder **ui** as we seen in the [previous structure section.](#structure).
+
+#### Prerequisites
+
+When you want to create a plugin page, you need two files :
+
+- **template.html** that will be accessible with a **GET /plugins/<*plugin_id*>**.
+
+- **actions.py** where you can add some scripting and logic with a **POST /plugins/<*plugin_id*>**. Notice that this file **need a function with the same name as the plugin** to work. This file is needed even if the function is empty.
+
+#### Basic example
+
+!!! info "Jinja 2 template"
+    The **template.html** file is a Jinja2 template, please refer to the [Jinja2 documentation](https://jinja.palletsprojects.com) if needed.
+
+We can put aside the **actions.py** file and start **only using the template on a GET situation**. The template can access app context and libs, so you can use Jinja, request or flask utils.
+
+For example, you can get the request arguments in your template like this :
+
+```html
+<p>request args : {{ request.args.get() }}.</p>
+```
+
+#### Actions.py
+
+!!! warning "CSRF Token"
+
+    Please note that every form submission is protected via a CSRF token, you will need to include the following snippet into your forms :
+    ```html
+    <input type="hidden" name="csrf_token" value="{{ csrf_token() }}" />
+    ```
+
+You can power-up your plugin page with additional scripting with the **actions.py** file when sending a **POST /plugins/<*plugin_id*>**.
+
+You have two functions by default in **actions.py** :
+
+**pre_render function**
+
+This allows you to retrieve data when you **GET** the template, and to use the data with the pre_render variable available in Jinja to display content more dynamically.
+
+```python
+def pre_render(**kwargs)
+  return <pre_render_data>
+```
+
+BunkerWeb will send you this type of response :
+
+
+```python
+return jsonify({"status": "ok|ko", "code" : XXX, "data": <pre_render_data>}), 200
+```
+
+**<*plugin_id*> function**
+
+This allows you to retrieve data when you make a **POST** from the template endpoint, which must be used in AJAX.
+
+```python
+def myplugin(**kwargs)
+  return <plugin_id_data>
+```
+
+BunkerWeb will send you this type of response :
+
+```python
+return jsonify({"message": "ok", "data": <plugin_id_data>}), 200
+```
+
+**What you can access from action.py**
+
+Here are the arguments that are passed and access on action.py functions:
+
+```python
+function(app=app, args=request.args.to_dict() or request.json or None)
+```
+
+!!! info "Python libraries"
+    In addition, you can use Python libraries that are already available like :
+    `Flask`, `Flask-Login`, `Flask-WTF`, `beautifulsoup4`, `docker`, `Jinja2`, `python-magic` and `requests`. To see the full list, you can have a look at the Web UI [requirements.txt](https://github.com/bunkerity/bunkerweb/blobsrc/ui/requirements.txt). If you need external libraries, you can install them inside the **ui** folder of your plugin and then use the classical **import** directive.
+
+
+**Some examples**
+
+- Retrieve form submitted data
+
+```python
+from flask import request
+
+def myplugin(**kwargs) :
+	my_form_value = request.form["my_form_input"]
+  return my_form_value
+```
+
+- Access app config
+
+**action.py**
+```python
+from flask import request
+
+def pre_render(**kwargs) :
+	config = kwargs['app'].config["CONFIG"].get_config(methods=False)
+  return config
+```
+
+**template**
+```html
+<!-- metadata + config -->
+<div>{{ pre_render }}</div>
+```

docs/professional-services.md

@@ -0,0 +1,32 @@
+# Professional services
+
+## Why should I get professional services ?
+
+Since BunkerWeb is a free (as in freedom) software, you've the right to use it freely as long as you respect the [AGPLv3 license](https://www.gnu.org/licenses/agpl-3.0.en.html).
+
+You can also upgrade BunkerWeb to the PRO version at any time. By doing so, you will get an enhanced experience to assist you in the security of your web services. Our goal is to help you focus on your business needs. The PRO version is updated regularly and we try our best to gather feedbacks from enterprises to include the needed features.
+
+But dedicating time to a specific technology may not be easy depending on your business priorities. Not mentioning that cybersecurity is complex domain where being both judge and jury is not recommended.
+
+Getting professional services in addition to the open-source or PRO version is the ideal solution to cover your business needs. You can focus on your top priorities and rely on a trusted partner when it comes to web security.
+
+Please note that professional services are directly offered by [Bunkerity](https://www.bunkerity.com/?utm_campaign=self&utm_source=doc), the company maintaining the BunkerWeb project, through our [BunkerWeb Panel](https://panel.bunkerweb.io/?utm_campaign=self&utm_source=doc) online platform.
+
+## Which professional services do you offer ?
+
+We offer technical support around the BunkerWeb solution. By using this service, we will assist you on the technical issues (installation, configuration, false positive, ...).
+
+According to your needs you have the choice between "one time" and subscriptions offers.
+
+One important thing to note is that the support service is based on "credit" system where you pay for a number of support hours dedicated for you. Time passed on your requests will be deducted to your credit. In other words, you only pay for real time dedicated to your needs.
+
+In addition to the support service, we also offer custom services around the BunkerWeb solution to meet your specific needs :
+
+- Consulting : a dedicated expert will give you advices on your project
+- Development : if you need specific features in BunkerWeb, we can do it for you
+
+## How can I get more information ?
+
+You will find more information by visiting the [BunkerWeb Panel](https://panel.bunkerweb.io/?utm_campaign=self&utm_source=doc), our dedicated platform for professional services.
+
+Don't hesitate to [contact us](https://panel.bunkerweb.io/contact.php?utm_campaign=self&utm_source=doc) if you have any question, we will be more than happy to respond to your needs.