Skip to content
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
2 changes: 1 addition & 1 deletion crowdsec-docs/docs/cscli/cscli_alerts.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ cscli alerts [action] [flags]

### SEE ALSO

* [cscli](/cscli/cscli.md) - cscli allows you to manage crowdsec
* [cscli](/cscli/intro.md) - cscli allows you to manage crowdsec
* [cscli alerts delete](/cscli/cscli_alerts_delete.md) - Delete alerts
/!\ This command can be used only on the same machine than the local API.
* [cscli alerts flush](/cscli/cscli_alerts_flush.md) - Flush alerts
Expand Down
2 changes: 1 addition & 1 deletion crowdsec-docs/docs/cscli/cscli_allowlists.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ cscli allowlists [action] [flags]

### SEE ALSO

* [cscli](/cscli/cscli.md) - cscli allows you to manage crowdsec
* [cscli](/cscli/intro.md) - cscli allows you to manage crowdsec
* [cscli allowlists add](/cscli/cscli_allowlists_add.md) - Add content to an allowlist
* [cscli allowlists check](/cscli/cscli_allowlists_check.md) - Check if a value is in an allowlist
* [cscli allowlists create](/cscli/cscli_allowlists_create.md) - Create a new allowlist
Expand Down
2 changes: 1 addition & 1 deletion crowdsec-docs/docs/cscli/cscli_appsec-configs.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ cscli waf-configs remove crowdsecurity/virtual-patching

### SEE ALSO

* [cscli](/cscli/cscli.md) - cscli allows you to manage crowdsec
* [cscli](/cscli/intro.md) - cscli allows you to manage crowdsec
* [cscli appsec-configs inspect](/cscli/cscli_appsec-configs_inspect.md) - Inspect given appsec-config(s)
* [cscli appsec-configs install](/cscli/cscli_appsec-configs_install.md) - Install given appsec-config(s)
* [cscli appsec-configs list](/cscli/cscli_appsec-configs_list.md) - List appsec-config(s)
Expand Down
2 changes: 1 addition & 1 deletion crowdsec-docs/docs/cscli/cscli_appsec-rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ cscli waf-rules remove crowdsecurity/crs

### SEE ALSO

* [cscli](/cscli/cscli.md) - cscli allows you to manage crowdsec
* [cscli](/cscli/intro.md) - cscli allows you to manage crowdsec
* [cscli appsec-rules inspect](/cscli/cscli_appsec-rules_inspect.md) - Inspect given appsec-rule(s)
* [cscli appsec-rules install](/cscli/cscli_appsec-rules_install.md) - Install given appsec-rule(s)
* [cscli appsec-rules list](/cscli/cscli_appsec-rules_list.md) - List appsec-rule(s)
Expand Down
2 changes: 1 addition & 1 deletion crowdsec-docs/docs/cscli/cscli_bouncers.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ cscli bouncers [action] [flags]

### SEE ALSO

* [cscli](/cscli/cscli.md) - cscli allows you to manage crowdsec
* [cscli](/cscli/intro.md) - cscli allows you to manage crowdsec
* [cscli bouncers add](/cscli/cscli_bouncers_add.md) - add a single bouncer to the database
* [cscli bouncers delete](/cscli/cscli_bouncers_delete.md) - delete bouncer(s) from the database
* [cscli bouncers inspect](/cscli/cscli_bouncers_inspect.md) - inspect a bouncer by name
Expand Down
2 changes: 1 addition & 1 deletion crowdsec-docs/docs/cscli/cscli_capi.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ cscli capi [action] [flags]

### SEE ALSO

* [cscli](/cscli/cscli.md) - cscli allows you to manage crowdsec
* [cscli](/cscli/intro.md) - cscli allows you to manage crowdsec
* [cscli capi register](/cscli/cscli_capi_register.md) - Register to Central API (CAPI)
* [cscli capi status](/cscli/cscli_capi_status.md) - Check status with the Central API (CAPI)

2 changes: 1 addition & 1 deletion crowdsec-docs/docs/cscli/cscli_collections.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ cscli collections remove crowdsecurity/http-cve crowdsecurity/iptables

### SEE ALSO

