zoraxy-crowdsec-bouncer

Zoraxy Reverse Proxy mit vorinstalliertem CrowdSec Bouncer Plugin – fertig für Unraid und Docker.

Inhaltsverzeichnis / Table of Contents

• 🇩🇪 Deutsch
  • CrowdSec auf Unraid einrichten
• 🇬🇧 English
  • Set up CrowdSec on Unraid
• Credits & Lizenzen

🇩🇪 Deutsch

Was ist das?

Dieses Docker-Image kombiniert Zoraxy – einen modernen HTTP Reverse Proxy – mit dem CrowdSec Bouncer Plugin, welches bösartige IPs automatisch blockiert.

Das Plugin ist bereits vorinstalliert – du musst nichts manuell herunterladen.

Die Plugin-config.yaml wird beim Container-Start aus den Umgebungsvariablen erzeugt – du trägst API Key und LAPI-URL in den Unraid-Einstellungen ein, ohne die Datei manuell zu bearbeiten.

CrowdSec selbst ist nicht enthalten – du benötigst eine separate CrowdSec-Instanz (z.B. als eigener Docker-Container).

Enthaltene Komponenten

Umgebungsvariablen

Diese Werte trägst du direkt in Unraid (oder docker-compose) ein – die config.yaml wird beim ersten Start automatisch daraus erstellt.

💡 Die Plugin-config.yaml wird bei jedem Start aus den Container-Variablen geschrieben. Manuelle Änderungen an der Datei werden beim nächsten Neustart überschrieben – Werte also lieber in Unraid unter den Umgebungsvariablen pflegen.

Ports

Volumes / Pfade

Unraid Installation

Methode 1 – Über Community Applications (empfohlen)

1. Öffne Community Applications in Unraid
2. Suche nach zoraxy-crowdsec-bouncer
3. Klicke Install
4. Passe die Einstellungen wie unten beschrieben an

Methode 2 – Template manuell hinzufügen

1. Gehe in Unraid zu Docker → Add Container
2. Scrolle ganz unten zu Template URL und füge ein:

   https://raw.githubusercontent.com/kabelsalatundklartext/zoraxy-crowdsec-bouncer/main/zoraxy-crowdsec-bouncer.xml
   

3. Klicke Load – das Template wird automatisch befüllt

Unraid Einstellungen

Pflichtfelder (immer sichtbar)

Erweiterte Felder (unter "Advanced")

Ports anpassen

Falls Port 80 oder 443 bereits belegt sind:

⚠️ Ändere nur den linken Wert (Host-Port), nicht den rechten (Container-Port)!

Pfade anpassen

💡 Tipp: Nutze /mnt/cache/appdata/ wenn du eine SSD als Cache-Laufwerk hast – das ist schneller.

CrowdSec auf Unraid einrichten (Voraussetzung)

Dieses Image enthält nur den Bouncer in Zoraxy – CrowdSec selbst installierst du separat. Ohne CrowdSec erkennt das System keine neuen Angreifer; der Bouncer blockiert nur IPs, die CrowdSec bereits in der LAPI kennt.

Kurzüberblick – so hängt alles zusammen:

1. CrowdSec-Container (Community Applications) installieren
2. Zoraxy-Logs in CrowdSec einbinden (acquis.yaml + Volume)
3. Zoraxy-Collection im Hub installieren (Parser für type: zoraxy)
4. Bouncer anlegen → API-Key ins Zoraxy-Image
5. Zoraxy-Container: LAPI-URL + Plugin + Tags (siehe unten)

📖 CrowdSec-Unraid-Template (IBRACORP): docs.ibracorp.io · Zoraxy-Diskussion: tobychui/zoraxy#338

Schritt 1 – CrowdSec aus Community Applications

1. In Unraid Community Applications öffnen
2. Nach crowdsec suchen (Entwickler: crowdsecurity, Maintainer z. B. IBRACORP)
3. Container installieren und starten
4. Merken: Container-Name (oft crowdsec) und wo die Config auf dem Host liegt (z. B. /mnt/user/Docker/crowdsec/ oder /mnt/user/appdata/crowdsec/)

Die LAPI ist standardmäßig unter Port 8080 erreichbar.

Schritt 2 – Zoraxy-Logs für CrowdSec freigeben

CrowdSec muss die Zoraxy-Access-Logs lesen (zr_*.log, monatliches Rollover). Dafür brauchst du zwei Dinge: ein Volume im CrowdSec-Container und eine acquis.yaml.

Volume im CrowdSec-Container (Unraid)

