novinem/upsmonitoring repository overview

⁠About this image

This repository contains the dockerfile (and PHP source code) for building our 'UPS Monitoring'. The UPS Monitoring is responsible for automatically shutting down the server when the main power is lost and the UPS reaches a specific battery threshold. It also sends alerts us via Slack about critical levels within the UPS.

⁠Installation: Requirements

There are no specific requirements to run this image.

⁠Installation: With Plain Docker

1. Download the UPS Monitoring image from the Docker Hub with the ID: novinem/upsmonitoring.
2. Make sure the required config file is mounted in the container.
   1. /usr/src/config/config.yml - The config for the UPS Monitoring (see the config.yml.example)
3. Start the container with: docker run --rm novinem/upsmonitoring -v ...
   • Like you see, this image doesn't expose any ports.

⁠Installation: With Docker-compose

1. Copy the docker-compose.yml file to your directory.
2. Make sure the required files/folders exist in your working directory. See the chapter above for details about the required config file.
3. Run the UPS Monitoring with: docker compose up

⁠Config examples

⁠config.yml

continuous: true
continuous_delay_ms: 60000

startup_ssh_test: true

snmp_host: 192.168.x.x
snmp_community: public

ssh_host: 192.168.x.x
ssh_username: USER
ssh_password: PASS

slack_webhook_url: https://slack.webhook.url.here

oid_battery_status: iso.3.6.1.2.1.33.1.4.1.0
oid_battery_seconds_active: iso.3.6.1.2.1.33.1.2.2.0
oid_battery_minutes_remaining: iso.3.6.1.2.1.33.1.2.3.0
oid_battery_percentage: iso.3.6.1.2.1.33.1.2.4.0
oid_ups_output_voltage: iso.3.6.1.2.1.33.1.4.4.1.2.1
oid_ups_output_percentage: iso.3.6.1.2.1.33.1.4.4.1.5.1

⁠docker-compose.yml

---
version: '3'
    
services:
    
    upsmonitoring:
        image: novinem/upsmonitoring:latest
        container_name: upsmonitoring
        volumes:
          - ./mounts/config.yml:/usr/src/config/config.yml
        restart: unless-stopped