jriou/check_trex
1
0
Fork 0
Code Issues Pull requests Activity

doc: Add T-Rex API security

Browse source 
Signed-off-by: Julien Riou <julien@riou.xyz>
This commit is contained in:
Julien Riou 2022-05-14 11:47:12 +02:00
parent 15f3746f2e
commit 2c78fccd1e
No known key found for this signature in database
GPG key ID: FF42D23B580C89F7
1 changed files with 16 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -2,6 +2,22 @@
Nagios check for [T-Rex miner](https://github.com/trexminer/T-Rex).
# Security
T-Rex API must be opened in a secured way:
* `--api-read-only`: accessible only in read-only, no modification
* `--api-bind-http 127.0.0.1:4067`: (default) accessible only to local connections
If the check is executed **remotely**, you should add a **firewall rule** to allow only the host running the check to
access the T-Rex API port.
**HTTPS** should be used:
* `--api-https`
* `--api-webserver-cert`
* `--api-webserver-pkey`
See full [list of options](https://github.com/trexminer/T-Rex#usage).
# Installation
Using pip: