From 1431d277ab0ae86856390c3994c400ed6da156d4 Mon Sep 17 00:00:00 2001 From: Arthur Mitchell Date: Thu, 7 Mar 2024 10:51:55 +0000 Subject: [PATCH] readme --- README.md | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 01d9bd7..bfc59e7 100644 --- a/README.md +++ b/README.md @@ -15,13 +15,14 @@

A Network UPS Tools (NUT) and APC daemon exporter to pass data to Prometheus and any JSON compatible applications

Key features

-* A graphic interface showing key data over time with diagnostic information. +* A drop-in replacement for other Prometheus scrapers such as HON95/prometheus-nut-exporter. +* A graphic interface showing key data over time with diagnostic information. * Supports pulling data from NUT and APC servers and formatting the UPS status for the [Prometheus](https://prometheus.io/) logging system * Supports formatting the UPS status as JSON for use with the beautiful [HomePage](https://gethomepage.dev/) app. * The JSON output can be used with [Uptime Kuma](https://github.com/louislam/uptime-kuma) and other reporting, alarming and monitoring apps. * Provides diagnostic information and usage information. * Supports APC apcupsd servers for graphic display **and** metric scraping - **Use one Prometheus and Grafana dashboard for all servers.** -* Supports filtering of JSON elements to support simple monitoring apps. See [Filtering the JSON](https://github.com/ArthurMitchell42/nutcase/wiki/Using-the-JSON-returned-by-NUTCase#filtering-the-json-) +* Supports filtering of JSON elements to support simple monitoring apps. See [Filtering the JSON](https://github.com/ArthurMitchell42/nutcase/wiki/Using-the-JSON-returned-by-NUTCase#filtering-the-json-) ![image](https://github.com/ArthurMitchell42/nutcase/assets/82239494/6fbfa4d8-7cbc-4882-9e8e-ac3907e70d9a) @@ -33,7 +34,7 @@ NUTCase sits between any nuber of UPS servers, either NUT or APC, and converts t The JSON is ideal for monitoring or display on dashboard systems such as HomePage.

Contents

- + - [Introduction](#introduction) - [Key features](#key-features) - [Contents](#contents) @@ -73,7 +74,7 @@ The Wiki for usage information and advice:

Supported Architectures

-Currently supports 'AMD64', 'ARM64 (ARM64V8)' (suitable for running on docker under Raspberry PI with a 64-bit OS such as Raspberry PI OS 64-bit and Ubuntu 64-bit)' +Currently supports 'AMD64', 'ARM64 (ARM64V8)' (suitable for running on docker under Raspberry PI with a 64-bit OS such as Raspberry PI OS 64-bit and Ubuntu 64-bit)'
@@ -105,6 +106,16 @@ Currently supports 'AMD64', 'ARM64 (ARM64V8)' (suitable for running on docker un + + + + + + + + + + @@ -180,7 +191,7 @@ To setup the NUTCase docker container:

NUTCase Usage

-For details on useage please see [Running the NUTCase container](https://github.com/ArthurMitchell42/nutcase/wiki/Running-the-NUTCase-container). +For details on useage please see [Running the NUTCase container](https://github.com/ArthurMitchell42/nutcase/wiki/Running-the-NUTCase-container). [Contents](#contents)
7/3/20240.3.3Add a check for release updates on the GUI, prep-work for next major release.
22/2/20240.3.2Correct re-work of cl-count miss reading data
19/2/2024 0.3.1 Fix for start crash Re missing config file