Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update blocklist documentation #701

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions crowdsec-docs/sidebarsUnversioned.js
Original file line number Diff line number Diff line change
Expand Up @@ -351,6 +351,11 @@ module.exports = {
id: "blocklists/getting_started",
label: "Getting Started",
},
{
type: "doc",
label: "Featured",
id: "console/blocklists/featured",
},
{
type: "doc",
label: "Catalog",
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified crowdsec-docs/static/img/console/blocklists/catalog.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
30 changes: 24 additions & 6 deletions crowdsec-docs/unversioned/console/blocklists/catalog.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,35 @@
# Blocklists catalog

To provide blocklists tailored to each need, CrowdSec has a wide catalog of blocklists, encompassing a variety of threat types and sources. This diversity allows to select and implement blocklists that best match their specific security requirements.
The search page in the CrowdSec Console provides a centralized interface to explore, subscribe, and manage blocklists tailored to enhance your organization’s security posture. This page allows to browse all available blocklists, find the ones most relevant to your needs, and activate them to protect your infrastructure.


![](/img/console/blocklists/catalog.png)

The catalog is split into two distinct sections:
The page is divided into several key sections, each serving a distinct purpose to simplify the process of managing blocklists:

**Top Section: Available Subscription Types Overview**
This section displays the number of subscriptions remaining for the organization under each tier.

![](/img/console/blocklists/blocklist-quotas.png)


**Left Panel: Blocklist Search and Filters**
The left-hand panel is dedicated to the search engine, which allows you to efficiently browse and filter blocklists based on specific criteria.
Using these filters helps you quickly locate blocklists that match your organization’s specific requirements.
<div style={{textAlign:'center'}}>
<img src="/img/console/blocklists/blocklist-search-filters.png" alt="Alt text for the image" width="200" height="400" />
</div>



* **The list of blocklists already installed on your infrastructure.**
**Main Section: Blocklist Results**
The central area displays the blocklist results based on your search and filters. Each blocklist card provides key details.

To review the infrastructure status at a glance, In the lower part of each item are listed the Security Engines subscribed to this blocklist, and the type of remediation applied to the IPs.
You can also toggle between Expanded Mode and Condensed Mode.

![](/img/console/blocklists/catalog_item_point_se_tag.png)
![](/img/console/blocklists/blocklist-search-main.png)

* **All the blocklists provided by CrowdSec**

Once a blocklist of interest has been spotted, clicking on the subscribe button will lead to the details page of this blocklist.
**Accessing Active Subscriptions**
To view and manage your active blocklist subscriptions, navigate to the Subscriptions menu in the Blocklists tab. This section provides an overview of all currently subscribed blocklists, allowing you to track and update your subscriptions as needed.
34 changes: 34 additions & 0 deletions crowdsec-docs/unversioned/console/blocklists/featured.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Featured Blocklists

Featured Blocklists page advertises the best of what CrowdSec has to provide security wise to your organization.

### Tailored Blocklist selection

![](/img/console/Blocklists/tailored.png)

CrowdSec's new Blocklist Suggestions feature leverages advanced AI technology to enhance your organization's cybersecurity measures. By analyzing signals shared by enrolled Security Engines, this feature identifies and recommends the most effective Blocklists to protect against specific types of attacks targeting your infrastructure.

**Pre-requisites**
For an organization to benefit from the Blocklist Suggestions feature, the following pre-requisites must be met:

* Security Engine must be enrolled in the CrowdSec ecosystem.
* Security Engine must actively share signals with the CrowdSec network.

**Feature Activation**
The feature is automatically enabled for all CrowdSec users who meet the pre-requisites. No manual configuration is required to start receiving suggestions.

**Data Privacy and Usage**
All data is processed internally by CrowdSec, with no third-party access. Only CrowdSec-owned systems handle the signals, ensuring that your data remains secure and private.

**Performance Metrics**
To help gauge the impact of these suggestions, an indicator in the Console shows the potential reduction in alerts you can expect after installing the recommended Blocklists. This allows you to see at a glance how much benefit each suggested Blocklist might provide.

**Update Frequency**
The AI analysis runs on a daily basis. Any newly suggested Blocklists appear automatically in the Console, reflecting the most recent attack patterns observed in your organization.

### Blocklist categorization

![](/img/console/Blocklists/categories.png)

Under the Blocklist suggestions, another section regroups many CrowdSec Blocklists, grouped into main categories addressing different security needs.
These Blocklists are categorized to make it quick for users to navigate and identify the most relevant ones based on their infrastructure, industry, or attack patterns. By selecting the appropriate Blocklists, users can enhance their security defenses and proactively mitigate threats.
Loading