prepare for 1.5.3 🚀

DitZii · Oct 20, 2023 · cd902eb · cd902eb
1 parent 029217f
commit cd902eb
Show file tree

Hide file tree

Showing 113 changed files with 364 additions and 364 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -47,7 +47,7 @@ body:
       label: BunkerWeb version
       description: What version of BunkerWeb are you running?
       placeholder: Version
-      value: 1.5.2
+      value: 1.5.3
     validations:
       required: true
   - type: dropdown

diff --git a/.github/workflows/staging-create-infra.yml b/.github/workflows/staging-create-infra.yml
@@ -30,7 +30,7 @@ jobs:
         uses: azure/setup-kubectl@901a10e89ea615cf61f57ac05cecdf23e7de06d8 # v3.2
         if: inputs.TYPE == 'k8s'
         with:
-          version: 'v1.28.2'
+          version: "v1.28.2"
       - name: Set up Python 3.11
         uses: actions/setup-python@65d7f2d534ac1bc67fcd62888c5f4f3d2cb2b236 # v4.7.1
         if: inputs.TYPE != 'k8s'

diff --git a/.github/workflows/staging-delete-infra.yml b/.github/workflows/staging-delete-infra.yml
@@ -37,7 +37,7 @@ jobs:
       - uses: azure/setup-kubectl@901a10e89ea615cf61f57ac05cecdf23e7de06d8 # v3.2
         if: inputs.TYPE == 'k8s'
         with:
-          version: 'v1.28.2'
+          version: "v1.28.2"
       # 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'

diff --git a/.github/workflows/staging-tests.yml b/.github/workflows/staging-tests.yml
@@ -69,7 +69,7 @@ jobs:
       - uses: azure/setup-kubectl@901a10e89ea615cf61f57ac05cecdf23e7de06d8 # v3.2
         if: inputs.TYPE == 'k8s'
         with:
-          version: 'v1.28.2'
+          version: "v1.28.2"
       - uses: azure/setup-helm@5119fcb9089d432beecbf79bb2c7915207344b78 # v3.5
         if: inputs.TYPE == 'k8s'
       - name: Pull BW linux ubuntu test image

diff --git a/README.md b/README.md
diff --git a/docs/concepts.md b/docs/concepts.md
@@ -81,7 +81,7 @@ 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.5.2/examples) directory of the repository.
+    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.5.3/examples) directory of the repository.
 
 ## Custom configurations
 
@@ -95,7 +95,7 @@ By leveraging custom configurations, you unlock a world of possibilities to tail
 
 !!! 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.5.2/examples) directory of the repository.
+    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.5.3/examples) directory of the repository.
 
 ## Database
 

diff --git a/docs/integrations.md b/docs/integrations.md
diff --git a/docs/migrating.md b/docs/migrating.md
@@ -2,7 +2,7 @@
 
 !!! warning "Read this if you were a 1.4.X user"
 
