Purge

Minimalistic purge bot for Discord

Project description

Motivation

The bulk delete functionality is one of the very few things that are only available for bots. This project aims to bring that functionality to the Discord end user.

Usage

This bot has only one command: /purge - which lets you delete up to 100 messages at once. Please keep in mind that due to discord limits, the messages may not be older than 2 weeks.

Self-host this bot

Running the server

You can self-host this bot using Nix. After importing the nixosModule from the flake you can simply enable the service using the configuration below.

Configuration

{ config, ...}:
{
  services.purge = {
    enable = true;
    listenPort = 9000;
    discord = {
      clientId = "941041925216157746";
      publicKey = "d2945f6130d9b4a8dda8c8bf52db5dee127a82f89c6b8782e84aa8f45f61d402";
      tokenFile = "/run/secrets/purge";
    };
  };
}

To expose the app to the internet, simply put an nginx reverse proxy in place.

{ config, ... }:
{
    services.nginx.virtualHosts."purge.example.com" = {
        enableACME = true;
        forceSSL = true;
        locations."/" = {
            proxyPass = "http://127.0.0.1:${toString config.services.purge.listenPort}";
        };
    };
}

Registering commands

To register commands, simply run python3 purge/__init__.py --deploy after cloning the repo and installing all requirements (If you are on nix, this can be achieved via nix develop). The following environment variables are required to be set before executing the command:

DISCORD_CLIENT_ID
DISCORD_CLIENT_SECRET