config.template.js

/* eslint-disable @typescript-eslint/no-unused-vars */
/** DETAILED CONFIG TYPINGS CAN BE FOUND IN src/types/config.ts! */


module.exports = {
  bot: {
    token: 'TOKEN', // discord token
    mode: 'regular', // either "dev", "beta" or "regular". the latter is default.
    clientId: '123456789' // discord client id
  },
  mode: {
    name: 'single', // "single" = no sharding, "shard" = sharding, "worker" = auto-sharding
    master: { }, // [only if name = "discovery"] dictates the master node to assign this worker node. see type file for more info
    shardId: process.env.SHARD_IDS || [ 0 ], // [only if name = "shard"] this shard id
    shardCount: process.env.SHARD_COUNT || 1 // [only if name = "shard"] total shard count
  },
  mongoDB: {
    url: 'URL', // url (including auth) to your mongodb database
    dbName: 'freestuff' // name of the database used by the bot
  },
  apiSettings: {
    key: 'loremipsumyourapitokenherehaveagreatday', // freestuff api key
    webhookSecret: 'mysecretsecret' // optional. webhook secret, can be removed if not using the webhook (or you don't want to use a secret (which you totally should))
  },
  server: { // optional. if you want to start a server for either freestuff api webhooks or prometheus metrics
    enable: true, // enable the server
    port: 6622, // pick a port you like
    endpoints: {
      apiWebhook: true, // enables the endpoint to receive api events. Can also pass a string instead of true to override the endpoint url
      metrics: true // enables the endpoint for prometheus metrics. Can also pass a string instead of true to override the endpoint url
      // metrics: '/super-secret-endpoint-name' // example for overriding the endpoint name
    }
  },

  // EVERYTHING BELOW IS OPTIONAL AND CAN BE REMOVED

  redis: {
    // redis settings. can be left empty. https://www.npmjs.com/package/redis#options-object-properties
  },
  thirdParty: {
    sentry: {
      dsn: 'URL' // sentry dsn. can be found in sentry dashboard
    }
  },
  /**
   * A discord channel webhook,
   * where debug messages are sent to whenever someone uses the "@freestuff here" command
   */
  supportWebhook: {
    id: '123456789123456789', // "@freestuff here" webhook.
    token: 'abcdefghijklmnopqrstuvwxyz' // see above
  },
  admins: [
    '137258778092503042' // list of users allowed to use admin commands
  ]
}