Skip to content
Merged
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
6 changes: 5 additions & 1 deletion crowdsec-docs/src/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,11 @@

body,
#__docusaurus {
@apply bg-background text-foreground;
@apply bg-neutral-950 text-foreground;
}

.theme-doc-sidebar-container {
@apply bg-neutral-900;
}

html[data-theme="light"] .menu__link--active {
Expand Down
6 changes: 2 additions & 4 deletions crowdsec-docs/src/theme/DocSidebarItem/Link/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ import { isActiveSidebarItem } from "@docusaurus/plugin-content-docs/client";
import { ThemeClassNames } from "@docusaurus/theme-common";
import { Badge } from "@site/src/ui/badge";
import type { Props } from "@theme/DocSidebarItem/Link";
import IconExternalLink from "@theme/Icon/ExternalLink";
import clsx from "clsx";
import { ExternalLinkIcon } from "lucide-react";
import React from "react";

export default function DocSidebarItemLink({ item, onItemClick, activePath, level, index, ...props }: Readonly<Props>): React.JSX.Element {
Expand All @@ -14,8 +14,6 @@ export default function DocSidebarItemLink({ item, onItemClick, activePath, leve
const isInternalLink = isInternalUrl(href);
const tag = customProps?.tag;

console.log(label, tag);

return (
<li
className={clsx(
Expand Down Expand Up @@ -49,7 +47,7 @@ export default function DocSidebarItemLink({ item, onItemClick, activePath, leve
Premium
</Badge>
)}
{!isInternalLink && <IconExternalLink />}
{!isInternalLink && <ExternalLinkIcon className="ml-1 h-4 text-foreground/80" />}
</Link>
</li>
);
Expand Down
2 changes: 0 additions & 2 deletions crowdsec-docs/unversioned/console/alerts/alerts_contexts.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Alerts Context
description: Understanding the alerts context in the CrowdSec Console
---

## Introduction

In specific scenarios, there might be a lack of context in alerts due to centralizing logs on one server. CrowdSec does not store raw log information after processing is completed. Additional data can be included within an alert using the alert context feature. Configuration can be done using the provided [documentation](/user_guides/alert_context.md).

## Usage
Expand Down
2 changes: 0 additions & 2 deletions crowdsec-docs/unversioned/console/alerts/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Introduction
description: Introduction to the Alerts section of the CrowdSec Console
---

## Introduction

On the Alerts page, a comprehensive list of all alerts triggered by Security Engines is provided. This page is designed to offer insights into the types and frequency of cyber attacks targeting your systems, as well as understanding the specific times these incidents occurred.

Users are encouraged to stay informed about the digital security landscape by navigating through detailed reports of each alert. The data available is crucial for empowering analysis and response strategies, paramount in safeguarding online presence. The space is continually enhanced to better serve security needs.
Expand Down
4 changes: 1 addition & 3 deletions crowdsec-docs/unversioned/console/alerts/quotas.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Quotas
description: Understanding alerts quotas in the CrowdSec Console`
---

## Introduction

At CrowdSec, we're committed to providing a range of cybersecurity solutions tailored to meet the needs of diverse users, from individual enthusiasts to large organizations. Our pricing plans, including the Community and Premium options, are designed to scale with your requirements, ensuring you have the tools and capabilities to monitor and respond to threats effectively.

### Community Plan: Starting Point for Cybersecurity Monitoring
Expand All @@ -13,7 +11,7 @@ Our Community Plan is designed as an entry point for users beginning to explore

- **500 first alerts of the month**: Receive up to 500 alerts per month, with the quota resetting on the 1st of every month. This allows organizations to stay informed about potential threats to their network.
- **2 Months of Retention**: Access alerts from the last two months, within the 500-alert limit per months. This ensures you can review and act on recent alerts while staying within your quota.

This plan is ideal for individual users or small teams looking for essential monitoring tools without the need for extensive historical data retention or a high volume of alerts.

### Why Upgrade to Premium? 🏅
Expand Down
6 changes: 1 addition & 5 deletions crowdsec-docs/unversioned/console/intro.mdx
Original file line number Diff line number Diff line change
@@ -1,12 +1,8 @@
---
id: intro
title: Introduction
title: Introduction to the CrowdSec Console
---

# Introduction to the Console

## Introduction to CrowdSec

CrowdSec is an open-source and collaborative cybersecurity solution that protects websites, servers, and IT infrastructures from attacks. It leverages the power of the community to create a continuously updated security model that adapts to emerging threats. By analyzing users' logs in real-time, CrowdSec identifies and blocks malicious behavior across the entire network. The participatory approach ensures that the intelligence gathered is shared across the community when one user is attacked, enabling all users to block potential threats without external intervention.

## The CrowdSec Console
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
---
title: Am I Under Attack 🏅
title: Am I Under Attack
description: Alerting you when a surge of attack is hitting you
---

## Introduction

import { Badge } from "@site/src/ui/badge";

<div className="mb-4">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Dashboard
description: Security Engines Dashboard page
---

# Introduction

This section displays all the CrowdSec Security Engines available in an Organization. This feature provides a quick overview of the organization's security status and allows the management of all the Security Engines remotely.

If you haven't signed up for Security Engines, check out the ["Getting Started"](/getting_started/post_installation/console.mdx) guide.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Details page
description: Learn how to view the details of a Security Engine in the CrowdSec Console its purpose and how to use it
---

## Introduction

This page will reference information about a specific Security Engine. This page is your one-stop resource for understanding everything related to the Security Engine you're interested in.

![Security Engine details page](/img/console/security_engines/details-page.jpeg)
Expand All @@ -19,10 +17,10 @@ At the top of the page, the essential information regarding the Security Engine

Quick actions are available from the summary to apply changes to your Security Engine.

- [Updating name or tags](/console/security_engines/name_and_tags.md)
- [Transferring an Engine](/console/security_engines/transfer_engine.md)
- [Archiving an Engine](/console/security_engines/archive_engine.md)
- [Removing an Engine](/console/security_engines/remove_engine.md)
- [Updating name or tags](/console/security_engines/name_and_tags.md)
- [Transferring an Engine](/console/security_engines/transfer_engine.md)
- [Archiving an Engine](/console/security_engines/archive_engine.md)
- [Removing an Engine](/console/security_engines/remove_engine.md)

![Security Engine details page](/img/console/security_engines/details-page-actions.png)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
---
title: Dashboard
title: Filter and Sort
description: Security Engines Dashboard page
---

## Introduction

This document offers guidance on utilizing the system's filtering feature for Security Engines. Users can refine their search and swiftly locate engines by applying name, IP, tags, and activity filters.

## Filter Options
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Name and Tags
description: Security Engines Name and Tags (edition)
---

## Introduction

Effective management of Security Engines allows for modifying information, such as the name and tags associated with the Engines.

- The name must be unique and can be changed at any given time.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Pending Security Engines
description: Accept or decline Security Engines waiting for enrollment
---

## Introduction

For security reasons, Engines are not enrolled without user verification. A table at the top of your Engines list will display all the waiting requests.
However, you can streamline this process using the "Auto-enroll" feature to automatically enroll your Security Engines.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Removing a Security Engine
description: Remove Security Engines from an organization
---

## Introduction

It is possible to remove an Engine quickly from an organization. This action un-enrolls the chosen Engines from the Console without affecting their operational status or shutting them down.

## Usage
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Select multiple organizations 🧪
description: Learn how to select multiple organizations to all their Security Engines in the CrowdSec Console
---

## Introduction

> 🧪 Beta users only

The Multi-organization selection feature allows monitoring engines across multiple organizations. This centralization simplifies the oversight of numerous security systems, making maintaining a high level of security effectiveness easier. This feature ensures you can promptly address the most pressing security concerns without navigating multiple systems or interfaces.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Transfer Engine
description: Transfer Security Engines to another organization
---

## Introduction

For members of multiple organizations, transferring Security Engines between them can streamline the organization. This feature is accessible via the Engine menu. It is important to note that transferring Security Engines requires having **Editor-level permissions** or higher in both organizations.

## Usage
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Troubleshooting Hints
description: Troubleshooting Security Engines
---

## Introduction

This feature simplifies cybersecurity management by providing a quick, comprehensive view of Security Engines requiring immediate action. It's designed for efficiency, enabling you to identify critical issues such as outdated or inactive components with just one click. This functionality ensures streamlined, focused security maintenance, ideal for teams with many servers to monitor simultaneously.

This feature will detect the following behaviors needing your remediation attention:
Expand Down
3 changes: 0 additions & 3 deletions crowdsec-docs/unversioned/integrations/intro.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,6 @@ sidebar_position: 1
import ThemedImage from "@theme/ThemedImage";
import useBaseUrl from "@docusaurus/useBaseUrl";

# Integrations

## Introduction

Integrations are direct integration with services that can act upon a feed provided by CrowdSec. Depending on if you would like to remediate or simply log, you would need to integrate with the appropriate service.

Expand Down