Databases

By default, the CrowdSec Local API use SQLite as backend storage. In case you expect a lot of traffic on your Local API, you should use MySQL, MariaDB or PostgreSQL.

For SQLite, there is nothing to do to make it work with CrowdSec. For MySQL, MariaDB and PostgreSQL , you need to create a database and an user.

Please refer to ent. supported database. At the time of writing :

• MySQL 5.6.35, 5.7.26 and 8
• MariaDB 10.2, 10.3 and latest
• PostgreSQL 11, 12, 13, 14 and 15
• SQLite
• Gremlin

warning

When switching an existing instance of CrowdSec to a new database backend, you need to register your machine(s) (ie. cscli machines add -a) and bouncer(s) to the new database, as data is not migrated.

MySQL and MariaDB

Connect to your MySQL or MariaDB server and run the following commands:

mysql> CREATE DATABASE crowdsec;
mysql> CREATE USER 'crowdsec'@'%' IDENTIFIED BY '<password>';
mysql> GRANT ALL PRIVILEGES ON crowdsec.* TO 'crowdsec'@'%';
mysql> FLUSH PRIVILEGES;

Then edit /etc/crowdsec/config.yaml to update the db_config part.

You can now start or restart CrowdSec.

PostgreSQL

Connect to your PostgreSQL server and run the following commands:

postgres=# CREATE DATABASE crowdsec;
postgres=# CREATE USER crowdsec WITH PASSWORD '<password>';
postgres=# ALTER SCHEMA public owner to crowdsec;
postgres=# GRANT ALL PRIVILEGES ON DATABASE crowdsec TO crowdsec;

If you are running a version of PostgreSQL >= 15, you will also need to grant permission to create objects in the public schema:

postgres=# \c crowdsec
postgres=# GRANT CREATE on SCHEMA public TO crowdsec;

Then edit /etc/crowdsec/config.yaml to update the db_config part.

You can now start or restart CrowdSec.