jude/reminder-bot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 3 Wiki Activity
Reminder Bot for Discord, now in Rust
509 Commits 19 Branches 4 Tags 36 MiB
CSS 43.5%
Rust 34.6%
TypeScript 13%
JavaScript 8.1%
SCSS 0.4%
Other 0.4%
5f0aa0f834
Go to file
jude 5f0aa0f834 Add routes for getting/posting user reminders
2024-03-05 20:36:38 +00:00
assets Remove need to supply webhook avatar 2023-05-08 17:32:59 +01:00
conf Log reminder send status 2023-07-30 17:00:55 +01:00
cron.d Fix cron username 2023-07-31 20:14:45 +01:00
debian Use conffiles 2023-06-17 12:49:01 +01:00
extract_derive Link all top-level commands with macro recording/replaying logic 2024-02-18 13:24:37 +00:00
migrations Support sending reminders to threads 2024-03-03 13:04:50 +00:00
nginx Rename some environment variables. Add partial deb metadata 2023-03-24 17:44:43 +00:00
postman Support sending reminders to threads 2024-03-03 13:04:50 +00:00
recordable_derive Link all top-level commands with macro recording/replaying logic 2024-02-18 13:24:37 +00:00
reminder-dashboard Add routes for getting/posting user reminders 2024-03-05 20:36:38 +00:00
src Support sending reminders to threads 2024-03-03 13:04:50 +00:00
systemd Suppress errors. Restyle 2023-07-31 17:59:38 +01:00
web Add routes for getting/posting user reminders 2024-03-05 20:36:38 +00:00
.gitignore Add overlay when data fetching 2024-02-24 17:31:39 +00:00
.prettierrc.toml collapse/expand elements. moved the embed color picker 2022-03-20 18:29:27 +00:00
build.rs Build dashboard with bot 2024-03-03 13:21:06 +00:00
Cargo.lock Add routes for getting/posting user reminders 2024-03-05 20:36:38 +00:00
Cargo.toml Add routes for getting/posting user reminders 2024-03-05 20:36:38 +00:00
Containerfile Change default Python location. Update build instructions. Add container build instructions 2023-05-08 17:04:51 +01:00
dp.py natural command stuff 2020-09-26 22:23:41 +01:00
healthcheck Change reminder sending behaviour to keep reminders but flag them as sent 2023-07-31 18:39:27 +01:00
LICENSE Create LICENSE 2020-09-21 09:16:10 +00:00
README.md Configure permissions properly on Rocket.toml. Make static path behave better 2023-06-14 13:29:48 +01:00
Rocket.toml Rename some environment variables. Add partial deb metadata 2023-03-24 17:44:43 +00:00
rustfmt.toml more commands. fixed an issue with text only commands 2021-09-11 00:14:23 +01:00

README.md

reminder-rs

Reminder Bot for Discord.

How do I use it?

I offer a hosted version of the bot. You can invite it with: https://invite.reminder-bot.com. The catch is that repeating reminders are paid on the hosted version of the bot. Keep reading if you want to host it yourself.

You'll need rustc and cargo for compilation. To run, you'll need Python 3 still (due to no suitable replacement for dateparser in Rust)

Build APT package

Recommended method.

By default, this builds targeting Ubuntu 20.04. Modify the Containerfile if you wish to target a different platform. These instructions are written using podman, but docker should work too.

  1. Install container software: sudo apt install podman.
  2. Install database server: sudo apt install mysql-server-8.0. Create a database called reminders
  3. Install SQLx CLI: cargo install sqlx-cli
  4. From the source code directory, execute sqlx migrate run
  5. Build container image: podman build -t reminder-rs .
  6. Build with podman: podman run --rm --network=host -v "$PWD":/mnt -w /mnt -e "DATABASE_URL=mysql://user@localhost/reminders" reminder-rs cargo deb

Compiling for other target

  1. Install requirements: sudo apt install gcc gcc-multilib cmake libssl-dev build-essential python3-dateparser
  2. Install rustup from https://rustup.rs
  3. Install the nightly toolchain: rustup toolchain default nightly
  4. Install database server: sudo apt install mysql-server-8.0. Create a database called reminders.
  5. Install sqlx-cli: cargo install sqlx-cli.
  6. Run migrations: sqlx migrate run.
  7. Set environment variables:
    • DATABASE_URL - the URL of your MySQL database (mysql://user[:password]@domain/database)
  8. Build: cargo build --release

Configuring

Reminder Bot reads a number of environment variables. Some are essential, and others have hardcoded fallbacks. Environment variables can be loaded from a .env file in the working directory.

Required Variables

  • DATABASE_URL - the URL of your MySQL database (mysql://user[:password]@domain/database)
  • DISCORD_TOKEN - your application's bot user's authorization token

Other Variables

  • MIN_INTERVAL - default 600, defines the shortest interval the bot should accept
  • LOCAL_TIMEZONE - default UTC, necessary for calculations in the natural language processor
  • SUBSCRIPTION_ROLES - default None, accepts a list of Discord role IDs that are given to subscribed users
  • CNC_GUILD - default None, accepts a single Discord guild ID for the server that the subscription roles belong to
  • PYTHON_LOCATION - default /usr/bin/python3. Can be changed if your Python executable is located somewhere else
  • THEME_COLOR - default 8fb677. Specifies the hex value of the color to use on info message embeds