From 224669599e95b87ec42c30c5cee3ac566d23c93d Mon Sep 17 00:00:00 2001 From: mathieuHa Date: Wed, 28 Sep 2022 21:39:15 +0200 Subject: [PATCH] Updates .traefik with good name parameter (#4) * Update readme, add about sectioj * Update readme about * Change parameter with capitalized letters Co-authored-by: MathieuHa --- .traefik.yml | 2 +- README.md | 15 ++++++++++++++- 2 files changed, 15 insertions(+), 2 deletions(-) diff --git a/.traefik.yml b/.traefik.yml index 3a461fd..8f5f209 100644 --- a/.traefik.yml +++ b/.traefik.yml @@ -10,5 +10,5 @@ testData: crowdsec: bouncer: enabled: true - crowdseclapikey: 40796d93c2958f9e58345514e67740e5 + CrowdsecLapiKey: 40796d93c2958f9e58345514e67740e5 diff --git a/README.md b/README.md index ad1a1ae..46d025f 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,14 @@ # Crowdsec Bouncer Traefik plugin -This plugins aims to implement a Crowdsec Bouncer into a traefik plugin +This plugins aims to implement a Crowdsec Bouncer into a traefik plugin. +> [CrowdSec](https://www.crowdsec.net/) is an open-source and collaborative IPS (Intrusion Prevention System) and a security suite. +> We leverage local behavior analysis and crowd power to build the largest CTI network in the world. ## Usage + ### Configuration For each plugin, the Traefik static configuration must define the module name (as is usual for Go packages). @@ -72,3 +75,13 @@ The source code of the plugin should be organized as follows: ├── readme.md └── vendor/* ``` +### About + +[maxlerebourg](https://github.com/maxlerebourg) and [I](https://github.com/mhanotaux) have been using traefik since 2020. +We come from developper and security engineer background and wanted to add the power of a very promesing technologie (Crowdsec) into the edge router we love. + +We initially run into this project: https://github.com/fbonalair/traefik-crowdsec-bouncer +It was using traefik and forward auth middleware to verify every requests. +They had to go through a webserver which then contacts of another webservice (the crowdsec LAPI) to make a decision based on the source IP. +We initially proposed some improvement by implementing a streaming mode and a local cache +With the Traefik hackathon we deciced to implement our solution directly as a traefik plugin which could be found by every one on plugins.traefik.io and be more performant. \ No newline at end of file