Skip to content

Commit

Permalink
Update version to 1.5.7
Browse files Browse the repository at this point in the history
  • Loading branch information
@TheophileDiot
TheophileDiot committed Mar 28, 2024
1 parent 58d195f commit 9ac335a
Show file tree
Hide file tree
Showing 116 changed files with 393 additions and 393 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ body:
label: BunkerWeb version
description: What version of BunkerWeb are you running?
placeholder: Version
value: 1.5.6
value: 1.5.7
validations:
required: true
- type: dropdown
Expand Down
86 changes: 43 additions & 43 deletions README.md
View file

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/concepts.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,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.6/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.7/examples) directory of the repository.

## Custom configurations

Expand All @@ -99,7 +99,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.6/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.7/examples) directory of the repository.

## Database

Expand Down
64 changes: 32 additions & 32 deletions docs/integrations.md
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/migrating.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,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.6/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.7/misc/integrations) folder of the repository.

### Scheduler

Expand Down
12 changes: 6 additions & 6 deletions docs/plugins.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,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.6
image: bunkerity/bunkerweb-scheduler:1.5.7
volumes:
- ./bw-data:/data
...
Expand Down Expand Up @@ -128,7 +128,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.6
image: bunkerity/bunkerweb-scheduler:1.5.7
volumes:
- ./bw-data:/data
...
Expand Down Expand Up @@ -167,7 +167,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.6
image: bunkerity/bunkerweb-scheduler:1.5.7
volumes:
- /shared/bw-plugins:/data/plugins
...
Expand Down Expand Up @@ -214,7 +214,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.6
image: bunkerity/bunkerweb-scheduler:1.5.7
imagePullPolicy: Always
env:
- name: KUBERNETES_MODE
Expand Down Expand Up @@ -297,7 +297,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.6/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.7/src/common/core) (already included in BunkerWeb but they are plugins, technically speaking).

What a plugin structure looks like :
```
Expand Down Expand Up @@ -567,7 +567,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.6/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.7/src/bw/lua/bunkerweb) of the repository.

### Jobs

Expand Down
50 changes: 25 additions & 25 deletions docs/quickstart-guide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

!!! 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.6/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.7/examples) of the repository to get real-world examples.

## Protect HTTP applications

Expand Down Expand Up @@ -37,7 +37,7 @@ You will find more settings about reverse proxy in the [settings section](settin
- bw-services

bunkerweb:
image: bunkerity/bunkerweb:1.5.6
image: bunkerity/bunkerweb:1.5.7
ports:
- 80:8080
- 443:8443
Expand All @@ -54,7 +54,7 @@ You will find more settings about reverse proxy in the [settings section](settin
- bw-services

bw-scheduler:
image: bunkerity/bunkerweb-scheduler:1.5.6
image: bunkerity/bunkerweb-scheduler:1.5.7
depends_on:
- bunkerweb
- bw-docker
Expand Down Expand Up @@ -391,7 +391,7 @@ You will find more settings about reverse proxy in the [settings section](settin
- bw-services

bunkerweb:
image: bunkerity/bunkerweb:1.5.6
image: bunkerity/bunkerweb:1.5.7
ports:
- 80:8080
- 443:8443
Expand All @@ -411,7 +411,7 @@ You will find more settings about reverse proxy in the [settings section](settin
- bw-services

bw-scheduler:
image: bunkerity/bunkerweb-scheduler:1.5.6
image: bunkerity/bunkerweb-scheduler:1.5.7
depends_on:
- bunkerweb
- bw-docker
Expand Down Expand Up @@ -830,7 +830,7 @@ REAL_IP_HEADER=X-Forwarded-For

```yaml
mybunker:
image: bunkerity/bunkerweb:1.5.6
image: bunkerity/bunkerweb:1.5.7
...
environment:
- USE_REAL_IP=yes
Expand All @@ -845,7 +845,7 @@ REAL_IP_HEADER=X-Forwarded-For

