✨ Add ban html template (#142)

* ✨ Add ban html template * 📝 Add doc for custom ban page * 🍱 fix Mathieu work * 🍱 fix lint * 🍱 fix lint * 🍱 fix lint * 🍱 fix lint --------- Co-authored-by: Max Lerebourg <maxlerebourg@gmail.com>
2026-07-21 03:28:59 +02:00 · 2024-04-03 17:58:18 +02:00
parent 6059f23dc3
commit 615e7ccf69
13 changed files with 865 additions and 50 deletions
@@ -0,0 +1,47 @@
+# Example
+## Adding a custom ban page
+
+Traefik can return a custom HTML ban page along with the 403 HTTP response code.  
+This can be usefull as some browser (Firefox for instance) return a 403 blank webpage and we can mistake a server/reverse-proxy error with a ban from Crowdsec.  
+
+### Traefik configuration
+
+
+```yaml
+  labels:
+      # Define ban HTML file path
+      - "traefik.http.middlewares.crowdsec.plugin.bouncer.captchaHTMLFilePath=/ban.html"
+```
+
+The ban HTML file must be present in the Traefik container (bind mounted or added during a custom build).  
+It is not directly accessible from Traefik even when importing the plugin, so [download](https://raw.githubusercontent.com/maxlerebourg/crowdsec-bouncer-traefik-plugin/master/ban.html) it locally to expose it to Traefik.
+
+```yaml 
+  ...
+  traefik:
+    image: "traefik:v2.11.0"
+    volumes:
+      - './ban.html:/ban.html'
+  ...
+```
+
+## Exemple navigation
+
+We can try to query normally the whoami server:
+```bash
+curl http://localhost:8000/foo
+```
+
+We can try to ban ourself
+
+```bash
+docker exec crowdsec cscli decisions add --ip 10.0.0.20 -d 4h --type ban
+```
+![image decision ban](image_decision_ban.png)
+
+We will see in the browser the ban custom page:
+
+To play the demo environment run:
+```bash
+make run_custom_ban_page
+```