-    A lot of things changed since the 1.4.X releases. Container-based integrations stacks contain more services but, trust us, fundamental principles of BunkerWeb are still there. You will find ready to use boilerplates for various integrations in the [misc/integrations](https://github.com/bunkerity/bunkerweb/tree/v1.5.2/misc/integrations) folder of the repository.
+    A lot of things changed since the 1.4.X releases. Container-based integrations stacks contain more services but, trust us, fundamental principles of BunkerWeb are still there. You will find ready to use boilerplates for various integrations in the [misc/integrations](https://github.com/bunkerity/bunkerweb/tree/v1.5.3/misc/integrations) folder of the repository.
 
 ## Scheduler
 

diff --git a/docs/plugins.md b/docs/plugins.md
@@ -58,7 +58,7 @@ The first step is to install the plugin by putting the plugin files inside the c
     services:
     ...
       bw-scheduler:
-        image: bunkerity/bunkerweb-scheduler:1.5.2
+        image: bunkerity/bunkerweb-scheduler:1.5.3
         volumes:
           - ./bw-data:/data
     ...
@@ -95,7 +95,7 @@ The first step is to install the plugin by putting the plugin files inside the c
     services:
     ...
       bw-scheduler:
-        image: bunkerity/bunkerweb-scheduler:1.5.2
+        image: bunkerity/bunkerweb-scheduler:1.5.3
         volumes:
           - ./bw-data:/data
     ...
@@ -134,7 +134,7 @@ The first step is to install the plugin by putting the plugin files inside the c
     services:
     ...
       bw-scheduler:
-        image: bunkerity/bunkerweb-scheduler:1.5.2
+        image: bunkerity/bunkerweb-scheduler:1.5.3
         volumes:
           - /shared/bw-plugins:/data/plugins
     ...
@@ -181,7 +181,7 @@ The first step is to install the plugin by putting the plugin files inside the c
           serviceAccountName: sa-bunkerweb
           containers:
             - name: bunkerweb-scheduler
-              image: bunkerity/bunkerweb-scheduler:1.5.2
+              image: bunkerity/bunkerweb-scheduler:1.5.3
               imagePullPolicy: Always
               env:
                 - name: KUBERNETES_MODE
@@ -262,7 +262,7 @@ The first step is to install the plugin by putting the plugin files inside the c
 
 !!! 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.5.2/src/common/core) (already included in BunkerWeb but they are plugins, technically speaking).
+    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.5.3/src/common/core) (already included in BunkerWeb but they are plugins, technically speaking).
 
 The first step is to create a folder that will contain the plugin :
 
@@ -507,7 +507,7 @@ 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.5.2/src/bw/lua/bunkerweb) of the repository.
+    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.5.3/src/bw/lua/bunkerweb) of the repository.
 
 ### Jobs
 

diff --git a/docs/quickstart-guide.md b/docs/quickstart-guide.md
@@ -4,7 +4,7 @@
     We assume that you're already familiar with the [core concepts](concepts.md) and you have followed the [integrations instructions](integrations.md) for your environment.
 
 !!! tip "Going further"