```yaml
mybunker:
image: bunkerity/bunkerweb:1.5.6
image: bunkerity/bunkerweb:1.5.7
...
environment:
- USE_REAL_IP=yes
Expand All @@ -860,7 +860,7 @@ REAL_IP_HEADER=X-Forwarded-For

```yaml
mybunker:
image: bunkerity/bunkerweb:1.5.6
image: bunkerity/bunkerweb:1.5.7
...
environment:
- USE_REAL_IP=yes
Expand Down Expand Up @@ -980,7 +980,7 @@ REAL_IP_HEADER=proxy_protocol

```yaml
mybunker:
image: bunkerity/bunkerweb:1.5.6
image: bunkerity/bunkerweb:1.5.7
...
environment:
- USE_REAL_IP=yes
Expand All @@ -996,7 +996,7 @@ REAL_IP_HEADER=proxy_protocol

```yaml
mybunker:
image: bunkerity/bunkerweb:1.5.6
image: bunkerity/bunkerweb:1.5.7
...
environment:
- USE_REAL_IP=yes
Expand All @@ -1012,7 +1012,7 @@ REAL_IP_HEADER=proxy_protocol

```yaml
mybunker:
image: bunkerity/bunkerweb:1.5.6
image: bunkerity/bunkerweb:1.5.7
...
environment:
- USE_REAL_IP=yes
Expand Down Expand Up @@ -1159,7 +1159,7 @@ For complete list of settings regarding `stream` mode, please refer to the [sett
- bw-services

bunkerweb:
image: bunkerity/bunkerweb:1.5.6
image: bunkerity/bunkerweb:1.5.7
ports:
- 80:8080 # Keep it if you want to use Let's Encrypt automation
- 10000:10000 # app1
Expand All @@ -1181,7 +1181,7 @@ For complete list of settings regarding `stream` mode, please refer to the [sett
- bw-services

bw-scheduler:
image: bunkerity/bunkerweb-scheduler:1.5.6
image: bunkerity/bunkerweb-scheduler:1.5.7
depends_on:
- bunkerweb
- bw-docker
Expand Down Expand Up @@ -1230,7 +1230,7 @@ For complete list of settings regarding `stream` mode, please refer to the [sett
services:

bunkerweb:
image: bunkerity/bunkerweb:1.5.6
image: bunkerity/bunkerweb:1.5.7
ports:
- 80:8080 # Keep it if you want to use Let's Encrypt automation
- 10000:10000 # app1
Expand Down Expand Up @@ -1288,7 +1288,7 @@ For complete list of settings regarding `stream` mode, please refer to the [sett

services:
bunkerweb:
image: bunkerity/bunkerweb:1.5.6
image: bunkerity/bunkerweb:1.5.7
ports:
# Keep it if you want to use Let's Encrypt automation
- published: 80
Expand Down Expand Up @@ -1476,7 +1476,7 @@ Some integrations provide more convenient ways to apply configurations, such as
```yaml
...
mybunker:
image: bunkerity/bunkerweb:1.5.6
image: bunkerity/bunkerweb:1.5.7
environment:
- |
CUSTOM_CONF_SERVER_HTTP_hello-world=
Expand Down Expand Up @@ -1519,7 +1519,7 @@ Some integrations provide more convenient ways to apply configurations, such as

