mastobotmon/README.md

74 lines
1.8 KiB
Markdown
Raw Normal View History

2018-02-27 23:38:05 +01:00
**mastobotmon** monitors your bots on Mastodon.
# Install
## Dependencies
* Tested OS: Linux
* C++ compiler (tested: gcc 6.4, clang 5.0)
* [cmake](https://cmake.org/) (tested: 3.9.6)
2018-02-28 23:09:07 +01:00
* [mastodon-cpp](https://github.com/tastytea/mastodon-cpp) (at least: 0.4.4)
2018-03-07 09:21:13 +01:00
* [jsoncpp](https://github.com/open-source-parsers/jsoncpp) (tested: 1.8.1)
2018-02-27 23:38:05 +01:00
## Get sourcecode
### Development version
git clone https://github.com/tastytea/mastobotmon.git
## Compile
mkdir build
cd build/
cmake ..
make
cmake options:
* `-DCMAKE_BUILD_TYPE=Debug` for a debug build
Install with `make install`.
# Usage
Run mastobotmon once. Edit config file (`~/.config/mastobotmon.json`).
2018-03-02 08:48:02 +01:00
Call mastobotmon from cron. If a bot is inactive for longer than the specified
minutes, it prints an alert to stdout.
## Commands
* add Add accounts
2018-02-27 23:38:05 +01:00
2018-02-28 23:09:07 +01:00
## Error codes
Same as [mastodon-cpp](https://github.com/tastytea/mastodon-cpp/blob/master/README.md#error-codes), plus:
| Code | Explanation |
| --------: |:------------------------------|
| 1 | Couldn't read / create config |
If you use a debug build, you get more verbose error messages.
2018-02-27 23:38:05 +01:00
# TODO
* Version 0.1.0
2018-03-02 06:11:18 +01:00
* [x] Cron mode
* [x] Config file
2018-03-02 06:11:18 +01:00
* [x] Alert if account seems inactive
2018-02-27 23:38:05 +01:00
* Version 0.2.0
2018-03-02 08:48:02 +01:00
* [x] Allow to add accounts later
2018-02-27 23:38:05 +01:00
* [ ] Write mentions to file
* Version 0.3.0
2018-03-02 14:08:49 +01:00
* [ ] Respect X-RateLimit header
2018-02-27 23:38:05 +01:00
* [ ] Write statistics to file
* Version 0.4.0
* [ ] Daemon mode
* Version 0.5.0
* [ ] Allow to run command on alert
# Copyright
Copyright © 2018 tastytea <tastytea@tastytea.de>.
License GPLv3: GNU GPL version 3 <https://www.gnu.org/licenses/gpl-3.0.html>.
This program comes with ABSOLUTELY NO WARRANTY. This is free software,
and you are welcome to redistribute it under certain conditions.