Skip to content

Latest commit

 

History

History
141 lines (98 loc) · 7.37 KB

crowdsec.md

File metadata and controls

141 lines (98 loc) · 7.37 KB

Title: Module crowdsec - Caddy Documentation

URL Source: https://caddyserver.com/docs/modules/crowdsec

Markdown Content: Module crowdsec - Caddy Documentation

===============

Image 1: Caddy

Documentation

a Image 2 project

Search K

DownloadDocumentationForumGitHubAccountSupportSponsor

All Modules

This page lists all registered Caddy modules. Modules are plugins which extend Caddy's JSON configuration structure.

We recommend using your browser's "Find in page" feature for quick lookups.

Module ID Description

Module crowdsec

There is more than one module named Module crowdsec. Choose one by its repository.

This module does not come with Caddy. It can be added by using xcaddy or our download page. Non-standard modules may be developed by the community and are not officially endorsed or maintained by the Caddy project. The documentation is shown here only as a courtesy.

Code repository:

Custom builds:xcaddy build --with

Description🔗

Field List

▸github.com/hslatman/caddy-crowdsec-bouncer

{▾ "api_key": "", "api_url": "", "ticker_interval": "", "enable_streaming": false, "enable_hard_fails": false}

Non-standardThis module does not come with Caddy. It can be added by using xcaddy or our download page. Non-standard modules may be developed by the community and are not officially endorsed or maintained by the Caddy project. The documentation is shown here only as a courtesy.

Code repository: https://github.com/hslatman/caddy-crowdsec-bouncer

Custom builds:xcaddy build --with github.com/hslatman/caddy-crowdsec-bouncer/crowdsec

Description🔗

crowdsec is a Caddy App that functions as a CrowdSec bouncer. It acts as a CrowdSec API client as well as a local cache for CrowdSec decisions, which can be used by the HTTP handler and Layer4 matcher to decide if a request or connection is allowed or not.

Field List

🔗api_key APIKey for the CrowdSec Local API

🔗api_url APIUrl for the CrowdSec Local API. Defaults to http://127.0.0.1:8080/

🔗ticker_interval TickerInterval is the interval the StreamBouncer uses for querying the CrowdSec Local API. Defaults to "10s".

🔗enable_streaming EnableStreaming indicates whether the StreamBouncer should be used. If it's false, the LiveBouncer is used. The StreamBouncer keeps CrowdSec decisions in memory, resulting in quicker lookups. The LiveBouncer will perform an API call to your CrowdSec instance. Defaults to true.

🔗enable_hard_fails EnableHardFails indicates whether calls to the CrowdSec API should result in hard failures, resulting in Caddy quitting vs. Caddy continuing operation (with a chance of not performing) validations. Defaults to false.

Fulfilled by modules in namespace:

This property is required because it specifies the module name.

Image 5: Caddy An open source Go community project

in partnership with Ardan Labs

Privacy-respecting analytics by Fathom

© 2025 ZeroSSL. All rights reserved.

Caddy® is a registered trademark of ZeroSSL GmbH.