Skip to content

Commit 9fc041d

Browse files
committed
Update Readme with instructions how to use openresty crowdsec bouncer.
1 parent da757f4 commit 9fc041d

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,38 @@
1+
## Note
2+
3+
This fork includes the [OpenResty Crowdsec Bouncer](https://github.com/crowdsecurity/cs-openresty-bouncer) V0.1.0 (Built in)
4+
5+
Please see the [crowdsec_support](https://github.com/LePresidente/docker-nginx-proxy-manager/tree/crowdsec_support) branch for the changes as
6+
7+
Docker images hosted on dockerhub.
8+
www.dockerhub.com/r/lepresidente/nginx-proxy-manager:latest = V0.1.0 (Built in)
9+
www.dockerhub.com/r/lepresidente/nginx-proxy-manager:dev = V0.1.1 (PreRelease) (Built in)
10+
11+
Instructions to use
12+
To enable it you will need to configure Nginx Proxy Manager as Below then do the following
13+
14+
Enable the following environment Variable by setting it to 1.
15+
| Variable | Description | Default |
16+
|----------------|----------------------------------------------|---------|
17+
|`CROWDSEC_BOUNCER`| When set to `1`, Crowdsec bouncer will be enabled. This is needed when you want to block hosts using crowdsec. | `0` |
18+
19+
Starting the container at this point will start Nginx-Proxy-Manager as before but will create a new file in /config/ called crowdsec-openresty-bouncer.conf
20+
21+
You will need to edit this file with at least the following changes
22+
23+
```
24+
API_URL=http://<crowdsecserver>:8080
25+
API_KEY=<APIKEY>
26+
```
27+
28+
the crowdsec api key can be generated on the crowdsec instance using the following command
29+
30+
```
31+
cscli bouncers add npm-proxy
32+
```
33+
34+
Currently this is a side project and I will try keep this up to date
35+
136
# Docker container for Nginx Proxy Manager
237
[![Docker Image Size](https://img.shields.io/docker/image-size/jlesage/nginx-proxy-manager/latest)](https://hub.docker.com/r/jlesage/nginx-proxy-manager/tags) [![Build Status](https://drone.le-sage.com/api/badges/jlesage/docker-nginx-proxy-manager/status.svg)](https://drone.le-sage.com/jlesage/docker-nginx-proxy-manager) [![GitHub Release](https://img.shields.io/github/release/jlesage/docker-nginx-proxy-manager.svg)](https://github.com/jlesage/docker-nginx-proxy-manager/releases/latest) [![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://paypal.me/JocelynLeSage/0usd)
338

0 commit comments

Comments
 (0)