Matrix Bot

My Matrix Bot. It does the following things:

• Post RSS notifications
• Post Github notifications
• Send reminder messages
• Auto-join and leave rooms
• Act on commands based on admin/mod status as configured in the config

Installation

Copy config.sample.yaml to config.yaml and run with cargo run. You can also use APP__LOGIN__PASSWORD for providing the password (and similar the respective environment variable for the other config options).

Alternatively, there is the possibility to build the docker image and use it for running:

docker build . -t yourtagname
docker run --rm -v /path/to/config:/opt/app/config.yaml -v /path/to/data:/opt/app/data yourtagname
# or use mine:
docker run --rm -v /path/to/config:/opt/app/config.yaml -v /path/to/data:/opt/app/data flixcoder/matrix-bot

Usage

To interact with the bot, put yourself as admin into the config and then invite it to a room of your choice.

You can type "!help" to run the help command. It should give an overview of how to use the commands and which commands are available.

Lints

This projects uses a bunch of clippy lints for higher code quality and style.

Install cargo-lints using cargo install --git https://github.com/FlixCoder/cargo-lints. The lints are defined in lints.toml and can be checked by running cargo lints clippy --all-targets --workspace.