Database

By default, the database does not need any extra configuration

You are able to configure the database the bot uses to your liking using these settings. Make sure you know what you are doing because the bot cannot function without a working database.

database:
  # Defines which datatype should be used, choose between [NONE, SQLITE]
  # ** WARNING ** if you set this to none, and no other database option is given, the process will crash on startup
  use_predefined_database_sets: "SQLITE"
  # ** WARNING ** When using custom, you may experience issues. This is a work in progress feature, so it is unstable, report problems on the GitHub page
  # Which type of custom db should be used: [SQLITE, MYSQL, POSTGRESQL, MARIADB]
  custom_type: ""
  # Here you can input a custom database url to connect to. Make sure to not include https:// or http://, just use the plain url for
  # database connection, e.g., < localhost:3306/test >
  custom_url: ""
  # Here you've input the custom db password
  custom_username: ""
  # Here you have to enter the password of your db session
  custom_password: ""

Use Predifined Database

The bot has databases that are already configured and ready to use without any setup. You can choose from:

NONE, SQLITE

Custom Type

The type of which database you use. Note that only SQL databases are supported, databases such as LiteDB will not work. The supported types are:

SQLITE, MYSQL, POSTGRESQL, MARIADB

Custom Url

If you are using docker, make sure to bind the ports correctly in your compose config.

The url to your database. Make sure to include the port, e.g. localhost:3006/test

Custom Username

Your database user.

Custom Password

The password to your database user.

The database does by default not need any configuration. It normally uses a sqlite database that needs no setup or changes.

If you want to change from the default sqlite database to another database.

database:
  # Defines which datatype should be used, choose between [NONE, SQLITE]
  # ** WARNING ** if you set this to none, and no other database option is given, the process will crash on startup
  use_predefined_database_sets: "SQLITE"
  # ** WARNING ** When using custom, you may experience issues. This is a work in progress feature, so it is unstable, report problems on the GitHub page
  # Which type of custom db should be used: [SQLITE, MYSQL, POSTGRESQL, MARIADB]
  custom_type: ""
  # Here you can input a custom database url to connect to. Make sure to not include https:// or http://, just use the plain url for
  # database connection, e.g., < localhost:3306/test >
  custom_url: ""
  # Here you've input the custom db password
  custom_username: ""
  # Here you have to enter the password of your db session
  custom_password: ""

Use Predifined Database Sets

You can choose from databases that have already been configured by the bot, available types are:

NONE, SQLITE

Custom Type

Which type of custom database do you use? Non-Sql databases are not supported:

SQLITE, MYSQL, POSTGRESQL, MARIADB

Custom Url

When using docker, make sure you pass through your database ports.

What is the url of your database? You have to include the port e.g. localhost:3306/test

Custom Username

The name of your database user.

Custom Password

The password for your database user.