366 lines
20 KiB
Markdown
366 lines
20 KiB
Markdown
<p align="center">
|
|
<img alt="BunkerWeb logo" src="https://github.com/bunkerity/bunkerweb/raw/v1.5.4/misc/logo.png" />
|
|
</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">Website</a>
|
|
|
|
|
📓 <a href="https://docs.bunkerweb.io">Documentation</a>
|
|
|
|
|
👨💻 <a href="https://demo.bunkerweb.io">Demo</a>
|
|
|
|
|
🛡️ <a href="https://github.com/bunkerity/bunkerweb/raw/v1.5.4/examples">Examples</a>
|
|
|
|
|
💬 <a href="https://discord.com/invite/fTf46FmtyD">Chat</a>
|
|
|
|
|
📝 <a href="https://github.com/bunkerity/bunkerweb/discussions">Forum</a>
|
|
<br/>
|
|
⚙️ <a href="https://config.bunkerweb.io">Configurator</a>
|
|
|
|
|
🗺️ <a href="https://threatmap.bunkerweb.io">Threatmap</a>
|
|
</p>
|
|
|
|
> 🛡️ Make security by default great again !
|
|
|
|
# BunkerWeb
|
|
|
|
<p align="center">
|
|
<img alt="Overview banner" src="https://github.com/bunkerity/bunkerweb/raw/v1.5.4/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.5.4/integrations/#linux), [Docker](https://docs.bunkerweb.io/1.5.4/integrations/#docker), [Swarm](https://docs.bunkerweb.io/1.5.4/integrations/#swarm), [Kubernetes](https://docs.bunkerweb.io/1.5.4/integrations/#kubernetes), …) and is fully configurable (don't panic, there is an [awesome web UI](https://docs.bunkerweb.io/1.5.4/web-ui/) 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.5.4/security-tuning/) as part of the core but can be easily extended with additional ones thanks to a [plugin system](https://docs.bunkerweb.io/1.5.4/plugins/).
|
|
|
|
## Why BunkerWeb ?
|
|
|
|
- **Easy integration into existing environments** : support for Linux, Docker, Swarm, Kubernetes, Ansible, Vagrant, ...
|
|
- **Highly customizable** : enable, disable and configure features easily to meet your use case
|
|
- **Secure by default** : offers out-of-the-box and hassle-free minimal security for your web services
|
|
- **Awesome web UI** : keep control of everything more efficiently without the need of the CLI
|
|
- **Plugin system** : extend BunkerWeb to meet your own use-cases
|
|
- **Free as in "freedom"** : licensed under the free [AGPLv3 license](https://www.gnu.org/licenses/agpl-3.0.en.html)
|
|
|
|
## 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.5.4/security-tuning/) 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). Feel free to visit it and perform some security tests.
|
|
|
|
# Concepts
|
|
|
|
<p align="center">
|
|
<img alt="Concepts banner" src="https://github.com/bunkerity/bunkerweb/raw/v1.5.4/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.5.4/concepts).
|
|
|
|
## 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.5.4/integrations/#docker)
|
|
- [Docker autoconf](https://docs.bunkerweb.io/1.5.4/integrations/#docker-autoconf)
|
|
- [Swarm](https://docs.bunkerweb.io/1.5.4/integrations/#swarm)
|
|
- [Kubernetes](https://docs.bunkerweb.io/1.5.4/integrations/#kubernetes)
|
|
- [Linux](https://docs.bunkerweb.io/1.5.4/integrations/#linux)
|
|
- [Ansible](https://docs.bunkerweb.io/1.5.4/integrations/#ansible)
|
|
- [Vagrant](https://docs.bunkerweb.io/1.5.4/integrations/#vagrant)
|
|
|
|
## 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).
|
|
|
|
## 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.5.4/plugins)), 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
|
|
|
|
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
|
|
|
|
## Docker
|
|
|
|
<p align="center">
|
|
<img alt="Docker banner" src="https://github.com/bunkerity/bunkerweb/raw/v1.5.4/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.5.4/integrations/#docker) of the documentation.
|
|
|
|
## Docker autoconf
|
|
|
|
<p align="center">
|
|
<img alt="Docker autoconf banner" src="https://github.com/bunkerity/bunkerweb/raw/v1.5.4/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.5.4/integrations/#docker-autoconf) of the documentation.
|
|
|
|
## Swarm
|
|
|
|
<p align="center">
|
|
<img alt="Swarm banner" src="https://github.com/bunkerity/bunkerweb/raw/v1.5.4/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.5.4/integrations/#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.5.4/integrations/#swarm) of the documentation.
|
|
|
|
## Kubernetes
|
|
|
|
<p align="center">
|
|
<img alt="Kubernetes banner" src="https://github.com/bunkerity/bunkerweb/raw/v1.5.4/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.5.4/integrations/#kubernetes) of the documentation.
|
|
|
|
## Linux
|
|
|
|
<p align="center">
|
|
<img alt="Linux banner" src="https://github.com/bunkerity/bunkerweb/raw/v1.5.4/docs/assets/img/integration-linux.svg" />
|
|
</p>
|
|
|
|
List of supported Linux distros :
|
|
|
|
- Debian 12 "Bookworm"
|
|
- Ubuntu 22.04 "Jammy"
|
|
- Fedora 39
|
|
- RHEL 8.9
|
|
|
|
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.5.4/integrations/#linux) of the documentation.
|
|
|
|
## Ansible
|
|
|
|
<p align="center">
|
|
<img alt="Ansible banner" src="https://github.com/bunkerity/bunkerweb/raw/v1.5.4/docs/assets/img/integration-ansible.svg" />
|
|
</p>
|
|
|
|
List of supported Linux distros :
|
|
|
|
- Debian 12 "Bookworm"
|
|
- Ubuntu 22.04 "Jammy"
|
|
- Fedora 39
|
|
- RHEL 8.9
|
|
|
|
[Ansible](https://www.ansible.com/) is an IT automation tool. It can configure systems, deploy software, and orchestrate more advanced IT tasks such as continuous deployments or zero downtime rolling updates.
|
|
|
|
A specific BunkerWeb Ansible role is available on [Ansible Galaxy](https://galaxy.ansible.com/bunkerity/bunkerweb) (source code is available [here](https://github.com/bunkerity/bunkerweb-ansible)).
|
|
|
|
You will find more information in the [Ansible section](https://docs.bunkerweb.io/1.5.4/integrations/#ansible) of the documentation.
|
|
|
|
## Vagrant
|
|
|
|
We maintain ready to use Vagrant boxes hosted on Vagrant cloud for the following providers :
|
|
|
|
- virtualbox
|
|
- libvirt
|
|
|
|
You will find more information in the [Vagrant section](https://docs.bunkerweb.io/1.5.4/integrations/#vagrant) 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.5.4/quickstart-guide/) 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.5.4/settings). 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.5.4/security-tuning) 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).
|
|
|
|
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.5.4/settings) 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.5.4/docs/assets/img/user_interface_demo.png" 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.5.4/web-ui) 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) repository for more information) :
|
|
|
|
| Name | Version | Description | Link |
|
|
| :------------: | :-----: | :------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------: |
|
|
| **ClamAV** | 1.2 | 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.2 | Inspect requests using a the Coraza WAF (alternative of ModSecurity). | [bunkerweb-plugins/coraza](https://github.com/bunkerity/bunkerweb-plugins/tree/main/coraza) |
|
|
| **CrowdSec** | 1.2 | CrowdSec bouncer for BunkerWeb. | [bunkerweb-plugins/crowdsec](https://github.com/bunkerity/bunkerweb-plugins/tree/main/crowdsec) |
|
|
| **Discord** | 1.2 | Send security notifications to a Discord channel using a Webhook. | [bunkerweb-plugins/discord](https://github.com/bunkerity/bunkerweb-plugins/tree/main/discord) |
|
|
| **Slack** | 1.2 | Send security notifications to a Slack channel using a Webhook. | [bunkerweb-plugins/slack](https://github.com/bunkerity/bunkerweb-plugins/tree/main/slack) |
|
|
| **VirusTotal** | 1.2 | 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.2 | 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.5.4/plugins) of the documentation.
|
|
|
|
# Support
|
|
|
|
## Professional
|
|
|
|
We offer professional services related to BunkerWeb like :
|
|
|
|
* Consulting
|
|
* Support
|
|
* Custom development
|
|
* Partnership
|
|
|
|
Please contact us at [contact@bunkerity.com](mailto:contact@bunkerity.com) if you are interested.
|
|
|
|
## 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.5.4/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.5.4/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.5.4/SECURITY.md) for more information.
|
|
|
|
# Stargazers over time
|
|
|
|
[](https://starchart.cc/bunkerity/bunkerweb)
|