https://github.com/cogsandsquigs/imperial-bot

A discord bot for Imperial College London discord servers.
https://github.com/cogsandsquigs/imperial-bot

Last synced: about 1 month ago
JSON representation

A discord bot for Imperial College London discord servers.

• Host: GitHub
• URL: https://github.com/cogsandsquigs/imperial-bot
• Owner: cogsandsquigs
• License: gpl-3.0
• Created: 2024-08-27T23:12:40.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-08-29T02:42:58.000Z (5 months ago)
• Last Synced: 2024-08-30T01:27:51.107Z (5 months ago)
• Language: Rust
• Size: 60.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# imperial-bot

A discord bot for verifying that users are actually from Imperial College London. May also include additional features

in the future.

## Running

Run either via using the included Dockerfile, or by compiling and running the program using `cargo`.

> [!WARN]

> The discord role for the bot must be _above_ the discord role for verified users!

## Configuration

Configuration is done via environment variables. Environment variables can be set in the environment, _or_ can be set in

a `.env` file in the _same directory_ that the binary lives in.

| Environment Variable | Description                                                                                  | Required, Default       |

| -------------------- | -------------------------------------------------------------------------------------------- | ----------------------- |

| `LOG_LEVEL`          | The logging level for the application. See https://docs.rs/log/latest/log/ for more details. | No, defaults to `error` |

| `DISCORD_TOKEN`      | The application token for the discord bot.                                                   | Yes                     |

| `DATABASE_URL`       | URL to the postgres database.                                                                | Yes                     |

| `SMTP_HOST`          | Host URL/domain for the SMTP mail server used to send verification messages.                 | Yes                     |

| `SMTP_USER`          | The username for the SMTP mail server.                                                       | Yes                     |

| `SMTP_PASS`          | The password for the SMTP mail server.                                                       | Yes                     |

| `SMTP_FROM`          | The email that the discord bot will send messages from (for example, `[email protected]`)        | Yes                     |