Skip to content

Commit 268945d

Browse files
committed
Merge branch 'master' of https://github.com/LePresidente/docker-nginx-proxy-manager into crowdsec_rework
2 parents c86c986 + efb1281 commit 268945d

File tree

1 file changed

+47
-0
lines changed

1 file changed

+47
-0
lines changed

README.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,50 @@
1+
## Note
2+
3+
This is a drop in replacement for [jlesage/nginx-proxy-manager](https://hub.docker.com/r/jlesage/nginx-proxy-manager)
4+
5+
This fork includes the [OpenResty Crowdsec Bouncer](https://github.com/crowdsecurity/cs-openresty-bouncer)
6+
7+
Please see the [crowdsec_support](https://github.com/LePresidente/docker-nginx-proxy-manager/tree/crowdsec_support) branch for the changes as
8+
9+
Docker images hosted on dockerhub.
10+
11+
https://hub.docker.com/r/lepresidente/nginx-proxy-manager
12+
13+
| TAG | cs-openresty-bouncer version|
14+
|-----------|-----------------------------|
15+
| latest | 0.1.0 |
16+
| dev | 0.1.1 (PreRelease) |
17+
18+
###Known Issues:
19+
20+
0.1.0:
21+
[logs spammed with errors regarding the use of variable ('err')](https://github.com/crowdsecurity/cs-openresty-bouncer/issues/15)
22+
23+
Instructions to use:
24+
To enable it you will need to configure Nginx Proxy Manager as Below then do the following
25+
26+
Enable the following environment Variable by setting it to 1.
27+
| Variable | Description | Default |
28+
|----------------|----------------------------------------------|---------|
29+
|`CROWDSEC_BOUNCER`| When set to `1`, Crowdsec bouncer will be enabled. This is needed when you want to block hosts using crowdsec. | `0` |
30+
31+
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
32+
33+
You will need to edit this file with at least the following changes
34+
35+
```
36+
API_URL=http://<crowdsecserver>:8080
37+
API_KEY=<APIKEY>
38+
```
39+
40+
the crowdsec api key can be generated on the crowdsec instance using the following command
41+
42+
```
43+
cscli bouncers add npm-proxy
44+
```
45+
46+
Currently this is a side project and I will try keep this up to date
47+
148
# Docker container for Nginx Proxy Manager
249
[![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)
350

0 commit comments

Comments
 (0)