Skip to content

Latest commit

 

History

History
326 lines (281 loc) · 9.8 KB

CONFIGURATION.md

File metadata and controls

326 lines (281 loc) · 9.8 KB
Raw

Configuration

ModBot offers two different ways to configure it, a config file or environment variables. To use the config file just copy the minimal configuration example to a new file called config.json and modify the options in it. If you chose to use environment variables then you first need to set the environment variable MODBOT_USE_ENV.

Environment variables use SCREAMING_SNAKE_CASE, the configuration file uses camelCase.

If both a config file exists and the MODBOT_USE_ENV variable is set ModBot will ignore the config.json file.

Auth Token (required)

Discord bot authentication token, can be generated in the Developer Portal

type config file environment
string authToken MODBOT_AUTH_TOKEN

Database (required)

MySQL/MariaDB access credentials. Other SQL dialects or Databases are not supported. If you're using a config file, you can easily add any additional options accepted by mysql2. This is not possible using environment variables. If you're missing an option just let us know ;)

Host

Database hostname or IP

type config file environment
string database.host MODBOT_DATABASE_HOST

User

Database username (Default: modbot)

type config file environment
string database.user MODBOT_DATABASE_USER

Password

Database password

type config file environment
string database.password MODBOT_DATABASE_PASSWORD

Database

Database name (Default: modbot)

type config file environment
string database.database MODBOT_DATABASE_DATABASE

Port

Database port (Default: 3306)

type config file environment
number database.port MODBOT_DATABASE_PORT

Database JSON Example

{
  "database": {
    "host": "localhost",
    "user": "modbot",
    "password": "password",
    "database": "modbot",
    "port": 3306
  }
}

Google API Key (optional)

Google cloud API Key. Currently used for the YouTube v3 API (/video and /playlist).

type config file environment
string googleApiKey MODBOT_GOOGLE_API_KEY

Google Cloud (optional)

Configuration for Google cloud features

Credentials

These options break our convention on using camelCase because they are passed directly to the Google API. If you're using a config file you add additional options to this, and they will be passed along. These credentials are used for the following apis if you enabled them in the config:

  • Cloud Vision
  • Cloud Logging

Base64 Encoded

If you're using environment variables it is recommended to base64 encode the credentials JSON object and set them in the environment variable MODBOT_GOOGLE_CLOUD_CREDENTIALS. If this variable is set ModBot will ignore the other variables.

Client Email

type config file environment
string googleCloud.credentials.client_email MODBOT_GOOGLE_CLOUD_CREDENTIALS_CLIENT_EMAIL

Private Key

type config file environment
string googleCloud.credentials.private_key MODBOT_GOOGLE_CLOUD_CREDENTIALS_PRIVATE_KEY

Credentials JSON Example

{
  "googleCloud": {
    "credentials": {
      "client_email": "[email protected]",
      "private_key": "-----BEGIN PRIVATE KEY-----\nkeydata\n-----END PRIVATE KEY-----\n"
    }
  }
}

Logging

Configuration for logging messages to the Google cloud using the Google cloud logging api. If you don't want to use Google cloud logging just ignore this.

Enabled

type config file environment
boolean googleCloud.logging.enabled MODBOT_GOOGLE_CLOUD_LOGGING_ENABLED

Project ID

type config file environment
string googleCloud.logging.projectId MODBOT_GOOGLE_CLOUD_LOGGING_PROJECT_ID

Log Name

type config file environment
string googleCloud.logging.logName MODBOT_GOOGLE_CLOUD_LOGGING_LOG_NAME

Logging JSON Example

{
  "googleCloud": {
    "logging": {
      "enabled": true,
      "projectId": "example-project",
      "logName": "modbot"
    }
  }
}

Vision

Configuration for using the cloud vision API to detect inappropriate images.

Enabled

type config file environment
boolean googleCloud.vision.enabled MODBOT_GOOGLE_CLOUD_VISION_ENABLED