Im CrowdSec-Container Path hinzufügen (Werte an dein Setup anpassen):

Host-Pfad finden: Dort liegen die Dateien zr_*.log – oft unter dem Zoraxy-Config-Volume in einem Unterordner log/. Wenn dein Config-Pfad abweicht, den Ordner mit den zr_*.log auf dem Host wählen.

Beispiel aus einem funktionierenden Setup: Host-Config unter /mnt/user/Docker/crowdsec/, Zoraxy-Logs vom Config-Volume nach /var/log/zoraxy im CrowdSec-Container gemountet.

acquis.yaml anlegen

Datei auf dem Host im CrowdSec-Config-Ordner, z. B.:

/mnt/user/Docker/crowdsec/acquis.yaml

(bzw. wo dein Template /etc/crowdsec mapped – Pfad anpassen)

Inhalt:

---
filenames:
  - "/var/log/zoraxy/zr_*.log"   ## Alle Zoraxy-Logs (monatliches Rollover)
labels:
  type: "zoraxy"                ## Muss zum installierten Parser passen

Der Pfad in filenames ist der Pfad im CrowdSec-Container (also /var/log/zoraxy/...), nicht der Unraid-Host-Pfad.

Manche Setups nutzen statt einer einzelnen acquis.yaml Dateien unter /etc/crowdsec/acquis.d/ – dann dieselbe Konfiguration z. B. als zoraxy.yaml dort ablegen.

CrowdSec-Container danach neu starten.

Schritt 3 – Zoraxy-Collection (Parser) installieren

Damit CrowdSec die Logs auswerten kann, die Collection mit Zoraxy-Parser installieren:

docker exec -it crowdsec cscli collections install raithmir/zoraxy-logs

Hub-Übersicht: Raithmir – zoraxy collection

Optional prüfen:

docker exec -it crowdsec cscli collections list
docker exec -it crowdsec cscli metrics

Schritt 4 – Netzwerk: Zoraxy ↔ CrowdSec LAPI

Der Zoraxy-Container muss die CrowdSec-LAPI erreichen (Port 8080).

Option A – Gleiches benutzerdefiniertes Docker-Netzwerk (empfohlen)
Beide Container im selben Custom Network; dann z. B.:

CROWDSEC_AGENT_URL=http://crowdsec:8080

(crowdsec = Container-Name von CrowdSec)

Option B – Bridge / unterschiedliche Netzwerke
IP des Unraid-Hosts oder des CrowdSec-Containers verwenden, z. B.:

CROWDSEC_AGENT_URL=http://192.168.1.10:8080

Schritt 5 – Bouncer anlegen & Zoraxy verbinden

Bouncer in CrowdSec registrieren (Name frei wählbar):

docker exec -it crowdsec cscli bouncers add zoraxy-bouncer

Den angezeigten API-Key kopieren und im Zoraxy-CrowdSec-Bouncer-Container eintragen:

• CrowdSec API Key = der Key von oben
• CrowdSec Agent URL = LAPI-URL aus Schritt 4

Danach Zoraxy-Container neu starten.

Schritt 6 – Prüfen ob die Kette funktioniert

# Bouncer registriert?
docker exec -it crowdsec cscli bouncers list

# Kommen Entscheidungen an? (nach etwas Traffic über Zoraxy)
docker exec -it crowdsec cscli decisions list

# Laufen Metriken / Parser?
docker exec -it crowdsec cscli metrics

Wenn decisions list leer bleibt: zuerst Logs (acquis.yaml, Volume, zr_*.log-Pfad) und Collection prüfen – ohne Logs keine neuen Bans.

CrowdSec API Key holen

Führe diesen Befehl in deinem CrowdSec-Container aus:

docker exec -it crowdsec cscli bouncers add zoraxy-bouncer

Den angezeigten Key kopieren und in das Feld CrowdSec API Key in Unraid eintragen.

Plugin in Zoraxy aktivieren

Nach dem ersten Start:

1. Öffne die Zoraxy WebUI: http://DEINE-UNRAID-IP:8000
2. Gehe zu Plugins – der CrowdSec Bouncer sollte erscheinen → Aktivieren
3. Gehe zu Tags → Neuen Tag erstellen (z.B. crowdsec-protected)
4. Tag bei allen Proxy-Regeln hinzufügen, die du schützen möchtest

Häufige Probleme

Plugin erscheint nicht in der WebUI → Prüfe ob der Plugin-Pfad korrekt gemountet ist → Starte den Container neu

