Go to file
Jan Christian Grünhage 163a409b8d feat: enable encryption 2020-10-27 12:10:48 +01:00
src feat: enable encryption 2020-10-27 12:10:48 +01:00
.gitignore feat: enable encryption 2020-10-27 12:10:48 +01:00
CHANGELOG.md chore: update changelog for initial release 2020-10-16 00:17:27 +02:00
Cargo.lock feat: enable encryption 2020-10-27 12:10:48 +01:00
Cargo.toml feat: enable encryption 2020-10-27 12:10:48 +01:00
LICENSE.md docs: add license, readme and changelog 2020-10-16 00:12:51 +02:00
README.md docs: add license, readme and changelog 2020-10-16 00:12:51 +02:00
config.sample.toml feat: enable encryption 2020-10-27 12:10:48 +01:00

README.md

matrix-wol

Matrix

matrix-wol is a matrix bot for waking up hosts using Wake-on-LAN. It requires configuring a name, mac address and array of users allowed to trigger a wakeup per host.

Installation

Use the package manager cargo to install matrix-wol.

cargo install --git https://doc.rust-lang.org/cargo/ --tag <version>

Usage

Take a look at the config.sample.toml file for a configuration example. Start the bot with a link to your config as the only argument:

matrix-wol config.toml

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

AGPL-3.0-only