diff --git a/crowdsec-docs/docs/getting_started/versions_matrix.md b/crowdsec-docs/docs/getting_started/versions_matrix.md deleted file mode 100644 index 5932bb370..000000000 --- a/crowdsec-docs/docs/getting_started/versions_matrix.md +++ /dev/null @@ -1,126 +0,0 @@ ---- -id: versions_matrix -title: Versions Matrix -sidebar_position: 1 ---- -# Versions matrix - -## Maintenance policy - -The last two releases are supported, see [releases page](https://github.com/crowdsecurity/crowdsec/releases) for more details. - -LTS versioning is not yet defined, but we are working on it. - -:::info -Crowdsec is open-source, and as such, we may not be aware of all the channels of crowdsec distribution. Our official distribution channel is packagecloud.io for packages, and github -::: - -## Matrix Versions - -| OS | Platform | Distribution | Distribution Version | CrowdSec Version | CrowdSec Location | -|----|----------|--------------|------------------|----------------------|-------------------| -| [Linux](/getting_started/install.mdx) | amd64/arm64/armhf | Debian | bookworm/bullseye/buster/stretch | 1.6.4 and 1.5.5 | [packagecloud](https://packagecloud.io/crowdsec/crowdsec) | -| [Linux](/getting_started/install.mdx) | amd64/arm64 | RedHat/CentOS | 7/8/9/10 | 1.6.4 and 1.5.5 | [packagecloud](https://packagecloud.io/crowdsec/crowdsec) | -| [Linux](/getting_started/install.mdx) | amd64/arm64 | Oracle Linux | 7/8/9 | 1.6.4 and 1.5.5 | [packagecloud](https://packagecloud.io/crowdsec/crowdsec) | -| [Linux](/getting_started/install.mdx) | amd64/arm64/armel/armhf/i386/mips64el/mipsel/ppc64el/s390x | Debian | 12 | 1.4.6 | [official debian repository](https://packages.debian.org/search?keywords=crowdsec&searchon=names&suite=stable§ion=all) | -| [Linux](/getting_started/install.mdx) | amd64/arm64 | Fedora | 40/41| 1.6.4 (and 1.5.5 only for fc39) | [packagecloud](https://packagecloud.io/crowdsec/crowdsec) | -| [Linux](/getting_started/install.mdx) | amd64/arm64 | Amazon linux | 2023 | 1.6.4 and 1.5.5 | [packagecloud](https://packagecloud.io/crowdsec/crowdsec) | -| [Linux](/getting_started/install.mdx) | amd64/arm64 | Ubuntu Linux| 16.04/18.04/20.04.6/22.04.5/24.04.1 | 1.6.0 and 1.5.5| [packagecloud](https://packagecloud.io/crowdsec/crowdsec) | -| [FreeBSD](/getting_started/install_freebsd.md) | amd64/i386/arm64 | N/A | 13 | 1.6.4 | [freshports](https://www.freshports.org/security/crowdsec/) | -| [FreeBSD](/getting_started/install_freebsd.md) | armv7 | N/A | 13 | 1.6.3 | [freshports](https://www.freshports.org/security/crowdsec/) | -| [FreeBSD](/getting_started/install_freebsd.md) | amd64/i386/arm64/armv7 | N/A | 14 | 1.6.4 | [freshports](https://www.freshports.org/security/crowdsec/) | -| [FreeBSD](/getting_started/install_freebsd.md) | amd64/i386/arm64 | N/A | 15 | 1.6.4 | [freshports](https://www.freshports.org/security/crowdsec/) | -| [OPNsense](/getting_started/install_opnsense.md) | amd64 | N/A | 23.7 | 1.5.4 | [freshports](https://www.freshports.org/security/crowdsec/) | -| [Windows](/getting_started/getting_started_on_windows.md) | N/A | amd64 | to be defined | 1.6.4 | [github releases](https://github.com/crowdsecurity/crowdsec/releases/tag/v1.6.4)| -| [Windows](/getting_started/getting_started_on_windows.md) | N/A | amd64 | to be defined | 1.6.4 | [chocolatey](https://community.chocolatey.org/packages?q=crowdsec) | -| Linux | almost all OpenWRT supported platform | OpenWRT | 23.05 | 1.5.4 | [OpenWrt repository](https://openwrt.org/packages/pkgdata/crowdsec) | -| Linux/Windows | amd64/arm64 | docker | N/A | 1.6.4 | [dockerhub](https://hub.docker.com/r/crowdsecurity/crowdsec) | -| home assistant | amd64/arm64 | docker | N/A | 1.6.4 | [crowdsecurity home assistant addon repo](https://github.com/crowdsecurity/home-assistant-addons/)| -| helm chart | amd64/arm64 | helm | N/A | 1.6.4 | [helm chart](https://github.com/crowdsecurity/helm-charts) | - - -Note: There is a subtile difference between armel, armhf and armv7: -armel and armhf are the ports name defined by debian, armel is -available on armv6 capable processer and higher, and armhf is -available on armv7 capable and higher. - -Linux -===== - -Linux packages are maintained by CrowdSec and shipped through -packagecloud.io repositories. Issues for packages have to be created -directly against the [crowdsec source -repository](https://github.com/crowdsecurity/crowdsec). Packages are -published automatically few hours after each new releases. - -There are two public repositories: -* [pkgcloud.io stable repository](https://packagecloud.io/crowdsec/) for published release -* [pkgcloud.io beta repository](https://packagecloud.io/crowdsec-testing/) for published release - -Note: There is a version on official debian repository as well. - - -FreeBSD -======= - -FreeBSD ports are updated via requests to https://bugs.freebsd.org/bugzilla/ - -Anybody can open issues or even updates but most packages have an official maintainer (@mmetc for crowdsec). -Issues are reviewed by maintainers, then by committers or by the ports management team. -A proper review process is in place therefore updates can take a few days. - -To see pending issues related to crowdsec or the bouncers, search "crowdsec". -To see closed issues as well, search for "ALL crowdsec" - -The state of the packages for the several FreeBSD versions and architectures can be seen at https://www.freshports.org/ - -Usually packages apprear in the repository updates (quarterly or latest), but -if required they can be installed directly, for example: - -$ pkg add https://pkg.freebsd.org/FreeBSD:12:amd64/latest/All/crowdsec-1.4.3.pkg - -The repository for work-in-progress ports is -https://github.com/crowdsecurity/packaging-freebsd, once tested they are -submitted in bugzilla. - -The following packages have been ported so far: - - - CrowdSec - https://github.com/freebsd/freebsd-ports/tree/main/security/crowdsec [1] - packages: https://www.freshports.org/security/crowdsec/ - - - Firewall Bouncer - https://github.com/freebsd/freebsd-ports/tree/main/security/crowdsec-firewall-bouncer - packages: https://www.freshports.org/security/crowdsec-firewall-bouncer/ - - - Blocklist Mirror - https://github.com/freebsd/freebsd-ports/tree/main/security/crowdsec-blocklist-mirror - packages: https://www.freshports.org/security/crowdsec-blocklist-mirror - - -[1] read-only mirror of https://cgit.freebsd.org/ports/ -also on https://gitlab.com/FreeBSD/freebsd-ports - - -OPNsense -======== - -OPNsense has its own port tree, which tracks the main branch from -freebsd: https://github.com/opnsense/ports Updates are frequent (often -daily) but can be delayed for code freeze or holidays. The source of -the crowdsec plugin is in -https://github.com/opnsense/plugins/tree/master/security/crowdsec and -it depends on the crowdsec and firewall bouncer packages. New -versions are pushed via pull requests on the github repository. - -Windows -======= - -CrowdSec Windows releases are available for download few minutes after -releasing directly on the [release page of -github](https://github.com/crowdsecurity/crowdsec/releases). - -We do our best to keep an up to date version in [chocolatey -repository](https://community.chocolatey.org/packages?q=crowdsec) as -well. It has go through a moderation process, so we don't have any -grasp on the publication timeline. - -Issues have to be filed directly against the [crowdsec source -repository](https://github.com/crowdsecurity/crowdsec) diff --git a/crowdsec-docs/docs/intro.mdx b/crowdsec-docs/docs/intro.mdx index 06bedc210..eb256f250 100644 --- a/crowdsec-docs/docs/intro.mdx +++ b/crowdsec-docs/docs/intro.mdx @@ -29,7 +29,7 @@ The crowd-sourced aspect allows the sharing of attacks they detected and blocked In addition to the core "detect and react" mechanism, CrowdSec is committed to several other key aspects: -- **Easy Installation**: Effortless out-of-the-box installation on all [supported platforms](/getting_started/versions_matrix.md). +- **Easy Installation**: Effortless out-of-the-box installation on all [supported platforms](/u/getting_started/intro). - **Simplified Daily Operations**: You have access to our Web UI administration via [CrowdSec's console](http://app.crowdsec.net) or the powerful [Command line tool cscli](/cscli/cscli.md) for effortless maintenance and keeping your detection mechanisms up-to-date. - **Reproducibility**: The Security Engine can analyze not only live logs but also [cold logs](/u/user_guides/replay_mode), making it easier to detect potential false triggers, conduct forensic analysis, or generate reports. - **Versatile**: The Security Engine can analyze [system logs](/docs/data_sources/intro) and [HTTP Requests](/docs/next/appsec/intro) to exhaustively protect your perimeter. diff --git a/crowdsec-docs/unversioned/blocklists/intro.md b/crowdsec-docs/unversioned/blocklists/intro.md index 48ea23c86..45ca21ff3 100644 --- a/crowdsec-docs/unversioned/blocklists/intro.md +++ b/crowdsec-docs/unversioned/blocklists/intro.md @@ -28,7 +28,7 @@ CrowdSec Blocklists are available in three tiers: - Community: - Limited number of Blocklists (Third-party and Free). - - You are limited to 3 Blocklists across [Integrations](integrations/intro.mdx) and [Security Engines](getting_started/introduction.md). + - You are limited to 3 Blocklists across [Integrations](integrations/intro.mdx) and [Security Engines](getting_started/introduction.mdx). - Premium (Included in paid plans): - Includes free tier - Removes the limit on the number of Blocklists you can use. diff --git a/crowdsec-docs/unversioned/console/getting_started.mdx b/crowdsec-docs/unversioned/console/getting_started.mdx index bbd2ab78c..65dc22352 100644 --- a/crowdsec-docs/unversioned/console/getting_started.mdx +++ b/crowdsec-docs/unversioned/console/getting_started.mdx @@ -32,4 +32,4 @@ Depending on your use case you may want to start with the following guides: link="/u/blocklists/getting_started/" />
-If you're new to CrowdSec, we recommend starting with the [Security Engine](/getting_started/introduction.md) guide, however, if you are unsure where to start, feel free to browse our [main website for more information](https://www.crowdsec.net/). +If you're new to CrowdSec, we recommend starting with the [Security Engine](/getting_started/introduction.mdx) guide, however, if you are unsure where to start, feel free to browse our [main website for more information](https://www.crowdsec.net/). diff --git a/crowdsec-docs/unversioned/console/notification_integrations/rule.mdx b/crowdsec-docs/unversioned/console/notification_integrations/rule.mdx index 8c3c30512..eb8c0693c 100644 --- a/crowdsec-docs/unversioned/console/notification_integrations/rule.mdx +++ b/crowdsec-docs/unversioned/console/notification_integrations/rule.mdx @@ -14,7 +14,7 @@ By setting up specific rules, you can ensure that you are only notified about ev This guide will walk you through the process of creating a notification rule for your linked integration. > You need at least one integration linked to your CrowdSec Console to create a notification rule. -> If you haven't linked an integration yet, please refer to the [Integrations Overview](/u/console/notification_integrations/overview) for more information on how to do so. +> If you haven't linked an integration yet, please refer to the [Integrations Overview](overview.mdx) for more information on how to do so. ## Create a notification rule @@ -22,7 +22,7 @@ This guide will walk you through the process of creating a notification rule for ![](/img/console/notification_integrations/notification-rule-list.png) -2. Select the events you want to be notified about. You can only select one of the three category at the time (Threat Hunting, Stack or Admin). Each of these categories contains a list of [events](/notification_integrations/overview.mdx) that you can choose from. (Threat hunting category let you select only one event due to its conditions variance). +2. Select the events you want to be notified about. You can only select one of the three category at the time (Threat Hunting, Stack or Admin). Each of these categories contains a list of [events](overview.mdx) that you can choose from. (Threat hunting category let you select only one event due to its conditions variance). ![](/img/console/notification_integrations/events-selection.png) diff --git a/crowdsec-docs/unversioned/console/notification_integrations/webhook.mdx b/crowdsec-docs/unversioned/console/notification_integrations/webhook.mdx index 1be1004bd..9d2c7de1c 100644 --- a/crowdsec-docs/unversioned/console/notification_integrations/webhook.mdx +++ b/crowdsec-docs/unversioned/console/notification_integrations/webhook.mdx @@ -87,7 +87,7 @@ Only one option may be checked under this category #### `Is Attacked` -Your organization is under attack, known as the `am I under attack` feature [documentation](console/security_engines/am_i_under_attack.md) +Your organization is under attack, known as the `am I under attack` feature [documentation](console/security_engines/am_i_under_attack.mdx) ```json { diff --git a/crowdsec-docs/unversioned/getting_started/introduction.mdx b/crowdsec-docs/unversioned/getting_started/introduction.mdx index 854bf45fd..1a3886def 100644 --- a/crowdsec-docs/unversioned/getting_started/introduction.mdx +++ b/crowdsec-docs/unversioned/getting_started/introduction.mdx @@ -74,8 +74,6 @@ We support the following operating systems: * [pfSense](/getting_started/installation/pfsense.mdx) * [WHM](/getting_started/installation/whm.mdx) -[See version matrix for detailed breakdown](/docs/next/getting_started/versions_matrix) - ### Ports CrowdSec Security Engine uses the following default ports (bound to localhost/loopback by default) - these can be altered after installation: diff --git a/crowdsec-docs/unversioned/getting_started/post_installation/acquisition.mdx b/crowdsec-docs/unversioned/getting_started/post_installation/acquisition.mdx index da16a4797..5dcfd1bea 100644 --- a/crowdsec-docs/unversioned/getting_started/post_installation/acquisition.mdx +++ b/crowdsec-docs/unversioned/getting_started/post_installation/acquisition.mdx @@ -60,7 +60,7 @@ Collections are a group of [Parsers](https://docs.crowdsec.net/docs/next/parsers ## Next steps? -If you already see all services you want covered by the then you can [head back to the post installation steps.](/getting_started/next_steps.md#3-acquisitions) +If you already see all services you want covered by the then you can [head back to the post installation steps.](/getting_started/next_steps.mdx#3-acquisitions) Follow the [how to setup a new acquisition](/getting_started/post_installation/acquisition_new.mdx) section if you see some log sources are not being monitored. diff --git a/crowdsec-docs/unversioned/getting_started/post_installation/console.mdx b/crowdsec-docs/unversioned/getting_started/post_installation/console.mdx index 81749adba..38f1e1985 100644 --- a/crowdsec-docs/unversioned/getting_started/post_installation/console.mdx +++ b/crowdsec-docs/unversioned/getting_started/post_installation/console.mdx @@ -146,4 +146,4 @@ Now that you have enrolled your first engine, you can start exploring the consol - [Third-Party Blocklists](/getting_started/post_installation/console_blocklists.mdx) - [CrowdSec Hub](/getting_started/post_installation/console_hub.mdx) -If not head back to the [post installation steps](/getting_started/next_steps.md#1-crowdsec-console) to follow the rest of the steps. +If not head back to the [post installation steps](/getting_started/next_steps.mdx#1-crowdsec-console) to follow the rest of the steps. diff --git a/crowdsec-docs/unversioned/getting_started/post_installation/console_blocklists.mdx b/crowdsec-docs/unversioned/getting_started/post_installation/console_blocklists.mdx index 07ffa83c6..3a846f39e 100644 --- a/crowdsec-docs/unversioned/getting_started/post_installation/console_blocklists.mdx +++ b/crowdsec-docs/unversioned/getting_started/post_installation/console_blocklists.mdx @@ -107,4 +107,4 @@ Now that you have subscribed your engine to a list, you can continue exploring t - [CrowdSec Hub](/getting_started/post_installation/console_hub.mdx) -If not head back to the [post installation steps](/getting_started/next_steps.md#1-crowdsec-console) to follow the rest of the steps. +If not head back to the [post installation steps](/getting_started/next_steps.mdx#1-crowdsec-console) to follow the rest of the steps. diff --git a/crowdsec-docs/unversioned/getting_started/post_installation/console_hub.mdx b/crowdsec-docs/unversioned/getting_started/post_installation/console_hub.mdx index de35a48a0..d557dc2db 100644 --- a/crowdsec-docs/unversioned/getting_started/post_installation/console_hub.mdx +++ b/crowdsec-docs/unversioned/getting_started/post_installation/console_hub.mdx @@ -140,4 +140,4 @@ These rules are defined and loaded by [AppSec Configurations](/docs/next/appsec/ ## Next Steps? -Now that you have viewed the CrowdSec Hub, you can head back to the [post installation steps](/getting_started/next_steps.md#1-crowdsec-console) to follow the rest of the steps. +Now that you have viewed the CrowdSec Hub, you can head back to the [post installation steps](/getting_started/next_steps.mdx#1-crowdsec-console) to follow the rest of the steps. diff --git a/crowdsec-docs/unversioned/getting_started/post_installation/troubleshoot.mdx b/crowdsec-docs/unversioned/getting_started/post_installation/troubleshoot.mdx index 84238c5c3..2f1a8acdd 100644 --- a/crowdsec-docs/unversioned/getting_started/post_installation/troubleshoot.mdx +++ b/crowdsec-docs/unversioned/getting_started/post_installation/troubleshoot.mdx @@ -47,7 +47,7 @@ Please update the above commands to match your log location if it is different. level=fatal msg="while serving local API: listen tcp 127.0.0.1:8080: bind: address already in use" ``` -By default as outlined in the [prerequisites](/unversioned/getting_started/prerequisites.md) page, CrowdSec uses ports `6060` and `8080`. If you have another service using these ports you will need to alter CrowdSec configuration to use different ports. +By default as outlined in the [prerequisites](/unversioned/getting_started/introduction.mdx) page, CrowdSec uses ports `6060` and `8080`. If you have another service using these ports you will need to alter CrowdSec configuration to use different ports. This can be achieved by modifying two configuration files here are the locations of the files: @@ -91,4 +91,4 @@ After you have made the changes you will need to restart the CrowdSec service. If the above hasn't resolved the issue you are facing, you can find more detailed troubleshooting documentation [here](/troubleshooting/intro.md). -If you have resolved the issue you can continue with the [post installation steps](/getting_started/next_steps.md#1-crowdsec-console). +If you have resolved the issue you can continue with the [post installation steps](/getting_started/next_steps.mdx#1-crowdsec-console). diff --git a/crowdsec-docs/unversioned/getting_started/post_installation/whitelists.mdx b/crowdsec-docs/unversioned/getting_started/post_installation/whitelists.mdx index fb81acfac..4504595fe 100644 --- a/crowdsec-docs/unversioned/getting_started/post_installation/whitelists.mdx +++ b/crowdsec-docs/unversioned/getting_started/post_installation/whitelists.mdx @@ -91,7 +91,7 @@ If you are unsure if you need a whitelist, you can monitor the logs and see if t However, please note if you should get a decision made agaisnt your IP address and using remediation components such as `iptables` or `nftables` then this will prevent you from accessing **ANY** service on the server. -Within our enterprise offering we have a feature called [Decision Management](console/decisions/decisions_management.md) that allows you to manage decisions via the [console](https://app.crowdsec.net/). +Within our enterprise offering we have a feature called [Decision Management](console/decisions/decisions_management.mdx) that allows you to manage decisions via the [console](https://app.crowdsec.net/). ## Creating your first whitelist. @@ -298,4 +298,4 @@ sudo cscli decisions delete --ip 192.168.1.1 If you are still looking for examples on how to create a whitelist, you can find more detailed documentation [here](/docs/next/whitelist/intro). -If you have created your first whitelist, tested it and happy to continue then [click here](getting_started/next_steps.md#2-whitelists). +If you have created your first whitelist, tested it and happy to continue then [click here](getting_started/next_steps.mdx#2-whitelists). diff --git a/crowdsec-docs/unversioned/user_guides/consuming_fastly_logs.md b/crowdsec-docs/unversioned/user_guides/consuming_fastly_logs.md index 7d99ca3e1..226a27593 100644 --- a/crowdsec-docs/unversioned/user_guides/consuming_fastly_logs.md +++ b/crowdsec-docs/unversioned/user_guides/consuming_fastly_logs.md @@ -57,7 +57,7 @@ We configure rsyslog to ignore local syslogs and keep only remote syslog. Then w ## Install crowdsec with fastly collection -On the same machine, install crowdsec following as mentioned [here](/getting_started/introduction.md) +On the same machine, install crowdsec following as mentioned [here](/getting_started/introduction.mdx) ### Setup acquisition @@ -82,4 +82,4 @@ sudo cscli collections install crowdsecurity/fastly ### Reload crowdec ``` sudo systemctl reload crowdsec.service -``` \ No newline at end of file +```