Elgato_dark/bunkerweb
1
0
Fork 0
mirror of https://github.com/bunkerity/bunkerweb synced 2026-05-24 09:28:37 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add deprecation notice for Swarm integration in documentation

Browse source
This commit is contained in:
Théophile Diot 2025-01-13 12:35:01 +01:00
parent 426f1a0349
commit 1b28fcd633
No known key found for this signature in database
GPG key ID: FA995104A0BA376A
6 changed files with 72 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
CHANGELOG.md
View file

@ -6,6 +6,7 @@
- [UI] Fixed condition when validating the setup wizard form when a custom certificate is used
- [FEATURE] Add extra validation of certificates in `customcert` plugin
- [FEATURE] Introduce new `SSL` plugin to manage SSL/TLS settings without tweaking the `misc` plugin
- [DOCS] Added Swarm deprecated notice in the documentation
- [DEPS] Updated libmaxminddb version to v1.12.2
## v1.6.0-rc1 - 2025/01/10

6
docs/integrations.md
View file

@ -1252,6 +1252,12 @@ If you use a custom domain name for your Kubernetes cluster different than the d
<figcaption>Docker Swarm integration</figcaption>
</figure>
!!! warning "Deprecated"
The Swarm integration is deprecated and will be removed in a future release. Please consider using the [Docker autoconf integration](#docker-autoconf) instead.
!!! tip "PRO support"
**If you need Swarm support**, please contact us at [contact@bunkerity.com](mailto:contact@bunkerity.com) or via the [contact form](https://panel.bunkerweb.io/contact.php).
!!! info "Docker autoconf"
The Swarm integration is similar to the Docker autoconf one (but with services instead of containers). Please read the [Docker autoconf integration section](#docker-autoconf) first if needed.

5
docs/plugins.md
View file

@ -134,6 +134,11 @@ The first step is to install the plugin by putting the plugin files inside the c
=== "Swarm"
!!! warning "Deprecated"
The Swarm integration is deprecated and will be removed in a future release. Please consider using the [Docker autoconf integration](#__tabbed_1_2) instead.
**More information can be found in the [Swarm integration documentation](integrations.md#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"

35
docs/quickstart-guide.md
View file

@ -103,6 +103,11 @@ You will find more settings about reverse proxy in the [settings section](settin
=== "Swarm"
!!! warning "Deprecated"
The Swarm integration is deprecated and will be removed in a future release. Please consider using the [Docker autoconf integration](#__tabbed_1_2) instead.
**More information can be found in the [Swarm integration documentation](integrations.md#swarm).**
We will assume that you already have the [Swarm integration](integrations.md#swarm) stack running on your cluster and connected to a network called `bw-services` so you can connect your existing application and configure BunkerWeb with labels :
```yaml
@ -363,6 +368,11 @@ You will find more settings about reverse proxy in the [settings section](settin
=== "Swarm"
!!! warning "Deprecated"
The Swarm integration is deprecated and will be removed in a future release. Please consider using the [Docker autoconf integration](#__tabbed_2_2) instead.
**More information can be found in the [Swarm integration documentation](integrations.md#swarm).**
We will assume that you already have the [Swarm integration](integrations.md#swarm) stack running on your cluster and connected to a network called `bw-services` so you can connect your existing application and configure BunkerWeb with labels :
```yaml
@ -610,6 +620,11 @@ REAL_IP_HEADER=X-Forwarded-For
=== "Swarm"
!!! warning "Deprecated"
The Swarm integration is deprecated and will be removed in a future release. Please consider using the [Docker autoconf integration](#__tabbed_3_2) instead.
**More information can be found in the [Swarm integration documentation](integrations.md#swarm).**
Before running the [Swarm integration](integrations.md#swarm) stack, you will need to add the settings for the Scheduler service :
```yaml
@ -716,6 +731,11 @@ REAL_IP_HEADER=proxy_protocol
=== "Swarm"
!!! warning "Deprecated"
The Swarm integration is deprecated and will be removed in a future release. Please consider using the [Docker autoconf integration](#__tabbed_4_2) instead.
**More information can be found in the [Swarm integration documentation](integrations.md#swarm).**
Before running the [Swarm integration](integrations.md#swarm) stack, you will need to add the settings for the Scheduler service :
```yaml
@ -926,6 +946,11 @@ For complete list of settings regarding `stream` mode, please refer to the [sett
=== "Swarm"
!!! warning "Deprecated"
The Swarm integration is deprecated and will be removed in a future release. Please consider using the [Docker autoconf integration](#__tabbed_5_2) instead.
**More information can be found in the [Swarm integration documentation](integrations.md#swarm).**
Before running the [Swarm integration](integrations.md#swarm) stack on your machine, you will need to edit the ports :
```yaml
@ -1196,6 +1221,11 @@ Some integrations provide more convenient ways to apply configurations, such as
=== "Swarm"
!!! warning "Deprecated"
The Swarm integration is deprecated and will be removed in a future release. Please consider using the [Docker autoconf integration](#__tabbed_6_2) instead.
**More information can be found in the [Swarm integration documentation](integrations.md#swarm).**
When using the [Swarm integration](integrations.md#swarm), custom configurations are managed using [Docker Configs](https://docs.docker.com/engine/swarm/configs/).
To keep it simple, you don't even need to attach the Config to a service : the autoconf service is listening for Config events and will update the custom configurations when needed.
@ -1594,6 +1624,11 @@ BunkerWeb supports PHP using external or remote [PHP-FPM](https://www.php.net/ma
=== "Swarm"
!!! warning "Deprecated"
The Swarm integration is deprecated and will be removed in a future release. Please consider using the [Docker autoconf integration](#__tabbed_7_2) instead.
**More information can be found in the [Swarm integration documentation](integrations.md#swarm).**
!!! info "Multisite mode enabled"
The [Swarm integration](integrations.md#docker-autoconf) integration implies the use of multisite mode : protecting one PHP application is the same as protecting multiple ones.

10
docs/troubleshooting.md
View file

@ -51,6 +51,11 @@ Here is how you can access the logs, depending on your integration :
=== "Swarm"
!!! warning "Deprecated"
The Swarm integration is deprecated and will be removed in a future release. Please consider using the [Docker autoconf integration](#__tabbed_1_2) instead.
**More information can be found in the [Swarm integration documentation](integrations.md#swarm).**
!!! tip "List services"
To list the services, you can use the following command :
```shell
@ -222,6 +227,11 @@ You can manually unban an IP which can be useful when doing some tests but it ne
=== "Swarm"
!!! warning "Deprecated"
The Swarm integration is deprecated and will be removed in a future release. Please consider using the [Docker autoconf integration](#__tabbed_2_2) instead.
**More information can be found in the [Swarm integration documentation](integrations.md#swarm).**
You can use the `docker exec` command (replace `myautoconf` with the name of your service) :
```shell
docker exec $(docker ps -q -f name=myautoconf) bwcli unban 1.2.3.4

15
docs/web-ui.md
View file

@ -302,6 +302,11 @@ Review your final BunkerWeb UI URL and then click on the `Setup` button. Once th
=== "Swarm"
!!! warning "Deprecated"
The Swarm integration is deprecated and will be removed in a future release. Please consider using the [Docker autoconf integration](#__tabbed_1_2) instead.
**More information can be found in the [Swarm integration documentation](integrations.md#swarm).**
If you want to use the setup wizard, you will need to set the `UI_HOST` setting to the HTTP endpoint of your web UI container. For example, if your web UI container is named `bw-ui` and is listening on the `7000` port, you will need to set the `UI_HOST` setting to `http://bw-ui:7000`.
!!! tip "Accessing the setup wizard"
@ -1064,6 +1069,11 @@ To keep the logs accessible from the web UI, you will need to use `syslog-ng` to
=== "Swarm"
!!! warning "Deprecated"
The Swarm integration is deprecated and will be removed in a future release. Please consider using the [Docker autoconf integration](#__tabbed_2_2) instead.
**More information can be found in the [Swarm integration documentation](integrations.md#swarm).**
To forward the logs correctly to the `/var/log/bunkerweb` directory on the Swarm integration, you will need to stream the logs to a file using `syslog-ng`. Here is an example of how to do this :
```yaml
@ -1653,6 +1663,11 @@ After a successful login/password combination, you will be prompted to enter you
=== "Swarm"
!!! warning "Deprecated"
The Swarm integration is deprecated and will be removed in a future release. Please consider using the [Docker autoconf integration](#__tabbed_3_2) instead.
**More information can be found in the [Swarm integration documentation](integrations.md#swarm).**
The web UI can be deployed using a dedicated container which is available on [Docker Hub](https://hub.docker.com/r/bunkerity/bunkerweb-ui) :
```shell