Skip to content

Commit 3998708

Browse files
rr404jdv
andauthored
mini update to cfworker doc to introduce BLaaS (#689)
Co-authored-by: jdv <[email protected]>
1 parent 18bd9fe commit 3998708

File tree

2 files changed

+13
-2
lines changed

2 files changed

+13
-2
lines changed
101 KB
Loading

crowdsec-docs/unversioned/bouncers/cloudflare-workers.mdx

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,16 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
2323
&#128172; <a href="https://discourse.crowdsec.net">Discourse </a>
2424
</p>
2525

26+
This **Remediation Component** (aka Bouncer) deploys a **Cloudflare Worker** in front of a **Cloudflare Zone/Website**, which checks if incoming request's IP address/Country/AS is present in a KV store and takes necessary remedial actions.
27+
It also periodically updates the KV store with IPs coming from your **CrowdSec Security Engine** OR a **Blocklist as a Service Integration**for Remediation components.
28+
29+
Useful links:
30+
* **Register** this **remediation component** into your **Security engine**: [Here](/u/bouncers/intro).
31+
* To setup a **Blocklist as a Service** endpoint for a **remediation component**: [Here](/u/integrations/remediationcomponent).
32+
33+
The following documentation dives into the installation, configuration, and troubleshooting of the **CrowdSec Cloudflare Worker** Remediation Component.
34+
35+
![cloudflare-worker remediation component global view](/img/bouncer/cloudflare-worker/cfworker_global_schema.png)
2636

2737
:::warning
2838
This Remediation Component heavily relies on Cloudflare Workers and KV store. It works best on a paid Workers subscription.
@@ -33,7 +43,6 @@ More explanation in the chapter [Test with Cloudflare free plan](#appendix-test-
3343
After configuring and starting the Remediation Component, please see the [setting up worker fail mode](#setting-up-the-worker-route-fail-mode) section.
3444
:::
3545

36-
This Remediation Component (aka Bouncer) deploys a Cloudflare Worker in front of a Cloudflare Zone/Website, which checks if incoming request's IP address/Country/AS is present in a KV store and takes necessary remedial actions. It also periodically updates the KV store with CrowdSec LAPI's decisions.
3746

3847
## Installation
3948

@@ -130,14 +139,16 @@ sudo systemctl start crowdsec-cloudflare-worker-bouncer
130139

131140
## How it works
132141

142+
*Note that in the following Schema, a Blocklist as a Service Integration can be substituted to the Security Engine.*
143+
133144
![Architecture](/img/bouncer/cloudflare-worker/cfworkerarch.png)
134145

135146
The Remediation Component does the following:
136147

137148
1. Create a Cloudflare Worker and a Worker KV per configured account.
138149
2. Create a Worker Route(s) per configured zone. Any request matching the route would be handled by the worker.
139150
3. For every matching incoming request, the worker checks whether it's IP, Country and AS have a decision against. It checks for this in it's KV store. If found it performs the corresponding remediation.
140-
4. The Remediation Component also periodically updates the KV store with the latest decisions from CrowdSec.
151+
4. The Remediation Component also periodically updates the KV store with the latest decisions from CrowdSec's **Security Engine** OR **Blocklist Integration**.
141152

142153
If your Cloudflare token has permission on D1, the remediation component will also automatically create a database to track:
143154
- Number of requests processed

0 commit comments

Comments
 (0)