Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Brandawg93/PeaNUT

A tiny dashboard for Network UPS Tools
https://github.com/Brandawg93/PeaNUT

Last synced: 2 months ago
JSON representation

A tiny dashboard for Network UPS Tools

Host: GitHub
URL: https://github.com/Brandawg93/PeaNUT
Owner: Brandawg93
License: apache-2.0
Created: 2023-08-31T01:36:37.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2024-08-05T17:29:00.000Z (3 months ago)
Last Synced: 2024-08-06T02:42:18.427Z (3 months ago)
Language: TypeScript
Size: 2.16 MB
Stars: 278
Watchers: 5
Forks: 6
Open Issues: 7
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

        


    



# PeaNUT

A Tiny Dashboard for Network UPS Tools

[![PayPal](https://img.shields.io/badge/paypal-donate-blue?logo=paypal)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=CEYYGVB7ZZ764&item_name=peanut&currency_code=USD&source=url)

![Docker Pulls](https://img.shields.io/docker/pulls/brandawg93/peanut)

[![Crowdin](https://badges.crowdin.net/nut-dashboard/localized.svg)](https://crowdin.com/project/nut-dashboard)



## Installation

Install using Docker

### docker run

```bash

docker run -p 8080:8080 --restart unless-stopped \

--env NUT_HOST=nut-upsd --env NUT_PORT=3493 \

--env WEB_PORT=8080 brandawg93/peanut

```

### docker-compose.yml

```yaml

services:

  peanut:

    image: brandawg93/peanut:latest

    container_name: PeaNUT

    restart: unless-stopped

    ports:

      - 8080:8080

    environment:

      - NUT_HOST=localhost

      - NUT_PORT=3493

      - WEB_PORT=8080

```

### compile from source

```bash

git clone https://github.com/Brandawg93/PeaNUT.git

cd PeaNUT

npm i -g pnpm # only if you don't have pnpm installed

pnpm i

pnpm run build:local

pnpm run start:local

```

More examples can be found in the [examples](https://github.com/Brandawg93/PeaNUT/tree/main/examples) folder.

## Environment Variables

| Variable  | Default   | Description                   |

| --------- | --------- | ----------------------------- |

| NUT_HOST  | localhost | Host of NUT server            |

| NUT_PORT  | 3493      | Port of NUT server            |

| WEB_HOST  | localhost | Hostname of web server        |

| WEB_PORT  | 8080      | Port of web server            |

| USERNAME  | undefined | Optional but required to edit |

| PASSWORD  | undefined | Optional but required to edit |

| BASE_PATH | undefined | Base path for reverse proxy   |

## API

| API Call                                            | Description                                                              |

| --------------------------------------------------- | ------------------------------------------------------------------------ |

| `GET /api/v1/devices`                               | Retrieves information about all UPS devices                              |

| `GET /api/v1/devices/[ups]`                         | Retrieves information about the specified UPS device                     |

| `GET /api/v1/devices/[ups]/var/[param]`             | Retrieves value for a single parameter of the specified UPS device       |

| `POST /api/v1/devices/[ups]/var/[param]`            | Saves value for a single parameter of the specified UPS device           |

| `GET /api/v1/devices/[ups]/var/[param]/description` | Retrieves description for a single parameter of the specified UPS device |

| `GET /api/v1/devices/[ups]/var/[param]/type`        | Retrieves type for a single parameter of the specified UPS device        |

| `GET /api/v1/devices/[ups]/commands`                | Retrieves available commands for the specified UPS device                |

| `GET /api/v1/devices/[ups]/description`             | Retrieves the description for the specified UPS device                   |

| `GET /api/v1/devices/[ups]/clients`                 | Retrieves the connected clients for the specified UPS device             |

| `GET /api/v1/devices/[ups]/rwvars`                  | Retrieves writable variables for the specified UPS device                |

## Homepage Support

For information about how to set up Homepage, check the [Homepage docs](https://gethomepage.dev/latest/widgets/services/peanut/).

Ex:

```yaml

widget:

  type: peanut

  url: http://peanut.host.or.ip:port

  key: nameofyourups

```

Or use the `customapi` widget for complete customization!

Ex:

```yaml

widget:

  type: customapi

  url: http://{HOSTNAME}:{PORT}/api/v1/devices/ups

  mappings:

    - field: battery.charge

      label: Battery Charge

      format: percent

    - field: battery.runtime

      label: Battery Runtime

      format: text

    - field: ups.load

      label: UPS Load

      format: percent

    - field: ups.status

      label: UPS Status

      format: text

      remap:

        - value: OL

          to: Online

        - value: OB

          to: On Battery

        - value: LB

          to: Low Battery

        - any: true

          to: Unknown

```

## Tested Devices

[A wiki](https://github.com/Brandawg93/PeaNUT/wiki/Tested-UPS-Devices) has been compiled of tested UPS devices. Feel free to look there for your device or add your device to the list by submitting an issue with the `tested device` label.

## Donate to Support PeaNUT

This project was made with you in mind. If you would like to show your appreciation for its continued development, please consider [sponsoring me on Github](https://github.com/sponsors/Brandawg93).