check_trex/README.md
Julien Riou 04446c9329
doc: Fix typo in usage
Signed-off-by: Julien Riou <julien@riou.xyz>
2022-05-14 09:44:15 +02:00

40 lines
604 B
Markdown

# check_trex
Nagios check for [T-Rex miner](https://github.com/trexminer/T-Rex).
# Installation
Using pip:
```
python3 -m venv venv
. ./venv/bin/activate
pip install -r requirements.txt
```
Using debian package manager:
```
sudo apt-get install python3-nagiosplugin python3-requests
```
# Usage
```
./check_trex.py --help
```
# Examples
Nagios NRPE:
```
command[check_trex]=/opt/check_trex/check_trex.py --hashrate-warning 60000000 --hashrate-critical 50000000 --uptime-critical 300 --uptime-warning 600
```
# Contributing
```
pip install pre-commit
pre-commit run --files check_trex.py
```