IT-Syndikat/its-matrix-bot
27
0
Fork 0
Code Issues Pull requests Packages1 Activity Actions
IT-Syndikat matrix bot - @schizohal:it-syndik.at
60 commits 3 branches 0 tags 663 KiB
Rust 100%
Find a file
Xiretza 61c9a3165f Update to edition 2024
2025-02-21 22:46:30 +00:00
.forgejo Don't cache when building builder container 2025-02-21 22:46:30 +00:00
src Update to edition 2024 2025-02-21 22:46:30 +00:00
.editorconfig Add .editorconfig 2022-11-13 09:20:47 +01:00
.gitignore Rewrite it in Rust! 2022-11-13 01:00:30 +01:00
build.rs Embed git hash in binary 2025-02-16 14:42:22 +00:00
Cargo.lock Embed git hash in binary 2025-02-16 14:42:22 +00:00
Cargo.toml Update to edition 2024 2025-02-21 22:46:30 +00:00
clippy.toml Rewrite it in Rust! 2022-11-13 01:00:30 +01:00
config.toml.example Support new spaceping API 2024-01-26 20:03:48 +00:00
deny.toml Add cargo-deny configuration 2022-11-13 01:04:14 +01:00
LICENSE.txt Add LICENSE.txt 2022-11-13 01:00:30 +01:00
README.md Update README 2025-02-15 22:45:58 +00:00
rustfmt.toml Rewrite it in Rust! 2022-11-13 01:00:30 +01:00

README.md

IT-Syndikat matrix bot

Running in #lobby:it-syndik.at.

This bot has been rewritten in Rust, the original python implementation can be found in the python-legacy branch.

Development

Commits pushed to main are automatically deployed to production (running on vandal.srv.it-syndikat.org) by CI.

For performance, CI builds happen in a prebuilt container described by Containerfile.build, which is regularly built and deployed using .forgejo/workflows/build-builder.yml.

Setup

For all these steps, either install the binary using cargo install and then run it as its-matrix-bot, or run the project directly from the repository using cargo run -- (e.g. cargo run -- setup).

  1. Copy config.toml.example to ~/.config/its-matrix-bot/config.toml (or some other location later specified using -c, --config)
  2. Run first-time setup using its-matrix-bot setup [-h HOMESERVER_URL] USERNAME and enter the bot user's password.
  3. Start the bot using its-matrix-bot run.

Available commands

  • !isitopen: check if the hackerspace is currently open
  • !spaceping: play a chime in the hackerpace to attempt to get someone to read your matrix messages