Skip to content

Commit e424a2a

Browse files
rr404jdv
andauthored
splitting premium page into 1+3 pages (#1003)
* splitting premium page into 1+3 pages * adding split pages to side bar --------- Co-authored-by: jdv <julien@crowdsec.net>
1 parent 431e470 commit e424a2a

5 files changed

Lines changed: 196 additions & 157 deletions

File tree

crowdsec-docs/sidebarsUnversioned.ts

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -456,9 +456,29 @@ const sidebarsUnversionedConfig: SidebarConfig = {
456456
id: "console/stackhealth",
457457
},
458458
{
459-
type: "doc",
459+
type: "category",
460460
label: "🏅 Premium Upgrade",
461-
id: "console/premium_upgrade",
461+
link: {
462+
type: "doc",
463+
id: "console/premium_upgrade",
464+
},
465+
items: [
466+
{
467+
type: "doc",
468+
label: "Optimal Setup",
469+
id: "console/premium_upgrade/optimal_setup",
470+
},
471+
{
472+
type: "doc",
473+
label: "Testing Premium",
474+
id: "console/premium_upgrade/testing_premium",
475+
},
476+
{
477+
type: "doc",
478+
label: "Features Overview",
479+
id: "console/premium_upgrade/features_overview",
480+
},
481+
],
462482
},
463483
],
464484
remediationSideBar: [

crowdsec-docs/unversioned/console/premium_upgrade.mdx

Lines changed: 9 additions & 155 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import { Badge } from "@site/src/ui/badge";
88

99
## Why Upgrade to Premium?
1010

11-
CrowdSec Premium features are designed for users who have **commercial usage** of the Console or organizations that want to **enhance the security posture** of their infrastructure.
11+
CrowdSec Premium features are designed for users who have **commercial usage** of the Console or organizations that want to **enhance the security posture** of their infrastructure.
1212
While our Community Plan provides essential security monitoring capabilities, Premium unlocks advanced features that scale with your business needs and provide business-grade protection.
1313

1414
Premium features bring the following benefits:
@@ -24,166 +24,20 @@ Premium features bring the following benefits:
2424

2525
A features comparison can be found on our [pricing page](https://app.crowdsec.net/pricing).
2626

27-
## Optimal Premium Upgrade Setup
28-
29-
When upgrading to a Premium plan, you may not want to upgrade every single Security Engine you monitor. It is common to have a mix of environments:
30-
- **Production:** Requires Premium features (longer data retention, heavy API limits, organization-wide blocklists).
31-
- **Dev / Test / Staging:** Can remain on the Free tier.
32-
33-
Because the Premium Upgrade applies to an entire **Organization**, the optimal strategy is to separate your Security Engines into different contexts before subscribing.
34-
35-
When you first create a Console account, your workspace is your "Personal Account".
36-
As a Community account, you can create one extra organization for free.
37-
38-
We recommend the following setup:
39-
- If you have not already, create a new organization for your **Production** environment.
40-
- Keep your **Dev / Test / Staging** Security Engines in your **Personal Account**.
41-
- Move your **Production** Security Engines to the new **Production** organization.
42-
- Upgrade the **Production** organization to **Premium**.
43-
44-
To split your Security Engines into different organizations, use either:
45-
- The [Transfer feature](/u/console/security_engines/transfer_engine) from the Security Engine page.
46-
- Or via `cscli`, re-enroll your Security Engines in the desired organization with the `--overwrite` flag to force moving them to the new organization.
47-
48-
After the transfer, the alerts will reappear in the new organization after a few minutes.
49-
50-
---
51-
52-
53-
## Test Premium Value in Your Environment
54-
55-
Before exploring all Premium features, here are practical ways to measure and experience the value yourself.
56-
The following can be used as a guide during your trial period to assess the benefits of upgrading to Premium.
57-
58-
### 🎯 Measure Improved Protection
59-
60-
**Activate:**
61-
- Community Blocklists (premium) will automatically be sent to your enrolled engines.
62-
- The [Threat Forecast Blocklist](/u/console/threat_forecast) Will be generated automatically used in your organization based on your shared signals.
63-
- Premium Tier Blocklists can be subscribed and subscription numbers per org are unlimited.
64-
- You can activate [Remediation Sync](/u/console/remediation_sync) to propagate decisions across all your enrolled Security Engines.
65-
- Respond faster to a spike of alerts thanks to "Am I Under Attack"
66-
67-
**Measure the impact:**
68-
- **Remediation Metrics:** Track your proactive vs reactive blocking ratio
69-
- **Server Resources:** Monitor CPU, memory, and bandwidth reduction
70-
- **SIEM Logs:** Measure log volume decrease and background noise reduction
71-
72-
**Expected results:** 2x more proactive blocking, 75-92% less malicious traffic reaching your servers, cleaner logs and reduced alert fatigue.
73-
74-
---
75-
76-
### 👥 Enable Team Collaboration
77-
78-
**Activate:**
79-
- Invite collaborators thanks to Multi-Seat Access
80-
- Extended Alert Retention (365 days) allow improved traceability
81-
- Use the improved in-console CTI quotas to enrich your investigations
82-
- Get notified within your tools thanks to [Push Notification Integrations](/u/console/notification_integrations/overview)
83-
84-
**How your team benefits:**
85-
- Analyze long-term attack trends and recurring threats
86-
- Conduct CTI investigations directly in the Console
87-
- Multiple team members work simultaneously without access conflicts
88-
89-
**Expected results:** Faster incident investigations, better threat attribution, reduced tool sprawl.
90-
9127
---
9228

93-
### 🏢 Scale for MSPs & Enterprises
94-
95-
**Activate:**
96-
- Administrate & share access to your clients thanks to Multi-Organization
97-
- Create & Share Blocklists across organizations via our [Service API (SAPI)](/u/console/service_api/getting_started)
98-
99-
100-
**Manage at scale:**
101-
- Segment customer environments (one org per client)
102-
- Share custom threat intelligence across organizations
103-
- Automate blocklist management via API
104-
105-
**Expected results:** Clear tenant isolation, streamlined multi-customer operations, custom visibility on their defenses.
106-
107-
---
108-
109-
## Premium Features Overview
110-
111-
Premium features enable multiple use cases.
112-
Make the best use of the premium features for your needs in: **Scaling, Multi-tenancy, Inhanced proactive protection, Centralized management, Team collaboration, Integration and automation, Enhanced threat intelligence, and improved support.**
113-
114-
---
115-
116-
### Scaling, Automation & Multi-Tenancy
117-
118-
#### Remediation Sync
119-
Automatically synchronize security decisions across your entire organization. Syncs to all Security Engines and Blocklists Integration endpoints, ensuring consistent protection across your infrastructure.
120-
[Learn more about remediation sync](/u/console/remediation_sync)
121-
122-
#### Console Decision Management
123-
Add, delete, and manage security decisions directly from the Console. Force pull blocklists when subscribing or unsubscribing, giving you complete control over your security posture from a central interface.
124-
[Learn more about decision management](/u/console/decisions/decisions_management)
125-
126-
#### Centralized Allowlists
127-
Manage allowlists from a single location and apply them across all security engines and integrations organization-wide. Supports IP expiration for temporary allowlisting.
128-
[Learn more about allowlists](/u/console/allowlists)
129-
130-
#### Service API (SAPI)
131-
Access APIs for console management.
132-
[Learn more about Service API](/u/console/service_api/getting_started)
133-
134-
#### Blocklist Creation & Sharing
135-
Via our [Service API (SAPI)](/u/console/service_api/getting_started) Distribute custom blocklists across multiple organizations or partners, enabling coordinated security operations across your business ecosystem.
136-
[Learn more about SAPI Blocklist endpoints](/u/console/service_api/blocklists)
137-
138-
#### Auto Enroll
139-
Automatically enroll new security engines into your organization for streamlined deployment and management.
140-
141-
#### Expanded Organization Seats
142-
Provide view/edit/admin access to you customers or collaborate with team members by adding more seats to your organization. (3 included in bas Premium plan)
143-
144-
### Extra protection
145-
146-
#### Threat Forecast Blocklists
147-
Access exclusive, organization-specific blocklists generated from the signals your organization shares with CrowdSec. These blocklists are more precise than community blocklists and provide tailored protection for your infrastructure.
148-
[Learn more about threat forecast blocklists](/u/console/threat_forecast)
149-
150-
#### Expanded Community Blocklist Coverage
151-
Unlock the premium Community Blocklist as a network participant.
152-
Receive up to 50k of the most aggressive attackers targeting similar services as yours *(up from top [3k in Community](/central_api/community_blocklist/#community-blocklist-lite)).*
153-
154-
#### Premium Tier Blocklist Access
155-
Get access to our Premium tier blocklists, providing enhanced protection with curated specialized blocklists tailored for different attack vectors.
156-
157-
#### Unlimited Blocklist Subscriptions
158-
Premium subscribers get unlimited blocklist subscriptions (compared to 3 in Community), allowing you to protect your infrastructure with multiple specialized blocklists simultaneously.
159-
[Learn more about premium tier blocklists features](/u/blocklists/intro#crowdsec-blocklist-tiers)
160-
161-
### Reactivity & Monitoring
162-
163-
#### Am I Under Attack Feature
164-
Receive real-time alerts when your infrastructure experiences attack surges. This feature analyzes current traffic patterns against historical baselines to detect anomalous activity, with support for email notifications and webhook integrations.
165-
[Learn more about attack detection](/u/console/security_engines/am_i_under_attack)
166-
167-
#### Push Notifications Integrations
168-
Receive alerts when security engines go offline or become outdated, ensuring your security infrastructure remains operational.
169-
[Learn more about push notifications](/u/console/notification_integrations/overview)
29+
## Getting Started with Premium
17030

171-
#### Increased Alert Quotas and Extended Retention
172-
Upgrade from the Community Plan's 500 alerts per month and 2-month retention to custom quotas (up to several million alerts) and up to 1 year of retention. This enables comprehensive monitoring of large-scale infrastructures and long-term security analysis.
173-
[Learn more about premium quotas](/u/console/alerts/quotas#why-upgrade-to-premium-)
31+
To help you make the most of your Premium upgrade, we've prepared the following guides:
17432

175-
#### Background Noise Filtering
176-
Automatically filter out internet background radiation and mass scanning activity to focus on genuine threats. Customize noise cancellation levels (Low, Medium, High) to match your security requirements.
177-
[Learn more about background noise filtering](/u/console/alerts/background_noise)
33+
### [Optimal Premium Upgrade Setup](/u/console/premium_upgrade/optimal_setup)
34+
Learn the best practices for organizing your Security Engines across different environments (Production, Dev, Test) before upgrading to maximize value and cost-efficiency.
17835

179-
#### IP reputation investigation quotas
180-
Audit what CrowdSec knows about IP addresses, attacking you and present in blocklists, with increased investigation quotas.
181-
100 attacker details per week (compared to 30 in Community), including IP reputation and MITRE ATT&CK mappings for comprehensive threat intelligence.
36+
### [Test Premium Value in Your Environment](/u/console/premium_upgrade/testing_premium)
37+
Discover practical ways to measure and experience Premium value during your trial period, including improved protection metrics, team collaboration features, and enterprise scaling capabilities.
18238

183-
#### CTI API Access
184-
Leverage CrowdSec IP reputation data into your vendors.
185-
Get 100 CTI API calls per week (compared to 30 in Community) for integration with SIEM, SOAR, and other security tools.
186-
[Learn more about CTI API](/u/cti_api/api_integration/integration_intro)
39+
### [Premium Features Overview](/u/console/premium_upgrade/features_overview)
40+
Explore the complete catalog of Premium features including scaling & automation, enhanced protection, reactivity & monitoring, and advanced threat intelligence capabilities.
18741

18842
---
18943

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
---
2+
id: features_overview
3+
title: Premium Features Overview
4+
description: Comprehensive overview of all Premium features
5+
---
6+
7+
Premium features enable multiple use cases.
8+
Make the best use of the premium features for your needs in: **Scaling, Multi-tenancy, Inhanced proactive protection, Centralized management, Team collaboration, Integration and automation, Enhanced threat intelligence, and improved support.**
9+
10+
---
11+
12+
## Scaling, Automation & Multi-Tenancy
13+
14+
### Remediation Sync
15+
Automatically synchronize security decisions across your entire organization. Syncs to all Security Engines and Blocklists Integration endpoints, ensuring consistent protection across your infrastructure.
16+
[Learn more about remediation sync](/u/console/remediation_sync)
17+
18+
### Console Decision Management
19+
Add, delete, and manage security decisions directly from the Console. Force pull blocklists when subscribing or unsubscribing, giving you complete control over your security posture from a central interface.
20+
[Learn more about decision management](/u/console/decisions/decisions_management)
21+
22+
### Centralized Allowlists
23+
Manage allowlists from a single location and apply them across all security engines and integrations organization-wide. Supports IP expiration for temporary allowlisting.
24+
[Learn more about allowlists](/u/console/allowlists)
25+
26+
### Service API (SAPI)
27+
Access APIs for console management.
28+
[Learn more about Service API](/u/console/service_api/getting_started)
29+
30+
### Blocklist Creation & Sharing
31+
Via our [Service API (SAPI)](/u/console/service_api/getting_started) Distribute custom blocklists across multiple organizations or partners, enabling coordinated security operations across your business ecosystem.
32+
[Learn more about SAPI Blocklist endpoints](/u/console/service_api/blocklists)
33+
34+
### Auto Enroll
35+
Automatically enroll new security engines into your organization for streamlined deployment and management.
36+
37+
### Expanded Organization Seats
38+
Provide view/edit/admin access to you customers or collaborate with team members by adding more seats to your organization. (3 included in bas Premium plan)
39+
40+
## Extra protection
41+
42+
### Threat Forecast Blocklists
43+
Access exclusive, organization-specific blocklists generated from the signals your organization shares with CrowdSec. These blocklists are more precise than community blocklists and provide tailored protection for your infrastructure.
44+
[Learn more about threat forecast blocklists](/u/console/threat_forecast)
45+
46+
### Expanded Community Blocklist Coverage
47+
Unlock the premium Community Blocklist as a network participant.
48+
Receive up to 50k of the most aggressive attackers targeting similar services as yours *(up from top [3k in Community](/docs/central_api/community_blocklist/#community-blocklist-lite)).*
49+
50+
### Premium Tier Blocklist Access
51+
Get access to our Premium tier blocklists, providing enhanced protection with curated specialized blocklists tailored for different attack vectors.
52+
53+
### Unlimited Blocklist Subscriptions
54+
Premium subscribers get unlimited blocklist subscriptions (compared to 3 in Community), allowing you to protect your infrastructure with multiple specialized blocklists simultaneously.
55+
[Learn more about premium tier blocklists features](/u/blocklists/intro#crowdsec-blocklist-tiers)
56+
57+
## Reactivity & Monitoring
58+
59+
### Am I Under Attack Feature
60+
Receive real-time alerts when your infrastructure experiences attack surges. This feature analyzes current traffic patterns against historical baselines to detect anomalous activity, with support for email notifications and webhook integrations.
61+
[Learn more about attack detection](/u/console/security_engines/am_i_under_attack)
62+
63+
### Push Notifications Integrations
64+
Receive alerts when security engines go offline or become outdated, ensuring your security infrastructure remains operational.
65+
[Learn more about push notifications](/u/console/notification_integrations/overview)
66+
67+
### Increased Alert Quotas and Extended Retention
68+
Upgrade from the Community Plan's 500 alerts per month and 2-month retention to custom quotas (up to several million alerts) and up to 1 year of retention. This enables comprehensive monitoring of large-scale infrastructures and long-term security analysis.
69+
[Learn more about premium quotas](/u/console/alerts/quotas#why-upgrade-to-premium-)
70+
71+
### Background Noise Filtering
72+
Automatically filter out internet background radiation and mass scanning activity to focus on genuine threats. Customize noise cancellation levels (Low, Medium, High) to match your security requirements.
73+
[Learn more about background noise filtering](/u/console/alerts/background_noise)
74+
75+
### IP reputation investigation quotas
76+
Audit what CrowdSec knows about IP addresses, attacking you and present in blocklists, with increased investigation quotas.
77+
100 attacker details per week (compared to 30 in Community), including IP reputation and MITRE ATT&CK mappings for comprehensive threat intelligence.
78+
79+
### CTI API Access
80+
Leverage CrowdSec IP reputation data into your vendors.
81+
Get 100 CTI API calls per week (compared to 30 in Community) for integration with SIEM, SOAR, and other security tools.
82+
[Learn more about CTI API](/u/cti_api/api_integration/integration_intro)
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
id: optimal_setup
3+
title: Optimal Premium Upgrade Setup
4+
description: Best practices for setting up your Premium upgrade
5+
---
6+
7+
When upgrading to a Premium plan, you may not want to upgrade every single Security Engine you monitor. It is common to have a mix of environments:
8+
- **Production:** Requires Premium features (longer data retention, heavy API limits, organization-wide blocklists).
9+
- **Dev / Test / Staging:** Can remain on the Free tier.
10+
11+
Because the Premium Upgrade applies to an entire **Organization**, the optimal strategy is to separate your Security Engines into different contexts before subscribing.
12+
13+
When you first create a Console account, your workspace is your "Personal Account".
14+
As a Community account, you can create one extra organization for free.
15+
16+
We recommend the following setup:
17+
- If you have not already, create a new organization for your **Production** environment.
18+
- Keep your **Dev / Test / Staging** Security Engines in your **Personal Account**.
19+
- Move your **Production** Security Engines to the new **Production** organization.
20+
- Upgrade the **Production** organization to **Premium**.
21+
22+
To split your Security Engines into different organizations, use either:
23+
- The [Transfer feature](/u/console/security_engines/transfer_engine) from the Security Engine page.
24+
- Or via `cscli`, re-enroll your Security Engines in the desired organization with the `--overwrite` flag to force moving them to the new organization.
25+
26+
After the transfer, the alerts will reappear in the new organization after a few minutes.

0 commit comments

Comments
 (0)