Matrix bot that sends you reminders

Go to file

Amanda Graven f0b3b2392e Help, messages, better parsing, packaging Add help message, add support for attaching a message to a reminder, use a better crate for parsing durations, add debian packaging.		2021-06-12 22:57:31 +02:00
debian	Help, messages, better parsing, packaging	2021-06-12 22:57:31 +02:00
src	Help, messages, better parsing, packaging	2021-06-12 22:57:31 +02:00
.gitignore	Initial commit	2021-06-11 21:42:14 +00:00
Cargo.toml	Help, messages, better parsing, packaging	2021-06-12 22:57:31 +02:00
LICENSE	Help, messages, better parsing, packaging	2021-06-12 22:57:31 +02:00
README.md	Help, messages, better parsing, packaging	2021-06-12 22:57:31 +02:00
rustfmt.toml	Initial commit	2021-06-11 23:49:26 +02:00
session.sample.json	Initial commit	2021-06-11 23:49:26 +02:00

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.