Usb-Ups-Reset-Repo

USB UPS Reset Toolkit Documentation

Welcome to the official documentation for the CyberPower USB UPS Reset Toolkit. This toolkit helps automate detection, reset, and monitoring of CyberPower UPS devices via USB on Linux-based systems, including QNAP, Synology, and Docker/Kubernetes environments.

Features

Auto-detection of CyberPower USB UPS devices
USB reset scripting
Slack webhook integration for alerts
NUT/SNMP compatibility
Cronjob-ready setup
Docker & Kubernetes deployment templates
Secure CI/CD integration with GitHub Actions & GHCR
Google Cloud Secret Manager support

🛠️ Quick Start (Linux / QNAP / Synology)

Clone the repository:

git clone https://github.com/Maistos-Stack-Hub-Lab/Usb-Ups-Reset-Repo.git
cd Usb-Ups-Reset-Repo
chmod +x */*.sh

Run detection script:
```
./common/detect_usb_id.sh
```

Add to cron (optional):

*/10 * * * * /path/to/common/detect_usb_id.sh >> /var/log/ups-check.log 2>&1

Windows Instructions

To run this on Windows:

Use WSL (Windows Subsystem for Linux):
- Install WSL: https://learn.microsoft.com/en-us/windows/wsl/install
- Open WSL and clone the repo as in the Linux steps above.
Run the script inside WSL:
```
bash ./common/detect_usb_id.sh
```
USB passthrough required: Ensure your CyberPower UPS is connected and USB passthrough is enabled in WSL. Native USB device handling in WSL may be limited depending on version.

macOS Instructions

Open Terminal

Clone and run:

git clone https://github.com/Maistos-Stack-Hub-Lab/Usb-Ups-Reset-Repo.git
cd Usb-Ups-Reset-Repo
chmod +x ./common/detect_usb_id.sh
./common/detect_usb_id.sh

Check USB device: Use system_profiler SPUSBDataType to confirm UPS presence on USB.

Kubernetes Setup

Deploy with the sample manifest:

kubectl apply -f k8s/deployment.yaml

Docker Usage

docker-compose up --build -d

🔐 Secret Management

Store Slack tokens or SSH keys securely in Google Cloud Secret Manager. Example CI usage:

- uses: google-github-actions/auth@v1
  with:
    credentials_json: '$'

🔎 SEO Keywords

cyberpower ups usb monitoring linux automation docker kubernetes qnap synology devops github-actions nut snmp energy-management slack-alerts powerpanel nas iot tools server-scripts cron job reset reboot windows mac wsl

📚 More Info

This documentation is hosted via GitHub Pages. For deployment instructions, visit Settings > Pages and select main > /docs.

Bei Fragen oder Verbesserungsvorschlägen gerne einen Pull Request oder Issue auf GitHub öffnen.

This site is open source. Improve this page.