explaingit

edywerder/nut-backup

Analysis updated 2026-05-18

2ShellAudience · ops devopsComplexity · 1/5Setup · easy

TLDR

A shell script that backs up a Proxmox server's NUT (UPS monitoring) configuration and diagnostic info into one archive.

Mindmap

mindmap
  root((repo))
    What it does
      Backs up NUT config
      Captures diagnostics
      Snapshots UPS data
    Tech stack
      Shell script
      Proxmox
      NUT SNMP
    Use cases
      Backup before changes
      Troubleshoot NUT setup
      Record UPS status
    Audience
      Proxmox admins
      Sysadmins
      Homelab users

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

What do people build with it?

USE CASE 1

Back up a Proxmox server's NUT configuration before making changes.

USE CASE 2

Capture a diagnostic snapshot of NUT service status and UPS data for troubleshooting.

USE CASE 3

Record installed NUT and SNMP package versions alongside network and USB device info.

What is it built with?

ShellProxmoxNUTSNMP

How does it compare?

edywerder/nut-backupaizhigitovamir-code/n8n-automation-suiteayush-sk-pathak/claude-code-starter-pack
Stars222
LanguageShellShellShell
Setup difficultyeasymoderateeasy
Complexity1/53/52/5
Audienceops devopspm founderdeveloper

Figures from each repo's GitHub metadata at analysis time.

How do you get it running?

Difficulty · easy Time to first run · 5min

Must be run as root on a Proxmox server that already has NUT installed and configured.

No license information was provided in the source material.

In plain English

This repository is a single shell script called nut-backup.sh, built for people who run a Proxmox server with NUT, short for Network UPS Tools, the software that monitors a battery backup power supply and lets a server shut down gracefully during a power outage. Rather than being a full application, the script's only job is to gather up everything useful about the current NUT setup and package it into one backup archive. The archive it creates includes a copy of the entire NUT configuration folder, a record of which versions of the NUT and SNMP packages are currently installed, the current status of the NUT service, information about the server's network interfaces, information about connected USB devices, and a snapshot of the live UPS data pulled from the upsc command line tool, which normally reports things like battery charge and power status. Using it is simple: make the script executable and then run it as the root user. The README provided is quite short and does not go into detail about where the resulting archive is saved, what format it uses, or whether the script accepts any command line options, so those specifics are not covered here. This is a small, focused utility rather than a general purpose backup tool. It is aimed at Proxmox administrators who want a quick way to capture their UPS monitoring configuration and diagnostic state, for example before making changes or when troubleshooting a NUT installation.

Copy-paste prompts

Prompt 1
Explain what each piece of data this nut-backup.sh script collects is used for.
Prompt 2
Help me run nut-backup.sh on my Proxmox server and find where the archive gets saved.
Prompt 3
What is NUT and why would a Proxmox admin want to back up its configuration?
Prompt 4
How could I modify this script to also compress or upload the backup archive automatically?

Frequently asked questions

What is nut-backup?

A shell script that backs up a Proxmox server's NUT (UPS monitoring) configuration and diagnostic info into one archive.

What language is nut-backup written in?

Mainly Shell. The stack also includes Shell, Proxmox, NUT.

What license does nut-backup use?

No license information was provided in the source material.

How hard is nut-backup to set up?

Setup difficulty is rated easy, with roughly 5min to a first successful run.

Who is nut-backup for?

Mainly ops devops.

Open on GitHub → Explain another repo

This repo across BitVibe Labs

Verify against the repo before relying on details.