Skip to content

Commit

Permalink
docs - add system requirements and fix broken links
Browse files Browse the repository at this point in the history
  • Loading branch information
fl0ppy-d1sk committed Feb 13, 2025
1 parent 3ee81ed commit 4f8be1a
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 6 deletions.
8 changes: 4 additions & 4 deletions docs/integrations.md
Original file line number Diff line number Diff line change
Expand Up @@ -353,7 +353,7 @@ Please ensure that you have **NGINX 1.26.3 installed before installing BunkerWeb
```

!!! example "Disable the setup wizard"
If you don't want to use the automatically enabled [setup wizard](web-ui.md#setup-wizard) when BunkerWeb is installed, export the following variable :
If you don't want to use the setup wizard of the web UI when BunkerWeb is installed, export the following variable :

```shell
export UI_WIZARD=no
Expand Down Expand Up @@ -401,7 +401,7 @@ Please ensure that you have **NGINX 1.26.3 installed before installing BunkerWeb
```

!!! example "Disable the setup wizard"
If you don't want to use the automatically enabled [setup wizard](web-ui.md#setup-wizard) when BunkerWeb is installed, export the following variable :
If you don't want to use the setup wizard of the web UI when BunkerWeb is installed, export the following variable :

```shell
export UI_WIZARD=no
Expand Down Expand Up @@ -442,7 +442,7 @@ Please ensure that you have **NGINX 1.26.3 installed before installing BunkerWeb
```

!!! example "Disable the setup wizard"
If you don't want to use the automatically enabled [setup wizard](web-ui.md#setup-wizard) when BunkerWeb is installed, export the following variable :
If you don't want to use the setup wizard of the web UI when BunkerWeb is installed, export the following variable :

```shell
export UI_WIZARD=no
Expand Down Expand Up @@ -492,7 +492,7 @@ Please ensure that you have **NGINX 1.26.3 installed before installing BunkerWeb
```

!!! example "Disable the setup wizard"
If you don't want to use the automatically enabled [setup wizard](web-ui.md#setup-wizard) when BunkerWeb is installed, export the following variable :
If you don't want to use the setup wizard of the web UI when BunkerWeb is installed, export the following variable :

```shell
export UI_WIZARD=no
Expand Down
8 changes: 8 additions & 0 deletions docs/quickstart-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,14 @@

This quickstart guide assumes that BunkerWeb is accessible from the Internet and you have configured at least two domains : one for the web UI and another one for your web service.

**System requirements**

The minimum recommended specifications for BunkerWeb are a machine with 2 (v)CPUs and 4 GB of RAM. Please note that this should be sufficient for testing environments or setups with very few services.

For production environments with many services to protect, we recommend at least 4 (v)CPUs and 16 GB of RAM. Resources should be adjusted based on your use case, network traffic, and potential DDoS attacks you may face.

It is highly recommended to enable global loading of CRS rules (by setting the `USE_MODSECURITY_GLOBAL_CRS` parameter to `yes`) if you are in environments with limited RAM or in production with many services. More details can be found in the [advanced usages](advanced.md#running-many-services-in-production) section of the documentation.

This quickstart guide will help you to quickly install BunkerWeb and secure a web service using the web User Interface.

Protecting existing web applications already accessible with the HTTP(S) protocol is the main goal of BunkerWeb : it will act as a classical [reverse proxy](https://en.wikipedia.org/wiki/Reverse_proxy) with extra security features.
Expand Down
2 changes: 1 addition & 1 deletion docs/upgrading.md
Original file line number Diff line number Diff line change
Expand Up @@ -346,7 +346,7 @@ In other words, the new system is fully agnostic and generic: the scheduler is i

**The instances will be automatically fetched by the controller**. You can also add custom instances to the list that may not be picked up by the controller.

Since the `1.6`, the Scheduler also have a new [built-in healthcheck system](concepts.md#instances-healthcheck), that will check the health of the instances. If an instance becomes unhealthy, the scheduler will stop sending the configuration to it. If the instance becomes healthy again, the scheduler will start sending the configuration to it again.
Since the `1.6`, the Scheduler also have a new [built-in healthcheck system](concepts.md), that will check the health of the instances. If an instance becomes unhealthy, the scheduler will stop sending the configuration to it. If the instance becomes healthy again, the scheduler will start sending the configuration to it again.

#### BunkerWeb container

Expand Down
2 changes: 1 addition & 1 deletion docs/web-ui.md
Original file line number Diff line number Diff line change
Expand Up @@ -1545,7 +1545,7 @@ The web UI can be deployed and configured without going through the setup wizard
=== "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.
The Swarm integration is deprecated and will be removed in a future release. Please consider using the [Kubernetes integration](integrations.md#kubernetes) instead.

**More information can be found in the [Swarm integration documentation](integrations.md#swarm).**

Expand Down

0 comments on commit 4f8be1a

Please sign in to comment.