Vision JSON Example

{
  "googleCloud": {
    "vision": {
      "enabled": true
    }
  }
}

Google Cloud JSON Example

{
  "googleCloud": {
    "credentials": {
      "client_email": "[email protected]",
      "private_key": "-----BEGIN PRIVATE KEY-----\nkeydata\n-----END PRIVATE KEY-----\n"
    },
    "logging": {
      "enabled": true,
      "projectId": "example-project",
      "logName": "modbot"
    },
    "vision": {
      "enabled": true
    }
  }
}

Feature Whitelist (optional)

Array of server ids that are allowed to use special features (e.g. /purge-invites).

type config file environment
string[] featureWhitelist MODBOT_FEATURE_WHITELIST

Feature Whitelist JSON Example

{
  "featureWhitelist": [
    "123456789012345678"
  ]
}

Emoji (optional)

Snowflakes of discord custom Emojis. The bot must be on the server the emoji is registered on. Emoji IDs are strings and the naming follows the conventions described above.

Currently, the following emojis are used:

  • source
  • privacy
  • invite
  • discord
  • youtube
  • zendesk
  • firstPage
  • previousPage
  • refresh
  • nextPage
  • lastPage
  • announcement
  • channel
  • forum
  • stage
  • thread
  • voice
  • avatar
  • ban
  • moderations
  • mute
  • pardon
  • strike
  • kick
  • userCreated
  • userId
  • userJoined

As environment variables these would follow the standard of MDOBOT_EMOJI_LAST_PAGE.

Emoji JSON Example

{
  "emoji": {
    "source": "123456789012345678",
    "privacy": "123456789012345678",
    "invite": "123456789012345678",
    "discord": "123456789012345678",
    "youtube": "123456789012345678"
  }
}

Minimal Configuration File

Below you can find an example of a minimal configuration. This is the bare minimum you need to run the bot. For details on the configuration options see above.

Please note: These are example values. The bot will not work correctly with them.

{
  "authToken": "AUTH TOKEN",
  "database": {
    "host": "localhost",
    "password": "password"
  }
}

Full Configuration File

Below you can find an example of a full configuration. This is the full configuration with all options. For details on the configuration options see above.

Please note: These are example values. The bot will not work correctly with them.

{
  "authToken":"AUTH TOKEN",
  "database": {
      "host": "localhost",
      "user": "modbot",
      "password": "password",
      "database": "modbot"
  },
  "googleApiKey": "google api key",
  "googleCloud": {
    "credentials": {
      "client_email": "[email protected]",
      "private_key": "-----BEGIN PRIVATE KEY-----\nkey data\n----- END PRIVATE KEY -----\n"
    },
    "logging": {
      "enabled": true,
      "projectId": "example-project",
      "logName": "modbot"
    },
    "vision": {
      "enabled": true
    }
  },
  "featureWhitelist": [
    "123456789012345678"
  ],
  "emoji": {
        "source": "123456789012345678",
        "privacy": "123456789012345678",
        "invite": "123456789012345678",
        "discord": "123456789012345678",
        "youtube": "123456789012345678",
        "zendesk": "123456789012345678",
        "firstPage": "123456789012345678",
        "previousPage": "123456789012345678",
        "refresh": "123456789012345678",
        "nextPage": "123456789012345678",
        "lastPage": "123456789012345678",
        "announcement": "123456789012345678",
        "channel": "123456789012345678",
        "forum": "123456789012345678",
        "stage": "123456789012345678",
        "thread": "123456789012345678",
        "voice": "123456789012345678",
        "avatar": "123456789012345678",
        "ban": "123456789012345678",
        "moderations": "123456789012345678",
        "mute": "123456789012345678",
        "pardon": "123456789012345678",
        "strike": "123456789012345678",
        "kick": "123456789012345678",
        "userCreated": "123456789012345678",
        "userId": "123456789012345678",
        "userJoined": "123456789012345678"
  }
}