Getting Started
Welcome to CrowdSec!
In this section, you'll be taken through the process of creating a console account, with the initial step being the installation of the Security Engine, followed by the deployment of your first Remediation Component.
Creating a console account
To embark on your CrowdSec journey, the optimal starting point is to set up a console account, as it grants you access to complimentary features that seamlessly integrate with your Security Engine.
The CrowdSec console serves as a web-based interface enabling you to conveniently monitor all your CrowdSec instances from a centralized hub. To get started, simply sign up here.
Deploy
Walkthrough
If you prefer a guided, step-by-step video tutorial for installing the Security Engine in a sandbox environment, please refer to our comprehensive guide.
Complete Introduction
Watch a short series of videos on how to install CrowdSec and protect your infrastructure
Learn with CrowdSec Academyor follow the steps below.
Security Engine
In our updated documentation, we now refer to CrowdSec as the "Security Engine" and Bouncers as "Remediation Components" to better describe their roles in the ecosystem.
Prerequisites
The Security Engine by default uses the following ports:
- 8080/tcp for the API
- 6060/tcp for the Prometheus metrics / Debugging
If these ports are not available on your system, you can change them in the configuration file post installation. See Configuration for more information.
Please note that the API is mandatory for your security engine, do not remove it from your configuration.
Using the repository
For the most straightforward installation of the Security Engine, utilize the official repository, guaranteeing you'll constantly have the latest version.
Please see the relevant documentation for your OS:
Installing from source
Should you opt for a source-based installation, you can follow the steps outlined here.
Remediation Component
After installing the Security Engine, you can proceed to install a Remediation Component, which is responsible for executing actions based on the decisions made by the Security Engine.
The specific Remediation Component to install may vary based on your network and operating system configuration.
If you are uncertain about which one to install, please refer to our Remediation Components section or join our Discord and ask our community.
Enroll
Since you created your account on the CrowdSec console, you can now enroll your Security Engine to your account.
To do so, you can find steps outlined here.
