matrix-wol/README.md

matrix-wol

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