config.yaml hat falschen API Key → Datei löschen unter /mnt/user/appdata/zoraxy/plugin/zoraxycrowdsecbouncer/config.yaml → Container neu starten – sie wird neu erstellt mit den aktuellen Variablen

CrowdSec API nicht erreichbar → Stelle sicher dass Zoraxy und CrowdSec im selben Docker-Netzwerk sind → Alternativ die direkte IP verwenden: http://192.168.1.xxx:8080

Keine Bans / leere cscli decisions list → Zoraxy-Logs in CrowdSec gemountet? (/var/log/zoraxy/zr_*.log im Container sichtbar?) → acquis.yaml mit type: zoraxy vorhanden? → cscli collections install raithmir/zoraxy-logs ausgeführt? → Traffic läuft über Zoraxy-Proxy-Regeln mit aktiviertem Plugin-Tag?

Port bereits belegt → Ändere den Host-Port in den Unraid Container-Einstellungen (nur den linken Wert!)

🇬🇧 English

What is this?

This Docker image combines Zoraxy – a modern HTTP reverse proxy – with the CrowdSec Bouncer Plugin, which automatically blocks malicious IPs.

The plugin is pre-installed – no manual download required.

The plugin config.yaml is generated on container start from environment variables – enter your CrowdSec API key and LAPI URL in Unraid, no manual file editing required.

CrowdSec itself is not included – you need a separate CrowdSec instance (e.g. as its own Docker container).

Included Components

Environment Variables

Enter these values directly in Unraid (or docker-compose) – the config.yaml is created automatically on first start.

💡 The plugin config.yaml is rewritten on every container start from the environment variables. Edit values in Unraid rather than hand-editing the file.

Ports

Volumes / Paths

Unraid Installation

Method 1 – Via Community Applications (recommended)

1. Open Community Applications in Unraid
2. Search for zoraxy-crowdsec-bouncer
3. Click Install
4. Adjust the settings as described below

Method 2 – Add template manually

1. Go to Unraid Docker → Add Container
2. Scroll to the bottom and find Template URL, paste:

   https://raw.githubusercontent.com/kabelsalatundklartext/zoraxy-crowdsec-bouncer/main/zoraxy-crowdsec-bouncer.xml
   

3. Click Load – the template fills in automatically

Unraid Settings

Required fields (always visible)

Advanced fields (under "Advanced")

Changing Ports

If port 80 or 443 are already in use:

⚠️ Only change the left value (host port), not the right one (container port)!

Changing Paths

💡 Tip: Use /mnt/cache/appdata/ if you have an SSD as cache drive – it's faster.

Set up CrowdSec on Unraid (prerequisite)

This image only ships the bouncer inside Zoraxy. You must run CrowdSec separately. Without CrowdSec analyzing traffic, the bouncer can only block IPs CrowdSec already knows via the LAPI.

Overview – how the pieces fit together:

1. Install the CrowdSec container (Community Applications)
2. Feed Zoraxy logs into CrowdSec (acquis.yaml + volume mount)
3. Install the Zoraxy collection from the Hub (parser for type: zoraxy)
4. Create a bouncer → paste API key into this Zoraxy image
5. Zoraxy container: LAPI URL + plugin + tags (see below)

📖 CrowdSec on Unraid (IBRACORP template): docs.ibracorp.io · Zoraxy thread: tobychui/zoraxy#338

Step 1 – CrowdSec from Community Applications

1. Open Community Applications on Unraid
2. Search for crowdsec (publisher crowdsecurity, maintainer e.g. IBRACORP)
3. Install and start the container
4. Note the container name (often crowdsec) and host config path (e.g. /mnt/user/Docker/crowdsec/ or /mnt/user/appdata/crowdsec/)

LAPI is usually on port 8080.

Step 2 – Expose Zoraxy logs to CrowdSec

CrowdSec must read Zoraxy access logs (zr_*.log, monthly rollover). You need a volume mount on the CrowdSec container and an acquis.yaml.

Volume on the CrowdSec container (Unraid)

Add a Path mapping (adjust to your layout):

Find the host path: use the directory that contains zr_*.log files—often under the Zoraxy config volume in a log/ subfolder.

Create acquis.yaml

On the host in your CrowdSec config folder, e.g.:

/mnt/user/Docker/crowdsec/acquis.yaml

(match wherever your template maps /etc/crowdsec)

Content:

---
filenames:
  - "/var/log/zoraxy/zr_*.log"   ## All Zoraxy logs (monthly rollover)
labels:
  type: "zoraxy"                  ## Must match the installed parser