-		To demonstrate the use of BunkerWeb, we will deploy a dummy "Hello World" web application as an example. See the [examples folder](https://github.com/bunkerity/bunkerweb/tree/v1.5.2/examples) of the repository to get real-world examples.
+		To demonstrate the use of BunkerWeb, we will deploy a dummy "Hello World" web application as an example. See the [examples folder](https://github.com/bunkerity/bunkerweb/tree/v1.5.3/examples) of the repository to get real-world examples.
 
 ## Protect HTTP applications
 
@@ -35,7 +35,7 @@ You will find more settings about reverse proxy in the [settings section](settin
           - bw-services
 
       bunkerweb:
-        image: bunkerity/bunkerweb:1.5.2
+        image: bunkerity/bunkerweb:1.5.3
         ports:
           - 80:8080
           - 443:8443
@@ -52,7 +52,7 @@ You will find more settings about reverse proxy in the [settings section](settin
           - bw-services
 
       bw-scheduler:
-        image: bunkerity/bunkerweb-scheduler:1.5.2
+        image: bunkerity/bunkerweb-scheduler:1.5.3
         depends_on:
           - bunkerweb
           - bw-docker
@@ -386,7 +386,7 @@ You will find more settings about reverse proxy in the [settings section](settin
           - bw-services
 
       bunkerweb:
-        image: bunkerity/bunkerweb:1.5.2
+        image: bunkerity/bunkerweb:1.5.3
         ports:
           - 80:8080
           - 443:8443
@@ -406,7 +406,7 @@ You will find more settings about reverse proxy in the [settings section](settin
           - bw-services
 
       bw-scheduler:
-        image: bunkerity/bunkerweb-scheduler:1.5.2
+        image: bunkerity/bunkerweb-scheduler:1.5.3
         depends_on:
           - bunkerweb
           - bw-docker
@@ -822,7 +822,7 @@ REAL_IP_HEADER=X-Forwarded-For
 
     ```yaml
     mybunker:
-      image: bunkerity/bunkerweb:1.5.2
+      image: bunkerity/bunkerweb:1.5.3
       ...
       environment:
         - USE_REAL_IP=yes
@@ -837,7 +837,7 @@ REAL_IP_HEADER=X-Forwarded-For
 
     ```yaml
     mybunker:
-      image: bunkerity/bunkerweb:1.5.2
+      image: bunkerity/bunkerweb:1.5.3
       ...
       environment:
         - USE_REAL_IP=yes
@@ -852,7 +852,7 @@ REAL_IP_HEADER=X-Forwarded-For
 
     ```yaml
     mybunker:
-      image: bunkerity/bunkerweb:1.5.2
+      image: bunkerity/bunkerweb:1.5.3
       ...
       environment:
         - USE_REAL_IP=yes
@@ -972,7 +972,7 @@ REAL_IP_HEADER=proxy_protocol
 
     ```yaml
     mybunker:
-      image: bunkerity/bunkerweb:1.5.2
+      image: bunkerity/bunkerweb:1.5.3
       ...
       environment:
         - USE_REAL_IP=yes
@@ -988,7 +988,7 @@ REAL_IP_HEADER=proxy_protocol
 
     ```yaml
     mybunker:
-      image: bunkerity/bunkerweb:1.5.2
+      image: bunkerity/bunkerweb:1.5.3
       ...
       environment:
         - USE_REAL_IP=yes
@@ -1004,7 +1004,7 @@ REAL_IP_HEADER=proxy_protocol
 
     ```yaml
     mybunker:
-      image: bunkerity/bunkerweb:1.5.2
+      image: bunkerity/bunkerweb:1.5.3
       ...
       environment:
         - USE_REAL_IP=yes
@@ -1150,7 +1150,7 @@ For complete list of settings regarding `stream` mode, please refer to the [sett
           - bw-services
 
       bunkerweb:
-        image: bunkerity/bunkerweb:1.5.2
+        image: bunkerity/bunkerweb:1.5.3
         ports:
           - 80:8080 # Keep it if you want to use Let's Encrypt automation
           - 10000:10000 # app1
@@ -1172,7 +1172,7 @@ For complete list of settings regarding `stream` mode, please refer to the [sett
           - bw-services
 
       bw-scheduler:
-        image: bunkerity/bunkerweb-scheduler:1.5.2
+        image: bunkerity/bunkerweb-scheduler:1.5.3
         depends_on:
           - bunkerweb
           - bw-docker
@@ -1221,7 +1221,7 @@ For complete list of settings regarding `stream` mode, please refer to the [sett
     services:
 
       bunkerweb:
-        image: bunkerity/bunkerweb:1.5.2
+        image: bunkerity/bunkerweb:1.5.3
         ports:
           - 80:8080 # Keep it if you want to use Let's Encrypt automation
           - 10000:10000 # app1
@@ -1279,7 +1279,7 @@ For complete list of settings regarding `stream` mode, please refer to the [sett
 
     services:
       bunkerweb:
-        image: bunkerity/bunkerweb:1.5.2
+        image: bunkerity/bunkerweb:1.5.3
         ports:
           # Keep it if you want to use Let's Encrypt automation
           - published: 80
@@ -1467,7 +1467,7 @@ Some integrations provide more convenient ways to apply configurations, such as
     ```yaml
     ...
     mybunker:
-      image: bunkerity/bunkerweb:1.5.2
+      image: bunkerity/bunkerweb:1.5.3
       environment:
         - |
           CUSTOM_CONF_SERVER_HTTP_hello-world=
@@ -1510,7 +1510,7 @@ Some integrations provide more convenient ways to apply configurations, such as
 
     ```yaml
     bw-scheduler:
-      image: bunkerity/bunkerweb-scheduler:1.5.2
+      image: bunkerity/bunkerweb-scheduler:1.5.3
       volumes:
         - ./bw-data:/data
       ...
@@ -1580,7 +1580,7 @@ Some integrations provide more convenient ways to apply configurations, such as
 
     ```yaml
     bw-scheduler:
-      image: bunkerity/bunkerweb-scheduler:1.5.2
+      image: bunkerity/bunkerweb-scheduler:1.5.3
       volumes:
         - ./bw-data:/data
       ...
@@ -1813,7 +1813,7 @@ BunkerWeb supports PHP using external or remote [PHP-FPM](https://www.php.net/ma
           - bw-services
 
       bunkerweb:
-        image: bunkerity/bunkerweb:1.5.2
+        image: bunkerity/bunkerweb:1.5.3
         volumes:
           - ./www:/var/www/html
         ports:
@@ -1836,7 +1836,7 @@ BunkerWeb supports PHP using external or remote [PHP-FPM](https://www.php.net/ma
           - bw-services
 
       bw-scheduler:
-        image: bunkerity/bunkerweb-scheduler:1.5.2
+        image: bunkerity/bunkerweb-scheduler:1.5.3
         depends_on:
           - bunkerweb
           - bw-docker
@@ -1914,7 +1914,7 @@ BunkerWeb supports PHP using external or remote [PHP-FPM](https://www.php.net/ma
 
     services:
       bunkerweb:
-        image: bunkerity/bunkerweb:1.5.2
+        image: bunkerity/bunkerweb:1.5.3
         volumes:
           - ./www:/var/www/html
         labels:
@@ -1928,7 +1928,7 @@ BunkerWeb supports PHP using external or remote [PHP-FPM](https://www.php.net/ma
           - bw-services
 
       bw-scheduler:
-        image: bunkerity/bunkerweb-scheduler:1.5.2
+        image: bunkerity/bunkerweb-scheduler:1.5.3
         depends_on:
           - bunkerweb
           - bw-docker
@@ -2072,7 +2072,7 @@ BunkerWeb supports PHP using external or remote [PHP-FPM](https://www.php.net/ma
 
     services:
       bunkerweb:
-        image: bunkerity/bunkerweb:1.5.2
+        image: bunkerity/bunkerweb:1.5.3
         volumes:
           - /shared/www:/var/www/html
     ...
@@ -2351,7 +2351,7 @@ By default, BunkerWeb will only listen on IPv4 addresses and won't use IPv6 for
     services:
 
       bunkerweb:
-        image: bunkerity/bunkerweb:1.5.2
+        image: bunkerity/bunkerweb:1.5.3
         environment:
           - USE_IPv6=yes
 
@@ -2396,7 +2396,7 @@ By default, BunkerWeb will only listen on IPv4 addresses and won't use IPv6 for
     services:
 
       bunkerweb:
-        image: bunkerity/bunkerweb:1.5.2
+        image: bunkerity/bunkerweb:1.5.3
         environment:
           - USE_IPv6=yes
 

diff --git a/docs/security-tuning.md b/docs/security-tuning.md
@@ -484,7 +484,7 @@ You can quickly protect sensitive resources like the admin area for example, by
 
 ### Auth request
 
-You can deploy complex authentication (e.g. SSO), by using the auth request settings (see [here](https://docs.nginx.com/nginx/admin-guide/security-controls/configuring-subrequest-authentication/) for more information on the feature). Please note that you will find [Authelia](https://www.authelia.com/) and [Authentik](https://goauthentik.io/) examples in the [repository](https://github.com/bunkerity/bunkerweb/tree/v1.5.2/examples).
+You can deploy complex authentication (e.g. SSO), by using the auth request settings (see [here](https://docs.nginx.com/nginx/admin-guide/security-controls/configuring-subrequest-authentication/) for more information on the feature). Please note that you will find [Authelia](https://www.authelia.com/) and [Authentik](https://goauthentik.io/) examples in the [repository](https://github.com/bunkerity/bunkerweb/tree/v1.5.3/examples).
 
 **Auth request settings are related to reverse proxy rules.**