Quickstart guide
Prerequisites
We assume that you're already familiar with the core concepts and you have followed the integrations instructions for your environment.
Going further
To demonstrate the use of BunkerWeb, we will deploy a dummy "Hello World" web application as an example. See the examples folder of the repository to get real-world examples.
Protect HTTP applications
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 with extra security features.
The following settings can be used :
USE_REVERSE_PROXY: enable/disable reverse proxy modeREVERSE_PROXY_URL: the public path prefixREVERSE_PROXY_HOST: (internal) address of the proxied web application
You will find more settings about reverse proxy in the settings section of the documentation.
Single application
When using Docker integration, the easiest way of protecting an existing application is to create a network so BunkerWeb can send requests using the container name.
Create the Docker network if it's not already created :
shell
docker network create bw-net
Then instantiate your app :
shell
docker run -d \
--name myapp \
--network bw-net \
nginxdemos/hello:plain-text
Create the BunkerWeb volume if it's not already created :
shell
docker volume create bw-data
You can now run BunkerWeb and configure it for your app :
shell
docker run -d \
--name mybunker \
--network bw-net \
-p 80:8080 \
-p 443:8443 \
-v bw-data:/data \
-e SERVER_NAME=www.example.com \
-e USE_REVERSE_PROXY=yes \
-e REVERSE_PROXY_URL=/ \
-e REVERSE_PROXY_HOST=http://myapp \
bunkerity/bunkerweb:1.4.0
Here is the docker-compose equivalent : ```yaml version: '3'
services:
mybunker: image: bunkerity/bunkerweb:1.4.0 ports: - 80:8080 - 443:8443 volumes: - bw-data:/data environment: - USE_REVERSE_PROXY=yes - REVERSE_PROXY_URL=/ - REVERSE_PROXY_HOST=http://myapp networks: - bw-net
myapp: image: nginxdemos/hello:plain-text networks: - bw-net
volumes: bw-data:
networks: bw-net: name: bw-net ```
We will assume that you already have the Docker autoconf integration stack running on your machine and connected to a network called bw-services.
You can instantiate your container and pass the settings as labels :
shell
docker run -d \
--name myapp \
--network bw-services \
-l bunkerweb.SERVER_NAME=www.example.com \
-l bunkerweb.USE_REVERSE_PROXY=yes \
-l bunkerweb.USE_REVERSE_URL=/ \
-l bunkerweb.REVERSE_PROXY_HOST=http://myapp \
nginxdemos/hello:plain-text
Here is the docker-compose equivalent : ```yaml version: '3'
services:
myapp: image: nginxdemos/hello:plain-text networks: bw-services: aliases: - myapp labels: - "bunkerweb.SERVER_NAME=www.example.com" - "bunkerweb.USE_REVERSE_PROXY=yes" - "bunkerweb.REVERSE_PROXY_URL=/" - "bunkerweb.REVERSE_PROXY_HOST=http://myapp"
networks: bw-services: external: name: bw-services ```
We will assume that you already have the Swarm integration stack running on your cluster.
You can instantiate your service and pass the settings as labels :
shell
docker service \
create \
--name myapp \
--network bw-services \
-l bunkerweb.SERVER_NAME=www.example.com \
-l bunkerweb.USE_REVERSE_PROXY=yes \
-l bunkerweb.REVERSE_PROXY_HOST=http://myapp \
-l bunkerweb.REVERSE_PROXY_URL=/ \
nginxdemos/hello:plain-text
Here is the docker-compose equivalent (using docker stack deploy) :
```yaml
version: "3"
services:
myapp: image: nginxdemos/hello:plain-text networks: bw-services: aliases: - myapp deploy: placement: constraints: - "node.role==worker" labels: - "bunkerweb.SERVER_NAME=www.example.com" - "bunkerweb.USE_REVERSE_PROXY=yes" - "bunkerweb.REVERSE_PROXY_URL=/" - "bunkerweb.REVERSE_PROXY_HOST=http://myapp"
networks: bw-services: external: name: bw-services ```
We will assume that you already have the Kubernetes integration stack running on your cluster.
Let's assume that you have a typical Deployment with a Service to access the web application from within the cluster : ```yaml apiVersion: apps/v1 kind: Deployment metadata: name: app labels: app: app spec: replicas: 1 selector: matchLabels: app: app template: metadata: labels: app: app spec: containers: - name: app image: nginxdemos/hello:plain-text ports: - containerPort: 80
apiVersion: v1 kind: Service metadata: name: svc-app spec: selector: app: app ports: - protocol: TCP port: 80 targetPort: 80 ```
Here is the corresponding Ingress definition to serve and protect the web application :
yaml
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
name: ingress
annotations:
bunkerweb.io/AUTOCONF: "yes"
spec:
rules:
- host: www.example.com
http:
paths:
- path: /
pathType: Prefix
backend:
service:
name: svc-app
port:
number: 80
We will assume that you already have the Linux integration stack running on your machine.
The following command will run a basic HTTP server on the port 8000 and deliver the files in the current directory :
shell
python3 -m http.server -b 127.0.0.1
Configuration of BunkerWeb is done by editing the /opt/bunkerweb/variables.env file :
conf
SERVER_NAME=www.example.com
HTTP_PORT=80
HTTPS_PORT=443
DNS_RESOLVERS=8.8.8.8 8.8.4.4
USE_REVERSE_PROXY=yes
REVERSE_PROXY_URL=/
REVERSE_PROXY_HOST=http://127.0.0.1:8000
Let's check the status of BunkerWeb :
shell
systemctl status bunkerweb
If it's already running we can just reload it :
shell
systemctl reload bunkerweb
Otherwise, we will need to start it :
shell
systemctl start bunkerweb
Multiple applications
Testing
To perform quick tests when multisite mode is enabled (and if you don't have the proper DNS entries set up for the domains) you can use curl with the HTTP Host header of your choice :
shell curl -H "Host: app1.example.com" http://ip-or-fqdn-of-server
When using Docker integration, the easiest way of protecting multiple existing applications is to create a network so BunkerWeb can send requests using the container names.
Create the Docker network if it's not already created :
shell
docker network create bw-net
Then instantiate your apps :
shell
docker run -d \
--name myapp1 \
--network bw-net \
nginxdemos/hello:plain-text
shell
docker run -d \
--name myapp2 \
--network bw-net \
nginxdemos/hello:plain-text
shell
docker run -d \
--name myapp3 \
--network bw-net \
nginxdemos/hello:plain-text
Create the BunkerWeb volume if it's not already created :
shell
docker volume create bw-data
You can now run BunkerWeb and configure it for your apps :
shell
docker run -d \
--name mybunker \
--network bw-net \
-p 80:8080 \
-p 443:8443 \
-v bw-data:/data \
-e MULTISITE=yes
-e "SERVER_NAME=app1.example.com app2.example.com app3.example.com" \
-e USE_REVERSE_PROXY=yes \
-e REVERSE_PROXY_URL=/ \
-e app1.example.com_REVERSE_PROXY_HOST=http://myapp1 \
-e app2.example.com_REVERSE_PROXY_HOST=http://myapp2 \
-e app3.example.com_REVERSE_PROXY_HOST=http://myapp3 \
bunkerity/bunkerweb:1.4.0
Here is the docker-compose equivalent : ```yaml version: '3'
services:
mybunker: image: bunkerity/bunkerweb:1.4.0 ports: - 80:8080 - 443:8443 volumes: - bw-data:/data environment: - MULTISITE=yes - SERVER_NAME=app1.example.com app2.example.com app3.example.com - USE_REVERSE_PROXY=yes - REVERSE_PROXY_URL=/ - app1.example.com_REVERSE_PROXY_HOST=http://myapp1 - app2.example.com_REVERSE_PROXY_HOST=http://myapp2 - app3.example.com_REVERSE_PROXY_HOST=http://myapp3 networks: - bw-net
myapp1: image: nginxdemos/hello:plain-text networks: - bw-net
myapp2: image: nginxdemos/hello:plain-text networks: - bw-net
myapp3: image: nginxdemos/hello:plain-text networks: - bw-net
volumes: bw-data:
networks: bw-net: name: bw-net ```
We will assume that you already have the Docker autoconf integration stack running on your machine and connected to a network called bw-services.
You can instantiate your containers and pass the settings as labels :
shell
docker run -d \
--name myapp1 \
--network bw-services \
-l bunkerweb.SERVER_NAME=app1.example.com \
-l bunkerweb.USE_REVERSE_PROXY=yes \
-l bunkerweb.USE_REVERSE_URL=/ \
-l bunkerweb.REVERSE_PROXY_HOST=http://myapp1 \
nginxdemos/hello:plain-text
Here is the docker-compose equivalent : ```yaml version: '3'
services:
myapp1: image: nginxdemos/hello:plain-text networks: bw-services: aliases: - myapp1 labels: - "bunkerweb.SERVER_NAME=app1.example.com" - "bunkerweb.USE_REVERSE_PROXY=yes" - "bunkerweb.REVERSE_PROXY_URL=/" - "bunkerweb.REVERSE_PROXY_HOST=http://myapp1"
networks: bw-services: external: name: bw-services ```
shell
docker run -d \
--name myapp2 \
--network bw-services \
-l bunkerweb.SERVER_NAME=app2.example.com \
-l bunkerweb.USE_REVERSE_PROXY=yes \
-l bunkerweb.USE_REVERSE_URL=/ \
-l bunkerweb.REVERSE_PROXY_HOST=http://myapp2 \
nginxdemos/hello:plain-text
Here is the docker-compose equivalent : ```yaml version: '3'
services:
myapp2: image: nginxdemos/hello:plain-text networks: bw-services: aliases: - myapp2 labels: - "bunkerweb.SERVER_NAME=app2.example.com" - "bunkerweb.USE_REVERSE_PROXY=yes" - "bunkerweb.REVERSE_PROXY_URL=/" - "bunkerweb.REVERSE_PROXY_HOST=http://myapp2"
networks: bw-services: external: name: bw-services ```
shell
docker run -d \
--name myapp3 \
--network bw-services \
-l bunkerweb.SERVER_NAME=app3.example.com \
-l bunkerweb.USE_REVERSE_PROXY=yes \
-l bunkerweb.USE_REVERSE_URL=/ \
-l bunkerweb.REVERSE_PROXY_HOST=http://myapp3 \
nginxdemos/hello:plain-text
Here is the docker-compose equivalent : ```yaml version: '3'
services:
myapp3: image: nginxdemos/hello:plain-text networks: bw-services: aliases: - myapp3 labels: - "bunkerweb.SERVER_NAME=app3.example.com" - "bunkerweb.USE_REVERSE_PROXY=yes" - "bunkerweb.REVERSE_PROXY_URL=/" - "bunkerweb.REVERSE_PROXY_HOST=http://myapp3"
networks: bw-services: external: name: bw-services ```
We will assume that you already have the Swarm integration stack running on your cluster.
You can instantiate your services and pass the settings as labels :
shell
docker service \
create \
--name myapp1 \
--network bw-services \
-l bunkerweb.SERVER_NAME=app1.example.com \
-l bunkerweb.USE_REVERSE_PROXY=yes \
-l bunkerweb.REVERSE_PROXY_HOST=http://myapp1 \
-l bunkerweb.REVERSE_PROXY_URL=/ \
nginxdemos/hello:plain-text
Here is the docker-compose equivalent (using docker stack deploy) :
```yaml
version: "3"
services:
myapp1: image: nginxdemos/hello:plain-text networks: bw-services: aliases: - myapp1 deploy: placement: constraints: - "node.role==worker" labels: - "bunkerweb.SERVER_NAME=app1.example.com" - "bunkerweb.USE_REVERSE_PROXY=yes" - "bunkerweb.REVERSE_PROXY_URL=/" - "bunkerweb.REVERSE_PROXY_HOST=http://myapp1"
networks: bw-services: external: name: bw-services ```
shell
docker service \
create \
--name myapp2 \
--network bw-services \
-l bunkerweb.SERVER_NAME=app2.example.com \
-l bunkerweb.USE_REVERSE_PROXY=yes \
-l bunkerweb.REVERSE_PROXY_HOST=http://myapp2 \
-l bunkerweb.REVERSE_PROXY_URL=/ \
nginxdemos/hello:plain-text
Here is the docker-compose equivalent (using docker stack deploy) :
```yaml
version: "3"
services:
myapp2: image: nginxdemos/hello:plain-text networks: bw-services: aliases: - myapp2 deploy: placement: constraints: - "node.role==worker" labels: - "bunkerweb.SERVER_NAME=app2.example.com" - "bunkerweb.USE_REVERSE_PROXY=yes" - "bunkerweb.REVERSE_PROXY_URL=/" - "bunkerweb.REVERSE_PROXY_HOST=http://myapp2"
networks: bw-services: external: name: bw-services ```
shell
docker service \
create \
--name myapp3 \
--network bw-services \
-l bunkerweb.SERVER_NAME=app3.example.com \
-l bunkerweb.USE_REVERSE_PROXY=yes \
-l bunkerweb.REVERSE_PROXY_HOST=http://myapp3 \
-l bunkerweb.REVERSE_PROXY_URL=/ \
nginxdemos/hello:plain-text
Here is the docker-compose equivalent (using docker stack deploy) :
```yaml
version: "3"
services:
myapp3: image: nginxdemos/hello:plain-text networks: bw-services: aliases: - myapp3 deploy: placement: constraints: - "node.role==worker" labels: - "bunkerweb.SERVER_NAME=app3.example.com" - "bunkerweb.USE_REVERSE_PROXY=yes" - "bunkerweb.REVERSE_PROXY_URL=/" - "bunkerweb.REVERSE_PROXY_HOST=http://myapp3"
networks: bw-services: external: name: bw-services ```
We will assume that you already have the Kubernetes integration stack running on your cluster.
Let's also assume that you have some typical Deployments with Services to access the web applications from within the cluster :
```yaml apiVersion: apps/v1 kind: Deployment metadata: name: app1 labels: app: app1 spec: replicas: 1 selector: matchLabels: app: app1 template: metadata: labels: app: app1 spec: containers: - name: app1 image: nginxdemos/hello:plain-text ports: - containerPort: 80
apiVersion: v1 kind: Service metadata: name: svc-app1 spec: selector: app: app1 ports: - protocol: TCP port: 80 targetPort: 80 ```
```yaml apiVersion: apps/v1 kind: Deployment metadata: name: app2 labels: app: app2 spec: replicas: 1 selector: matchLabels: app: app2 template: metadata: labels: app: app2 spec: containers: - name: app2 image: nginxdemos/hello:plain-text ports: - containerPort: 80
apiVersion: v1 kind: Service metadata: name: svc-app2 spec: selector: app: app2 ports: - protocol: TCP port: 80 targetPort: 80 ```
```yaml apiVersion: apps/v1 kind: Deployment metadata: name: app3 labels: app: app3 spec: replicas: 1 selector: matchLabels: app: app3 template: metadata: labels: app: app3 spec: containers: - name: app1 image: nginxdemos/hello:plain-text ports: - containerPort: 80
apiVersion: v1 kind: Service metadata: name: svc-app3 spec: selector: app: app3 ports: - protocol: TCP port: 80 targetPort: 80 ```
Here is the corresponding Ingress definition to serve and protect the web applications :
yaml
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
name: ingress
annotations:
bunkerweb.io/AUTOCONF: "yes"
spec:
rules:
- host: app1.example.com
http:
paths:
- path: /
pathType: Prefix
backend:
service:
name: svc-app1
port:
number: 80
- host: app2.example.com
http:
paths:
- path: /
pathType: Prefix
backend:
service:
name: svc-app2
port:
number: 80
- host: app3.example.com
http:
paths:
- path: /
pathType: Prefix
backend:
service:
name: svc-app3
port:
number: 80
We will assume that you already have the Linux integration stack running on your machine.
Let's assume that you have some web applications running on the same machine as BunkerWeb :
The following command will run a basic HTTP server on the port 8001 and deliver the files in the current directory :
shell
python3 -m http.server -b 127.0.0.1 8001
The following command will run a basic HTTP server on the port 8002 and deliver the files in the current directory :
shell
python3 -m http.server -b 127.0.0.1 8002
The following command will run a basic HTTP server on the port 8003 and deliver the files in the current directory :
shell
python3 -m http.server -b 127.0.0.1 8003
Configuration of BunkerWeb is done by editing the /opt/bunkerweb/variables.env file :
conf
SERVER_NAME=app1.example.com app2.example.com app3.example.com
HTTP_PORT=80
HTTPS_PORT=443
DNS_RESOLVERS=8.8.8.8 8.8.4.4
USE_REVERSE_PROXY=yes
REVERSE_PROXY_URL=/
app1.example.com_REVERSE_PROXY_HOST=http://127.0.0.1:8001
app2.example.com_REVERSE_PROXY_HOST=http://127.0.0.1:8002
app3.example.com_REVERSE_PROXY_HOST=http://127.0.0.1:8003
Let's check the status of BunkerWeb :
shell
systemctl status bunkerweb
If it's already running we can just reload it :
shell
systemctl reload bunkerweb
Otherwise, we will need to start it :
shell
systemctl start bunkerweb
Behind load balancer or reverse proxy
When BunkerWeb is itself behind a load balancer or a reverse proxy, you will need to configure it so it can get the real IP address of the clients. If you don't do it, the security features will block the IP address of the load balancer or reverse proxy instead of the client one.
BunkerWeb actually supports two methods to retrieve the real IP address of the client :
- Using the PROXY protocol
- Using a HTTP header like X-Forwarded-For
The following settings can be used :
USE_REAL_IP: enable/disable real IP retrievalUSE_PROXY_PROTOCOL: enable/disable PROXY protocol supportREAL_IP_FROM: list of trusted IP/network address allowed to send us the "real IP"REAL_IP_HEADER: the HTTP header containing the real IP or special value "proxy_protocol" when using PROXY protocol
You will find more settings about real IP in the settings section of the documentation.
HTTP header
We will assume the following regarding the load balancers or reverse proxies (you will need to update the settings depending on your configuration) :
- They use the X-Forwarded-For header to set the real IP
- They have IPs in the 1.2.3.0/24 and 100.64.0.0/16 networks
The following settings need to be set :
conf
USE_REAL_IP=yes
REAL_IP_FROM=1.2.3.0/24 100.64.0.0/16
REAL_IP_HEADER=X-Forwarded-For
When starting the BunkerWeb container, you will need to add the settings :
shell
docker run \
...
-e USE_REAL_IP=yes \
-e "REAL_IP_FROM=1.2.3.0/24 100.64.0.0/16" \
-e REAL_IP_HEADER=X-Forwarded-For \
...
bunkerity/bunkerweb:1.4.0
Here is the docker-compose equivalent :
yaml
mybunker:
image: bunkerity/bunkerweb:1.4.0
...
environment:
- USE_REAL_IP=yes
- REAL_IP_FROM=1.2.3.0/24 100.64.0.0/16
- REAL_IP_HEADER=X-Forwarded-For
...
Before running the Docker autoconf integration stack, you will need to add the settings for the BunkerWeb container :
shell
docker run \
...
-e USE_REAL_IP=yes \
-e "REAL_IP_FROM=1.2.3.0/24 100.64.0.0/16" \
-e REAL_IP_HEADER=X-Forwarded-For \
...
bunkerity/bunkerweb:1.4.0
Here is the docker-compose equivalent :
yaml
mybunker:
image: bunkerity/bunkerweb:1.4.0
...
environment:
- USE_REAL_IP=yes
- REAL_IP_FROM=1.2.3.0/24 100.64.0.0/16
- REAL_IP_HEADER=X-Forwarded-For
...
Before running the Swarm integration stack, you will need to add the settings for the BunkerWeb service :
shell
docker service create \
...
-e USE_REAL_IP=yes \
-e "REAL_IP_FROM=1.2.3.0/24 100.64.0.0/16" \
-e REAL_IP_HEADER=X-Forwarded-For \
...
bunkerity/bunkerweb:1.4.0
Here is the docker-compose equivalent (using docker stack deploy) :
yaml
mybunker:
image: bunkerity/bunkerweb:1.4.0
...
environment:
- USE_REAL_IP=yes
- REAL_IP_FROM=1.2.3.0/24 100.64.0.0/16
- REAL_IP_HEADER=X-Forwarded-For
...
You will need to add the settings to the environment variables of the bunkerweb containers (doing it using the ingress is not supported because you will get into trouble when using things like Let's Encrypt) :
yaml
apiVersion: apps/v1
kind: DaemonSet
metadata:
name: bunkerweb
spec:
selector:
matchLabels:
app: bunkerweb
template:
spec:
containers:
- name: bunkerweb
image: bunkerity/bunkerweb:1.4.0
...
env:
- name: USE_REAL_IP
value: "yes"
- name: REAL_IP_HEADER
value: "X-Forwarded-For"
- name: REAL_IP_FROM
value: "1.2.3.0/24 100.64.0.0/16"
...
You will need to add the settings to the /opt/bunkerweb/variables.env file :
conf
...
USE_REAL_IP=yes
REAL_IP_FROM=1.2.3.0/24 100.64.0.0/16
REAL_IP_HEADER=X-Forwarded-For
...
Don't forget to reload the bunkerweb service once it's done.
Proxy protocol
We will assume the following regarding the load balancers or reverse proxies (you will need to update the settings depending on your configuration) :
- They use the PROXY protocol v1 or v2 to set the real IP
- They have IPs in the 1.2.3.0/24 and 100.64.0.0/16 networks
The following settings need to be set :
conf
USE_REAL_IP=yes
USE_PROXY_PROTOCOL=yes
REAL_IP_FROM=1.2.3.0/24 100.64.0.0/16
REAL_IP_HEADER=proxy_protocol
When starting the BunkerWeb container, you will need to add the settings :
shell
docker run \
...
-e USE_REAL_IP=yes \
-e USE_PROXY_PROTOCOL=yes \
-e "REAL_IP_FROM=1.2.3.0/24 100.64.0.0/16" \
-e REAL_IP_HEADER=proxy_protocol \
...
bunkerity/bunkerweb:1.4.0
Here is the docker-compose equivalent :
yaml
mybunker:
image: bunkerity/bunkerweb:1.4.0
...
environment:
- USE_REAL_IP=yes
- USE_PROXY_PROTOCOL=yes
- REAL_IP_FROM=1.2.3.0/24 100.64.0.0/16
- REAL_IP_HEADER=proxy_protocol
...
Before running the Docker autoconf integration stack, you will need to add the settings for the BunkerWeb container :
shell
docker run \
...
-e USE_REAL_IP=yes \
-e USE_PROXY_PROTOCOL=yes \
-e "REAL_IP_FROM=1.2.3.0/24 100.64.0.0/16" \
-e REAL_IP_HEADER=proxy_protocol \
...
bunkerity/bunkerweb:1.4.0
Here is the docker-compose equivalent :
yaml
mybunker:
image: bunkerity/bunkerweb:1.4.0
...
environment:
- USE_REAL_IP=yes
- USE_PROXY_PROTOCOL=yes
- REAL_IP_FROM=1.2.3.0/24 100.64.0.0/16
- REAL_IP_HEADER=proxy_protocol
...
Before running the Swarm integration stack, you will need to add the settings for the BunkerWeb service :
shell
docker service create \
...
-e USE_REAL_IP=yes \
-e USE_PROXY_PROTOCOL=yes \
-e "REAL_IP_FROM=1.2.3.0/24 100.64.0.0/16" \
-e REAL_IP_HEADER=proxy_protocol \
...
bunkerity/bunkerweb:1.4.0
Here is the docker-compose equivalent (using docker stack deploy) :
yaml
mybunker:
image: bunkerity/bunkerweb:1.4.0
...
environment:
- USE_REAL_IP=yes
- USE_PROXY_PROTOCOL=yes
- REAL_IP_FROM=1.2.3.0/24 100.64.0.0/16
- REAL_IP_HEADER=proxy_protocol
...
You will need to add the settings to the environment variables of the bunkerweb containers (doing it using the ingress is not supported because you will get into trouble when using things like Let's Encrypt) :
yaml
apiVersion: apps/v1
kind: DaemonSet
metadata:
name: bunkerweb
spec:
selector:
matchLabels:
app: bunkerweb
template:
spec:
containers:
- name: bunkerweb
image: bunkerity/bunkerweb:1.4.0
...
env:
- name: USE_REAL_IP
value: "yes"
- name: USE_PROXY_PROTOCOL
value: "yes"
- name: REAL_IP_HEADER
value: "proxy_protocol"
- name: REAL_IP_FROM
value: "1.2.3.0/24 100.64.0.0/16"
...
You will need to add the settings to the /opt/bunkerweb/variables.env file :
conf
...
USE_REAL_IP=yes
USE_PROXY_PROTOCOL=yes
REAL_IP_FROM=1.2.3.0/24 100.64.0.0/16
REAL_IP_HEADER=proxy_protocol
...
Don't forget to reload the bunkerweb service once it's done.
Custom configurations
Because BunkerWeb is based on the NGINX web server, you can add custom NGINX configurations in different NGINX contexts. You can also apply custom configurations for the ModSecurity WAF which is a core component of BunkerWeb (more info here). Here is the list of custom configurations types :
- http : http level of NGINX
- server-http : server level of NGINX
- default-server-http : server level of NGINX (only apply to the "default server" when the name supplied by the client doesn't match any server name in
SERVER_NAME) - modsec-crs : before the OWASP Core Rule Set is loaded
- modsec : after the OWASP Core Rule Set is loaded (also used if CRS is not loaded)
Custom configurations can be applied globally or only for a specific server when applicable and if multisite mode is enabled.
The howto depends on the integration used but under the hood, applying custom configurations is done by adding files ending with the .conf suffix in their name to specific folders. To apply a custom configuration for a specific server, the file is written to a subfolder which is named as the primary server name.
Some integrations offer a more convenient way of applying configurations for example using Configs with Swarm or ConfigMap with Kubernetes.
When using the Docker integration, custom configurations must be written to the volume mounted on /data.
The first thing to do is to create the folders :
shell
mkdir -p ./bw-data/configs/server-http
You can now write your configurations :
shell
echo "location /hello {
default_type 'text/plain';
content_by_lua_block {
ngx.say('world')
}
}" > ./bw-data/configs/server-http/hello-world.conf
Because BunkerWeb runs as an unprivileged user with UID and GID 101, you will need to edit the permissions :
shell
chown -R root:101 bw-data && \
chmod -R 770 bw-data
When starting the BunkerWeb container, you will need to mount the folder on /data :
shell
docker run \
...
-v "${PWD}/bw-data:/data" \
...
bunkerity/bunkerweb:1.4.0
Here is the docker-compose equivalent :
yaml
mybunker:
image: bunkerity/bunkerweb:1.4.0
volumes:
- ./bw-data:/data
...
When using the Docker autoconf integration, custom configurations must be written to the volume mounted on /data.
The first thing to do is to create the folders :
shell
mkdir -p ./bw-data/configs/server-http
You can now write your configurations :
shell
echo "location /hello {
default_type 'text/plain';
content_by_lua_block {
ngx.say('world')
}
}" > ./bw-data/configs/server-http/hello-world.conf
Because BunkerWeb runs as an unprivileged user with UID and GID 101, you will need to edit the permissions :
shell
chown -R root:101 bw-data && \
chmod -R 770 bw-data
When starting the BunkerWeb container, you will need to mount the folder on /data :
shell
docker run \
...
-v "${PWD}/bw-data:/data" \
...
bunkerity/bunkerweb:1.4.0
Here is the docker-compose equivalent :
yaml
mybunker:
image: bunkerity/bunkerweb:1.4.0
volumes:
- ./bw-data:/data
...
When using the Swarm integration, custom configurations are managed using Docker 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.
When creating a Config you will need to add special labels :
- bunkerweb.CONFIG_TYPE : must be set to a valid custom configuration type (http, server-http, default-server-http, modsec or modsec-crs)
- bunkerweb.CONFIG_SITE : set to a server name to apply configuration to that specific server (optional, will be applied globally if unset)
Here is the example :
shell
echo "location /hello {
default_type 'text/plain';
content_by_lua_block {
ngx.say('world')
}
}" | docker config create -l bunkerweb.CONFIG_TYPE=server-http my-config -
There is no update mechanism : the alternative is to remove an existing config using docker config rm and then recreate it.
When using the Kubernetes integration, custom configurations are managed using ConfigMap.
To keep it simple, you don't even need to use the ConfigMap with a Pod (e.g. as environment variable or volume) : the autoconf Pod is listening for ConfigMap events and will update the custom configurations when needed.
When creating a ConfigMap you will need to add special labels :
- bunkerweb.io/CONFIG_TYPE : must be set to a valid custom configuration type (http, server-http, default-server-http, modsec or modsec-crs)
- bunkerweb.io/CONFIG_SITE : set to a server name to apply configuration to that specific server (optional, will be applied globally if unset)
Here is the example :
yaml
apiVersion: v1
kind: ConfigMap
metadata:
name: cfg-bunkerweb-all-server-http
annotations:
bunkerweb.io/CONFIG_TYPE: "server-http"
data:
myconf: |
location /hello {
default_type 'text/plain';
content_by_lua_block {
ngx.say('world')
}
}
When using the Linux integration, custom configurations must be written to the /opt/bunkerweb/configs folder.
Here is an example for server-http/hello-world.conf :
conf
location /hello {
default_type 'text/plain';
content_by_lua_block {
ngx.say('world')
}
}
Because BunkerWeb runs as an unprivileged user (nginx:nginx), you will need to edit the permissions :
shell
chown -R root:nginx /opt/bunkerweb/configs && \
chmod -R 770 /opt/bunkerweb/configs
Don't forget to reload the bunkerweb service once it's done.