* [cscli](/cscli/cscli.md) - cscli allows you to manage crowdsec
* [cscli](/cscli/intro.md) - cscli allows you to manage crowdsec
* [cscli collections inspect](/cscli/cscli_collections_inspect.md) - Inspect given collection(s)
* [cscli collections install](/cscli/cscli_collections_install.md) - Install given collection(s)
* [cscli collections list](/cscli/cscli_collections_list.md) - List collection(s)
Expand Down
2 changes: 1 addition & 1 deletion crowdsec-docs/docs/cscli/cscli_completion.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,5 +88,5 @@ cscli completion [bash|zsh|powershell|fish]

### SEE ALSO

* [cscli](/cscli/cscli.md) - cscli allows you to manage crowdsec
* [cscli](/cscli/intro.md) - cscli allows you to manage crowdsec

2 changes: 1 addition & 1 deletion crowdsec-docs/docs/cscli/cscli_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ cscli config [command] [flags]

### SEE ALSO

* [cscli](/cscli/cscli.md) - cscli allows you to manage crowdsec
* [cscli](/cscli/intro.md) - cscli allows you to manage crowdsec
* [cscli config feature-flags](/cscli/cscli_config_feature-flags.md) - Displays feature flag status
* [cscli config show](/cscli/cscli_config_show.md) - Displays current config
* [cscli config show-yaml](/cscli/cscli_config_show-yaml.md) - Displays merged config.yaml + config.yaml.local
Expand Down
2 changes: 1 addition & 1 deletion crowdsec-docs/docs/cscli/cscli_console.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Manage interaction with Crowdsec console (https://app.crowdsec.net)

### SEE ALSO

* [cscli](/cscli/cscli.md) - cscli allows you to manage crowdsec
* [cscli](/cscli/intro.md) - cscli allows you to manage crowdsec
* [cscli console disable](/cscli/cscli_console_disable.md) - Disable a console option
* [cscli console enable](/cscli/cscli_console_enable.md) - Enable a console option
* [cscli console enroll](/cscli/cscli_console_enroll.md) - Enroll this instance to https://app.crowdsec.net [requires local API]
Expand Down
2 changes: 1 addition & 1 deletion crowdsec-docs/docs/cscli/cscli_contexts.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ cscli contexts remove crowdsecurity/bf_base crowdsecurity/fortinet

### SEE ALSO

* [cscli](/cscli/cscli.md) - cscli allows you to manage crowdsec
* [cscli](/cscli/intro.md) - cscli allows you to manage crowdsec
* [cscli contexts inspect](/cscli/cscli_contexts_inspect.md) - Inspect given context(s)
* [cscli contexts install](/cscli/cscli_contexts_install.md) - Install given context(s)
* [cscli contexts list](/cscli/cscli_contexts_list.md) - List context(s)
Expand Down
2 changes: 1 addition & 1 deletion crowdsec-docs/docs/cscli/cscli_dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,5 +31,5 @@ cscli dashboard [flags]

### SEE ALSO

* [cscli](/cscli/cscli.md) - cscli allows you to manage crowdsec
* [cscli](/cscli/intro.md) - cscli allows you to manage crowdsec

2 changes: 1 addition & 1 deletion crowdsec-docs/docs/cscli/cscli_decisions.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ cscli decisions [action] [filter]

### SEE ALSO

* [cscli](/cscli/cscli.md) - cscli allows you to manage crowdsec
* [cscli](/cscli/intro.md) - cscli allows you to manage crowdsec
* [cscli decisions add](/cscli/cscli_decisions_add.md) - Add decision to LAPI
* [cscli decisions delete](/cscli/cscli_decisions_delete.md) - Delete decisions
* [cscli decisions import](/cscli/cscli_decisions_import.md) - Import decisions from a file or pipe
Expand Down
2 changes: 1 addition & 1 deletion crowdsec-docs/docs/cscli/cscli_explain.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,5 +58,5 @@ tail -n 5 myfile.log | cscli explain --type nginx -f -

### SEE ALSO

* [cscli](/cscli/cscli.md) - cscli allows you to manage crowdsec
* [cscli](/cscli/intro.md) - cscli allows you to manage crowdsec

2 changes: 1 addition & 1 deletion crowdsec-docs/docs/cscli/cscli_hub.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ cscli hub upgrade

### SEE ALSO

* [cscli](/cscli/cscli.md) - cscli allows you to manage crowdsec
* [cscli](/cscli/intro.md) - cscli allows you to manage crowdsec
* [cscli hub branch](/cscli/cscli_hub_branch.md) - Show selected hub branch
* [cscli hub list](/cscli/cscli_hub_list.md) - List all installed configurations
* [cscli hub types](/cscli/cscli_hub_types.md) - List supported item types
Expand Down
2 changes: 1 addition & 1 deletion crowdsec-docs/docs/cscli/cscli_hubtest.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ cscli hubtest [flags]

### SEE ALSO

* [cscli](/cscli/cscli.md) - cscli allows you to manage crowdsec
* [cscli](/cscli/intro.md) - cscli allows you to manage crowdsec
* [cscli hubtest clean](/cscli/cscli_hubtest_clean.md) - clean [test_name]
* [cscli hubtest coverage](/cscli/cscli_hubtest_coverage.md) - coverage
* [cscli hubtest create](/cscli/cscli_hubtest_create.md) - create [test_name]
Expand Down
2 changes: 1 addition & 1 deletion crowdsec-docs/docs/cscli/cscli_lapi.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ cscli lapi [action] [flags]

### SEE ALSO

* [cscli](/cscli/cscli.md) - cscli allows you to manage crowdsec
* [cscli](/cscli/intro.md) - cscli allows you to manage crowdsec
* [cscli lapi context](/cscli/cscli_lapi_context.md) - Manage context to send with alerts
* [cscli lapi register](/cscli/cscli_lapi_register.md) - Register a machine to Local API (LAPI)
* [cscli lapi status](/cscli/cscli_lapi_status.md) - Check authentication to Local API (LAPI)
Expand Down
2 changes: 1 addition & 1 deletion crowdsec-docs/docs/cscli/cscli_machines.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ cscli machines [action]

### SEE ALSO

* [cscli](/cscli/cscli.md) - cscli allows you to manage crowdsec
* [cscli](/cscli/intro.md) - cscli allows you to manage crowdsec
* [cscli machines add](/cscli/cscli_machines_add.md) - add a single machine to the database
* [cscli machines delete](/cscli/cscli_machines_delete.md) - delete machine(s) by name
* [cscli machines inspect](/cscli/cscli_machines_inspect.md) - inspect a machine by name
Expand Down
2 changes: 1 addition & 1 deletion crowdsec-docs/docs/cscli/cscli_metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ cscli metrics list

### SEE ALSO

* [cscli](/cscli/cscli.md) - cscli allows you to manage crowdsec
* [cscli](/cscli/intro.md) - cscli allows you to manage crowdsec
* [cscli metrics list](/cscli/cscli_metrics_list.md) - List available types of metrics.
* [cscli metrics show](/cscli/cscli_metrics_show.md) - Display all or part of the available metrics.

2 changes: 1 addition & 1 deletion crowdsec-docs/docs/cscli/cscli_notifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ cscli notifications [action] [flags]

### SEE ALSO

* [cscli](/cscli/cscli.md) - cscli allows you to manage crowdsec
* [cscli](/cscli/intro.md) - cscli allows you to manage crowdsec
* [cscli notifications inspect](/cscli/cscli_notifications_inspect.md) - Inspect notifications plugin
* [cscli notifications list](/cscli/cscli_notifications_list.md) - list notifications plugins
* [cscli notifications reinject](/cscli/cscli_notifications_reinject.md) - reinject an alert into profiles to trigger notifications
Expand Down
2 changes: 1 addition & 1 deletion crowdsec-docs/docs/cscli/cscli_papi.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ cscli papi [action] [flags]

### SEE ALSO

* [cscli](/cscli/cscli.md) - cscli allows you to manage crowdsec
* [cscli](/cscli/intro.md) - cscli allows you to manage crowdsec
* [cscli papi status](/cscli/cscli_papi_status.md) - Get status of the Polling API
* [cscli papi sync](/cscli/cscli_papi_sync.md) - Sync with the Polling API, pulling all non-expired orders for the instance

2 changes: 1 addition & 1 deletion crowdsec-docs/docs/cscli/cscli_parsers.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ cscli parsers remove crowdsecurity/caddy-logs crowdsecurity/sshd-logs

### SEE ALSO

* [cscli](/cscli/cscli.md) - cscli allows you to manage crowdsec
* [cscli](/cscli/intro.md) - cscli allows you to manage crowdsec
* [cscli parsers inspect](/cscli/cscli_parsers_inspect.md) - Inspect given parser(s)
* [cscli parsers install](/cscli/cscli_parsers_install.md) - Install given parser(s)
* [cscli parsers list](/cscli/cscli_parsers_list.md) - List parser(s)
Expand Down
2 changes: 1 addition & 1 deletion crowdsec-docs/docs/cscli/cscli_postoverflows.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ cscli postoverflows remove crowdsecurity/cdn-whitelist crowdsecurity/rdns

### SEE ALSO

* [cscli](/cscli/cscli.md) - cscli allows you to manage crowdsec
* [cscli](/cscli/intro.md) - cscli allows you to manage crowdsec
* [cscli postoverflows inspect](/cscli/cscli_postoverflows_inspect.md) - Inspect given postoverflow(s)
* [cscli postoverflows install](/cscli/cscli_postoverflows_install.md) - Install given postoverflow(s)
* [cscli postoverflows list](/cscli/cscli_postoverflows_list.md) - List postoverflow(s)
Expand Down
2 changes: 1 addition & 1 deletion crowdsec-docs/docs/cscli/cscli_scenarios.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ cscli scenarios remove crowdsecurity/ssh-bf crowdsecurity/http-probing

### SEE ALSO

* [cscli](/cscli/cscli.md) - cscli allows you to manage crowdsec
* [cscli](/cscli/intro.md) - cscli allows you to manage crowdsec
* [cscli scenarios inspect](/cscli/cscli_scenarios_inspect.md) - Inspect given scenario(s)
* [cscli scenarios install](/cscli/cscli_scenarios_install.md) - Install given scenario(s)
* [cscli scenarios list](/cscli/cscli_scenarios_list.md) - List scenario(s)
Expand Down
2 changes: 1 addition & 1 deletion crowdsec-docs/docs/cscli/cscli_setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ cscli setup [command]

### SEE ALSO

* [cscli](/cscli/cscli.md) - cscli allows you to manage crowdsec
* [cscli](/cscli/intro.md) - cscli allows you to manage crowdsec
* [cscli setup detect](/cscli/cscli_setup_detect.md) - Detect installed services and generate a setup file
* [cscli setup install-acquisition](/cscli/cscli_setup_install-acquisition.md) - Generate acquisition configuration from a setup file
* [cscli setup install-hub](/cscli/cscli_setup_install-hub.md) - Install recommended hub items from a setup file
Expand Down
2 changes: 1 addition & 1 deletion crowdsec-docs/docs/cscli/cscli_simulation.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ cscli simulation disable crowdsecurity/ssh-bf

### SEE ALSO

* [cscli](/cscli/cscli.md) - cscli allows you to manage crowdsec
* [cscli](/cscli/intro.md) - cscli allows you to manage crowdsec
* [cscli simulation disable](/cscli/cscli_simulation_disable.md) - Disable the simulation mode. Disable only specified scenarios
* [cscli simulation enable](/cscli/cscli_simulation_enable.md) - Enable the simulation, globally or on specified scenarios
* [cscli simulation status](/cscli/cscli_simulation_status.md) - Show simulation mode status
Expand Down
2 changes: 1 addition & 1 deletion crowdsec-docs/docs/cscli/cscli_support.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,6 @@ cscli support [action] [flags]

### SEE ALSO

* [cscli](/cscli/cscli.md) - cscli allows you to manage crowdsec
* [cscli](/cscli/intro.md) - cscli allows you to manage crowdsec
* [cscli support dump](/cscli/cscli_support_dump.md) - Dump all your configuration to a zip file for easier support

2 changes: 1 addition & 1 deletion crowdsec-docs/docs/cscli/cscli_version.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,5 +31,5 @@ cscli version [flags]

### SEE ALSO

* [cscli](/cscli/cscli.md) - cscli allows you to manage crowdsec
* [cscli](/cscli/intro.md) - cscli allows you to manage crowdsec

Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: cscli
id: intro
title: cscli
---
## cscli
Expand Down
2 changes: 1 addition & 1 deletion crowdsec-docs/docs/intro.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ CrowdSec is crowdsourced: when you participate, you share the attacks you detect
In addition to the core "detect and react" mechanism, CrowdSec is committed to several other key aspects:

- **Easy Installation**: Get started quickly on all [supported platforms](/u/getting_started/intro).
- **Simplified Daily Operations**: Manage and maintain your setup from the [CrowdSec Console](http://app.crowdsec.net) (Web UI) or with the [cscli command-line tool](/cscli/cscli.md).
- **Simplified Daily Operations**: Manage and maintain your setup from the [CrowdSec Console](http://app.crowdsec.net) (Web UI) or with the [cscli command-line tool](/cscli/intro.md).
- **Reproducibility**: Analyze live logs and [cold logs](/u/user_guides/replay_mode) to validate detections, run forensic analysis, or generate reports.
- **Versatile**: Protect your perimeter by analyzing [system logs](/log_processor/data_sources/introduction.md) and [HTTP requests](/appsec/intro.md).
- **Observability**: Providing valuable insights into the system's activity:
Expand Down
9 changes: 2 additions & 7 deletions crowdsec-docs/docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -57,12 +57,6 @@ const ACADEMY_URL = `https://academy.crowdsec.net/courses?${
}`;

const NAVBAR_ITEMS: NavbarItem[] = [
{
type: "docsVersionDropdown",
docsPluginId: "default",
position: "left",
dropdownActiveClassDisabled: true,
},
{
label: "Security Stack",
position: "left",
Expand All @@ -74,7 +68,7 @@ const NAVBAR_ITEMS: NavbarItem[] = [
to: "/docs/next/appsec/intro",
label: "Web Application Firewall (AppSec)",
},
{ type: "doc", docId: "cscli/cscli", label: "Cscli" },
{ type: "doc", docId: "cscli/intro", label: "Cscli" },
{ to: "/u/user_guides/intro", label: "Guides" },
{
type: "doc",
Expand Down Expand Up @@ -203,6 +197,7 @@ const redirects = [
from: "/blog/crowdsec_firewall_freebsd",
to: "/u/bouncers/firewall#pf-setup-freebsd",
},

];

const config: Config = {
Expand Down
2 changes: 1 addition & 1 deletion crowdsec-docs/sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -330,7 +330,7 @@ const sidebarsConfig: SidebarConfig = {
{
type: "doc",
label: "cscli",
id: "cscli/cscli",
id: "cscli/intro",
},
{
type: "category",
Expand Down
76 changes: 76 additions & 0 deletions crowdsec-docs/src/sectionMap.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
/**
* Maps each Docusaurus sidebar name (the key in sidebars.ts / sidebarsUnversioned.ts)
* to a human-readable label and the path to that section's intro page.
*
* The label appears as the first breadcrumb item after the home icon.
* The introPath is where clicking that breadcrumb item navigates to.
*
* Optional `parent` adds an intermediate crumb before the section label,
* e.g. for sub-sections of Security Engine.
*/
export type SectionInfo = {
label: string;
introPath: string;
parent?: {
label: string;
introPath: string;
};
};

export const SECTION_MAP: Record<string, SectionInfo> = {
// ── Versioned (sidebars.ts) ───────────────────────────────────
tutorialSidebar: {
label: "Security Engine",
introPath: "/docs/intro",
},
appSecSideBar: {
label: "Web Application Firewall",
introPath: "/docs/next/appsec/intro",
parent: { label: "Security Engine", introPath: "/docs/intro" },
},
cscliSidebar: {
label: "Cscli",
introPath: "/docs/cscli/cscli",
parent: { label: "Security Engine", introPath: "/docs/intro" },
},
sdkSideBar: {
label: "SDK",
introPath: "/docs/getting_started/sdk_intro",
parent: { label: "Security Engine", introPath: "/docs/intro" },
},

// ── Unversioned (sidebarsUnversioned.ts) ─────────────────────
consoleSidebar: {
label: "Console",
introPath: "/u/console/intro",
},
ctiApiSidebar: {
label: "CTI",
introPath: "/u/cti_api/intro",
},
remediationSideBar: {
label: "Remediation Components",
introPath: "/u/bouncers/intro",
},
blocklistsSideBar: {
label: "Blocklists",
introPath: "/u/blocklists/getting_started",
},
trackerApiSidebar: {
label: "Tracker API",
introPath: "/u/tracker_api/intro",
},
troubleshootingSideBar: {
label: "Troubleshooting",
introPath: "/u/troubleshooting/intro",
},
guidesSideBar: {
label: "Guides",
introPath: "/u/user_guides/intro",
},
gettingStarted: {
label: "Getting Started",
introPath: "/u/getting_started/intro",
parent: { label: "Security Engine", introPath: "/docs/intro" },
},
};
Loading
Loading