```yaml
bw-scheduler:
image: bunkerity/bunkerweb-scheduler:1.5.6
image: bunkerity/bunkerweb-scheduler:1.5.7
volumes:
- ./bw-data:/data
...
Expand Down Expand Up @@ -1589,7 +1589,7 @@ Some integrations provide more convenient ways to apply configurations, such as

```yaml
bw-scheduler:
image: bunkerity/bunkerweb-scheduler:1.5.6
image: bunkerity/bunkerweb-scheduler:1.5.7
volumes:
- ./bw-data:/data
...
Expand Down Expand Up @@ -1822,7 +1822,7 @@ BunkerWeb supports PHP using external or remote [PHP-FPM](https://www.php.net/ma
- bw-services

bunkerweb:
image: bunkerity/bunkerweb:1.5.6
image: bunkerity/bunkerweb:1.5.7
volumes:
- ./www:/var/www/html
ports:
Expand All @@ -1845,7 +1845,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.6
image: bunkerity/bunkerweb-scheduler:1.5.7
depends_on:
- bunkerweb
- bw-docker
Expand Down Expand Up @@ -1923,7 +1923,7 @@ BunkerWeb supports PHP using external or remote [PHP-FPM](https://www.php.net/ma

services:
bunkerweb:
image: bunkerity/bunkerweb:1.5.6
image: bunkerity/bunkerweb:1.5.7
volumes:
- ./www:/var/www/html
labels:
Expand All @@ -1937,7 +1937,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.6
image: bunkerity/bunkerweb-scheduler:1.5.7
depends_on:
- bunkerweb
- bw-docker
Expand Down Expand Up @@ -2081,7 +2081,7 @@ BunkerWeb supports PHP using external or remote [PHP-FPM](https://www.php.net/ma

services:
bunkerweb:
image: bunkerity/bunkerweb:1.5.6
image: bunkerity/bunkerweb:1.5.7
volumes:
- /shared/www:/var/www/html
...
Expand Down Expand Up @@ -2364,7 +2364,7 @@ By default, BunkerWeb will only listen on IPv4 addresses and won't use IPv6 for
services:

bunkerweb:
image: bunkerity/bunkerweb:1.5.6
image: bunkerity/bunkerweb:1.5.7
environment:
- USE_IPv6=yes

Expand Down Expand Up @@ -2409,7 +2409,7 @@ By default, BunkerWeb will only listen on IPv4 addresses and won't use IPv6 for
services:

bunkerweb:
image: bunkerity/bunkerweb:1.5.6
image: bunkerity/bunkerweb:1.5.7
environment:
- USE_IPv6=yes

Expand Down
12 changes: 6 additions & 6 deletions docs/security-tuning.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -159,18 +159,18 @@ Full Let's Encrypt automation is fully working with stream mode as long as you o

STREAM support :white_check_mark:

The Let's Encrypt DNS plugin facilitates the automatic creation, renewal, and configuration of Let's Encrypt certificates using DNS challenges.
The Let's Encrypt DNS plugin facilitates the automatic creation, renewal, and configuration of Let's Encrypt certificates using DNS challenges.

This plugin offers seamless integration with various DNS providers for streamlined certificate management.

**List of features**
**List of features**

- Automatic creation and renewal of Let's Encrypt certificates
- Integration with DNS providers for DNS challenges
- Generate wildcard certificates
- Configuration options for customization and flexibility

**Settings of the Let's Encrypt DNS plugin**
**Settings of the Let's Encrypt DNS plugin**

| Setting | Default | Context | Multiple | Description |
| ---------------------------------- | --------- | --------- | -------- | --------------------------------------------------------------------------------------- |
Expand All @@ -184,7 +184,7 @@ This plugin offers seamless integration with various DNS providers for streamlin

!!! info "Information and behavior"
- The `LETS_ENCRYPT_DNS_CREDENTIAL_ITEM` setting is a multiple setting and can be used to set multiple items for the DNS provider. The items will be saved as a cache file and Certbot will read the credentials from it.

- If no `LETS_ENCRYPT_DNS_PROPAGATION` setting is set, the provider's default propagation time will be used.

**Available DNS Providers**
Expand Down Expand Up @@ -539,7 +539,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.6/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.7/examples).

**Auth request settings are related to reverse proxy rules.**

Expand Down Expand Up @@ -632,4 +632,4 @@ The Reporting plugin provides a comprehensive solution for regular reporting of
- Accepted values for `REPORTING_SCHEDULE` are `daily`, `weekly`and `monthly`.
- case no `REPORTING_SMTP_FROM_USER` and `REPORTING_SMTP_FROM_PASSWORD` are set, the plugin will try to send the email without authentication.
- case `REPORTING_SMTP_FROM_USER` isn't set but `REPORTING_SMTP_FROM_PASSWORD` is set, the plugin will use the `REPORTING_SMTP_FROM_EMAIL` as the username.
- case the job fails, the plugin will retry sending the report in the next execution.
- case the job fails, the plugin will retry sending the report in the next execution.
Loading

0 comments on commit 9ac335a

Please sign in to comment.