> For the complete documentation index, see [llms.txt](https://kermitcloud.gitbook.io/kermitcloud-hosting-wiki/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://kermitcloud.gitbook.io/kermitcloud-hosting-wiki/discord-bot/configurations.md).

# Configurations

This page contains the entire config file content as a table, we have marked what you will need to run the bot. And its default values and descriptions/explanations.

### NOTE <a href="#note" id="note"></a>

The current content is based on the pre-release of KermitCloud V3.

### Config file <a href="#config-file" id="config-file"></a>

| **Name**                             | **Description**                                                               | **Default**                                                                                  | **Required**                |
| ------------------------------------ | ----------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | --------------------------- |
| **config.version**                   | The config file version                                                       | 2.0.0                                                                                        | yes                         |
| **config.creation**                  | The config file creation time                                                 | ?                                                                                            | yes                         |
| **hikari.sql.user**                  | The SQL username                                                              | root                                                                                         | yes                         |
| **hikari.sql.db**                    | The SQL database name                                                         | root                                                                                         | yes                         |
| **hikari.sql.pw**                    | The SQL password                                                              | yourpw                                                                                       | yes                         |
| **hikari.sql.host**                  | The SQL server address                                                        | localhost                                                                                    | yes                         |
| **hikari.sql.port**                  | The SQL server port                                                           | 3306                                                                                         | yes                         |
| **hikari.misc.storage**              | Possible entries: sqlite, mariadb, postgresql, h2, h2-server                  | sqlite                                                                                       | no                          |
| **hikari.sql.storageFile**           | The SQL storage file                                                          | storage/KermitCloud.db                                                                       | no                          |
| **hikari.misc.createEmbeddedServer** | Should an instance of an embedded server be created? Only used for H2-Server. | false                                                                                        | no                          |
| **hikari.sql.poolSize**              | Hikari SQL pool size                                                          | 10                                                                                           | yes                         |
| **bot.tokens.release**               | Token used when set to release build.                                         | ReleaseTokenhere                                                                             | yes                         |
| **bot.tokens.beta**                  | Token used when set to beta build.                                            | BetaTokenhere                                                                                | no                          |
| **bot.tokens.dev**                   | Token used when set to dev build.                                             | DevTokenhere                                                                                 | no                          |
| **bot.misc.status**                  | The status of the bot.                                                        | KermitCloud.de                                                                               | %guilds% Servers. (%shard%) |
| **bot.misc.feedbackChannelId**       | The channel used for feedback.                                                | 0                                                                                            | no                          |
| **bot.misc.ownerId**                 | The ID of the bot owner. Change this to yours!                                | 321580743488831490                                                                           | yes                         |
| **bot.misc.predefineInformation**    | Predefined information for the AI.                                            | You are KermitCloud, a Discord bot.                                                          | no                          |
| **bot.misc.invite**                  | The invite link of the bot.                                                   | [https://invite.KermitCloud.de](https://invite.kermitcloud.de/)                              | no                          |
| **bot.misc.support**                 | The support server link of the bot.                                           | [https://support.KermitCloud.de](https://support.kermitcloud.de/)                            | no                          |
| **bot.misc.github**                  | The GitHub link of the bot.                                                   | [https://github.KermitCloud.de](https://github.kermitcloud.de/)                              | no                          |
| **bot.misc.website**                 | The website link of the bot.                                                  | [https://KermitCloud.de](https://kermitcloud.de/)                                            | no                          |
| **bot.misc.webinterface**            | The web interface link of the bot.                                            | [https://cp.KermitCloud.de](https://cp.kermitcloud.de/)                                      | no                          |
| **bot.misc.record**                  | The recording link of the bot.                                                | [https://cp.KermitCloud.de/external/recording](https://cp.kermitcloud.de/external/recording) | no                          |
| **bot.misc.twitchAuth**              | The Twitch authentication link of the bot.                                    | [https://cp.KermitCloud.de/external/twitch](https://cp.kermitcloud.de/external/twitch)       | no                          |
| **bot.misc.advertisement**           | The advertisement in embed footers and others.                                | powered by Tube-hosting                                                                      | no                          |
| **bot.misc.name**                    | The name of the bot.                                                          | KermitCloud                                                                                  | yes                         |
| **bot.misc.shards**                  | The shard amount of the bot.                                                  | 1                                                                                            | yes                         |
| **bot.misc.modules.moderation**      | Enable the moderation module.                                                 | true                                                                                         | no                          |
| **bot.misc.modules.music**           | Enable the music module.                                                      | true                                                                                         | no                          |
| **bot.misc.modules.fun**             | Enable the fun commands.                                                      | true                                                                                         | no                          |
| **bot.misc.modules.community**       | Enable the community commands.                                                | true                                                                                         | no                          |
| **bot.misc.modules.economy**         | Enable the economy commands.                                                  | true                                                                                         | no                          |
| **bot.misc.modules.level**           | Enable the level module.                                                      | true                                                                                         | no                          |
| **bot.misc.modules.nsfw**            | Enable the NSFW module.                                                       | true                                                                                         | no                          |
| **bot.misc.modules.info**            | Enable the info commands.                                                     | true                                                                                         | no                          |
| **bot.misc.modules.hidden**          | Enable the hidden commands.                                                   | true                                                                                         | no                          |
| **bot.misc.modules.logging**         | Enable the logging module.                                                    | true                                                                                         | no                          |
| **bot.misc.modules.notifier**        | Enable the notifier module.                                                   | true                                                                                         | no                          |
| **bot.misc.modules.streamtools**     | Enable the stream-tools module.                                               | true                                                                                         | no                          |
| **bot.misc.modules.temporalvoice**   | Enable the temporal-voice module.                                             | true                                                                                         | no                          |
| **bot.misc.modules.tickets**         | Enable the tickets module.                                                    | true                                                                                         | no                          |
| **bot.misc.modules.suggestions**     | Enable the suggestions module.                                                | true                                                                                         | no                          |
| **bot.misc.modules.customcommands**  | Enable the custom commands module.                                            | true                                                                                         | no                          |
| **bot.misc.modules.customevents**    | Enable the custom events module.                                              | true                                                                                         | no                          |
| **bot.misc.modules.ai**              | Enable the AI module.                                                         | true                                                                                         | no                          |
| **bot.misc.modules.addons**          | Enable the addons module.                                                     | false                                                                                        | no                          |
| **bot.misc.modules.news**            | Enable the news command/module.                                               | true                                                                                         | no                          |
| **bot.misc.modules.games**           | Enable the games module.                                                      | true                                                                                         | no                          |
| **bot.misc.modules.reactionroles**   | Enable the reaction-roles module.                                             | true                                                                                         | no                          |
| **bot.misc.modules.slashcommands**   | Enable the slash-commands support.                                            | true                                                                                         | no                          |
| **bot.misc.modules.messagecommands** | Enable the message-commands support.                                          | true                                                                                         | no                          |
| **heartbeat.url**                    | The URL to the heartbeat server.                                              | none                                                                                         | no                          |
| **heartbeat.interval**               | The interval of the heartbeat.                                                | 60                                                                                           | no                          |
| **dagpi.apitoken**                   | Your Dagpi.xyz API token, for tweet image generation!                         | DAGPI.xyz API-Token                                                                          | no                          |
| **amari.apitoken**                   | Your Amari API token, for Amari Level imports!                                | Amari API-Token                                                                              | no                          |
| **openai.apiToken**                  | Your OpenAI API token, for ChatGPT!                                           | OpenAI API-Token                                                                             | no                          |
| **openai.apiUrl**                    | The URL to the OpenAI API.                                                    | <https://api.openai.com/v1/chat/completions>                                                 | no                          |
| **openai.model**                     | The model used for the OpenAI API.                                            | gpt-3.5-turbo-0301                                                                           | no                          |
| **sentry.dsn**                       | Your Sentry DSN, for error reporting!                                         | yourSentryDSNHere                                                                            | no                          |
| **spotify.client.id**                | Your Spotify application client ID                                            | yourspotifyclientid                                                                          | no                          |
| **spotify.client.secret**            | Your Spotify application client secret                                        | yourspotifyclientsecret                                                                      | no                          |
| **twitch.client.id**                 | Your Twitch application client ID                                             | yourtwitchclientid                                                                           | no                          |
| **twitch.client.secret**             | Your Twitch application client secret                                         | yourtwitchclientsecret                                                                       | no                          |
| **twitter.bearer**                   | Your Twitter APIv2 Bearer Token                                               | yourTwitterBearerToken                                                                       | no                          |
| **reddit.client.id**                 | Your Reddit application client ID                                             | yourredditclientid                                                                           | no                          |
| **reddit.client.secret**             | Your Reddit application client secret                                         | yourredditclientsecret                                                                       | no                          |
| **instagram.username**               | Your Instagram username                                                       | yourInstagramUsername                                                                        | no                          |
| **instagram.password**               | Your Instagram password                                                       | yourInstagramPassword                                                                        | no                          |
