Matrix bot that sends you reminders
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Amanda Graven 1debd08c02
Add graceful shutdown on SIGTERM
1 year ago
debian Help, messages, better parsing, packaging 1 year ago
src Add graceful shutdown on SIGTERM 1 year ago
.gitignore Initial commit 1 year ago
Cargo.toml Add graceful shutdown on SIGTERM 1 year ago
LICENSE Help, messages, better parsing, packaging 1 year ago
README.md Help, messages, better parsing, packaging 1 year ago
rustfmt.toml Initial commit 1 year ago
session.sample.json Initial commit 1 year ago

README.md

am-reminder-bot

am-reminder-bot is a matrix bot that autojoins any matrix room its invited to, and lets you schedule reminders. It's made with matrix-rust-sdk.

Setup

Build the bot with cargo build --release. Configure a session file, see session.sample.json file for an example. You can generate one by starting the bot with login as the first argument. If you want the bot to work properly in encrypted rooms, also give it a storage directory it can write to. You can configure paths with these environment variables:

  • SESSION_FILE: The path of the session file. The session file shouldn't be readable by other users, since it contains the matrix acc
  • STORAGE_DIR: The directory the bot will use for storing matrix data. Needs to be writable.

A systemd service file is provided with sane defaults. A debian package can be generated with the cargo-deb utility.