@fetchlabs/unraid-api-plugin-omnifetch
v0.1.33
Published
Extended functionality plugin for the Unraid API - FetchLabs
Maintainers
Readme
OmniFetch - Unraid API Plugin
Comprehensive hardware monitoring and system management plugin for the Unraid API.
Features
✅ Power Monitoring - CPU power usage tracking with historical data ✅ Hardware Sensors - Temperature, fan speed, and voltage monitoring ✅ GPU Monitoring - Intel integrated GPU statistics ✅ VM Monitoring - Virtual machine status and configuration ✅ System Management - Shutdown and reboot capabilities via GraphQL ✅ Health Status - Real-time hardware health monitoring
Installation
npm install @fetchlabs/unraid-api-plugin-omnifetchUsage
After installation, the plugin extends the Unraid API with additional GraphQL queries and mutations.
Example Queries
# Get monitoring data
query {
omnifetch {
data {
hardware
power
status
}
}
}
# Get system uptime
query {
systemUptime {
uptime
uptimeSeconds
}
}
# List virtual machines
query {
listVMs {
totalVMs
runningVMs
stoppedVMs
}
}Example Mutations
# Schedule system reboot
mutation {
rebootSystem(input: {
delayMinutes: 1
message: "Scheduled maintenance"
}) {
success
message
scheduledFor
}
}
# Cancel scheduled operation
mutation {
cancelSystemOperation {
success
message
}
}Requirements
- Unraid 6.12.0 or higher
- Unraid API installed and running
- Node.js 18+ (for installation)
License
Free for Non-Commercial Use
NON-COMMERCIAL USE LICENSE
Copyright (c) 2025 FetchLabs Ltd. All rights reserved.
GRANT OF LICENSE
FetchLabs Ltd. grants you a free, non-exclusive, non-transferable license to
use, copy, and modify this software for NON-COMMERCIAL purposes only.
NON-COMMERCIAL USE DEFINITION
Non-commercial use means use solely for personal, educational, academic, or
non-profit purposes where no monetary compensation or commercial advantage is gained.
PERMITTED USES (Non-Commercial)
You MAY:
- Use the Software for personal home server monitoring
- Use the Software for educational or research purposes
- Modify the Software for your own non-commercial use
- Share the Software with others for non-commercial purposes
RESTRICTIONS
You may NOT:
- Use the Software for any commercial purpose, including:
* Providing services to third parties for compensation
* Using the Software in a commercial product or service
* Selling, licensing, or sublicensing the Software
- Remove or alter any copyright notices or license information
COMMERCIAL LICENSING
For commercial use, enterprise deployments, or revenue-generating activity,
contact us on Discord: https://discord.gg/T2hMfq4hWy
DISCLAIMER
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND.Support
For issues and questions:
- Discord: Join our Discord
- Documentation: View docs
Built by FetchLabs | Website | OmniFetch App | GitHub
