Skip to content

Self-Hosting

Mailman was made to allow anyone to host their own instance of the bot. This allows you to have full control over the bot and its data. Source code is available in the GitHub repository.

Requirements

Node.js 18.18.0 or higher is required.

Package Version
better-sqlite3 ^8.6.0
discord.js ^14.13.0
nodemailer ^6.9.5

Setup

  1. Clone the repository or use the built JavaScript files through releases.
  2. Run npm install to install the required packages.
  3. Create a config.json file in the /src/ folder.
  4. Build the TypeScript files (skip this step if you are using the built JavaScript files).
  5. Run node src/index.js to start the bot.

config.json

{
    "token": "your-bot-token-here",
    "sender_email": "your-email-here",
    "sender_password": "your-email-password-here",
    "topgg_token": "your-topgg-token-here (leave blank if you don't need to update topgg stats)"
}

Currently, only Gmail is supported.

Note: If you are using Gmail, you will need to enable less secure apps for the bot to be able to send emails.