From 2c78fccd1ef97b05b48e3ba8837807d70adb8b28 Mon Sep 17 00:00:00 2001 From: Julien Riou Date: Sat, 14 May 2022 11:47:12 +0200 Subject: [PATCH] doc: Add T-Rex API security Signed-off-by: Julien Riou --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index fbd2a55..34e4440 100644 --- a/README.md +++ b/README.md @@ -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: