declanmccormack/nut-client
Docker image for a Network UPS Tools client
821
declanmccormack/nut-client repository overview
Network UPS Tools client
Docker image for a Network UPS Tools client to issue a shutdown command on the host machine. This container connects to a remote UPS running a NUTs server.
Usage
Provide the environment variables to connect to the remote UPS.
UPS_DEVICE
Example: [email protected]
The name of the UPS.
UPS_USER
Example: admin
The user name for logging into remote UPS.
UPS_PASSWORD
Example: 123456
The user password for logging into remote UPS.
docker-compose.yml
version: '3'
services:
nut-client:
image: declanmccormack/nut-client:latest
container_name: nut-client
restart: unless-stopped
environment:
- UPS_DEVICE=${UPS_DEVICE}
- UPS_USER=${UPS_USER}
- UPS_PASSWORD=${UPS_PASSWORD}
volumes:
- /tmp/nut-client:/tmp/nut-client
Start the container:
# docker-compose up -d
Check that you have access to the remote UPS.
# docker exec -it nut-client upsc <UPS_DEVICE>
Host Shutdown
When a shutdown signal is detected the container will write a 1 into a file with the name monitor located in the /tmp/nut-client folder that was mapped earlier.
host-shutdown-action.sh contains a cron script to be executed on the host machine. It is recommended to run it every minute. When it reads a value of 1 in the file /tmp/nut-client/monitor it will execute a shutdown action.
#!/bin/bash -e
# This file should be executed at a regular interval (e.g. cron job). It has to be run on the host, and not within a container, in order to be able to shutdown the machine.
MONITOR_FILE="/tmp/nut-client/monitor"
# Place your shutdown commands in this function.
shutdown_action(){
echo "Detected '1' in '$MONITOR_FILE'"
# Power off in 5 minutes
sudo shutdown -h +5
echo "Stop all Docker containers..."
docker stop $(docker ps -a -q) -t 300
# Power off now, if containers have already stopped
sudo shutdown -h now
}
# Do not change below
if [ -f "$MONITOR_FILE" ]; then
read -r first_line < $MONITOR_FILE
if [ "$first_line" == "1" ]; then
echo "0" > $MONITOR_FILE
shutdown_action;
fi
fi
Tag summary
Content type
Image
Digest
Size
5.1 MB
Last updated
over 6 years ago
docker pull declanmccormack/nut-client