[Install] DRY some docs (#482)

* DRY * Fix linkl * DRY * Update RC * Fix hub link * dec
crowdsecurity · Oct 26, 2023 · 7791556 · 7791556
1 parent 3093fd9
commit 7791556
Show file tree

Hide file tree

Showing 4 changed files with 43 additions and 72 deletions.
diff --git a/crowdsec-docs/docs/bouncers/intro.md b/crowdsec-docs/docs/bouncers/intro.md
@@ -9,19 +9,24 @@ sidebar_position: 1
 :::info
 You may see Remediation Components referred to as "bouncers" in the documentation and/or within cscli commands.
 :::
+
 ## Introduction
 
-Remediation Components are software packages in charge of acting upon decision's provided by the Security Engine.
+Remediation Components are software packages in charge of acting upon decisions provided by the Security Engine. Depending on where you would like to remediate the decision, you will need to install the appropriate remediation component.
+
+:::info
+Don't know which component suits your needs? Then join our [discord](https://discord.gg/crowdsec) and ask the community!
+:::
+
+- [nginx](/bouncers/nginx.mdx) will check requester IP against the local API before granting or denying access.
+- [firewall](/bouncers/firewall.mdx) will add IPs to nftables/ipset set.
+- [cloudflare](/bouncers/cloudflare.mdx) will add IPs to the Cloudflare firewall.
+- [blocklist](/bouncers/blocklist-mirror.mdx) will serve the blocklist to a appliance such as pfsense, fortinet, untangle via a http server.
 
-- [nginx bouncer](/bouncers/nginx.mdx) will check requester IP against the local API before granting or denying access.
-- [firewall bouncer](/bouncers/firewall.mdx) will add IPs to nftables/ipset set.
-- [cloudflare bouncer](/bouncers/cloudflare.mdx) will add IPs to the Cloudflare firewall.
-- [blocklist mirror](/bouncers/blocklist-mirror.mdx) will serve the blocklist to a appliance such as pfsense, fortinet, untangle via a http server.
+**The above is not an exhaustive list of remediation components, you can find more on the [hub](https://app.crowdsec.net/hub/bouncers).**
 
 Remediation Components interact with [crowdsec's Local API](/local_api/intro.md) to retrieve active decisions and remediate appropriately.
 
-You can explore [available remediation components on the hub](https://hub.crowdsec.net/browse/#bouncers).
-
 For your remediation components to communicate with the local API, you have to generate an API token with `cscli` and put it in the associated configuration file:
 
 ```bash

diff --git a/crowdsec-docs/docs/getting_started/install.mdx b/crowdsec-docs/docs/getting_started/install.mdx
@@ -96,14 +96,15 @@ Before installing the package, you might want to check [the ports that will be u
   </TabItem>
 </Tabs>
 
-<!-- TBD : fix links -->
-
 You now have the Security Engine running ! You can move forward and install a [remediation component](/bouncers/intro.md), or take a [tour](/getting_started/crowdsec_tour.md) of the software beforehand !
 
 Directories:
 
-* The application lives in the folder `\etc\crowdsec` using less than 0.5 MBytes of storage.
-* The data is stored in the folder `\lib\crowdsec\data` and needs around 97 MBytes of storage.
+* The application lives in the folder `/etc/crowdsec`.
+* The data is stored in the folder `/var/lib/crowdsec/data`.
+
+
+## Remediation Component
 
 :::caution
 
@@ -112,48 +113,6 @@ You need to deploy a [Remediation Component](/bouncers/intro.md) to enforce deci
 
 :::
 
-
-## Install a Remediation Component
-
-:::info
-While we're suggesting to install the firewall remediation component it may not be best suited for your setup.
-
-Please reffer to [remediation components](/bouncers/intro.md) section about different components we have.
-:::
-
-<Tabs
-  defaultValue="debian"
-  groupId="operating-systems"
-  values={[
-    {label: 'Debian/Ubuntu', value: 'debian'},
-    {label: 'EL/Fedora/Centos7', value: 'centos7'},
-    {label: 'EL/Fedora/Centos8', value: 'centos8'},
-    {label: 'Amzn Linux 2', value: 'amz'},
-    {label: 'OpenWRT', value: 'openwrt'},
-    {label: 'CloudLinux', value: 'cloudlinux'},
-  ]}>
-  <TabItem value="debian">
-    <CodeBlock className="language-bash">apt install crowdsec-firewall-bouncer-iptables</CodeBlock>
-  </TabItem>
-
-  <TabItem value="centos7">
-      <CodeBlock className="language-bash">yum install crowdsec-firewall-bouncer-iptables</CodeBlock>
-  </TabItem>
-  <TabItem value="centos8">
-    <CodeBlock className="language-bash">dnf install crowdsec-firewall-bouncer-iptables</CodeBlock>
-  </TabItem>
-  <TabItem value="amz">
-    <CodeBlock className="language-bash">yum install crowdsec-firewall-bouncer-iptables</CodeBlock>
-  </TabItem>
-  <TabItem value="openwrt">
-    <CodeBlock className="language-bash">opkg install crowdsec-firewall-bouncer</CodeBlock>
-  </TabItem>
-  <TabItem value="cloudlinux">
-      <CodeBlock className="language-bash">yum install crowdsec-firewall-bouncer-iptables</CodeBlock>
-  </TabItem>
-</Tabs>
-
-
 ## Running CrowdSec on Raspberry Pi OS/Raspbian 
 
 Please keep in mind that Raspberry Pi OS is designed to work on all

diff --git a/crowdsec-docs/docs/getting_started/intro.md b/crowdsec-docs/docs/getting_started/intro.md
@@ -12,9 +12,12 @@ You may see Security Engine referred to as "agent" in the documentation/videos a
 
 The Security Engine is a core component of CrowdSec. It is the component that will analyze logs and will expose an API endpoint for the remediation components to get the decisions made by the engine.
 
+## Supported Platforms
 
-### Why is my Security Engine classed as a "log processor" within the console?
+See [Version Matrix](/getting_started/versions_matrix.md) for a list of supported platforms.
+
+## Why is my Security Engine classed as a "log processor" within the console?
 
 The `Security Engine` comes compiled with a number of optional features that can be enabled or disabled at runtime. One of these features is called the "LAPI" (Local API). If this feature is disabled at runtime, the Security Engine will be classed as a "log processor" within the console as it will only be able to process logs and forward the alerts to the local API you define in the configuration.
 
-Most commonly this is the case when you are running in a distributed setup, where you have a central server that is running the LAPI and a number of remote servers that are running the "Log processors".
+Most commonly this is the case when you are running in a distributed setup, where you have a central server that is running the LAPI and a number of remote servers that are running the "Log processors".
diff --git a/crowdsec-docs/docs/getting_started/versions_matrix.md b/crowdsec-docs/docs/getting_started/versions_matrix.md
@@ -7,28 +7,32 @@ sidebar_position: 1
 
 ## Maintenance policy
 
-The last two major releases are supported. Hence as of now 1.4.4 and
-1.3.4 are supported. 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 
+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 | amd64/arm64/armhf | Debian | bookworm/bullseye/buster/stretch | 1.5.4 and 1.4.6 | [packagecloud](https://packagecloud.io/crowdsec/crowdsec) |
-| Linux | amd64/arm64 | RedHat/CentOS | 6/7/8/9 | 1.5.4 and 1.4.6| [packagecloud](https://packagecloud.io/crowdsec/crowdsec) |
-| Linux | amd64/arm64 | Oracle Linux | 7/8/9 | 1.5.4 and 1.4.6| [packagecloud](https://packagecloud.io/crowdsec/crowdsec) |
-| Linux | amd64/arm64/armel/armhf/i386/mips64el/mipsel/ppc64el/s390x | Debian | 1.4.6 | [official debian repository](https://packages.debian.org/search?keywords=crowdsec&searchon=names&suite=stable&section=all) |
-| Linux | amd64/arm64 | Fedora | 37/38 | 1.5.4 (and 1.4.6 only for fc37) | [packagecloud](https://packagecloud.io/crowdsec/crowdsec) |
-| Linux | amd64/arm64 | Amazon linux | 2 | 1.5.4 and 1.4.6 |  [packagecloud](https://packagecloud.io/crowdsec/crowdsec) |
-| Linux | amd64/arm64 | Ubuntu Linux| 16.04/18.04/20.04/22.04/22.10 | 1.4.4 and 1.4.6| [packagecloud](https://packagecloud.io/crowdsec/crowdsec) |
-| FreeBSD | amd64/i386 | N/A | 12 | 1.5.4 | [freshports](https://www.freshports.org/security/crowdsec/) |
-| FreeBSD | amd64/i386/arm64/armv7 | N/A | 13 | 1.5.4 | [freshports](https://www.freshports.org/security/crowdsec/) |
-| FreeBSD | amd64/i386 | N/A | 14 | 1.5.4 | [freshports](https://www.freshports.org/security/crowdsec/) |
-| FreeBSD | arm64/armv7 | N/A | 14 | 1.5.4 | [freshports](https://www.freshports.org/security/crowdsec/) |
-| OPNsense | amd64 | N/A | 23.7 | 1.5.4 | [freshports](https://www.freshports.org/security/crowdsec/) |
-| Windows | amd64 | to be defined | 1.5.4 | [github releases](https://github.com/crowdsecurity/crowdsec/releases/tag/v1.4.4)|
-| Windows | amd64 | to be defined | 1.4.2 | [chocolatey](https://community.chocolatey.org/packages?q=crowdsec) |
+| [Linux](/getting_started/install.mdx) | amd64/arm64/armhf | Debian | bookworm/bullseye/buster/stretch | 1.5.4 and 1.4.6 | [packagecloud](https://packagecloud.io/crowdsec/crowdsec) |
+| [Linux](/getting_started/install.mdx) | amd64/arm64 | RedHat/CentOS | 6/7/8/9 | 1.5.4 and 1.4.6| [packagecloud](https://packagecloud.io/crowdsec/crowdsec) |
+| [Linux](/getting_started/install.mdx) | amd64/arm64 | Oracle Linux | 7/8/9 | 1.5.4 and 1.4.6| [packagecloud](https://packagecloud.io/crowdsec/crowdsec) |
+| [Linux](/getting_started/install.mdx) | amd64/arm64/armel/armhf/i386/mips64el/mipsel/ppc64el/s390x | Debian | 1.4.6 | [official debian repository](https://packages.debian.org/search?keywords=crowdsec&searchon=names&suite=stable&section=all) |
+| [Linux](/getting_started/install.mdx) | amd64/arm64 | Fedora | 37/38 | 1.5.4 (and 1.4.6 only for fc37) | [packagecloud](https://packagecloud.io/crowdsec/crowdsec) |
+| [Linux](/getting_started/install.mdx) | amd64/arm64 | Amazon linux | 2 | 1.5.4 and 1.4.6 |  [packagecloud](https://packagecloud.io/crowdsec/crowdsec) |
+| [Linux](/getting_started/install.mdx) | amd64/arm64 | Ubuntu Linux| 16.04/18.04/20.04/22.04/22.10 | 1.4.4 and 1.4.6| [packagecloud](https://packagecloud.io/crowdsec/crowdsec) |
+| [FreeBSD](/getting_started/install_freebsd.md) | amd64/i386 | N/A | 12 | 1.5.4 | [freshports](https://www.freshports.org/security/crowdsec/) |
+| [FreeBSD](/getting_started/install_freebsd.md) | amd64/i386/arm64/armv7 | N/A | 13 | 1.5.4 | [freshports](https://www.freshports.org/security/crowdsec/) |
+| [FreeBSD](/getting_started/install_freebsd.md) | amd64/i386 | N/A | 14 | 1.5.4 | [freshports](https://www.freshports.org/security/crowdsec/) |
+| [FreeBSD](/getting_started/install_freebsd.md) | arm64/armv7 | N/A | 14 | 1.5.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) | amd64 | to be defined | 1.5.4 | [github releases](https://github.com/crowdsecurity/crowdsec/releases/tag/v1.4.4)|
+| [Windows](/getting_started/getting_started_on_windows.md) | amd64 | to be defined | 1.4.2 | [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.5.4 | [dockerhub](https://hub.docker.com/r/crowdsecurity/crowdsec) |
 | helm chart | amd64/arm64 | helm | N/A | 1.5.4 | [helm chart](https://github.com/crowdsecurity/helm-charts) |