Paths in filenames are inside the CrowdSec container (/var/log/zoraxy/...), not the Unraid host path.

Some setups use /etc/crowdsec/acquis.d/ instead—same YAML as e.g. zoraxy.yaml there.

Restart the CrowdSec container after changes.

Step 3 – Install Zoraxy collection (parser)

docker exec -it crowdsec cscli collections install raithmir/zoraxy-logs

Hub: Raithmir – zoraxy collection

Optional checks:

docker exec -it crowdsec cscli collections list
docker exec -it crowdsec cscli metrics

Step 4 – Network: Zoraxy ↔ CrowdSec LAPI

The Zoraxy container must reach CrowdSec LAPI (port 8080).

Option A – Same custom Docker network (recommended)
Both containers on one network; then e.g.:

CROWDSEC_AGENT_URL=http://crowdsec:8080

(crowdsec = your CrowdSec container name)

Option B – Bridge / different networks
Use the Unraid host IP or CrowdSec container IP, e.g.:

CROWDSEC_AGENT_URL=http://192.168.1.10:8080

Step 5 – Create bouncer & connect Zoraxy

docker exec -it crowdsec cscli bouncers add zoraxy-bouncer

Copy the API key into the Zoraxy-CrowdSec-Bouncer container:

• CrowdSec API Key = key from above
• CrowdSec Agent URL = LAPI URL from step 4

Restart the Zoraxy container.

Step 6 – Verify the pipeline

docker exec -it crowdsec cscli bouncers list
docker exec -it crowdsec cscli decisions list
docker exec -it crowdsec cscli metrics

If decisions list stays empty, fix logs first (acquis.yaml, volume, zr_*.log path) and the collection—no logs means no new bans.

Getting the CrowdSec API Key

Run this command in your CrowdSec container:

docker exec -it crowdsec cscli bouncers add zoraxy-bouncer

Copy the displayed key and paste it into the CrowdSec API Key field in Unraid.

Activating the Plugin in Zoraxy

After the first start:

1. Open Zoraxy WebUI: http://YOUR-UNRAID-IP:8000
2. Go to Plugins – the CrowdSec Bouncer should appear → Activate
3. Go to Tags → Create a new tag (e.g. crowdsec-protected)
4. Add the tag to all proxy rules you want to protect

Troubleshooting

Plugin not showing in WebUI → Check if the plugin path is correctly mounted → Restart the container

config.yaml has wrong API key → Delete the file at /mnt/user/appdata/zoraxy/plugin/zoraxycrowdsecbouncer/config.yaml → Restart the container – it will be recreated with the current variables

CrowdSec API not reachable → Make sure Zoraxy and CrowdSec are in the same Docker network → Alternatively use the direct IP: http://192.168.1.xxx:8080

No bans / empty cscli decisions list → Are Zoraxy logs mounted into CrowdSec? (/var/log/zoraxy/zr_*.log visible in the container?) → acquis.yaml with type: zoraxy present? → Ran cscli collections install raithmir/zoraxy-logs? → Traffic goes through Zoraxy proxy rules with the plugin tag enabled?

Port already in use → Change the host port in the Unraid container settings (left value only!)

docker-compose (local testing)

services:
  zoraxy:
    image: ghcr.io/kabelsalatundklartext/zoraxy-crowdsec-bouncer:latest
    container_name: zoraxy
    restart: unless-stopped
    ports:
      - "80:80"
      - "443:443"
      - "8000:8000"
    volumes:
      - ./config:/opt/zoraxy/config/
      - ./plugin:/opt/zoraxy/plugin/
      - /var/run/docker.sock:/var/run/docker.sock
      - /etc/localtime:/etc/localtime
    extra_hosts:
      - "host.docker.internal:host-gateway"
    environment:
      - CROWDSEC_API_KEY=DEIN_API_KEY
      - CROWDSEC_AGENT_URL=http://crowdsec:8080
      - CROWDSEC_LOG_LEVEL=warning
      - CROWDSEC_CLOUDFLARE=false
      - FASTGEOIP=true
      - DOCKER=true

Credits & Lizenzen / Licenses

Dieses Projekt verwendet folgende Open-Source-Software / This project uses the following open source software:

MIT License – zoraxy_crowdsec_bouncer Copyright (c) 2025 Anthony Rubick

Dieses Docker-Image / Template wird unabhängig gepflegt und ist nicht mit den oben genannten Projekten affiliiert. This Docker image / template is independently maintained and is not affiliated with the projects listed above.