thespad/traefik-crowdsec-bouncer repository overview

⁠thespad/traefik-crowdsec-bouncer⁠

traefik-crowdsec-bouncer⁠ is an HTTP service to verify requests and bounce them according to decisions made by CrowdSec. Fork of https://github.com/fbonalair/traefik-crowdsec-bouncer⁠ with extra features.

⁠Supported Architectures

Our images support multiple architectures such as x86-64, arm64 and armhf.

Simply pulling ghcr.io/thespad/traefik-crowdsec-bouncer should retrieve the correct image for your arch.

The architectures supported by this image are:

⁠Application Setup

1. Get a bouncer API key from CrowdSec with command docker exec -t crowdsec cscli bouncers add bouncer-traefik
2. Copy the API key printed. You WON'T be able the get it again.
3. Paste this API key as the value for bouncer environment variable CROWDSEC_BOUNCER_API_KEY, or use an .env file.
4. Set the other environment variables as required (see below for details).
5. Start bouncer.
6. Visit a site proxied by Traefik and confirm you can access it.
7. In another console, ban your IP with command docker exec crowdsec cscli decisions add --ip <your ip> -R "Test Ban", modify the IP with your address.
8. Visit the site again, in your browser you will see "Forbidden" since this time since you've been banned.
9. Unban yourself with docker exec crowdsec cscli decisions delete --ip <your IP>
10. Visit the site one last time, you will have access to the site again.

⁠Traefik Setup

Create a Forward Auth middleware, i.e.

    middleware-crowdsec-bouncer:
      forwardauth:
        address: http://traefik-crowdsec-bouncer:8080/api/v1/forwardAuth
        trustForwardHeader: true

Then apply it either to individual containers you wish to protect or as a default middlware on the Traefik listener.

⁠Usage

Here are some example snippets to help you get started creating a container.

⁠docker-compose (recommended⁠)

Compatible with docker-compose v2 schemas.

---
version: "2.1"
services:
  traefik-crowdsec-bouncer:
    image: ghcr.io/thespad/traefik-crowdsec-bouncer
    container_name: traefik-crowdsec-bouncer
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Europe/London
      - CROWDSEC_BOUNCER_API_KEY=${TRAEFIK_BOUNCER_KEY}
      - CROWDSEC_AGENT_HOST=crowdsec:8080
      - CROWDSEC_BOUNCER_SCHEME=http #Optional
      - TRUSTED_PROXIES=0.0.0.0/0 #Optional
      - PORT=8080 #Optional
      - CROWDSEC_BOUNCER_LOG_LEVEL=1 #Optional
      - GIN_MODE=release #Optional
      - CROWDSEC_BOUNCER_SKIPRFC1918=true #Optional
      - CROWDSEC_BOUNCER_REDIRECT= #Optional
      - CROWDSEC_BOUNCER_CLOUDFLARE=false #Optional
    ports:
      - 8080:8080
    restart: unless-stopped

⁠docker cli

docker run -d \
  --name=traefik-crowdsec-bouncer \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZEurope/London \
  -e CROWDSEC_BOUNCER_API_KEY=${TRAEFIK_BOUNCER_KEY} \
  -e CROWDSEC_AGENT_HOST=crowdsec:8080 \
  -e CROWDSEC_BOUNCER_SCHEME=http `#optional` \
  -e TRUSTED_PROXIES=0.0.0.0/0 `#optional` \
  -e PORT=8080 `#optional` \
  -e CROWDSEC_BOUNCER_LOG_LEVEL=1 `#optional` \
  -e GIN_MODE=release `#optional` \
  -e CROWDSEC_BOUNCER_SKIPRFC1918=true `#optional` \
  -e CROWDSEC_BOUNCER_REDIRECT= `#optional` \
  -e CROWDSEC_BOUNCER_CLOUDFLARE=false `#optional` \
  -p 8080:8080 \
  --restart unless-stopped \
  ghcr.io/thespad/traefik-crowdsec-bouncer

⁠Parameters

Container images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.

⁠Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.

As an example:

-e FILE__PASSWORD=/run/secrets/mysecretpassword

Will set the environment variable PASSWORD based on the contents of the /run/secrets/mysecretpassword file.

⁠Umask for running applications

For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022 setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here⁠ before asking for support.

⁠User / Group Identifiers

When using volumes (-v flags) permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID and group PGID.

Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.

In this instance PUID=1000 and PGID=1000, to find yours use id user as below:

  $ id username
    uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)

⁠Support Info

• Shell access whilst the container is running: docker exec -it traefik-crowdsec-bouncer /bin/bash
• To monitor the logs of the container in realtime: docker logs -f traefik-crowdsec-bouncer

⁠Updating Info

Most of our images are static, versioned, and require an image update and container recreation to update the app inside. We do not recommend or support updating apps inside the container. Please consult the Application Setup⁠ section above to see if it is recommended for the image.

Below are the instructions for updating containers:

⁠Via Docker Compose

• Update all images: docker-compose pull
  • or update a single image: docker-compose pull traefik-crowdsec-bouncer
• Let compose update all containers as necessary: docker-compose up -d
  • or update a single container: docker-compose up -d traefik-crowdsec-bouncer
• You can also remove the old dangling images: docker image prune

⁠Via Docker Run

• Update the image: docker pull ghcr.io/thespad/traefik-crowdsec-bouncer
• Stop the running container: docker stop traefik-crowdsec-bouncer
• Delete the container: docker rm traefik-crowdsec-bouncer
• Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your /config folder and settings will be preserved)
• You can also remove the old dangling images: docker image prune

⁠Image Update Notifications - Diun (Docker Image Update Notifier)

• We recommend Diun⁠ for update notifications. Other tools that automatically update containers unattended are not recommended or supported.

⁠Building locally

If you want to make local modifications to these images for development purposes or just to customize the logic:

git clone https://github.com/thespad/docker-traefik-crowdsec-bouncer.git
cd docker-traefik-crowdsec-bouncer
docker build \
  --no-cache \
  --pull \
  -t ghcr.io/thespad/traefik-crowdsec-bouncer:latest .

⁠Versions

• 14.05.23: - Rebase to Alpine 3.18. Drop support for armhf.
• 02.05.23: - Bump Go to 1.20 for build stage.
• 01.05.23: - Update deps.
• 01.05.23: - Restructure repo.
• 26.04.23: - Support CF forwarded IP headers.
• 15.02.22: - Initial Release.