forked from HomeLab/unraid-mcp
chore: enhance project metadata, tooling, and documentation
**Project Configuration:** - Enhance pyproject.toml with comprehensive metadata, keywords, and classifiers - Add LICENSE file (MIT) for proper open-source distribution - Add PUBLISHING.md with comprehensive publishing guidelines - Update .gitignore to exclude tool artifacts (.cache, .pytest_cache, .ruff_cache, .ty_cache) - Ignore documentation working directories (.docs, .full-review, docs/plans, docs/sessions) **Documentation:** - Add extensive Unraid API research documentation - API source code analysis and resolver mapping - Competitive analysis and feature gap assessment - Release notes analysis (7.0.0, 7.1.0, 7.2.0) - Connect platform overview and remote access documentation - Document known API patterns, limitations, and edge cases **Testing & Code Quality:** - Expand test coverage across all tool modules - Add destructive action confirmation tests - Improve test assertions and error case validation - Refine type annotations for better static analysis **Tool Improvements:** - Enhance error handling consistency across all tools - Improve type safety with explicit type annotations - Refine GraphQL query construction patterns - Better handling of optional parameters and edge cases This commit prepares the project for v0.2.0 release with improved metadata, comprehensive documentation, and enhanced code quality. Co-authored-by: Claude <noreply@anthropic.com>
This commit is contained in:
@@ -15,7 +15,7 @@ logs/
|
||||
*.sqlite3
|
||||
instance/
|
||||
.pytest_cache/
|
||||
.mypy_cache/
|
||||
.ty_cache/
|
||||
.venv/
|
||||
venv/
|
||||
env/
|
||||
|
||||
18
.gitignore
vendored
18
.gitignore
vendored
@@ -5,6 +5,18 @@ build/
|
||||
dist/
|
||||
wheels/
|
||||
*.egg-info
|
||||
*.egg
|
||||
|
||||
# Tool artifacts (pytest, ruff, ty, coverage all write here)
|
||||
.cache/
|
||||
|
||||
# Legacy artifact locations (in case tools run outside pyproject config)
|
||||
.pytest_cache/
|
||||
.ruff_cache/
|
||||
.ty_cache/
|
||||
htmlcov/
|
||||
.coverage
|
||||
coverage.xml
|
||||
|
||||
# Virtual environments
|
||||
.venv
|
||||
@@ -19,6 +31,12 @@ logs/
|
||||
# Serena IDE configuration
|
||||
.serena/
|
||||
|
||||
# Documentation and session artifacts
|
||||
.docs/
|
||||
.full-review/
|
||||
docs/plans/
|
||||
docs/sessions/
|
||||
|
||||
# Google OAuth client secrets
|
||||
client_secret_*.apps.googleusercontent.com.json
|
||||
|
||||
|
||||
@@ -123,4 +123,4 @@ The server loads environment variables from multiple locations in order:
|
||||
- Increased timeouts for disk operations (90s read timeout)
|
||||
- Selective queries to avoid GraphQL type overflow issues
|
||||
- Optional caching controls for Docker container queries
|
||||
- Rotating log files to prevent disk space issues
|
||||
- Log file overwrite at 10MB cap to prevent disk space issues
|
||||
21
LICENSE
Normal file
21
LICENSE
Normal file
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2026 jmagar
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
218
PUBLISHING.md
Normal file
218
PUBLISHING.md
Normal file
@@ -0,0 +1,218 @@
|
||||
# Publishing Guide for unraid-mcp
|
||||
|
||||
This guide covers how to publish `unraid-mcp` to PyPI so it can be installed via `uvx` or `pip` from anywhere.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
1. **PyPI Account**: Create accounts on both:
|
||||
- [Test PyPI](https://test.pypi.org/account/register/) (for testing)
|
||||
- [PyPI](https://pypi.org/account/register/) (for production)
|
||||
|
||||
2. **API Tokens**: Generate API tokens for automated publishing:
|
||||
- Test PyPI: https://test.pypi.org/manage/account/token/
|
||||
- PyPI: https://pypi.org/manage/account/token/
|
||||
|
||||
3. **Save Tokens Securely**:
|
||||
```bash
|
||||
# Add to ~/.pypirc (never commit this file!)
|
||||
cat > ~/.pypirc << 'EOF'
|
||||
[distutils]
|
||||
index-servers =
|
||||
pypi
|
||||
testpypi
|
||||
|
||||
[pypi]
|
||||
username = __token__
|
||||
password = pypi-YOUR-API-TOKEN-HERE
|
||||
|
||||
[testpypi]
|
||||
username = __token__
|
||||
password = pypi-YOUR-TEST-API-TOKEN-HERE
|
||||
repository = https://test.pypi.org/legacy/
|
||||
EOF
|
||||
|
||||
chmod 600 ~/.pypirc # Secure the file
|
||||
```
|
||||
|
||||
## Version Management
|
||||
|
||||
Before publishing, update the version in `pyproject.toml`:
|
||||
|
||||
```toml
|
||||
[project]
|
||||
version = "0.2.1" # Follow semantic versioning: MAJOR.MINOR.PATCH
|
||||
```
|
||||
|
||||
**Semantic Versioning Guide:**
|
||||
- **MAJOR** (1.0.0): Breaking changes
|
||||
- **MINOR** (0.2.0): New features (backward compatible)
|
||||
- **PATCH** (0.2.1): Bug fixes (backward compatible)
|
||||
|
||||
## Publishing Workflow
|
||||
|
||||
### 1. Clean Previous Builds
|
||||
|
||||
```bash
|
||||
# Remove old build artifacts
|
||||
rm -rf dist/ build/ *.egg-info/
|
||||
```
|
||||
|
||||
### 2. Run Quality Checks
|
||||
|
||||
```bash
|
||||
# Format code
|
||||
uv run black unraid_mcp/
|
||||
|
||||
# Lint code
|
||||
uv run ruff check unraid_mcp/
|
||||
|
||||
# Type check
|
||||
uv run ty check unraid_mcp/
|
||||
|
||||
# Run tests
|
||||
uv run pytest
|
||||
|
||||
# Check coverage
|
||||
uv run pytest --cov=unraid_mcp --cov-report=html
|
||||
```
|
||||
|
||||
### 3. Build the Package
|
||||
|
||||
```bash
|
||||
# Build both wheel and source distribution
|
||||
uv run python -m build
|
||||
```
|
||||
|
||||
This creates:
|
||||
- `dist/unraid_mcp-VERSION-py3-none-any.whl` (wheel)
|
||||
- `dist/unraid_mcp-VERSION.tar.gz` (source distribution)
|
||||
|
||||
### 4. Validate the Package
|
||||
|
||||
```bash
|
||||
# Check that the package meets PyPI requirements
|
||||
uv run twine check dist/*
|
||||
```
|
||||
|
||||
Expected output: `PASSED` for both files.
|
||||
|
||||
### 5. Test on Test PyPI (IMPORTANT!)
|
||||
|
||||
Always test on Test PyPI first:
|
||||
|
||||
```bash
|
||||
# Upload to Test PyPI
|
||||
uv run twine upload --repository testpypi dist/*
|
||||
|
||||
# Test installation from Test PyPI
|
||||
uvx --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ unraid-mcp-server
|
||||
|
||||
# Or with pip in a test environment
|
||||
pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple/ unraid-mcp
|
||||
```
|
||||
|
||||
**Note**: `--extra-index-url https://pypi.org/simple/` is needed because dependencies come from production PyPI.
|
||||
|
||||
### 6. Publish to PyPI (Production)
|
||||
|
||||
Once testing passes:
|
||||
|
||||
```bash
|
||||
# Upload to production PyPI
|
||||
uv run twine upload dist/*
|
||||
```
|
||||
|
||||
### 7. Verify Installation
|
||||
|
||||
```bash
|
||||
# Install and run from PyPI using uvx (no installation required!)
|
||||
uvx unraid-mcp-server --help
|
||||
|
||||
# Or install globally
|
||||
uv tool install unraid-mcp
|
||||
|
||||
# Or install in a project
|
||||
uv add unraid-mcp
|
||||
```
|
||||
|
||||
## Post-Publishing Checklist
|
||||
|
||||
- [ ] Create a GitHub Release with the same version tag
|
||||
- [ ] Update CHANGELOG.md with release notes
|
||||
- [ ] Test installation on a fresh machine
|
||||
- [ ] Update documentation if API changed
|
||||
- [ ] Announce release (if applicable)
|
||||
|
||||
## Running from Any Machine with uvx
|
||||
|
||||
Once published to PyPI, users can run the server without installing:
|
||||
|
||||
```bash
|
||||
# Run directly with uvx (recommended)
|
||||
uvx unraid-mcp-server
|
||||
|
||||
# Or with custom environment variables
|
||||
UNRAID_API_URL=https://your-server uvx unraid-mcp-server
|
||||
```
|
||||
|
||||
**Benefits of uvx:**
|
||||
- No installation required
|
||||
- Automatic virtual environment management
|
||||
- Always uses the latest version (or specify version: `uvx unraid-mcp-server@0.2.0`)
|
||||
- Clean execution environment
|
||||
|
||||
## Automation with GitHub Actions (Future)
|
||||
|
||||
Consider adding `.github/workflows/publish.yml`:
|
||||
|
||||
```yaml
|
||||
name: Publish to PyPI
|
||||
|
||||
on:
|
||||
release:
|
||||
types: [published]
|
||||
|
||||
jobs:
|
||||
publish:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: astral-sh/setup-uv@v4
|
||||
- name: Build package
|
||||
run: uv run python -m build
|
||||
- name: Publish to PyPI
|
||||
env:
|
||||
TWINE_USERNAME: __token__
|
||||
TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
|
||||
run: uv run twine upload dist/*
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### "File already exists" Error
|
||||
|
||||
PyPI doesn't allow re-uploading the same version. Options:
|
||||
1. Increment version number in `pyproject.toml`
|
||||
2. Delete old dist files and rebuild
|
||||
|
||||
### Missing Dependencies
|
||||
|
||||
If installation fails due to missing dependencies:
|
||||
1. Check that all dependencies are in `pyproject.toml` `dependencies` section
|
||||
2. Ensure dependency version constraints are correct
|
||||
3. Test in a clean virtual environment
|
||||
|
||||
### Import Errors After Installation
|
||||
|
||||
If the package installs but imports fail:
|
||||
1. Verify package structure in wheel: `unzip -l dist/*.whl`
|
||||
2. Check that `__init__.py` files exist in all package directories
|
||||
3. Ensure `packages = ["unraid_mcp"]` in `[tool.hatch.build.targets.wheel]`
|
||||
|
||||
## Resources
|
||||
|
||||
- [PyPI Publishing Guide](https://packaging.python.org/tutorials/packaging-projects/)
|
||||
- [Semantic Versioning](https://semver.org/)
|
||||
- [Python Packaging User Guide](https://packaging.python.org/)
|
||||
- [uv Documentation](https://docs.astral.sh/uv/)
|
||||
- [Twine Documentation](https://twine.readthedocs.io/)
|
||||
@@ -256,7 +256,7 @@ uv run black unraid_mcp/
|
||||
uv run ruff check unraid_mcp/
|
||||
|
||||
# Type checking
|
||||
uv run mypy unraid_mcp/
|
||||
uv run ty check unraid_mcp/
|
||||
|
||||
# Run tests
|
||||
uv run pytest
|
||||
|
||||
616
docs/research/competitive-analysis.md
Normal file
616
docs/research/competitive-analysis.md
Normal file
@@ -0,0 +1,616 @@
|
||||
# Competitive Analysis: Unraid Integration Projects
|
||||
|
||||
> **Date:** 2026-02-07
|
||||
> **Purpose:** Identify features and capabilities that competing Unraid integration projects offer that our `unraid-mcp` server (26 tools, GraphQL-based) currently lacks.
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Executive Summary](#executive-summary)
|
||||
- [Project Profiles](#project-profiles)
|
||||
- [1. unraid-management-agent (Go plugin)](#1-unraid-management-agent)
|
||||
- [2. domalab/unraid-api-client (Python library)](#2-domalabu nraid-api-client)
|
||||
- [3. mcp-ssh-sre / unraid-ssh-mcp (SSH-based MCP)](#3-mcp-ssh-sre--unraid-ssh-mcp)
|
||||
- [4. PSUnraid (PowerShell module)](#4-psunraid)
|
||||
- [5. ha-unraid (Home Assistant integration)](#5-ha-unraid)
|
||||
- [6. chris-mc1/unraid_api (HA integration)](#6-chris-mc1unraid_api)
|
||||
- [Feature Matrix](#feature-matrix)
|
||||
- [Gap Analysis](#gap-analysis)
|
||||
- [Recommended Priorities](#recommended-priorities)
|
||||
- [Sources](#sources)
|
||||
|
||||
---
|
||||
|
||||
## Executive Summary
|
||||
|
||||
Our `unraid-mcp` server provides 26 MCP tools built on the official Unraid GraphQL API. After analyzing six competing projects, we identified several significant gaps:
|
||||
|
||||
**Critical gaps (high-value features we lack):**
|
||||
1. **Array control operations** (start/stop array, parity check control, disk spin up/down)
|
||||
2. **UPS monitoring** (battery level, load, runtime, power status)
|
||||
3. **GPU metrics** (utilization, temperature, memory, power draw)
|
||||
4. **SMART disk health data** (per-disk SMART status, errors, power-on hours)
|
||||
5. **Parity check history** (dates, durations, error counts)
|
||||
6. **System reboot/shutdown** commands
|
||||
7. **Services status** (running system services)
|
||||
8. **Flash drive info** (boot device monitoring)
|
||||
9. **Plugins list** (installed plugins)
|
||||
|
||||
**Moderate gaps (nice-to-have features):**
|
||||
10. **Docker container resource metrics** (CPU %, memory usage per container)
|
||||
11. **Docker container pause/unpause** operations
|
||||
12. **ZFS pool/dataset/snapshot management**
|
||||
13. **User script execution** (User Scripts plugin integration)
|
||||
14. **Network bandwidth monitoring** (per-interface stats)
|
||||
15. **Prometheus metrics endpoint**
|
||||
16. **MQTT event publishing**
|
||||
17. **WebSocket real-time streaming** (not just subscription diagnostics)
|
||||
18. **MCP Resources** (subscribable data streams)
|
||||
19. **MCP Prompts** (guided interaction templates)
|
||||
20. **Unassigned devices** monitoring
|
||||
|
||||
**Architectural gaps:**
|
||||
21. No confirmation/safety mechanism for destructive operations
|
||||
22. No Pydantic response models (type-safe responses)
|
||||
23. No Docker network listing
|
||||
24. No container update capability
|
||||
25. No owner/cloud/remote-access info queries
|
||||
|
||||
---
|
||||
|
||||
## Project Profiles
|
||||
|
||||
### 1. unraid-management-agent
|
||||
|
||||
- **Repository:** [ruaan-deysel/unraid-management-agent](https://github.com/ruaan-deysel/unraid-management-agent)
|
||||
- **Language:** Go
|
||||
- **Architecture:** Unraid plugin with REST API + WebSocket + MCP + Prometheus + MQTT
|
||||
- **API Type:** REST (59 endpoints) + WebSocket (9 event types) + MCP (54 tools)
|
||||
- **Data Collection:** Native Go libraries (Docker SDK, libvirt, /proc, /sys) -- does NOT depend on the GraphQL API
|
||||
- **Stars/Activity:** Active development, comprehensive documentation
|
||||
|
||||
**Key differentiators from our project:**
|
||||
- Runs as an Unraid plugin directly on the server (no external dependency on GraphQL API)
|
||||
- Collects data directly from /proc, /sys, Docker SDK, and libvirt
|
||||
- 59 REST endpoints vs our 26 MCP tools
|
||||
- 54 MCP tools with Resources and Prompts
|
||||
- Real-time WebSocket event streaming (9 event types, 5-60s intervals)
|
||||
- 41 Prometheus metrics for Grafana dashboards
|
||||
- MQTT publishing for Home Assistant/IoT integration
|
||||
- Confirmation-required destructive operations (`confirm: true` parameter)
|
||||
- Collector management (enable/disable collectors, adjust intervals)
|
||||
- System reboot and shutdown commands
|
||||
|
||||
**Unique capabilities not available via GraphQL API:**
|
||||
- GPU metrics (utilization, temperature, memory, power draw via nvidia-smi)
|
||||
- UPS metrics via NUT (Network UPS Tools) direct integration
|
||||
- Fan RPM readings from /sys
|
||||
- Motherboard temperature from /sys
|
||||
- SMART disk data (power-on hours, power cycles, read/write bytes, I/O utilization)
|
||||
- Network interface bandwidth (rx/tx bytes, real-time)
|
||||
- Docker container resource usage (CPU %, memory bytes, network I/O)
|
||||
- Unassigned devices monitoring
|
||||
- ZFS pools, datasets, snapshots, ARC stats
|
||||
- Parity check scheduling
|
||||
- Mover settings
|
||||
- Disk thresholds/settings
|
||||
- Service management
|
||||
- Plugin and update management
|
||||
- Flash drive info
|
||||
- Network access URLs (LAN, WAN, mDNS, IPv6)
|
||||
- User script execution
|
||||
- Share configuration modification (POST endpoints)
|
||||
- System settings modification
|
||||
|
||||
**MCP-specific features we lack:**
|
||||
- MCP Resources (subscribable real-time data: `unraid://system`, `unraid://array`, `unraid://containers`, `unraid://vms`, `unraid://disks`)
|
||||
- MCP Prompts (`analyze_disk_health`, `system_overview`, `troubleshoot_issue`)
|
||||
- Dual MCP transport (HTTP + SSE)
|
||||
- Confirmation-gated destructive operations
|
||||
|
||||
**REST Endpoints (59 total):**
|
||||
|
||||
| Category | Endpoints |
|
||||
|----------|-----------|
|
||||
| System & Health | `GET /health`, `GET /system`, `POST /system/reboot`, `POST /system/shutdown` |
|
||||
| Array | `GET /array`, `POST /array/start`, `POST /array/stop` |
|
||||
| Parity | `POST /parity-check/start\|stop\|pause\|resume`, `GET /parity-check/history`, `GET /parity-check/schedule` |
|
||||
| Disks | `GET /disks`, `GET /disks/{id}` |
|
||||
| Shares | `GET /shares`, `GET /shares/{name}/config`, `POST /shares/{name}/config` |
|
||||
| Docker | `GET /docker`, `GET /docker/{id}`, `POST /docker/{id}/start\|stop\|restart\|pause\|unpause` |
|
||||
| VMs | `GET /vm`, `GET /vm/{id}`, `POST /vm/{id}/start\|stop\|restart\|pause\|resume\|hibernate\|force-stop` |
|
||||
| UPS | `GET /ups` |
|
||||
| GPU | `GET /gpu` |
|
||||
| Network | `GET /network`, `GET /network/access-urls`, `GET /network/{interface}/config` |
|
||||
| Collectors | `GET /collectors/status`, `GET /collectors/{name}`, `POST /collectors/{name}/enable\|disable`, `PATCH /collectors/{name}/interval` |
|
||||
| Logs | `GET /logs`, `GET /logs/{filename}` |
|
||||
| Settings | `GET /settings/system\|docker\|vm\|disks\|disk-thresholds\|mover\|services\|network-services`, `POST /settings/system` |
|
||||
| Plugins | `GET /plugins`, `GET /updates` |
|
||||
| Flash | `GET /system/flash` |
|
||||
| Prometheus | `GET /metrics` |
|
||||
| WebSocket | `WS /ws` |
|
||||
|
||||
---
|
||||
|
||||
### 2. domalab/unraid-api-client
|
||||
|
||||
- **Repository:** [domalab/unraid-api-client](https://github.com/domalab/unraid-api-client)
|
||||
- **Language:** Python (async, aiohttp)
|
||||
- **Architecture:** Client library for the official Unraid GraphQL API
|
||||
- **API Type:** GraphQL client (same API we use)
|
||||
- **PyPI Package:** `unraid-api` (installable via pip)
|
||||
|
||||
**Key differentiators from our project:**
|
||||
- Pure client library (not an MCP server), but shows what the GraphQL API can do
|
||||
- Full Pydantic model coverage for all responses (type-safe)
|
||||
- SSL auto-discovery (handles Unraid's "No", "Yes", "Strict" SSL modes)
|
||||
- Redirect handling for myunraid.net remote access
|
||||
- Session injection for Home Assistant integration
|
||||
- Comprehensive exception hierarchy
|
||||
|
||||
**Methods we should consider adding MCP tools for:**
|
||||
|
||||
| Method | Our Coverage | Notes |
|
||||
|--------|-------------|-------|
|
||||
| `test_connection()` | Missing | Connection validation |
|
||||
| `get_version()` | Missing | API and OS version info |
|
||||
| `get_server_info()` | Partial | For device registration |
|
||||
| `get_system_metrics()` | Missing | CPU, memory, temperature, power, uptime as typed model |
|
||||
| `typed_get_array()` | Have `get_array_status()` | They have richer Pydantic model |
|
||||
| `typed_get_containers()` | Have `list_docker_containers()` | They have typed models |
|
||||
| `typed_get_vms()` | Have `list_vms()` | They have typed models |
|
||||
| `typed_get_ups_devices()` | **Missing** | UPS battery, power, runtime |
|
||||
| `typed_get_shares()` | Have `get_shares_info()` | Similar |
|
||||
| `get_notification_overview()` | Have it | Same |
|
||||
| `start/stop_container()` | Have `manage_docker_container()` | Same |
|
||||
| `pause/unpause_container()` | **Missing** | Docker pause/unpause |
|
||||
| `update_container()` | **Missing** | Container image update |
|
||||
| `remove_container()` | **Missing** | Container removal |
|
||||
| `start/stop_vm()` | Have `manage_vm()` | Same |
|
||||
| `pause/resume_vm()` | **Missing** | VM pause/resume |
|
||||
| `force_stop_vm()` | **Missing** | Force stop VM |
|
||||
| `reboot_vm()` | **Missing** | VM reboot |
|
||||
| `start/stop_array()` | **Missing** | Array start/stop control |
|
||||
| `start/pause/resume/cancel_parity_check()` | **Missing** | Full parity control |
|
||||
| `spin_up/down_disk()` | **Missing** | Disk spin control |
|
||||
| `get_parity_history()` | **Missing** | Historical parity data |
|
||||
| `typed_get_vars()` | Have `get_unraid_variables()` | Same |
|
||||
| `typed_get_registration()` | Have `get_registration_info()` | Same |
|
||||
| `typed_get_services()` | **Missing** | System services list |
|
||||
| `typed_get_flash()` | **Missing** | Flash drive info |
|
||||
| `typed_get_owner()` | **Missing** | Server owner info |
|
||||
| `typed_get_plugins()` | **Missing** | Installed plugins |
|
||||
| `typed_get_docker_networks()` | **Missing** | Docker network list |
|
||||
| `typed_get_log_files()` | Have `list_available_log_files()` | Same |
|
||||
| `typed_get_cloud()` | **Missing** | Unraid Connect cloud status |
|
||||
| `typed_get_connect()` | Have `get_connect_settings()` | Same |
|
||||
| `typed_get_remote_access()` | **Missing** | Remote access settings |
|
||||
| `get_physical_disks()` | Have `list_physical_disks()` | Same |
|
||||
| `get_array_disks()` | **Missing** | Array disk assignments |
|
||||
|
||||
---
|
||||
|
||||
### 3. mcp-ssh-sre / unraid-ssh-mcp
|
||||
|
||||
- **Repository:** [ohare93/mcp-ssh-sre](https://github.com/ohare93/mcp-ssh-sre)
|
||||
- **Language:** TypeScript/Node.js
|
||||
- **Architecture:** MCP server that connects via SSH to run predefined commands
|
||||
- **API Type:** SSH command execution (read-only by design)
|
||||
- **Tools:** 12 tool modules with 79+ actions
|
||||
|
||||
**Why SSH instead of GraphQL API:**
|
||||
The project's documentation explicitly compares SSH vs API capabilities:
|
||||
|
||||
| Feature | GraphQL API | SSH |
|
||||
|---------|------------|-----|
|
||||
| Docker container logs | Limited | Full |
|
||||
| SMART disk health data | Limited | Full (smartctl) |
|
||||
| Real-time CPU/load averages | Polling | Direct |
|
||||
| Network bandwidth monitoring | Limited | Full (iftop, nethogs) |
|
||||
| Process monitoring (ps/top) | Not available | Full |
|
||||
| Log file analysis | Basic | Full (grep, awk) |
|
||||
| Security auditing | Not available | Full |
|
||||
|
||||
**Tool modules and actions:**
|
||||
|
||||
| Module | Tool Name | Actions |
|
||||
|--------|-----------|---------|
|
||||
| Docker | `docker` | list_containers, inspect, logs, stats, port, env, top, health, logs_aggregate, list_networks, inspect_network, list_volumes, inspect_volume, network_containers |
|
||||
| System | `system` | list_files, read_file, find_files, disk_usage, system_info |
|
||||
| Monitoring | `monitoring` | ps, process_tree, top, iostat, network_connections |
|
||||
| Security | `security` | open_ports, audit_privileges, ssh_connections, cert_expiry |
|
||||
| Log Analysis | `log` | grep_all, error_aggregator, timeline, parse_docker, compare_timerange, restart_history |
|
||||
| Resources | `resource` | dangling, hogs, disk_analyzer, docker_df, zombies, io_profile |
|
||||
| Performance | `performance` | bottleneck, bandwidth, track_metric |
|
||||
| VMs | `vm` | list, info, vnc, logs |
|
||||
| Container Topology | `container_topology` | network_topology, volume_sharing, dependency_graph, port_conflicts, network_test |
|
||||
| Health Diagnostics | `health` | comprehensive, common_issues, threshold_alerts, compare_baseline, diagnostic_report, snapshot |
|
||||
| **Unraid Array** | `unraid` | array_status, smart, temps, shares, share_usage, parity_status, parity_history, sync_status, spin_status, unclean_check, mover_status, mover_log, cache_usage, split_level |
|
||||
| **Unraid Plugins** | `plugin` | list, updates, template, scripts, share_config, disk_assignments, recent_changes |
|
||||
|
||||
**Unique capabilities we lack entirely:**
|
||||
- Container log retrieval and aggregation
|
||||
- Container environment variable inspection
|
||||
- Container topology analysis (network maps, shared volumes, dependency graphs, port conflicts)
|
||||
- Process monitoring (ps, top, process trees)
|
||||
- Disk I/O monitoring (iostat)
|
||||
- Network connection analysis (ss/netstat)
|
||||
- Security auditing (open ports, privilege audit, SSH connection logs, SSL cert expiry)
|
||||
- Performance bottleneck analysis
|
||||
- Resource waste detection (dangling Docker resources, zombie processes)
|
||||
- Comprehensive health diagnostics with baseline comparison
|
||||
- Mover status and logs
|
||||
- Cache usage analysis
|
||||
- Split level configuration
|
||||
- User script discovery
|
||||
- Docker template inspection
|
||||
- Disk assignment information
|
||||
- Recent config file change detection
|
||||
|
||||
---
|
||||
|
||||
### 4. PSUnraid
|
||||
|
||||
- **Repository:** [jlabon2/PSUnraid](https://github.com/jlabon2/PSUnraid)
|
||||
- **Language:** PowerShell
|
||||
- **Architecture:** PowerShell module using GraphQL API
|
||||
- **API Type:** GraphQL (same as ours)
|
||||
- **Status:** Proof of concept, 30+ cmdlets
|
||||
|
||||
**Cmdlets and operations:**
|
||||
|
||||
| Category | Cmdlets |
|
||||
|----------|---------|
|
||||
| Connection | `Connect-Unraid`, `Disconnect-Unraid` |
|
||||
| System | `Get-UnraidServer`, `Get-UnraidMetrics`, `Get-UnraidLog`, `Start-UnraidMonitor` |
|
||||
| Docker | `Get-UnraidContainer`, `Start-UnraidContainer`, `Stop-UnraidContainer`, `Restart-UnraidContainer` |
|
||||
| VMs | `Get-UnraidVm`, `Start-UnraidVm`, `Stop-UnraidVm`, `Suspend-UnraidVm`, `Resume-UnraidVm`, `Restart-UnraidVm` |
|
||||
| Array | `Get-UnraidArray`, `Get-UnraidPhysicalDisk`, `Get-UnraidShare`, `Start-UnraidArray`, `Stop-UnraidArray` |
|
||||
| Parity | `Start-UnraidParityCheck`, `Stop-UnraidParityCheck`, `Suspend-UnraidParityCheck`, `Resume-UnraidParityCheck`, `Get-UnraidParityHistory` |
|
||||
| Notifications | `Get-UnraidNotification`, `Set-UnraidNotification`, `Remove-UnraidNotification` |
|
||||
| Other | `Get-UnraidPlugin`, `Get-UnraidUps`, `Restart-UnraidApi` |
|
||||
|
||||
**Features we lack that PSUnraid has (via same GraphQL API):**
|
||||
- Real-time monitoring dashboard (`Start-UnraidMonitor`)
|
||||
- Notification management (mark as read, delete notifications)
|
||||
- Array start/stop
|
||||
- Parity check full lifecycle (start, stop, pause, resume, history)
|
||||
- UPS monitoring
|
||||
- Plugin listing
|
||||
- API restart capability
|
||||
- VM suspend/resume/restart
|
||||
|
||||
---
|
||||
|
||||
### 5. ha-unraid (Home Assistant)
|
||||
|
||||
- **Repository:** [domalab/ha-unraid](https://github.com/domalab/ha-unraid) (ruaan-deysel fork is active)
|
||||
- **Language:** Python
|
||||
- **Architecture:** Home Assistant custom integration
|
||||
- **API Type:** Originally SSH-based (through v2025.06.11), rebuilt for GraphQL API (v2025.12.0+)
|
||||
- **Requires:** Unraid 7.2.0+, GraphQL API v4.21.0+
|
||||
|
||||
**Sensors provided:**
|
||||
|
||||
| Entity Type | Entities |
|
||||
|-------------|----------|
|
||||
| **Sensors** | CPU Usage, CPU Temperature, CPU Power, Memory Usage, Uptime, Array State, Array Usage, Parity Progress, per-Disk Usage, per-Share Usage, Flash Usage, UPS Battery, UPS Load, UPS Runtime, UPS Power, Notifications count |
|
||||
| **Binary Sensors** | Array Started, Parity Check Running, Parity Valid, per-Disk Health, UPS Connected |
|
||||
| **Switches** | Docker Container start/stop, VM start/stop |
|
||||
| **Buttons** | Array Start/Stop, Parity Check Start/Stop, Disk Spin Up/Down |
|
||||
|
||||
**Features we lack:**
|
||||
- CPU temperature and CPU power consumption monitoring
|
||||
- UPS full monitoring (battery, load, runtime, power, connected status)
|
||||
- Parity progress tracking
|
||||
- Per-disk health binary status
|
||||
- Flash device usage monitoring
|
||||
- Array start/stop buttons
|
||||
- Parity check start/stop
|
||||
- Disk spin up/down
|
||||
- Dynamic entity creation (only creates entities for available services)
|
||||
|
||||
---
|
||||
|
||||
### 6. chris-mc1/unraid_api (HA integration)
|
||||
|
||||
- **Repository:** [chris-mc1/unraid_api](https://github.com/chris-mc1/unraid_api)
|
||||
- **Language:** Python
|
||||
- **Architecture:** Lightweight Home Assistant integration using GraphQL API
|
||||
- **API Type:** GraphQL
|
||||
- **Status:** Simpler/lighter alternative to ha-unraid
|
||||
|
||||
**Entities provided:**
|
||||
- Array state sensor
|
||||
- Array used space percentage
|
||||
- RAM usage percentage
|
||||
- CPU utilization
|
||||
- Per-share free space (optional)
|
||||
- Per-disk state, temperature, spinning status, used space (optional)
|
||||
|
||||
**Notable:** This is a simpler, lighter-weight integration focused on monitoring only (no control operations).
|
||||
|
||||
---
|
||||
|
||||
## Feature Matrix
|
||||
|
||||
### Legend
|
||||
- **Y** = Supported
|
||||
- **N** = Not supported
|
||||
- **P** = Partial support
|
||||
- **--** = Not applicable
|
||||
|
||||
### Monitoring Features
|
||||
|
||||
| Feature | Our MCP (26 tools) | mgmt-agent (54 MCP tools) | unraid-api-client | mcp-ssh-sre (79 actions) | PSUnraid | ha-unraid | chris-mc1 |
|
||||
|---------|:---:|:---:|:---:|:---:|:---:|:---:|:---:|
|
||||
| System info (hostname, uptime) | Y | Y | Y | Y | Y | Y | N |
|
||||
| CPU usage | Y | Y | Y | Y | Y | Y | Y |
|
||||
| CPU temperature | N | Y | Y | N | N | Y | N |
|
||||
| CPU power consumption | N | Y | N | N | N | Y | N |
|
||||
| Memory usage | Y | Y | Y | Y | Y | Y | Y |
|
||||
| GPU metrics | N | Y | N | N | N | N | N |
|
||||
| Fan RPM | N | Y | N | N | N | N | N |
|
||||
| Motherboard temperature | N | Y | N | N | N | N | N |
|
||||
| UPS monitoring | N | Y | Y | N | Y | Y | N |
|
||||
| Network config | Y | Y | Y | Y | N | N | N |
|
||||
| Network bandwidth | N | Y | N | Y | N | N | N |
|
||||
| Registration/license info | Y | Y | Y | N | N | N | N |
|
||||
| Connect settings | Y | Y | Y | N | N | N | N |
|
||||
| Unraid variables | Y | Y | Y | N | N | N | N |
|
||||
| System services status | N | Y | Y | N | N | N | N |
|
||||
| Flash drive info | N | Y | Y | N | N | Y | N |
|
||||
| Owner info | N | N | Y | N | N | N | N |
|
||||
| Installed plugins | N | Y | Y | Y | Y | N | N |
|
||||
| Available updates | N | Y | N | Y | N | N | N |
|
||||
|
||||
### Storage Features
|
||||
|
||||
| Feature | Our MCP | mgmt-agent | unraid-api-client | mcp-ssh-sre | PSUnraid | ha-unraid | chris-mc1 |
|
||||
|---------|:---:|:---:|:---:|:---:|:---:|:---:|:---:|
|
||||
| Array status | Y | Y | Y | Y | Y | Y | Y |
|
||||
| Array start/stop | N | Y | Y | N | Y | Y | N |
|
||||
| Physical disk listing | Y | Y | Y | N | Y | N | N |
|
||||
| Disk details | Y | Y | Y | Y | Y | Y | Y |
|
||||
| Disk SMART data | N | Y | N | Y | N | P | N |
|
||||
| Disk spin up/down | N | Y | Y | Y | N | Y | N |
|
||||
| Disk temperatures | P | Y | Y | Y | N | Y | Y |
|
||||
| Disk I/O stats | N | Y | N | Y | N | N | N |
|
||||
| Shares info | Y | Y | Y | Y | Y | Y | Y |
|
||||
| Share configuration | N | Y | N | Y | N | N | N |
|
||||
| Parity check control | N | Y | Y | N | Y | Y | N |
|
||||
| Parity check history | N | Y | Y | Y | Y | N | N |
|
||||
| Parity progress | N | Y | Y | Y | Y | Y | N |
|
||||
| ZFS pools/datasets/snapshots | N | Y | N | N | N | N | N |
|
||||
| ZFS ARC stats | N | Y | N | N | N | N | N |
|
||||
| Unassigned devices | N | Y | N | N | N | N | N |
|
||||
| Mover status/logs | N | N | N | Y | N | N | N |
|
||||
| Cache usage | N | N | N | Y | N | N | N |
|
||||
|
||||
### Docker Features
|
||||
|
||||
| Feature | Our MCP | mgmt-agent | unraid-api-client | mcp-ssh-sre | PSUnraid | ha-unraid | chris-mc1 |
|
||||
|---------|:---:|:---:|:---:|:---:|:---:|:---:|:---:|
|
||||
| List containers | Y | Y | Y | Y | Y | Y | N |
|
||||
| Container details | Y | Y | Y | Y | N | P | N |
|
||||
| Start/stop/restart | Y | Y | Y | N | Y | Y | N |
|
||||
| Pause/unpause | N | Y | Y | N | N | N | N |
|
||||
| Container resource usage | N | Y | Y | Y | N | N | N |
|
||||
| Container logs | N | N | N | Y | N | N | N |
|
||||
| Container env vars | N | N | N | Y | N | N | N |
|
||||
| Container network topology | N | N | N | Y | N | N | N |
|
||||
| Container port inspection | N | N | N | Y | N | N | N |
|
||||
| Docker networks | N | Y | Y | Y | N | N | N |
|
||||
| Docker volumes | N | N | N | Y | N | N | N |
|
||||
| Container update | N | N | Y | N | N | N | N |
|
||||
| Container removal | N | N | Y | N | N | N | N |
|
||||
| Docker settings | N | Y | N | N | N | N | N |
|
||||
|
||||
### VM Features
|
||||
|
||||
| Feature | Our MCP | mgmt-agent | unraid-api-client | mcp-ssh-sre | PSUnraid | ha-unraid | chris-mc1 |
|
||||
|---------|:---:|:---:|:---:|:---:|:---:|:---:|:---:|
|
||||
| List VMs | Y | Y | Y | Y | Y | Y | N |
|
||||
| VM details | Y | Y | Y | Y | N | P | N |
|
||||
| Start/stop | Y | Y | Y | N | Y | Y | N |
|
||||
| Restart | Y | Y | N | N | Y | N | N |
|
||||
| Pause/resume | N | Y | Y | N | Y | N | N |
|
||||
| Hibernate | N | Y | N | N | N | N | N |
|
||||
| Force stop | N | Y | Y | N | Y | N | N |
|
||||
| Reboot VM | N | N | Y | N | N | N | N |
|
||||
| VNC info | N | N | N | Y | N | N | N |
|
||||
| VM libvirt logs | N | N | N | Y | N | N | N |
|
||||
| VM settings | N | Y | N | N | N | N | N |
|
||||
|
||||
### Cloud Storage (RClone) Features
|
||||
|
||||
| Feature | Our MCP | mgmt-agent | unraid-api-client | mcp-ssh-sre | PSUnraid | ha-unraid | chris-mc1 |
|
||||
|---------|:---:|:---:|:---:|:---:|:---:|:---:|:---:|
|
||||
| List remotes | Y | N | N | N | N | N | N |
|
||||
| Get config form | Y | N | N | N | N | N | N |
|
||||
| Create remote | Y | N | N | N | N | N | N |
|
||||
| Delete remote | Y | N | N | N | N | N | N |
|
||||
|
||||
> **Note:** RClone management is unique to our project among these competitors.
|
||||
|
||||
### Notification Features
|
||||
|
||||
| Feature | Our MCP | mgmt-agent | unraid-api-client | mcp-ssh-sre | PSUnraid | ha-unraid | chris-mc1 |
|
||||
|---------|:---:|:---:|:---:|:---:|:---:|:---:|:---:|
|
||||
| Notification overview | Y | Y | Y | N | N | Y | N |
|
||||
| List notifications | Y | Y | Y | Y | Y | N | N |
|
||||
| Mark as read | N | N | N | N | Y | N | N |
|
||||
| Delete notifications | N | N | N | N | Y | N | N |
|
||||
|
||||
### Logs & Diagnostics
|
||||
|
||||
| Feature | Our MCP | mgmt-agent | unraid-api-client | mcp-ssh-sre | PSUnraid | ha-unraid | chris-mc1 |
|
||||
|---------|:---:|:---:|:---:|:---:|:---:|:---:|:---:|
|
||||
| List log files | Y | Y | Y | N | N | N | N |
|
||||
| Get log contents | Y | Y | Y | Y | Y | N | N |
|
||||
| Log search/grep | N | N | N | Y | N | N | N |
|
||||
| Error aggregation | N | N | N | Y | N | N | N |
|
||||
| Syslog access | N | Y | N | Y | Y | N | N |
|
||||
| Docker daemon log | N | Y | N | Y | N | N | N |
|
||||
| Health check | Y | Y | N | Y | N | N | N |
|
||||
| Subscription diagnostics | Y | N | N | N | N | N | N |
|
||||
|
||||
### Integration & Protocol Features
|
||||
|
||||
| Feature | Our MCP | mgmt-agent | unraid-api-client | mcp-ssh-sre | PSUnraid | ha-unraid | chris-mc1 |
|
||||
|---------|:---:|:---:|:---:|:---:|:---:|:---:|:---:|
|
||||
| MCP tools | Y (26) | Y (54) | N | Y (79 actions) | N | N | N |
|
||||
| MCP Resources | N | Y (5) | N | N | N | N | N |
|
||||
| MCP Prompts | N | Y (3) | N | N | N | N | N |
|
||||
| REST API | N | Y (59) | N | N | N | N | N |
|
||||
| WebSocket streaming | N | Y (9 events) | N | N | N | N | N |
|
||||
| Prometheus metrics | N | Y (41) | N | N | N | N | N |
|
||||
| MQTT publishing | N | Y | N | N | N | N | N |
|
||||
| SSE transport | Y | Y | N | Y | N | N | N |
|
||||
| Stdio transport | Y | N | N | Y | N | N | N |
|
||||
| Streamable HTTP | Y | Y | N | Y | N | N | N |
|
||||
| Pydantic models | N | N | Y | N | N | N | N |
|
||||
| Safety confirmations | N | Y | N | N | N | N | N |
|
||||
|
||||
### Security & Operational Features
|
||||
|
||||
| Feature | Our MCP | mgmt-agent | mcp-ssh-sre | PSUnraid |
|
||||
|---------|:---:|:---:|:---:|:---:|
|
||||
| Open port scanning | N | N | Y | N |
|
||||
| SSH login monitoring | N | N | Y | N |
|
||||
| Container privilege audit | N | N | Y | N |
|
||||
| SSL certificate expiry | N | N | Y | N |
|
||||
| Process monitoring | N | N | Y | N |
|
||||
| Zombie process detection | N | N | Y | N |
|
||||
| Performance bottleneck analysis | N | N | Y | N |
|
||||
| System reboot | N | Y | N | N |
|
||||
| System shutdown | N | Y | N | N |
|
||||
| User script execution | N | Y | Y | N |
|
||||
|
||||
---
|
||||
|
||||
## Gap Analysis
|
||||
|
||||
### Priority 1: High-Value Features Available via GraphQL API
|
||||
|
||||
These features are available through the same GraphQL API we already use and should be straightforward to implement:
|
||||
|
||||
1. **Array start/stop control** -- Both `domalab/unraid-api-client` and `PSUnraid` implement this via GraphQL mutations. This is a fundamental control operation that every competitor supports.
|
||||
|
||||
2. **Parity check lifecycle** (start, stop, pause, resume, history) -- Available via GraphQL mutations. Critical for array management.
|
||||
|
||||
3. **Disk spin up/down** -- Available via GraphQL mutations. Important for power management and noise control.
|
||||
|
||||
4. **UPS monitoring** -- Available via GraphQL query. Present in `unraid-api-client`, `PSUnraid`, and `ha-unraid`. Data includes battery level, load, runtime, power state.
|
||||
|
||||
5. **System services list** -- Available via GraphQL query (`services`). Shows Docker service, VM manager status, etc.
|
||||
|
||||
6. **Flash drive info** -- Available via GraphQL query (`flash`). Boot device monitoring.
|
||||
|
||||
7. **Installed plugins list** -- Available via GraphQL query (`plugins`). Useful for understanding server configuration.
|
||||
|
||||
8. **Docker networks** -- Available via GraphQL query. Listed in `unraid-api-client`.
|
||||
|
||||
9. **Parity history** -- Available via GraphQL query. Historical parity check data.
|
||||
|
||||
10. **VM pause/resume and force stop** -- Available via GraphQL mutations. Completing our VM control capabilities.
|
||||
|
||||
11. **Docker pause/unpause** -- Available via GraphQL mutations. Completing our Docker control capabilities.
|
||||
|
||||
12. **Cloud/remote access status** -- Available via GraphQL queries. Shows Unraid Connect status, remote access configuration.
|
||||
|
||||
13. **Notification management** -- Mark as read, delete. `PSUnraid` implements this via GraphQL.
|
||||
|
||||
14. **API/OS version info** -- Simple query that helps with compatibility checks.
|
||||
|
||||
### Priority 2: High-Value Features Requiring Non-GraphQL Data Sources
|
||||
|
||||
These would require SSH access or other system-level access that our GraphQL-only architecture cannot provide:
|
||||
|
||||
1. **Container logs** -- Not available via GraphQL. SSH-based solutions (mcp-ssh-sre) can retrieve full container logs via `docker logs`.
|
||||
|
||||
2. **SMART disk data** -- Limited via GraphQL. Full SMART data (power-on hours, error counts, reallocated sectors) requires `smartctl` access.
|
||||
|
||||
3. **GPU metrics** -- Not available via GraphQL. Requires nvidia-smi or similar.
|
||||
|
||||
4. **Process monitoring** -- Not available via GraphQL. Requires `ps`/`top` access.
|
||||
|
||||
5. **Network bandwidth** -- Not in GraphQL. Requires direct system access.
|
||||
|
||||
6. **Container resource usage** (CPU%, memory) -- Not available through the current GraphQL API at a per-container level in real-time.
|
||||
|
||||
7. **Log search/grep** -- While we can get log contents, we cannot search across logs.
|
||||
|
||||
8. **Security auditing** -- Not available via GraphQL.
|
||||
|
||||
### Priority 3: Architectural Improvements
|
||||
|
||||
1. **MCP Resources** -- Add subscribable data streams (system, array, containers, VMs, disks) for real-time AI agent monitoring.
|
||||
|
||||
2. **MCP Prompts** -- Add guided interaction templates (disk health analysis, system overview, troubleshooting).
|
||||
|
||||
3. **Confirmation for destructive operations** -- Add a `confirm` parameter for array stop, system reboot, container removal, etc.
|
||||
|
||||
4. **Pydantic response models** -- Type-safe response parsing like `domalab/unraid-api-client`.
|
||||
|
||||
5. **Connection validation tool** -- Simple tool to verify API connectivity and version compatibility.
|
||||
|
||||
---
|
||||
|
||||
## Recommended Priorities
|
||||
|
||||
### Phase 1: Low-Hanging Fruit (GraphQL mutations/queries we already have access to)
|
||||
|
||||
**Estimated effort: Small -- these are straightforward GraphQL queries/mutations**
|
||||
|
||||
| New Tool | Priority | Notes |
|
||||
|----------|----------|-------|
|
||||
| `start_array()` / `stop_array()` | Critical | Every competitor has this |
|
||||
| `start_parity_check()` / `stop_parity_check()` | Critical | Full parity lifecycle |
|
||||
| `pause_parity_check()` / `resume_parity_check()` | Critical | Full parity lifecycle |
|
||||
| `get_parity_history()` | High | Historical data |
|
||||
| `spin_up_disk()` / `spin_down_disk()` | High | Disk power management |
|
||||
| `get_ups_status()` | High | UPS monitoring |
|
||||
| `get_services_status()` | Medium | System services |
|
||||
| `get_flash_info()` | Medium | Flash drive info |
|
||||
| `get_plugins()` | Medium | Plugin management |
|
||||
| `get_docker_networks()` | Medium | Docker networking |
|
||||
| `pause_docker_container()` / `unpause_docker_container()` | Medium | Docker control |
|
||||
| `pause_vm()` / `resume_vm()` / `force_stop_vm()` | Medium | VM control |
|
||||
| `get_cloud_status()` / `get_remote_access()` | Low | Connect info |
|
||||
| `get_version()` | Low | API version |
|
||||
| `manage_notifications()` | Low | Mark read/delete |
|
||||
|
||||
### Phase 2: MCP Protocol Enhancements
|
||||
|
||||
| Enhancement | Priority | Notes |
|
||||
|-------------|----------|-------|
|
||||
| MCP Resources (5 streams) | High | Real-time data for AI agents |
|
||||
| MCP Prompts (3 templates) | Medium | Guided interactions |
|
||||
| Confirmation parameter | High | Safety for destructive ops |
|
||||
| Connection validation tool | Medium | Health/compatibility check |
|
||||
|
||||
### Phase 3: Advanced Features (may require SSH)
|
||||
|
||||
| Feature | Priority | Notes |
|
||||
|---------|----------|-------|
|
||||
| Container log retrieval | High | Most-requested SSH-only feature |
|
||||
| SMART disk health data | High | Disk failure prediction |
|
||||
| GPU monitoring | Medium | For GPU passthrough users |
|
||||
| Performance/resource monitoring | Medium | Bottleneck analysis |
|
||||
| Security auditing | Low | Port scan, login audit |
|
||||
|
||||
---
|
||||
|
||||
## Sources
|
||||
|
||||
- [ruaan-deysel/unraid-management-agent](https://github.com/ruaan-deysel/unraid-management-agent) -- Go-based Unraid plugin with REST API, WebSocket, MCP, Prometheus, and MQTT
|
||||
- [domalab/unraid-api-client](https://github.com/domalab/unraid-api-client) -- Async Python client for Unraid GraphQL API (PyPI: `unraid-api`)
|
||||
- [ohare93/mcp-ssh-sre](https://github.com/ohare93/mcp-ssh-sre) -- SSH-based MCP server for read-only server monitoring
|
||||
- [jlabon2/PSUnraid](https://github.com/jlabon2/PSUnraid) -- PowerShell module for Unraid 7.x management via GraphQL API
|
||||
- [domalab/ha-unraid](https://github.com/domalab/ha-unraid) (ruaan-deysel fork) -- Home Assistant integration via GraphQL API
|
||||
- [chris-mc1/unraid_api](https://github.com/chris-mc1/unraid_api) -- Lightweight Home Assistant integration for Unraid
|
||||
- [nickbeddows-ctrl/unraid-ssh-mcp](https://github.com/nickbeddows-ctrl/unraid-ssh-mcp) -- Guardrailed MCP server for Unraid management via SSH
|
||||
- [MCP SSH Unraid on LobeHub](https://lobehub.com/mcp/ohare93-unraid-ssh-mcp)
|
||||
- [MCP SSH SRE on Glama](https://glama.ai/mcp/servers/@ohare93/mcp-ssh-sre)
|
||||
- [Unraid Integration for Home Assistant (domalab docs)](https://domalab.github.io/ha-unraid/)
|
||||
- [Home Assistant Unraid Integration forum thread](https://community.home-assistant.io/t/unraid-integration/785003)
|
||||
845
docs/research/feature-gap-analysis.md
Normal file
845
docs/research/feature-gap-analysis.md
Normal file
@@ -0,0 +1,845 @@
|
||||
# Unraid API Feature Gap Analysis
|
||||
|
||||
> **Date:** 2026-02-07
|
||||
> **Purpose:** Comprehensive inventory of every API capability that could become an MCP tool, cross-referenced against our current 26 tools to identify gaps.
|
||||
> **Sources:** 7 research documents (3,800+ lines), Unraid API source code analysis, community project reviews, official documentation crawl.
|
||||
|
||||
---
|
||||
|
||||
## Table of Contents
|
||||
|
||||
1. [All GraphQL Queries Available](#a-all-graphql-queries-available)
|
||||
2. [All GraphQL Mutations Available](#b-all-graphql-mutations-available)
|
||||
3. [All GraphQL Subscriptions Available](#c-all-graphql-subscriptions-available)
|
||||
4. [All Custom Scalars and Types](#d-all-custom-scalars-and-types)
|
||||
5. [All Enums](#e-all-enums)
|
||||
6. [API Capabilities NOT in Current MCP Server](#f-api-capabilities-not-currently-in-the-mcp-server)
|
||||
7. [Community Project Capabilities](#g-community-project-capabilities)
|
||||
8. [Known API Bugs and Limitations](#h-known-api-bugs-and-limitations)
|
||||
|
||||
---
|
||||
|
||||
## A. All GraphQL Queries Available
|
||||
|
||||
Every query type identified across all research documents, with their fields and sub-fields.
|
||||
|
||||
### A.1 System & Server Queries
|
||||
|
||||
| Query | Fields | Current MCP Coverage |
|
||||
|-------|--------|---------------------|
|
||||
| `info` | `time`, `baseboard { manufacturer, model, version, serial }`, `cpu { manufacturer, brand, vendor, family, model, stepping, revision, voltage, speed, speedmin, speedmax, threads, cores, processors, socket, cache, flags }`, `devices`, `display`, `machineId`, `memory { max, total, free, used, active, available, buffcache, swaptotal, swapused, swapfree, layout[] }`, `os { platform, distro, release, codename, kernel, arch, hostname, codepage, logofile, serial, build, uptime }`, `system { manufacturer, model, version, serial, uuid }`, `versions { kernel, docker, unraid, node }`, `apps { installed, started }` | **YES** - `get_system_info()` |
|
||||
| `vars` | `id`, `version`, `name`, `timeZone`, `comment`, `security`, `workgroup`, `domain`, `useNtp`, `ntpServer1-4`, `useSsl`, `port`, `portssl`, `useTelnet`, `useSsh`, `portssh`, `startPage`, `startArray`, `spindownDelay`, `defaultFormat`, `defaultFsType`, `shutdownTimeout`, `shareDisk`, `shareUser`, `shareSmbEnabled`, `shareNfsEnabled`, `shareAfpEnabled`, `shareCacheEnabled`, `shareMoverSchedule`, `shareMoverLogging`, `safeMode`, `configValid`, `configError`, `deviceCount`, `flashGuid`, `flashProduct`, `flashVendor`, `regState`, `regTo`, `mdState`, `mdNumDisks`, `mdNumDisabled`, `mdNumInvalid`, `mdNumMissing`, `mdResync`, `mdResyncAction`, `fsState`, `fsProgress`, `fsCopyPrcnt`, `shareCount`, `shareSmbCount`, `shareNfsCount`, `csrfToken`, `maxArraysz`, `maxCachesz` | **YES** - `get_unraid_variables()` |
|
||||
| `online` | `Boolean` | **NO** |
|
||||
| `owner` | Server owner information | **NO** |
|
||||
| `server` | Server details | **NO** |
|
||||
| `servers` | `[Server!]!` - List of all servers (Connect-managed) | **NO** |
|
||||
| `me` | `id`, `name`, `description`, `roles`, `permissions` (current authenticated user) | **NO** |
|
||||
| `user(id)` | `id`, `name`, `description`, `roles`, `password`, `permissions` | **NO** |
|
||||
| `users(input)` | `[User!]!` - List of users | **NO** |
|
||||
| `config` | `Config!` - System configuration | **NO** |
|
||||
| `display` | Display settings | **NO** |
|
||||
| `services` | `[Service!]!` - Running services list | **NO** |
|
||||
| `cloud` | `error`, `apiKey`, `relay`, `minigraphql`, `cloud`, `allowedOrigins` | **NO** |
|
||||
| `flash` | Flash drive information | **NO** |
|
||||
|
||||
### A.2 Network Queries
|
||||
|
||||
| Query | Fields | Current MCP Coverage |
|
||||
|-------|--------|---------------------|
|
||||
| `network` | `id`, `iface`, `ifaceName`, `ipv4`, `ipv6`, `mac`, `internal`, `operstate`, `type`, `duplex`, `mtu`, `speed`, `carrierChanges`, `accessUrls { type, name, ipv4, ipv6 }` | **YES** - `get_network_config()` |
|
||||
|
||||
### A.3 Storage & Array Queries
|
||||
|
||||
| Query | Fields | Current MCP Coverage |
|
||||
|-------|--------|---------------------|
|
||||
| `array` | `id`, `state`, `previousState`, `pendingState`, `capacity { kilobytes { free, used, total }, disks { free, used, total } }`, `boot { id, idx, name, device, size, fsSize, fsFree, fsUsed, status, rotational, temp, numReads, numWrites, numErrors, type, exportable, warning, critical, fsType, comment, format, transport, color, isSpinning }`, `parities[...]`, `disks[...]`, `caches[...]`, `parityCheckStatus` | **PARTIAL** - `get_array_status()` (missing `previousState`, `pendingState`, `parityCheckStatus`, disk fields like `color`, `isSpinning`, `transport`, `format`) |
|
||||
| `parityHistory` | `[ParityCheck]` - Historical parity check records | **NO** |
|
||||
| `disks` | `[Disk]!` - All physical disks with `device`, `type`, `name`, `vendor`, `size`, `bytesPerSector`, `totalCylinders`, `totalHeads`, `totalSectors`, `totalTracks`, `tracksPerCylinder`, `sectorsPerTrack`, `firmwareRevision`, `serialNum`, `interfaceType`, `smartStatus`, `temperature`, `partitions[]` | **YES** - `list_physical_disks()` |
|
||||
| `disk(id)` | Single disk by PrefixedID | **YES** - `get_disk_details()` |
|
||||
| `shares` | `name`, `free`, `used`, `size`, `include[]`, `exclude[]`, `cache`, `nameOrig`, `comment`, `allocator`, `splitLevel`, `floor`, `cow`, `color`, `luksStatus` | **PARTIAL** - `get_shares_info()` (may not query all fields like `allocator`, `splitLevel`, `floor`, `cow`, `luksStatus`) |
|
||||
| `unassignedDevices` | `[UnassignedDevice]` - Devices not assigned to array/pool | **NO** |
|
||||
|
||||
### A.4 Docker Queries
|
||||
|
||||
| Query | Fields | Current MCP Coverage |
|
||||
|-------|--------|---------------------|
|
||||
| `docker` | `id`, `containers[]`, `networks[]` | **YES** - `list_docker_containers()` |
|
||||
| `dockerContainers(all)` | `[DockerContainer!]!` - All containers with full details including `id`, `names`, `image`, `imageId`, `command`, `created`, `ports[]`, `lanIpPorts[]`, `sizeRootFs`, `sizeRw`, `sizeLog`, `labels`, `state`, `status`, `hostConfig`, `networkSettings`, `mounts`, `autoStart`, `autoStartOrder`, `autoStartWait`, `templatePath`, `projectUrl`, `registryUrl`, `supportUrl`, `iconUrl`, `webUiUrl`, `shell`, `templatePorts`, `isOrphaned` | **YES** - `list_docker_containers()` / `get_docker_container_details()` |
|
||||
| `container(id)` (via Docker resolver) | Single container by PrefixedID | **YES** - `get_docker_container_details()` |
|
||||
| `docker.logs(id, since, tail)` | Container log output with filtering | **NO** |
|
||||
| `docker.networks` / `dockerNetworks(all)` | `[DockerNetwork]` - name, id, created, scope, driver, enableIPv6, ipam, internal, attachable, ingress, configFrom, configOnly, containers, options, labels | **NO** |
|
||||
| `dockerNetwork(id)` | Single network by ID | **NO** |
|
||||
| `docker.portConflicts` | Port conflict detection | **NO** |
|
||||
| `docker.organizer` | Container organization/folder structure | **NO** |
|
||||
| `docker.containerUpdateStatuses` | Check for available container image updates (`UpdateStatus`: UP_TO_DATE, UPDATE_AVAILABLE, REBUILD_READY, UNKNOWN) | **NO** |
|
||||
|
||||
### A.5 VM Queries
|
||||
|
||||
| Query | Fields | Current MCP Coverage |
|
||||
|-------|--------|---------------------|
|
||||
| `vms` | `id`, `domain[{ uuid/id, name, state }]` | **YES** - `list_vms()` / `get_vm_details()` |
|
||||
|
||||
### A.6 Notification Queries
|
||||
|
||||
| Query | Fields | Current MCP Coverage |
|
||||
|-------|--------|---------------------|
|
||||
| `notifications` | `id`, `overview { unread { info, warning, alert, total }, archive { info, warning, alert, total } }`, `list(filter) [{ id, title, subject, description, importance, link, type, timestamp, formattedTimestamp }]` | **YES** - `get_notifications_overview()` / `list_notifications()` |
|
||||
| `notifications.warningsAndAlerts` | Deduplicated unread warnings and alerts | **NO** |
|
||||
|
||||
### A.7 Registration & Connect Queries
|
||||
|
||||
| Query | Fields | Current MCP Coverage |
|
||||
|-------|--------|---------------------|
|
||||
| `registration` | `id`, `type`, `state`, `expiration`, `updateExpiration`, `keyFile { location, contents }` | **YES** - `get_registration_info()` |
|
||||
| `connect` | `id`, `dynamicRemoteAccess { ... }` | **YES** - `get_connect_settings()` |
|
||||
| `remoteAccess` | `accessType`, `forwardType`, `port` | **NO** |
|
||||
| `extraAllowedOrigins` | `[String!]!` | **NO** |
|
||||
|
||||
### A.8 RClone Queries
|
||||
|
||||
| Query | Fields | Current MCP Coverage |
|
||||
|-------|--------|---------------------|
|
||||
| `rclone.remotes` | `name`, `type`, `parameters`, `config` | **YES** - `list_rclone_remotes()` |
|
||||
| `rclone.configForm(formOptions)` | `id`, `dataSchema`, `uiSchema` | **YES** - `get_rclone_config_form()` |
|
||||
|
||||
### A.9 Logs Queries
|
||||
|
||||
| Query | Fields | Current MCP Coverage |
|
||||
|-------|--------|---------------------|
|
||||
| `logFiles` | List available log files | **YES** - `list_available_log_files()` |
|
||||
| `logFile(path, lines, startLine)` | Specific log file content with pagination | **YES** - `get_logs()` |
|
||||
|
||||
### A.10 Settings Queries
|
||||
|
||||
| Query | Fields | Current MCP Coverage |
|
||||
|-------|--------|---------------------|
|
||||
| `settings` | `unified { values }`, SSO config | **NO** |
|
||||
|
||||
### A.11 API Key Queries
|
||||
|
||||
| Query | Fields | Current MCP Coverage |
|
||||
|-------|--------|---------------------|
|
||||
| `apiKeys` | `[ApiKey!]!` - List all API keys with `id`, `name`, `description`, `roles[]`, `createdAt`, `permissions[]` | **NO** |
|
||||
| `apiKey(id)` | Single API key by ID | **NO** |
|
||||
|
||||
### A.12 UPS Queries
|
||||
|
||||
| Query | Fields | Current MCP Coverage |
|
||||
|-------|--------|---------------------|
|
||||
| `upsDevices` | List UPS devices with status | **NO** |
|
||||
| `upsDeviceById(id)` | Specific UPS device | **NO** |
|
||||
| `upsConfiguration` | UPS configuration settings | **NO** |
|
||||
|
||||
### A.13 Metrics Queries
|
||||
|
||||
| Query | Fields | Current MCP Coverage |
|
||||
|-------|--------|---------------------|
|
||||
| `metrics` | System performance metrics (CPU, memory utilization) | **NO** |
|
||||
|
||||
---
|
||||
|
||||
## B. All GraphQL Mutations Available
|
||||
|
||||
Every mutation identified across all research documents with their parameters and return types.
|
||||
|
||||
### B.1 Array Management Mutations
|
||||
|
||||
| Mutation | Parameters | Returns | Current MCP Coverage |
|
||||
|----------|------------|---------|---------------------|
|
||||
| `startArray` | none | `Array` | **NO** |
|
||||
| `stopArray` | none | `Array` | **NO** |
|
||||
| `addDiskToArray(input)` | `arrayDiskInput` | `Array` | **NO** |
|
||||
| `removeDiskFromArray(input)` | `arrayDiskInput` | `Array` | **NO** |
|
||||
| `mountArrayDisk(id)` | `ID!` | `Disk` | **NO** |
|
||||
| `unmountArrayDisk(id)` | `ID!` | `Disk` | **NO** |
|
||||
| `clearArrayDiskStatistics(id)` | `ID!` | `JSON` | **NO** |
|
||||
|
||||
### B.2 Parity Check Mutations
|
||||
|
||||
| Mutation | Parameters | Returns | Current MCP Coverage |
|
||||
|----------|------------|---------|---------------------|
|
||||
| `startParityCheck(correct)` | `correct: Boolean` | `JSON` | **NO** |
|
||||
| `pauseParityCheck` | none | `JSON` | **NO** |
|
||||
| `resumeParityCheck` | none | `JSON` | **NO** |
|
||||
| `cancelParityCheck` | none | `JSON` | **NO** |
|
||||
|
||||
### B.3 Docker Container Mutations
|
||||
|
||||
| Mutation | Parameters | Returns | Current MCP Coverage |
|
||||
|----------|------------|---------|---------------------|
|
||||
| `docker.start(id)` | `PrefixedID!` | `DockerContainer` | **YES** - `manage_docker_container(action="start")` |
|
||||
| `docker.stop(id)` | `PrefixedID!` | `DockerContainer` | **YES** - `manage_docker_container(action="stop")` |
|
||||
| `docker.pause(id)` | `PrefixedID!` | `DockerContainer` | **NO** |
|
||||
| `docker.unpause(id)` | `PrefixedID!` | `DockerContainer` | **NO** |
|
||||
| `docker.removeContainer(id, withImage?)` | `PrefixedID!`, `Boolean` | `DockerContainer` | **NO** |
|
||||
| `docker.updateContainer(id)` | `PrefixedID!` | `DockerContainer` | **NO** |
|
||||
| `docker.updateContainers(ids)` | `[PrefixedID!]!` | `[DockerContainer]` | **NO** |
|
||||
| `docker.updateAllContainers` | none | `[DockerContainer]` | **NO** |
|
||||
| `docker.updateAutostartConfiguration` | auto-start config | varies | **NO** |
|
||||
|
||||
### B.4 Docker Organizer Mutations (Feature-Flagged)
|
||||
|
||||
| Mutation | Parameters | Returns | Current MCP Coverage |
|
||||
|----------|------------|---------|---------------------|
|
||||
| `docker.createDockerFolder` | folder config | varies | **NO** |
|
||||
| `docker.setDockerFolderChildren` | folder ID, children | varies | **NO** |
|
||||
| `docker.deleteDockerEntries` | entry IDs | varies | **NO** |
|
||||
| `docker.moveDockerEntriesToFolder` | entries, folder | varies | **NO** |
|
||||
| `docker.moveDockerItemsToPosition` | items, position | varies | **NO** |
|
||||
| `docker.renameDockerFolder` | folder ID, name | varies | **NO** |
|
||||
| `docker.createDockerFolderWithItems` | folder config, items | varies | **NO** |
|
||||
|
||||
### B.5 Docker Template Mutations
|
||||
|
||||
| Mutation | Parameters | Returns | Current MCP Coverage |
|
||||
|----------|------------|---------|---------------------|
|
||||
| `docker.syncDockerTemplatePaths` | none | varies | **NO** |
|
||||
| `docker.resetDockerTemplateMappings` | none | varies | **NO** |
|
||||
|
||||
### B.6 VM Management Mutations
|
||||
|
||||
| Mutation | Parameters | Returns | Current MCP Coverage |
|
||||
|----------|------------|---------|---------------------|
|
||||
| `vm.start(id)` | `PrefixedID!` | `Boolean` | **YES** - `manage_vm(action="start")` |
|
||||
| `vm.stop(id)` | `PrefixedID!` | `Boolean` | **YES** - `manage_vm(action="stop")` |
|
||||
| `vm.pause(id)` | `PrefixedID!` | `Boolean` | **YES** - `manage_vm(action="pause")` |
|
||||
| `vm.resume(id)` | `PrefixedID!` | `Boolean` | **YES** - `manage_vm(action="resume")` |
|
||||
| `vm.forceStop(id)` | `PrefixedID!` | `Boolean` | **YES** - `manage_vm(action="forceStop")` |
|
||||
| `vm.reboot(id)` | `PrefixedID!` | `Boolean` | **YES** - `manage_vm(action="reboot")` |
|
||||
| `vm.reset(id)` | `PrefixedID!` | `Boolean` | **YES** - `manage_vm(action="reset")` |
|
||||
|
||||
### B.7 Notification Mutations
|
||||
|
||||
| Mutation | Parameters | Returns | Current MCP Coverage |
|
||||
|----------|------------|---------|---------------------|
|
||||
| `createNotification(input)` | `NotificationData!` | `Notification!` | **NO** |
|
||||
| `deleteNotification(id, type)` | `String!`, `NotificationType!` | `NotificationOverview!` | **NO** |
|
||||
| `deleteArchivedNotifications` | none | `NotificationOverview!` | **NO** |
|
||||
| `archiveNotification(id)` | `String!` | `Notification!` | **NO** |
|
||||
| `unreadNotification(id)` | `String!` | `Notification!` | **NO** |
|
||||
| `archiveNotifications(ids)` | `[String!]` | `NotificationOverview!` | **NO** |
|
||||
| `unarchiveNotifications(ids)` | `[String!]` | `NotificationOverview!` | **NO** |
|
||||
| `archiveAll(importance?)` | `Importance` (optional) | `NotificationOverview!` | **NO** |
|
||||
| `unarchiveAll(importance?)` | `Importance` (optional) | `NotificationOverview!` | **NO** |
|
||||
| `recalculateOverview` | none | `NotificationOverview!` | **NO** |
|
||||
| `notifyIfUnique(input)` | `NotificationData!` | `Notification!` | **NO** |
|
||||
|
||||
### B.8 RClone Mutations
|
||||
|
||||
| Mutation | Parameters | Returns | Current MCP Coverage |
|
||||
|----------|------------|---------|---------------------|
|
||||
| `createRCloneRemote(input)` | name, type, config | `RCloneRemote` | **YES** - `create_rclone_remote()` |
|
||||
| `deleteRCloneRemote(input)` | name | `Boolean` | **YES** - `delete_rclone_remote()` |
|
||||
|
||||
### B.9 Server Power Mutations
|
||||
|
||||
| Mutation | Parameters | Returns | Current MCP Coverage |
|
||||
|----------|------------|---------|---------------------|
|
||||
| `shutdown` | none | `String` | **NO** |
|
||||
| `reboot` | none | `String` | **NO** |
|
||||
|
||||
### B.10 Authentication & User Mutations
|
||||
|
||||
| Mutation | Parameters | Returns | Current MCP Coverage |
|
||||
|----------|------------|---------|---------------------|
|
||||
| `login(username, password)` | `String!`, `String!` | `String` | **NO** |
|
||||
| `createApiKey(input)` | `CreateApiKeyInput!` | `ApiKeyWithSecret!` | **NO** |
|
||||
| `addPermission(input)` | `AddPermissionInput!` | `Boolean!` | **NO** |
|
||||
| `addRoleForUser(input)` | `AddRoleForUserInput!` | `Boolean!` | **NO** |
|
||||
| `addRoleForApiKey(input)` | `AddRoleForApiKeyInput!` | `Boolean!` | **NO** |
|
||||
| `removeRoleFromApiKey(input)` | `RemoveRoleFromApiKeyInput!` | `Boolean!` | **NO** |
|
||||
| `deleteApiKeys(input)` | API key IDs | `Boolean` | **NO** |
|
||||
| `updateApiKey(input)` | API key update data | `Boolean` | **NO** |
|
||||
| `addUser(input)` | `addUserInput!` | `User` | **NO** |
|
||||
| `deleteUser(input)` | `deleteUserInput!` | `User` | **NO** |
|
||||
|
||||
### B.11 Connect/Remote Access Mutations
|
||||
|
||||
| Mutation | Parameters | Returns | Current MCP Coverage |
|
||||
|----------|------------|---------|---------------------|
|
||||
| `connectSignIn(input)` | `ConnectSignInInput!` | `Boolean!` | **NO** |
|
||||
| `connectSignOut` | none | `Boolean!` | **NO** |
|
||||
| `enableDynamicRemoteAccess(input)` | `EnableDynamicRemoteAccessInput!` | `Boolean!` | **NO** |
|
||||
| `setAdditionalAllowedOrigins(input)` | `AllowedOriginInput!` | `[String!]!` | **NO** |
|
||||
| `setupRemoteAccess(input)` | `SetupRemoteAccessInput!` | `Boolean!` | **NO** |
|
||||
|
||||
### B.12 UPS Mutations
|
||||
|
||||
| Mutation | Parameters | Returns | Current MCP Coverage |
|
||||
|----------|------------|---------|---------------------|
|
||||
| `configureUps(config)` | UPS configuration | varies | **NO** |
|
||||
|
||||
---
|
||||
|
||||
## C. All GraphQL Subscriptions Available
|
||||
|
||||
Every subscription channel identified with update intervals and event triggers.
|
||||
|
||||
### C.1 PubSub Channel Definitions (from source code)
|
||||
|
||||
```
|
||||
GRAPHQL_PUBSUB_CHANNEL {
|
||||
ARRAY // Array state changes
|
||||
CPU_UTILIZATION // 1-second CPU utilization data
|
||||
CPU_TELEMETRY // 5-second CPU power & temperature
|
||||
DASHBOARD // Dashboard aggregate updates
|
||||
DISPLAY // Display settings changes
|
||||
INFO // System information changes
|
||||
MEMORY_UTILIZATION // 2-second memory utilization
|
||||
NOTIFICATION // Notification state changes
|
||||
NOTIFICATION_ADDED // New notification created
|
||||
NOTIFICATION_OVERVIEW // Notification count updates
|
||||
NOTIFICATION_WARNINGS_AND_ALERTS // Warning/alert changes
|
||||
OWNER // Owner information changes
|
||||
SERVERS // Server list changes
|
||||
VMS // VM state changes
|
||||
DOCKER_STATS // Container performance stats
|
||||
LOG_FILE // Real-time log file updates (dynamic path)
|
||||
PARITY // Parity check progress
|
||||
}
|
||||
```
|
||||
|
||||
### C.2 GraphQL Subscription Types (from schema)
|
||||
|
||||
| Subscription | Channel | Interval | Description | Current MCP Coverage |
|
||||
|-------------|---------|----------|-------------|---------------------|
|
||||
| `array` | ARRAY | Event-based | Real-time array state changes | **NO** (diag only) |
|
||||
| `parityHistory` | PARITY | Event-based | Parity check progress updates | **NO** |
|
||||
| `ping` | - | - | Connection keepalive | **NO** |
|
||||
| `info` | INFO | Event-based | System info changes | **NO** (diag only) |
|
||||
| `online` | - | Event-based | Online status changes | **NO** |
|
||||
| `config` | - | Event-based | Configuration changes | **NO** |
|
||||
| `display` | DISPLAY | Event-based | Display settings changes | **NO** |
|
||||
| `dockerContainer(id)` | DOCKER_STATS | Polling | Single container stats (CPU%, mem, net I/O, block I/O) | **NO** |
|
||||
| `dockerContainers` | DOCKER_STATS | Polling | All container state changes | **NO** |
|
||||
| `dockerNetwork(id)` | - | Event-based | Single network changes | **NO** |
|
||||
| `dockerNetworks` | - | Event-based | All network changes | **NO** |
|
||||
| `flash` | - | Event-based | Flash drive changes | **NO** |
|
||||
| `notificationAdded` | NOTIFICATION_ADDED | Event-based | New notification created | **NO** |
|
||||
| `notificationsOverview` | NOTIFICATION_OVERVIEW | Event-based | Notification count updates | **NO** |
|
||||
| `notificationsWarningsAndAlerts` | NOTIFICATION_WARNINGS_AND_ALERTS | Event-based | Warning/alert changes | **NO** |
|
||||
| `owner` | OWNER | Event-based | Owner info changes | **NO** |
|
||||
| `registration` | - | Event-based | Registration changes | **NO** |
|
||||
| `server` | - | Event-based | Server status changes | **NO** |
|
||||
| `service(name)` | - | Event-based | Specific service changes | **NO** |
|
||||
| `share(id)` | - | Event-based | Single share changes | **NO** |
|
||||
| `shares` | - | Event-based | All shares changes | **NO** |
|
||||
| `unassignedDevices` | - | Event-based | Unassigned device changes | **NO** |
|
||||
| `me` | - | Event-based | Current user changes | **NO** |
|
||||
| `user(id)` | - | Event-based | Specific user changes | **NO** |
|
||||
| `users` | - | Event-based | User list changes | **NO** |
|
||||
| `vars` | - | Event-based | Server variable changes | **NO** |
|
||||
| `vms` | VMS | Event-based | VM state changes | **NO** |
|
||||
| `systemMetricsCpu` | CPU_UTILIZATION | 1 second | Real-time CPU utilization | **NO** |
|
||||
| `systemMetricsCpuTelemetry` | CPU_TELEMETRY | 5 seconds | CPU power & temperature | **NO** |
|
||||
| `systemMetricsMemory` | MEMORY_UTILIZATION | 2 seconds | Memory utilization | **NO** |
|
||||
| `logFileSubscription(path)` | LOG_FILE (dynamic) | Event-based | Real-time log tailing | **NO** |
|
||||
| `upsUpdates` | - | Event-based | UPS status changes | **NO** |
|
||||
|
||||
**Note:** The current MCP server has `test_subscription_query()` and `diagnose_subscriptions()` as diagnostic tools but does NOT expose any production subscription-based tools that stream real-time data.
|
||||
|
||||
---
|
||||
|
||||
## D. All Custom Scalars and Types
|
||||
|
||||
### D.1 Custom Scalar Types
|
||||
|
||||
| Scalar | Description | Serialization | Usage |
|
||||
|--------|-------------|---------------|-------|
|
||||
| `PrefixedID` | Server-prefixed identifiers | String (format: `TypePrefix:uuid`) | Container IDs, VM IDs, disk IDs, share IDs |
|
||||
| `Long` | 52-bit integers (exceeds GraphQL Int 32-bit limit) | String in JSON | Disk sizes, memory values, operation counters |
|
||||
| `BigInt` | Large integer values | String in JSON | Same as Long (used in newer schema versions) |
|
||||
| `DateTime` | ISO 8601 date-time string (RFC 3339) | String | Timestamps, uptime, creation dates |
|
||||
| `JSON` | Arbitrary JSON data structures | Object | Labels, network settings, mounts, host config |
|
||||
| `Port` | Valid TCP port number (0-65535) | Integer | Network port references |
|
||||
| `URL` | Standard URL format | String | Web UI URLs, registry URLs, support URLs |
|
||||
| `UUID` | Universally Unique Identifier | String | VM domain UUIDs |
|
||||
|
||||
### D.2 Core Interface Types
|
||||
|
||||
| Interface | Fields | Implementors |
|
||||
|-----------|--------|-------------|
|
||||
| `Node` | `id: ID!` | `Array`, `Info`, `Network`, `Notifications`, `Connect`, `ArrayDisk`, `DockerContainer`, `VmDomain`, `Share` |
|
||||
| `UserAccount` | `id`, `name`, `description`, `roles`, `permissions` | `Me`, `User` |
|
||||
|
||||
### D.3 Key Object Types
|
||||
|
||||
| Type | Key Fields | Notes |
|
||||
|------|-----------|-------|
|
||||
| `Array` | `state`, `previousState`, `pendingState`, `capacity`, `boot`, `parities[]`, `disks[]`, `caches[]`, `parityCheckStatus` | Implements Node |
|
||||
| `ArrayDisk` | `id`, `idx`, `name`, `device`, `size`, `fsSize`, `fsFree`, `fsUsed`, `status`, `rotational`, `temp`, `numReads`, `numWrites`, `numErrors`, `type`, `exportable`, `warning`, `critical`, `fsType`, `comment`, `format`, `transport`, `color`, `isSpinning` | Implements Node |
|
||||
| `ArrayCapacity` | `kilobytes { free, used, total }`, `disks { free, used, total }` | |
|
||||
| `Capacity` | `free`, `used`, `total` | All String type |
|
||||
| `ParityCheck` | Parity check status/progress data | |
|
||||
| `DockerContainer` | 25+ fields (see A.4) | Implements Node |
|
||||
| `Docker` | `id`, `containers[]`, `networks[]` | Implements Node |
|
||||
| `DockerNetwork` | `name`, `id`, `created`, `scope`, `driver`, `enableIPv6`, `ipam`, etc. | |
|
||||
| `ContainerPort` | `ip`, `privatePort`, `publicPort`, `type` | |
|
||||
| `ContainerHostConfig` | JSON host configuration | |
|
||||
| `VmDomain` | `uuid/id`, `name`, `state` | Implements Node |
|
||||
| `Vms` | `id`, `domain[]` | |
|
||||
| `Info` | `time`, `baseboard`, `cpu`, `devices`, `display`, `machineId`, `memory`, `os`, `system`, `versions`, `apps` | Implements Node |
|
||||
| `InfoCpu` | `manufacturer`, `brand`, `vendor`, `family`, `model`, `stepping`, `revision`, `voltage`, `speed`, `speedmin`, `speedmax`, `threads`, `cores`, `processors`, `socket`, `cache`, `flags` | |
|
||||
| `InfoMemory` | `max`, `total`, `free`, `used`, `active`, `available`, `buffcache`, `swaptotal`, `swapused`, `swapfree`, `layout[]` | |
|
||||
| `MemoryLayout` | `bank`, `type`, `clockSpeed`, `manufacturer` | Missing `size` field (known bug) |
|
||||
| `Os` | `platform`, `distro`, `release`, `codename`, `kernel`, `arch`, `hostname`, `codepage`, `logofile`, `serial`, `build`, `uptime` | |
|
||||
| `Baseboard` | `manufacturer`, `model`, `version`, `serial` | |
|
||||
| `SystemInfo` | `manufacturer`, `model`, `version`, `serial`, `uuid` | |
|
||||
| `Versions` | `kernel`, `docker`, `unraid`, `node` | |
|
||||
| `InfoApps` | `installed`, `started` | |
|
||||
| `Network` | `iface`, `ifaceName`, `ipv4`, `ipv6`, `mac`, `internal`, `operstate`, `type`, `duplex`, `mtu`, `speed`, `carrierChanges`, `id`, `accessUrls[]` | Implements Node |
|
||||
| `AccessUrl` | `type`, `name`, `ipv4`, `ipv6` | |
|
||||
| `Share` | `name`, `free`, `used`, `size`, `include[]`, `exclude[]`, `cache`, `nameOrig`, `comment`, `allocator`, `splitLevel`, `floor`, `cow`, `color`, `luksStatus` | |
|
||||
| `Disk` (physical) | `device`, `type`, `name`, `vendor`, `size`, `bytesPerSector`, `totalCylinders`, `totalHeads`, `totalSectors`, `totalTracks`, `tracksPerCylinder`, `sectorsPerTrack`, `firmwareRevision`, `serialNum`, `interfaceType`, `smartStatus`, `temperature`, `partitions[]` | |
|
||||
| `DiskPartition` | Partition details | |
|
||||
| `Notification` | `id`, `title`, `subject`, `description`, `importance`, `link`, `type`, `timestamp`, `formattedTimestamp` | Implements Node |
|
||||
| `NotificationOverview` | `unread { info, warning, alert, total }`, `archive { info, warning, alert, total }` | |
|
||||
| `NotificationCounts` | `info`, `warning`, `alert`, `total` | |
|
||||
| `Registration` | `id`, `type`, `state`, `expiration`, `updateExpiration`, `keyFile { location, contents }` | |
|
||||
| `Connect` | `id`, `dynamicRemoteAccess { ... }` | Implements Node |
|
||||
| `RemoteAccess` | `accessType`, `forwardType`, `port` | |
|
||||
| `Cloud` | `error`, `apiKey`, `relay`, `minigraphql`, `cloud`, `allowedOrigins` | |
|
||||
| `Flash` | Flash drive information | |
|
||||
| `UnassignedDevice` | Unassigned device details | |
|
||||
| `Service` | Service name and status | |
|
||||
| `Server` | Server details (Connect-managed) | |
|
||||
| `ApiKey` | `id`, `name`, `description`, `roles[]`, `createdAt`, `permissions[]` | |
|
||||
| `ApiKeyWithSecret` | `id`, `key`, `name`, `description`, `roles[]`, `createdAt`, `permissions[]` | |
|
||||
| `Permission` | `resource`, `actions[]` | |
|
||||
| `Config` | System configuration | |
|
||||
| `Display` | Display settings | |
|
||||
| `Owner` | Server owner info | |
|
||||
| `Me` | Current user info | Implements UserAccount |
|
||||
| `User` | User account info | Implements UserAccount |
|
||||
| `Vars` | Server variables (40+ fields) | Implements Node |
|
||||
|
||||
### D.4 Input Types
|
||||
|
||||
| Input Type | Used By | Fields |
|
||||
|-----------|---------|--------|
|
||||
| `CreateApiKeyInput` | `createApiKey` | `name!`, `description`, `roles[]`, `permissions[]`, `overwrite` |
|
||||
| `AddPermissionInput` | `addPermission` | `resource!`, `actions![]` |
|
||||
| `AddRoleForUserInput` | `addRoleForUser` | User + role assignment |
|
||||
| `AddRoleForApiKeyInput` | `addRoleForApiKey` | API key + role assignment |
|
||||
| `RemoveRoleFromApiKeyInput` | `removeRoleFromApiKey` | API key + role removal |
|
||||
| `arrayDiskInput` | `addDiskToArray`, `removeDiskFromArray` | Disk assignment data |
|
||||
| `ConnectSignInInput` | `connectSignIn` | Connect credentials |
|
||||
| `EnableDynamicRemoteAccessInput` | `enableDynamicRemoteAccess` | Remote access config |
|
||||
| `AllowedOriginInput` | `setAdditionalAllowedOrigins` | Origin URLs |
|
||||
| `SetupRemoteAccessInput` | `setupRemoteAccess` | Remote access setup |
|
||||
| `NotificationData` | `createNotification`, `notifyIfUnique` | title, subject, description, importance |
|
||||
| `NotificationFilter` | `notifications.list` | Filter criteria |
|
||||
| `addUserInput` | `addUser` | User creation data |
|
||||
| `deleteUserInput` | `deleteUser` | User deletion target |
|
||||
| `usersInput` | `users` | User listing filter |
|
||||
|
||||
---
|
||||
|
||||
## E. All Enums
|
||||
|
||||
### E.1 Array & Disk Enums
|
||||
|
||||
| Enum | Values |
|
||||
|------|--------|
|
||||
| **ArrayState** | `STARTED`, `STOPPED`, `NEW_ARRAY`, `RECON_DISK`, `DISABLE_DISK`, `SWAP_DSBL`, `INVALID_EXPANSION`, `PARITY_NOT_BIGGEST`, `TOO_MANY_MISSING_DISKS`, `NEW_DISK_TOO_SMALL`, `NO_DATA_DISKS` |
|
||||
| **ArrayPendingState** | Pending state transitions (exact values not documented) |
|
||||
| **ArrayDiskStatus** | `DISK_NP`, `DISK_OK`, `DISK_NP_MISSING`, `DISK_INVALID`, `DISK_WRONG`, `DISK_DSBL`, `DISK_NP_DSBL`, `DISK_DSBL_NEW`, `DISK_NEW` |
|
||||
| **ArrayDiskType** | `Data`, `Parity`, `Flash`, `Cache` |
|
||||
| **ArrayDiskFsColor** | `GREEN_ON`, `GREEN_BLINK`, `BLUE_ON`, `BLUE_BLINK`, `YELLOW_ON`, `YELLOW_BLINK`, `RED_ON`, `RED_OFF`, `GREY_OFF` |
|
||||
| **DiskInterfaceType** | `SAS`, `SATA`, `USB`, `PCIe`, `UNKNOWN` |
|
||||
| **DiskFsType** | `xfs`, `btrfs`, `vfat`, `zfs` |
|
||||
| **DiskSmartStatus** | SMART health assessment values |
|
||||
|
||||
### E.2 Docker Enums
|
||||
|
||||
| Enum | Values |
|
||||
|------|--------|
|
||||
| **ContainerState** | `RUNNING`, `PAUSED`, `EXITED` |
|
||||
| **ContainerPortType** | `TCP`, `UDP` |
|
||||
| **UpdateStatus** | `UP_TO_DATE`, `UPDATE_AVAILABLE`, `REBUILD_READY`, `UNKNOWN` |
|
||||
|
||||
### E.3 VM Enums
|
||||
|
||||
| Enum | Values |
|
||||
|------|--------|
|
||||
| **VmState** | `NOSTATE`, `RUNNING`, `IDLE`, `PAUSED`, `SHUTDOWN`, `SHUTOFF`, `CRASHED`, `PMSUSPENDED` |
|
||||
|
||||
### E.4 Notification Enums
|
||||
|
||||
| Enum | Values |
|
||||
|------|--------|
|
||||
| **Importance** | `ALERT`, `INFO`, `WARNING` |
|
||||
| **NotificationType** | `UNREAD`, `ARCHIVE` |
|
||||
|
||||
### E.5 Auth & Permission Enums
|
||||
|
||||
| Enum | Values |
|
||||
|------|--------|
|
||||
| **Role** | `ADMIN`, `CONNECT`, `GUEST`, `VIEWER` |
|
||||
| **AuthAction** | `CREATE_ANY`, `CREATE_OWN`, `READ_ANY`, `READ_OWN`, `UPDATE_ANY`, `UPDATE_OWN`, `DELETE_ANY`, `DELETE_OWN` |
|
||||
| **Resource** (35 total) | `ACTIVATION_CODE`, `API_KEY`, `ARRAY`, `CLOUD`, `CONFIG`, `CONNECT`, `CONNECT__REMOTE_ACCESS`, `CUSTOMIZATIONS`, `DASHBOARD`, `DISK`, `DISPLAY`, `DOCKER`, `FLASH`, `INFO`, `LOGS`, `ME`, `NETWORK`, `NOTIFICATIONS`, `ONLINE`, `OS`, `OWNER`, `PERMISSION`, `REGISTRATION`, `SERVERS`, `SERVICES`, `SHARE`, `USER`, `VARS`, `VMS`, `WELCOME` |
|
||||
|
||||
### E.6 Registration Enums
|
||||
|
||||
| Enum | Values |
|
||||
|------|--------|
|
||||
| **RegistrationState** | `TRIAL`, `BASIC`, `PLUS`, `PRO`, `STARTER`, `UNLEASHED`, `LIFETIME`, `EEXPIRED`, `EGUID`, `EGUID1`, `ETRIAL`, `ENOKEYFILE`, `ENOFLASH`, `EBLACKLISTED`, `ENOCONN` |
|
||||
|
||||
### E.7 Configuration Enums
|
||||
|
||||
| Enum | Values |
|
||||
|------|--------|
|
||||
| **ConfigErrorState** | Configuration error state values |
|
||||
| **WAN_ACCESS_TYPE** | `DYNAMIC`, `ALWAYS`, `DISABLED` |
|
||||
| **WAN_FORWARD_TYPE** | WAN forwarding type values |
|
||||
|
||||
---
|
||||
|
||||
## F. API Capabilities NOT Currently in the MCP Server
|
||||
|
||||
The current MCP server has 26 tools. The following capabilities are available in the Unraid API but NOT covered by any existing tool.
|
||||
|
||||
### F.1 HIGH PRIORITY - New Tool Candidates
|
||||
|
||||
#### Array Management (0 tools currently, 7 mutations available)
|
||||
|
||||
| Proposed Tool | API Operation | Why Important |
|
||||
|--------------|---------------|---------------|
|
||||
| `start_array()` | `startArray` mutation | Core server management |
|
||||
| `stop_array()` | `stopArray` mutation | Core server management |
|
||||
| `start_parity_check(correct)` | `startParityCheck` mutation | Data integrity management |
|
||||
| `pause_parity_check()` | `pauseParityCheck` mutation | Parity management |
|
||||
| `resume_parity_check()` | `resumeParityCheck` mutation | Parity management |
|
||||
| `cancel_parity_check()` | `cancelParityCheck` mutation | Parity management |
|
||||
| `get_parity_history()` | `parityHistory` query | Historical parity check results |
|
||||
|
||||
#### Server Power Management (0 tools currently, 2 mutations available)
|
||||
|
||||
| Proposed Tool | API Operation | Why Important |
|
||||
|--------------|---------------|---------------|
|
||||
| `shutdown_server()` | `shutdown` mutation | Remote server management |
|
||||
| `reboot_server()` | `reboot` mutation | Remote server management |
|
||||
|
||||
#### Notification Management (read-only currently, 10+ mutations available)
|
||||
|
||||
| Proposed Tool | API Operation | Why Important |
|
||||
|--------------|---------------|---------------|
|
||||
| `create_notification(input)` | `createNotification` mutation | Proactive alerting from MCP |
|
||||
| `archive_notification(id)` | `archiveNotification` mutation | Notification lifecycle |
|
||||
| `archive_all_notifications(importance?)` | `archiveAll` mutation | Bulk management |
|
||||
| `delete_notification(id, type)` | `deleteNotification` mutation | Cleanup |
|
||||
| `delete_archived_notifications()` | `deleteArchivedNotifications` mutation | Bulk cleanup |
|
||||
| `unread_notification(id)` | `unreadNotification` mutation | Mark as unread |
|
||||
| `get_warnings_and_alerts()` | `notifications.warningsAndAlerts` query | Focused severity view |
|
||||
|
||||
#### Docker Extended Operations (3 tools currently, 10+ mutations available)
|
||||
|
||||
| Proposed Tool | API Operation | Why Important |
|
||||
|--------------|---------------|---------------|
|
||||
| `pause_docker_container(id)` | `docker.pause` mutation | Container lifecycle |
|
||||
| `unpause_docker_container(id)` | `docker.unpause` mutation | Container lifecycle |
|
||||
| `remove_docker_container(id, with_image?)` | `docker.removeContainer` mutation | Container cleanup |
|
||||
| `update_docker_container(id)` | `docker.updateContainer` mutation | Keep containers current |
|
||||
| `update_all_docker_containers()` | `docker.updateAllContainers` mutation | Bulk updates |
|
||||
| `check_docker_updates()` | `containerUpdateStatuses` query | Pre-update assessment |
|
||||
| `get_docker_container_logs(id, since?, tail?)` | `docker.logs` query | Debugging/monitoring |
|
||||
| `list_docker_networks(all?)` | `dockerNetworks` query | Network inspection |
|
||||
| `get_docker_network(id)` | `dockerNetwork` query | Network details |
|
||||
| `check_docker_port_conflicts()` | `docker.portConflicts` query | Conflict detection |
|
||||
|
||||
#### Disk Operations (2 tools currently, 3 mutations available)
|
||||
|
||||
| Proposed Tool | API Operation | Why Important |
|
||||
|--------------|---------------|---------------|
|
||||
| `mount_array_disk(id)` | `mountArrayDisk` mutation | Disk management |
|
||||
| `unmount_array_disk(id)` | `unmountArrayDisk` mutation | Disk management |
|
||||
| `clear_disk_statistics(id)` | `clearArrayDiskStatistics` mutation | Statistics reset |
|
||||
| `add_disk_to_array(input)` | `addDiskToArray` mutation | Array expansion |
|
||||
| `remove_disk_from_array(input)` | `removeDiskFromArray` mutation | Array modification |
|
||||
|
||||
### F.2 MEDIUM PRIORITY - New Tool Candidates
|
||||
|
||||
#### UPS Monitoring (0 tools currently, 3 queries + 1 mutation + 1 subscription)
|
||||
|
||||
| Proposed Tool | API Operation | Why Important |
|
||||
|--------------|---------------|---------------|
|
||||
| `list_ups_devices()` | `upsDevices` query | UPS monitoring |
|
||||
| `get_ups_device(id)` | `upsDeviceById` query | UPS details |
|
||||
| `get_ups_configuration()` | `upsConfiguration` query | UPS config |
|
||||
| `configure_ups(config)` | `configureUps` mutation | UPS management |
|
||||
|
||||
#### System Metrics (0 tools currently, 1 query + 3 subscriptions)
|
||||
|
||||
| Proposed Tool | API Operation | Why Important |
|
||||
|--------------|---------------|---------------|
|
||||
| `get_system_metrics()` | `metrics` query | Performance monitoring |
|
||||
| `get_cpu_utilization()` | `systemMetricsCpu` subscription (polled) | Real-time CPU |
|
||||
| `get_memory_utilization()` | `systemMetricsMemory` subscription (polled) | Real-time memory |
|
||||
| `get_cpu_telemetry()` | `systemMetricsCpuTelemetry` subscription (polled) | CPU temp/power |
|
||||
|
||||
#### Unassigned Devices (0 tools currently, 1 query + 1 subscription)
|
||||
|
||||
| Proposed Tool | API Operation | Why Important |
|
||||
|--------------|---------------|---------------|
|
||||
| `list_unassigned_devices()` | `unassignedDevices` query | Device management |
|
||||
|
||||
#### Flash Drive (0 tools currently, 1 query + 1 subscription)
|
||||
|
||||
| Proposed Tool | API Operation | Why Important |
|
||||
|--------------|---------------|---------------|
|
||||
| `get_flash_info()` | `flash` query | Flash drive status |
|
||||
|
||||
#### User Management (0 tools currently, 3 queries + 2 mutations)
|
||||
|
||||
| Proposed Tool | API Operation | Why Important |
|
||||
|--------------|---------------|---------------|
|
||||
| `get_current_user()` | `me` query | Identity context |
|
||||
| `list_users()` | `users` query | User management |
|
||||
| `get_user(id)` | `user(id)` query | User details |
|
||||
| `add_user(input)` | `addUser` mutation | User creation |
|
||||
| `delete_user(input)` | `deleteUser` mutation | User removal |
|
||||
|
||||
#### Services (0 tools currently, 1 query + 1 subscription)
|
||||
|
||||
| Proposed Tool | API Operation | Why Important |
|
||||
|--------------|---------------|---------------|
|
||||
| `list_services()` | `services` query | Service monitoring |
|
||||
|
||||
#### Settings (0 tools currently, 1 query)
|
||||
|
||||
| Proposed Tool | API Operation | Why Important |
|
||||
|--------------|---------------|---------------|
|
||||
| `get_settings()` | `settings` query | Configuration inspection |
|
||||
|
||||
### F.3 LOW PRIORITY - New Tool Candidates
|
||||
|
||||
#### API Key Management (0 tools currently, 2 queries + 5 mutations)
|
||||
|
||||
| Proposed Tool | API Operation | Why Important |
|
||||
|--------------|---------------|---------------|
|
||||
| `list_api_keys()` | `apiKeys` query | Key inventory |
|
||||
| `get_api_key(id)` | `apiKey(id)` query | Key details |
|
||||
| `create_api_key(input)` | `createApiKey` mutation | Key provisioning |
|
||||
| `delete_api_keys(input)` | `deleteApiKeys` mutation | Key cleanup |
|
||||
| `update_api_key(input)` | `updateApiKey` mutation | Key modification |
|
||||
|
||||
#### Remote Access Management (0 tools currently, 1 query + 3 mutations)
|
||||
|
||||
| Proposed Tool | API Operation | Why Important |
|
||||
|--------------|---------------|---------------|
|
||||
| `get_remote_access()` | `remoteAccess` query | Remote access status |
|
||||
| `setup_remote_access(input)` | `setupRemoteAccess` mutation | Remote access config |
|
||||
| `enable_dynamic_remote_access(input)` | `enableDynamicRemoteAccess` mutation | Toggle remote access |
|
||||
| `set_allowed_origins(input)` | `setAdditionalAllowedOrigins` mutation | CORS config |
|
||||
|
||||
#### Cloud/Connect Management (0 tools currently, 1 query + 2 mutations)
|
||||
|
||||
| Proposed Tool | API Operation | Why Important |
|
||||
|--------------|---------------|---------------|
|
||||
| `get_cloud_status()` | `cloud` query | Cloud connectivity |
|
||||
| `connect_sign_in(input)` | `connectSignIn` mutation | Connect auth |
|
||||
| `connect_sign_out()` | `connectSignOut` mutation | Connect deauth |
|
||||
|
||||
#### Server Management (0 tools currently, 2 queries)
|
||||
|
||||
| Proposed Tool | API Operation | Why Important |
|
||||
|--------------|---------------|---------------|
|
||||
| `get_server_info()` | `server` query | Server details |
|
||||
| `list_servers()` | `servers` query | Multi-server view |
|
||||
| `get_online_status()` | `online` query | Connectivity check |
|
||||
| `get_owner_info()` | `owner` query | Server owner |
|
||||
|
||||
#### Display & Config (0 tools currently, 2 queries)
|
||||
|
||||
| Proposed Tool | API Operation | Why Important |
|
||||
|--------------|---------------|---------------|
|
||||
| `get_display_settings()` | `display` query | Display config |
|
||||
| `get_config()` | `config` query | System config |
|
||||
|
||||
### F.4 Summary: Coverage Statistics
|
||||
|
||||
| Category | Available in API | Covered by MCP | Gap |
|
||||
|----------|-----------------|----------------|-----|
|
||||
| **Queries** | ~30+ | 14 | ~16+ uncovered |
|
||||
| **Mutations** | ~50+ | 10 (start/stop Docker+VM, RClone CRUD) | ~40+ uncovered |
|
||||
| **Subscriptions** | ~30+ | 0 (2 diagnostic only) | ~30+ uncovered |
|
||||
| **Total Operations** | ~110+ | 24 active | ~86+ uncovered |
|
||||
|
||||
**Current coverage: approximately 22% of available API operations.**
|
||||
|
||||
---
|
||||
|
||||
## G. Community Project Capabilities
|
||||
|
||||
### G.1 unraid-management-agent (Go Plugin by Ruaan Deysel)
|
||||
|
||||
Capabilities this project offers that we do NOT:
|
||||
|
||||
| Capability | Details | Our Status |
|
||||
|-----------|---------|------------|
|
||||
| **SMART Disk Data** | Detailed SMART attributes, health monitoring | NOT available via GraphQL API (Issue #1839) |
|
||||
| **Container Logs** | Docker container log retrieval | Available via `docker.logs` query (we don't use it) |
|
||||
| **GPU Metrics** | GPU utilization, temperature, VRAM | NOT available via GraphQL API |
|
||||
| **Process Monitoring** | Active process list, resource usage | NOT available via GraphQL API |
|
||||
| **CPU Load Averages** | Real-time 1/5/15 min load averages | Available via `metrics` query (we don't use it) |
|
||||
| **Prometheus Metrics** | 41 exportable metrics at `/metrics` | NOT applicable to MCP |
|
||||
| **MQTT Publishing** | IoT event streaming | NOT applicable to MCP |
|
||||
| **Home Assistant Auto-Discovery** | MQTT auto-discovery | NOT applicable to MCP |
|
||||
| **Disk Temperature History** | Historical temp tracking | Limited via API |
|
||||
| **UPS Data** | UPS status monitoring | Available via API (we don't use it) |
|
||||
| **Plugin Information** | List installed plugins | NOT available via GraphQL API |
|
||||
| **Update Status** | Check for OS/plugin updates | NOT available via GraphQL API |
|
||||
| **Mover Control** | Invoke the mover tool | NOT available via GraphQL API (Issue #1873) |
|
||||
| **Disk Thresholds** | Warning/critical temp settings | Partially available via `ArrayDisk.warning`/`critical` |
|
||||
| **54 MCP Tools** | Full MCP tool suite | We have 26 |
|
||||
| **WebSocket Events** | Real-time event stream | We have diagnostic-only subscriptions |
|
||||
|
||||
### G.2 PSUnraid (PowerShell Module)
|
||||
|
||||
| Capability | Details | Our Status |
|
||||
|-----------|---------|------------|
|
||||
| **Server Status** | Comprehensive server overview | We have `get_system_info()` |
|
||||
| **Array Status** | Array state and disk health | We have `get_array_status()` |
|
||||
| **Docker Start/Stop/Restart** | Container lifecycle | We have start/stop only (no restart, no pause) |
|
||||
| **VM Start/Stop** | VM lifecycle | We have full VM lifecycle |
|
||||
| **Notification Retrieval** | Read notifications | We have `list_notifications()` |
|
||||
| **Restart Containers** | Dedicated restart action | We do NOT have restart (would be stop+start) |
|
||||
|
||||
### G.3 unraid-ssh-mcp
|
||||
|
||||
Chose SSH over GraphQL API due to these gaps:
|
||||
|
||||
| Missing from GraphQL API | Impact on Our Project |
|
||||
|--------------------------|----------------------|
|
||||
| Container logs | Now available in API (`docker.logs`) -- we should add it |
|
||||
| Detailed SMART data | Still missing from API (Issue #1839) |
|
||||
| Real-time CPU load | Now available via `metrics` query -- we should add it |
|
||||
| Process monitoring | Still missing from API |
|
||||
| `/proc` and `/sys` access | Not applicable via API |
|
||||
|
||||
### G.4 Home Assistant Integrations
|
||||
|
||||
#### domalab/ha-unraid
|
||||
|
||||
| Capability | Our Status |
|
||||
|-----------|------------|
|
||||
| CPU usage, temperature, power consumption | NO - missing metrics tools |
|
||||
| Memory utilization tracking | NO - missing metrics tools |
|
||||
| Per-disk and per-share metrics | PARTIAL - have basic disk/share info |
|
||||
| Docker container start/stop switches | YES |
|
||||
| VM management controls | YES |
|
||||
| UPS monitoring with energy dashboard | NO |
|
||||
| Notification counts | YES |
|
||||
| Dynamic entity creation | N/A |
|
||||
|
||||
#### chris-mc1/unraid_api
|
||||
|
||||
| Capability | Our Status |
|
||||
|-----------|------------|
|
||||
| Array status, storage utilization | YES |
|
||||
| RAM and CPU usage | NO - missing metrics |
|
||||
| Per-share free space | YES |
|
||||
| Per-disk: temperature, spin state, capacity | PARTIAL |
|
||||
|
||||
---
|
||||
|
||||
## H. Known API Bugs and Limitations
|
||||
|
||||
### H.1 Active Bugs (from GitHub Issues)
|
||||
|
||||
| Issue | Title | Impact on MCP Implementation |
|
||||
|-------|-------|------------------------------|
|
||||
| **#1837** | GraphQL partial failures | **CRITICAL**: Entire queries fail when VMs/Docker unavailable. Must implement partial failure handling with separate try/catch per section. |
|
||||
| **#1842** | Temperature inconsistency | SSD temps unavailable in `disks` query but accessible via `array` query. Use Array endpoint for temperature data. |
|
||||
| **#1840** | Docker cache invalidation | Docker container data may be stale after external changes (docker CLI). Use `skipCache: true` parameter when available. |
|
||||
| **#1825** | UPS false data | API returns hardcoded/phantom values when NO UPS is connected. Must validate UPS data before presenting to user. |
|
||||
| **#1861** | VM PMSUSPENDED issues | Cannot unsuspend VMs in `PMSUSPENDED` state. Must handle this state explicitly and warn users. |
|
||||
| **#1859** | Notification counting errors | Archive counts may include duplicates. Use `recalculateOverview` mutation to fix. |
|
||||
| **#1818** | Network query failures | GraphQL may return empty lists for network data. Handle gracefully. |
|
||||
| **#1871** | Container restart/update mutation | Single restart+update operation not yet in API. Must implement as separate stop+start. |
|
||||
| **#1873** | Mover not invocable via API | No GraphQL mutation to trigger the mover. Cannot implement mover tools. |
|
||||
| **#1839** | SMART disk data missing | Detailed SMART attributes not yet exposed via GraphQL. Major gap for disk health tools. |
|
||||
| **#1872** | CLI list missing creation dates | Timestamp data unavailable in some CLI operations. |
|
||||
|
||||
### H.2 Schema/Type Issues
|
||||
|
||||
| Issue | Description | Workaround |
|
||||
|-------|-------------|------------|
|
||||
| **Int Overflow** | Memory size fields and disk operation counters can overflow 32-bit Int. API uses `Long`/`BigInt` scalars but some fields remain problematic. | Parse values as strings, convert to Python `int` |
|
||||
| **NaN Values** | Fields `sysArraySlots`, `sysCacheSlots`, `cacheNumDevices`, `cacheSbNumDisks` in `vars` query can return NaN. | Query only curated subset of `vars` fields (current approach) |
|
||||
| **Non-nullable Null** | `info.devices` section has non-nullable fields that return null in practice. | Avoid querying `info.devices` entirely (current approach) |
|
||||
| **Memory Layout Size** | Individual memory stick `size` values not returned by API. | Cannot calculate total memory from layout data |
|
||||
| **PrefixedID Format** | IDs follow `TypePrefix:uuid` format. Clients must handle as opaque strings. | Already handled in current implementation |
|
||||
|
||||
### H.3 Infrastructure Limitations
|
||||
|
||||
| Limitation | Description | Impact |
|
||||
|-----------|-------------|--------|
|
||||
| **Rate Limiting** | 100 requests per 10 seconds (`@nestjs/throttler`). | Must implement request queuing/backoff for bulk operations |
|
||||
| **EventEmitter Limit** | Max 30 concurrent subscription listeners. | Limit simultaneous subscription tools |
|
||||
| **Disk Operation Timeouts** | Disk queries require 90s+ read timeouts. | Already handled with custom timeout config |
|
||||
| **Docker Size Queries** | `sizeRootFs` query is expensive. | Make it optional in list queries, only include in detail queries |
|
||||
| **Storage Polling Interval** | SMART query overhead means storage data should poll at 5min minimum. | Rate-limit storage-related subscriptions |
|
||||
| **Cache TTL** | cache-manager v7 expects TTL in milliseconds (not seconds). | Correct TTL units in any caching implementation |
|
||||
| **Schema Volatility** | API schema is still evolving between versions. | Consider version-checking at startup, graceful degradation |
|
||||
| **Nchan Memory** | WebSocket subscriptions can cause Nginx memory exhaustion (mitigated in 7.1.0+ but still possible). | Limit concurrent subscriptions, implement reconnection logic |
|
||||
| **SSL/TLS** | Self-signed certificates require special handling for local IP access. | Already handled via `UNRAID_VERIFY_SSL` env var |
|
||||
| **Version Dependency** | Full API requires Unraid 7.2+. Pre-7.2 needs Connect plugin. | Document minimum version requirements per tool |
|
||||
|
||||
### H.4 Features Requested but NOT Yet in API
|
||||
|
||||
| Feature | GitHub Issue | Status |
|
||||
|---------|-------------|--------|
|
||||
| Mover invocation | #1873 | Open feature request |
|
||||
| SMART disk data | #1839 | Open feature request (was bounty candidate) |
|
||||
| System temperature monitoring (CPU, GPU, motherboard, NVMe, chipset) | #1597 | Open bounty (not implemented) |
|
||||
| Container restart+update single mutation | #1871 | Open feature request |
|
||||
| Docker Compose native support | Roadmap TBD | Under consideration |
|
||||
| Plugin information/management via API | Not filed | Not exposed |
|
||||
| File browser/upload/download | Not filed | Legacy PHP WebGUI only |
|
||||
| Process list monitoring | Not filed | Not exposed |
|
||||
| GPU metrics | Not filed | Not exposed |
|
||||
|
||||
---
|
||||
|
||||
## Appendix: Proposed New Tool Count by Priority
|
||||
|
||||
| Priority | Category | New Tools | Total After |
|
||||
|----------|----------|-----------|-------------|
|
||||
| **HIGH** | Array Management | 7 | |
|
||||
| **HIGH** | Server Power | 2 | |
|
||||
| **HIGH** | Notification Mutations | 7 | |
|
||||
| **HIGH** | Docker Extended | 10 | |
|
||||
| **HIGH** | Disk Operations | 5 | |
|
||||
| | **High Priority Subtotal** | **31** | **57** |
|
||||
| **MEDIUM** | UPS Monitoring | 4 | |
|
||||
| **MEDIUM** | System Metrics | 4 | |
|
||||
| **MEDIUM** | Unassigned Devices | 1 | |
|
||||
| **MEDIUM** | Flash Drive | 1 | |
|
||||
| **MEDIUM** | User Management | 5 | |
|
||||
| **MEDIUM** | Services | 1 | |
|
||||
| **MEDIUM** | Settings | 1 | |
|
||||
| | **Medium Priority Subtotal** | **17** | **74** |
|
||||
| **LOW** | API Key Management | 5 | |
|
||||
| **LOW** | Remote Access | 4 | |
|
||||
| **LOW** | Cloud/Connect | 3 | |
|
||||
| **LOW** | Server Management | 4 | |
|
||||
| **LOW** | Display & Config | 2 | |
|
||||
| | **Low Priority Subtotal** | **18** | **92** |
|
||||
| | **GRAND TOTAL NEW TOOLS** | **66** | **92** |
|
||||
|
||||
**Current tools: 26 | Potential total: 92 | Gap: 66 tools (72% of potential uncovered)**
|
||||
|
||||
---
|
||||
|
||||
## Appendix: Data Sources Cross-Reference
|
||||
|
||||
| Document | Lines | Key Contributions |
|
||||
|----------|-------|-------------------|
|
||||
| `unraid-api-research.md` | 819 | API overview, auth flow, query/mutation examples, version history, recommendations |
|
||||
| `unraid-api-source-analysis.md` | 998 | Complete resolver listing, PubSub channels, mutation details, open issues, community projects |
|
||||
| `unraid-api-exa-research.md` | 569 | DeepWiki architecture, rate limits, OIDC providers, Python client library, MCP listings |
|
||||
| `unraid-api-crawl.md` | 1451 | Complete GraphQL schema (Query/Mutation/Subscription types), CLI reference, all enums/scalars |
|
||||
| `raw/release-7.0.0.md` | 958 | ZFS support, VM snapshots/clones, File Manager, Tailscale, notification agents |
|
||||
| `raw/release-7.2.0.md` | 348 | API built into OS, responsive WebGUI, RAIDZ expansion, SSO, Ext2/3/4/NTFS/exFAT support |
|
||||
| `raw/blog-api-bounty.md` | 139 | Feature Bounty Program, community projects showcase |
|
||||
176
docs/research/raw/blog-7.2.0.md
Normal file
176
docs/research/raw/blog-7.2.0.md
Normal file
@@ -0,0 +1,176 @@
|
||||
* [Unraid News](https://unraid.net/blog)
|
||||
|
||||
|
||||
29 October 2025
|
||||
|
||||
Unraid OS 7.2.0 Stable is Now Available
|
||||
=======================================
|
||||
|
||||
Unraid 7.2.0 delivers a **fully responsive web interface, expanded filesystem support, a built-in, open-source API**, **ZFS RAIDZ Expansion,** and much more!
|
||||
|
||||

|
||||
|
||||
**Your Server: More Responsive, Secure, and More Flexible than ever.**
|
||||
|
||||
Building on months of testing and feedback, this release brings major quality-of-life improvements for new and seasoned users alike. Whether you're upgrading your homelab or deploying at scale, this release brings more control, compatibility, and confidence to every system.
|
||||
|
||||
We want to give a huge thanks to the _over 5,000 beta testers_ that helped bring this release to Stable.
|
||||
|
||||
**Fully Responsive WebGUI**
|
||||
---------------------------
|
||||
|
||||
Unraid now adapts seamlessly to any screen size. The redesigned WebGUI ensures smooth operation across desktops, tablets, and mobile devices making it easier than ever to manage your server from anywhere, with any device.
|
||||
|
||||
### See the Responsive Webgui in action
|
||||
|
||||
**Expand Your RAIDZ Pools and Bring Every Drive With You**
|
||||
----------------------------------------------------------
|
||||
|
||||
### **ZFS RAIDZ Expansion**
|
||||
|
||||
You can now expand your single-vdev RAIDZ1/2/3 pools, one drive at a time!
|
||||
|
||||
1. Stop the array
|
||||
2. On _**Main → Pool Devices,**_ add a slot to the pool
|
||||
3. Select the appropriate drive. _Note: must be at least as large as the smallest drive in the pool._
|
||||
4. Start the array
|
||||
|
||||
### See How RAIDZ Expansion Works
|
||||
|
||||
### **External Drive Support: ext2/3/4, NTFS, exFAT**
|
||||
|
||||
Alongside XFS, BTRFS, and the ZFS file systems, Unraid now supports ext2 / ext3 / ext4, NTFS, and exFAT out of the box, making it easier to import data from external sources or legacy systems.
|
||||
|
||||
This means you can _create an array or single device pool with existing drives formatted in Ext2/3/4 or NTFS, and you can format drives in Ext4 or NTFS._
|
||||
|
||||
### Learn How Unraid Handles ext, NTFS, and exFAT Out of the Box
|
||||
|
||||
Cyber Weekend is Coming
|
||||
-----------------------
|
||||
|
||||
Don’t miss our biggest sale of the year November 28-December 1st. Subscribe to the [Unraid Digest](https://newsletter.unraid.net/)
|
||||
and be the first to know all of the details!
|
||||
|
||||
[Subscribe](https://newsletter.unraid.net/)
|
||||
|
||||
**Unraid API**
|
||||
--------------
|
||||
|
||||
The [**Unraid API**](https://docs.unraid.net/API/)
|
||||
is now integrated directly into Unraid OS, giving developers and power users new ways to interact with their systems.
|
||||
|
||||
The new **Notifications panel** is the first major feature built on this foundation, and over time, more of the webGUI will transition to use the API for faster, more dynamic updates.
|
||||
|
||||
The API is fully [**open source**](https://github.com/unraid/api)
|
||||
, providing direct access to system data and functionality for building automations, dashboards, and third‑party integrations. It also supports [**external authentication (OIDC)**](https://docs.unraid.net/API/oidc-provider-setup/)
|
||||
for secure, scalable access.
|
||||
|
||||
### See the Unraid API in Action!
|
||||
|
||||
Learn More about the Unraid API
|
||||
-------------------------------
|
||||
|
||||
* #### [Follow along the Unraid API Roadmap](https://docs.unraid.net/API/upcoming-features/)
|
||||
|
||||
* #### [See current apps using the Unraid API](https://discord.com/channels/216281096667529216/1375651142704566282)
|
||||
|
||||
|
||||
**Additional Improvements and Fixes**
|
||||
-------------------------------------
|
||||
|
||||
### **Storage & Array**
|
||||
|
||||
* Two-device ZFS pools default to mirrors; use RAIDZ1 for future vdev expansion
|
||||
* New _File System Status_ shows if drives are mounted and/or empty
|
||||
* Exclusive shares now exportable via NFS
|
||||
* Restricted special share names (homes, global, printers)
|
||||
* Improved SMB config (smb3 directory leases = no) and security settings UX
|
||||
* Better handling for parity disks with 1MiB partitions
|
||||
* BTRFS mounts more reliably with multiple FS signatures
|
||||
* New drives now repartitioned when added to parity-protected arrays
|
||||
* Devices in SMART test won’t spin down
|
||||
* Cleaner handling of case-insensitive share names and invalid characters
|
||||
* ZFS vdevs now display correctly in allocation profiles
|
||||
|
||||
### **VM Manager**
|
||||
|
||||
* Console access now works even when user shares are disabled
|
||||
* Single quotes are no longer allowed in the Domains storage path
|
||||
* Windows 11 defaults have been updated for better compatibility
|
||||
* Cdrom Bus now defaults to IDE for i440fx and SATA for Q35 machines
|
||||
* Vdisk locations now display properly in non-English languages
|
||||
* You'll now see a warning when adding a second vdisk if you forget to assign a capacity
|
||||
|
||||
### **WebGUI**
|
||||
|
||||
* Network and RAM stats now shown in human-readable units
|
||||
* Font size and layout fixes
|
||||
* Better error protection for PHP-based failures
|
||||
|
||||
### Miscellaneous **Improvements**
|
||||
|
||||
* Better logging during plugin installs
|
||||
* Added safeguards to protect WebGUI from fatal PHP errors
|
||||
* Diagnostics ZIPs are now further anonymized
|
||||
* Resolved crash related to Docker container CPU pinning
|
||||
* Fixed Docker NAT issue caused by missing br\_netfilter
|
||||
* Scheduled mover runs are now properly logged
|
||||
|
||||
### **Kernel & Packages**
|
||||
|
||||
* Linux Kernel 6.12.54-Unraid
|
||||
* Samba 4.23.2
|
||||
* Updated versions of openssl, mesa, kernel-firmware, git, exfatprogs, and more
|
||||
|
||||
**Plugin Compatibility Notice**
|
||||
-------------------------------
|
||||
|
||||
To maintain stability with the new responsive WebGUI, the following plugins will be removed during upgrade if present:
|
||||
|
||||
* **Theme Engine**
|
||||
* **Dark Theme**
|
||||
* **Dynamix Date Time**
|
||||
* **Flash Remount**
|
||||
* **Outdated versions of Unraid Connect**
|
||||
|
||||
Please update all other plugins—**especially Unraid Connect and Nvidia Driver**—before upgrading!
|
||||
|
||||
Unraid 7.2.0
|
||||
------------
|
||||
|
||||
Important Release Links
|
||||
|
||||
* #### [Docs](https://docs.unraid.net/unraid-os/release-notes/7.2.0/)
|
||||
|
||||
Version 7.2.0 Full Release Notes
|
||||
|
||||
* #### [Forum Thread](https://forums.unraid.net/topic/194610-unraid-os-version-720-available/)
|
||||
|
||||
Unraid 7.2.0 Forum Thread
|
||||
|
||||
* #### [Known Issues](https://docs.unraid.net/unraid-os/release-notes/7.2.0/#known-issues)
|
||||
|
||||
See the Known Issues for the Unraid 7.2 series
|
||||
|
||||
* #### [Learn More](https://docs.unraid.net/unraid-os/system-administration/maintain-and-update/upgrading-unraid/#standard-upgrade-process)
|
||||
|
||||
Ready to Upgrade? Visit your server’s Tools → Update OS page to install Unraid 7.2.0.
|
||||
|
||||
|
||||

|
||||
|
||||
Pricing
|
||||
-------
|
||||
|
||||
With affordable options starting at just $49, we have a license for everyone.
|
||||
|
||||
[Buy Now](https://account.unraid.net/buy)
|
||||
|
||||

|
||||
|
||||
Try before you buy
|
||||
------------------
|
||||
|
||||
Not sure if Unraid is right for you? Take Unraid for a test drive for 30 days—no credit card required.
|
||||
|
||||
[Free Trial](https://unraid.net/getting-started)
|
||||
139
docs/research/raw/blog-api-bounty.md
Normal file
139
docs/research/raw/blog-api-bounty.md
Normal file
@@ -0,0 +1,139 @@
|
||||
* [Unraid News](https://unraid.net/blog)
|
||||
|
||||
|
||||
5 September 2025
|
||||
|
||||
Introducing the Unraid API Feature Bounty Program
|
||||
=================================================
|
||||
|
||||
We’re opening new doors for developers and power users to directly shape the Unraid experience, together.
|
||||
|
||||
The new [Unraid API](https://docs.unraid.net/API/)
|
||||
has already come a long way as a powerful, open-source toolkit that unlocks endless possibilities for automation, integrations, and third-party applications. With each release, we’ve seen the creativity of our community take center stage, building tools that extend the Unraid experience in ways we never imagined.
|
||||
|
||||
Now, we’re taking it one step further with the [**Unraid API Feature Bounty Program**.](https://unraid.net/feature-bounty)
|
||||
|
||||
### **What Is the Feature Bounty Program?**
|
||||
|
||||
The bounty program gives developers (and adventurous users) a way to directly contribute to the Unraid API roadmap. Here’s how it works:
|
||||
|
||||
1. **Feature Requests Become Bounties:** We post specific API features that would benefit the entire Unraid ecosystem.
|
||||
2. **You Build & Contribute:** Developers who implement these features can claim the bounty, earn recognition, and a monetary reward.
|
||||
3. **Community Driven Growth:** Instead of waiting for features to arrive, you can help build them, get rewarded, and help the Unraid community.
|
||||
|
||||
Our core team focuses on high-priority roadmap items. Bounties give the community a way to help accelerate other highly requested features by bringing more ideas to life, faster, with recognition and reward for those who contribute.
|
||||
|
||||
API Feature Bounty Program Details
|
||||
----------------------------------
|
||||
|
||||
You can turn feature requests into reality, get rewarded for your contributions, and help grow the open-source Unraid API ecosystem.
|
||||
|
||||
[Learn More](https://unraid.net/feature-bounty)
|
||||
|
||||
### **The Open-Source Unraid API**
|
||||
|
||||
Alongside the bounty program, we’re thrilled to highlight just how open and flexible the Unraid API has become. Whether you’re scripting via the CLI, building automations with the API, or integrating with external identity providers through OAuth2/OIDC, the API is designed to be transparent and extensible.
|
||||
|
||||
API Docs
|
||||
--------
|
||||
|
||||
Learn about how to get started with the Unraid API.
|
||||
|
||||
[Start Here](https://docs.unraid.net/API/)
|
||||
|
||||
OIDC Provider Setup
|
||||
-------------------
|
||||
|
||||
Configure OIDC providers for SSO authentication in the Unraid API using the web interface.
|
||||
|
||||
[OIDC](https://docs.unraid.net/API/oidc-provider-setup/)
|
||||
|
||||
Upcoming API Features
|
||||
---------------------
|
||||
|
||||
The roadmap outlines completed and planned features for the Unraid API. Features and timelines may change based on development priorities and community feedback.
|
||||
|
||||
[Learn More](https://docs.unraid.net/API/upcoming-features/)
|
||||
|
||||
Community API Projects in Action
|
||||
--------------------------------
|
||||
|
||||
The power of an open API is best shown by what you build with it. Here are just a few highlights from the community so far!
|
||||
|
||||

|
||||
|
||||
### [Unraid Mobile App](https://forums.unraid.net/topic/189522-unraid-mobile-app/)
|
||||
|
||||
by S3ppo
|
||||
|
||||

|
||||
|
||||
### [Homepage Dashboard Widget](https://discord.com/channels/216281096667529216/1379497640110063656)
|
||||
|
||||
by surf108
|
||||
|
||||

|
||||
|
||||
### [Home Assistant Integration](https://github.com/domalab/ha-unraid-connect)
|
||||
|
||||
by domalab
|
||||
|
||||

|
||||
|
||||
[Unloggarr (AI-powered log analysis)](https://github.com/jmagar/unloggarr)
|
||||
|
||||
---------------------------------------------------------------------------
|
||||
|
||||
by jmagar
|
||||
|
||||

|
||||
|
||||
[nzb360 Mobile App (Android)](https://play.google.com/store/apps/details?id=com.kevinforeman.nzb360&hl=en_US)
|
||||
|
||||
--------------------------------------------------------------------------------------------------------------
|
||||
|
||||
by nzb360dev
|
||||
|
||||

|
||||
|
||||
[API Show and Tell](https://discord.com/channels/216281096667529216/1375651142704566282)
|
||||
|
||||
-----------------------------------------------------------------------------------------
|
||||
|
||||
Show off your project or see them all in action on our Discord channel!
|
||||
|
||||
Get Involved
|
||||
------------
|
||||
|
||||
Whether you’re a developer looking to contribute, or a user eager to see your most-wanted features come to life, the new Unraid API Feature Bounty Program is your chance to help shape the future of Unraid. The Unraid API is open and the bounties are live!
|
||||
|
||||
* #### [Feature Bounty Program](https://unraid.net/feature-bounty)
|
||||
|
||||
Learn More about the Feature Bounty Program
|
||||
|
||||
* #### [Claim Bounties](https://github.com/orgs/unraid/projects/3/views/1)
|
||||
|
||||
Browse the live bounty board
|
||||
|
||||
* #### [API Info](https://docs.unraid.net/API/)
|
||||
|
||||
Read the API Docs
|
||||
|
||||
|
||||

|
||||
|
||||
Pricing
|
||||
-------
|
||||
|
||||
With affordable options starting at just $49, we have a license for everyone.
|
||||
|
||||
[Buy Now](https://account.unraid.net/buy)
|
||||
|
||||

|
||||
|
||||
Try before you buy
|
||||
------------------
|
||||
|
||||
Not sure if Unraid is right for you? Take Unraid for a test drive for 30 days—no credit card required.
|
||||
|
||||
[Free Trial](https://unraid.net/getting-started)
|
||||
259
docs/research/raw/connect-overview.md
Normal file
259
docs/research/raw/connect-overview.md
Normal file
@@ -0,0 +1,259 @@
|
||||
[Skip to main content](https://docs.unraid.net/unraid-connect/overview-and-setup#__docusaurus_skipToContent_fallback)
|
||||
|
||||
On this page
|
||||
|
||||
**Unraid Connect** is a cloud-enabled companion designed to enhance your Unraid OS server experience. It makes server management, monitoring, and maintenance easier than ever, bringing cloud convenience directly to your homelab or business setup.
|
||||
|
||||
Unraid Connect works seamlessly with Unraid OS, boosting your server experience without altering its core functions. You can think of Unraid Connect as your remote command center. It expands the capabilities of your Unraid server by providing secure, web-based access and advanced features, no matter where you are.
|
||||
|
||||
With Unraid Connect, you can:
|
||||
|
||||
* Remotely access and manage your Unraid server from any device, anywhere in the world.
|
||||
* Monitor real-time server health and resource usage, including storage, network, and Docker container status.
|
||||
* Perform and schedule secure online flash backups to protect your configuration and licensing information.
|
||||
* Receive notifications about server health, storage status, and critical events.
|
||||
* Use dynamic remote access and server deep linking to navigate to specific management pages or troubleshoot issues quickly.
|
||||
* Manage multiple servers from a single dashboard, making it perfect for users with more than one Unraid system.
|
||||
|
||||
Unraid Connect is more than just an add-on; it's an essential extension of the Unraid platform, designed to maximize the value, security, and convenience of your Unraid OS investment.
|
||||
|
||||
[**Click here to dive in to Unraid Connect!**](https://connect.myunraid.net/)
|
||||
|
||||
Data collection and privacy[](https://docs.unraid.net/unraid-connect/overview-and-setup#data-collection-and-privacy "Direct link to Data collection and privacy")
|
||||
|
||||
-------------------------------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
**Click to see what data is collected and how we handle it**
|
||||
|
||||
Unraid Connect prioritizes your privacy and transparency. Here’s what you need to know about how we handle your data:
|
||||
|
||||
### What data is collected and why
|
||||
|
||||
When your server connects to Unraid.net, it establishes a secure connection to our infrastructure and transmits only the necessary data required for a seamless experience in the Unraid Connect Dashboard. This includes:
|
||||
|
||||
* Server hostname, description, and icon
|
||||
* Keyfile details and flash GUID
|
||||
* Local access URL and LAN IP (only if a certificate is installed)
|
||||
* Remote access URL and WAN IP (if remote access is turned on)
|
||||
* Installed Unraid version and uptime
|
||||
* Unraid Connect plugin version and unraid-api version/uptime
|
||||
* Array size and usage (only numbers, no file specifics)
|
||||
* Number of Docker containers and VMs installed and running
|
||||
|
||||
We use this data solely to enable Unraid Connect features, such as remote monitoring, management, and notifications. It is not used for advertising or profiling.
|
||||
|
||||
### Data retention policy
|
||||
|
||||
* We only keep the most recent update from your server; no past data is stored.
|
||||
* Data is retained as long as your server is registered and using Unraid Connect.
|
||||
* To delete your data, simply uninstall the plugin and remove any SSL certificates issued through Let's Encrypt.
|
||||
|
||||
### Data sharing
|
||||
|
||||
* Your data is **not shared with third parties** unless it is necessary for Unraid Connect services, such as certificate provisioning through Let's Encrypt.
|
||||
* We do not collect or share any user content, file details, or personal information beyond what is specified above.
|
||||
|
||||
For more details, check out our [Policies](https://unraid.net/policies)
|
||||
page.
|
||||
|
||||
Installation[](https://docs.unraid.net/unraid-connect/overview-and-setup#installation "Direct link to Installation")
|
||||
|
||||
----------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
Unraid Connect is available as a plugin that requires Unraid OS 6.10 or later. Before you start, make sure your server is connected to the internet and you have the [Community Applications](https://docs.unraid.net/unraid-os/using-unraid-to/run-docker-containers/community-applications/)
|
||||
plugin installed.
|
||||
|
||||
To install Unraid Connect:
|
||||
|
||||
1. Navigate to the **Apps** tab in the Unraid WebGUI.
|
||||
2. Search for **Unraid Connect** and proceed to install the plugin. Wait for the installation to fully complete before closing the dialog.
|
||||
3. In the top right corner of your Unraid WebGUI, click on the Unraid logo and select **Sign In**.
|
||||
|
||||

|
||||
|
||||
4. Sign in with your Unraid.net credentials or create a new account if necessary.
|
||||
5. Follow the on-screen instructions to register your server with Unraid Connect.
|
||||
6. After registration, you can access the [Unraid Connect Dashboard](https://connect.myunraid.net/)
|
||||
for centralized management.
|
||||
|
||||
note
|
||||
|
||||
Unraid Connect requires a myunraid.net certificate for secure remote management and access. To provision a certificate, go to _**Settings → Management Access**_ in the WebGUI and click **Provision** under the Certificate section.
|
||||
|
||||
Dashboard[](https://docs.unraid.net/unraid-connect/overview-and-setup#dashboard "Direct link to Dashboard")
|
||||
|
||||
-------------------------------------------------------------------------------------------------------------
|
||||
|
||||
The **Unraid Connect Dashboard** offers a centralized, cloud-based view of all your registered Unraid servers, with features like:
|
||||
|
||||
* **My Servers:** All linked servers appear in a sidebar and as interactive tiles for easy selection.
|
||||
* **Status (at a glance):** Quickly see which servers are online or offline, along with their Unraid OS version, license type, and recent activity.
|
||||
* **Health and alerts:** Visual indicators show server health, notifications, and update status.
|
||||
|
||||
When you click **Details** on a server, you will see:
|
||||
|
||||
* **Online/Offline:** Real-time connectivity status.
|
||||
* **License type:** Starter, Unleashed, or Lifetime.
|
||||
* **Uptime:** Duration the server has been running.
|
||||
* **Unraid OS version:** Current version and update availability.
|
||||
* **Storage:** Total and free space on all arrays and pools.
|
||||
* **Health metrics:** CPU usage, memory usage, and temperature (if supported).
|
||||
* **Notifications:** Hardware/software alerts, warnings, and errors.
|
||||
* **Flash backup:** Status and date of the last successful backup.
|
||||
|
||||
* * *
|
||||
|
||||
Managing your server remotely[](https://docs.unraid.net/unraid-connect/overview-and-setup#managing-your-server-remotely "Direct link to Managing your server remotely")
|
||||
|
||||
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
tip
|
||||
|
||||
To use all management features, provision a myunraid.net certificate under _**Settings → Management Access**_ on your server.
|
||||
|
||||
With a valid **myunraid.net** certificate, Unraid Connect enables secure, remote server management directly from the Connect web interface.
|
||||
|
||||
Remote management features include:
|
||||
|
||||
* **Remote WebGUI access:** Access the WebGUI from anywhere.
|
||||
* **Array controls:** Start or stop arrays and manage storage pools.
|
||||
* **Docker and VM management:** View, start, stop, and monitor containers and VMs.
|
||||
* **Parity & Scrub:** Launch parity check or ZFS/BTRFS scrub jobs
|
||||
* **Flash backup:** Trigger and monitor flash device backups to the cloud.
|
||||
* **Diagnostics:** Download a diagnostics zip for support
|
||||
* **Notifications:** Review and acknowledge system alerts.
|
||||
* **Server controls:** Reboot or shut down your server remotely.
|
||||
* **User management:** Manage Unraid.net account access and registration.
|
||||
|
||||
You can manage multiple servers from any device - phone, tablet, or computer - with a single browser window.
|
||||
|
||||
* * *
|
||||
|
||||
Deep linking[](https://docs.unraid.net/unraid-connect/overview-and-setup#deep-linking "Direct link to Deep linking")
|
||||
|
||||
----------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
Deep linking in Unraid Connect lets you jump directly to specific sections of your Unraid WebGUI with a single click. Simply click any of the circled link buttons (below) in the Connect interface to go straight to the relevant management page for your server.
|
||||
|
||||

|
||||
|
||||
* * *
|
||||
|
||||
Customization[](https://docs.unraid.net/unraid-connect/overview-and-setup#customization "Direct link to Customization")
|
||||
|
||||
-------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
Unraid Connect provides a flexible dashboard experience, allowing you to personalize your server view and appearance. The customization options are organized below for easy reference.
|
||||
|
||||
* Change banner image
|
||||
* Rearrange dashboard tiles
|
||||
* Switch themes
|
||||
|
||||
To display your server’s banner image on the Connect dashboard, upload or select a banner image from your WebGUI under _**Settings → Display Settings → Banner**_. This banner will automatically appear in your Connect dashboard for that server.
|
||||
|
||||
You can customize your dashboard layout by dragging and dropping server tiles. In the Connect dashboard, click the hamburger (≡) button on any tile to rearrange its position. This allows you to prioritize the information and the services most important to you.
|
||||
|
||||
Toggle between dark and light mode by clicking the Sun or Moon icon on the far right of the Connect UI. Your theme preference will be instantly applied across the Connect dashboard for a consistent experience.
|
||||
|
||||
* * *
|
||||
|
||||
License management[](https://docs.unraid.net/unraid-connect/overview-and-setup#license-management "Direct link to License management")
|
||||
|
||||
----------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
Managing your licenses in Unraid Connect is easy. Under the **My Keys** section, you can:
|
||||
|
||||
* View or reissue a key to a new USB.
|
||||
* Upgrade your license tier directly from the Connect UI.
|
||||
* Download registration key files for backup or transfer.
|
||||
* Review license status and expiration (if applicable).
|
||||
|
||||

|
||||
|
||||
You don’t need to leave the Connect interface to manage or upgrade your licenses.
|
||||
|
||||
* * *
|
||||
|
||||
Language localization[](https://docs.unraid.net/unraid-connect/overview-and-setup#language-localization "Direct link to Language localization")
|
||||
|
||||
-------------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
Unraid Connect supports multiple languages to cater to a global user base. You can change your language preference through the language selector in the Connect interface.
|
||||
|
||||
To change your language preference:
|
||||
|
||||
1. Open the Connect UI.
|
||||
2. Go to the language selector.
|
||||
|
||||

|
||||
|
||||
3. Select your preferred language from the list.
|
||||
|
||||
The interface will update automatically to reflect your selection.
|
||||
|
||||
* * *
|
||||
|
||||
Signing out[](https://docs.unraid.net/unraid-connect/overview-and-setup#signing-out "Direct link to Signing out")
|
||||
|
||||
-------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
You can sign out of Unraid Connect anytime from _**Settings → Management Access → Unraid Connect → Account Status**_ by clicking the **Sign Out** button.
|
||||
|
||||
When you sign out:
|
||||
|
||||
* Your server remains listed on the Connect dashboard, but you lose access to remote management features.
|
||||
* Remote access, cloud-based flash backups, and other Unraid Connect features will be disabled for that server.
|
||||
* You can still download your registration keys, but you cannot manage or monitor the server remotely until you sign in again.
|
||||
* Signing out does **not** disconnect your server from the local network or affect local access.
|
||||
|
||||
* * *
|
||||
|
||||
Uninstalling the plugin[](https://docs.unraid.net/unraid-connect/overview-and-setup#uninstalling-the-plugin "Direct link to Uninstalling the plugin")
|
||||
|
||||
-------------------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
When you uninstall the Unraid Connect plugin:
|
||||
|
||||
* All flash backup files will be deactivated and deleted from your local flash drive.
|
||||
* Cloud backups are marked for removal from Unraid servers; they will be retained for 30 days, after which they are permanently purged. For immediate deletion, [disable Flash Backup](https://docs.unraid.net/unraid-connect/automated-flash-backup/)
|
||||
before uninstalling.
|
||||
* Remote access will be disabled. Ensure that you remove any related port forwarding rules from your router.
|
||||
* Your server will be signed out of Unraid.net.
|
||||
|
||||
note
|
||||
|
||||
Uninstalling the plugin does **not** revert your server's URL from `https://yourpersonalhash.unraid.net` to `http://computername`. If you wish to change your access URL, refer to [Disabling SSL for local access](https://docs.unraid.net/unraid-os/system-administration/secure-your-server/securing-your-connection/#disabling-ssl-for-local-access)
|
||||
.
|
||||
|
||||
* * *
|
||||
|
||||
Connection errors[](https://docs.unraid.net/unraid-connect/overview-and-setup#connection-errors "Direct link to Connection errors")
|
||||
|
||||
-------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
If you encounter connection errors in Unraid Connect, [open a terminal](https://docs.unraid.net/unraid-os/system-administration/advanced-tools/command-line-interface/)
|
||||
from the WebGUI and run:
|
||||
|
||||
unraid-api restart
|
||||
|
||||
* [Data collection and privacy](https://docs.unraid.net/unraid-connect/overview-and-setup#data-collection-and-privacy)
|
||||
|
||||
* [Installation](https://docs.unraid.net/unraid-connect/overview-and-setup#installation)
|
||||
|
||||
* [Dashboard](https://docs.unraid.net/unraid-connect/overview-and-setup#dashboard)
|
||||
|
||||
* [Managing your server remotely](https://docs.unraid.net/unraid-connect/overview-and-setup#managing-your-server-remotely)
|
||||
|
||||
* [Deep linking](https://docs.unraid.net/unraid-connect/overview-and-setup#deep-linking)
|
||||
|
||||
* [Customization](https://docs.unraid.net/unraid-connect/overview-and-setup#customization)
|
||||
|
||||
* [License management](https://docs.unraid.net/unraid-connect/overview-and-setup#license-management)
|
||||
|
||||
* [Language localization](https://docs.unraid.net/unraid-connect/overview-and-setup#language-localization)
|
||||
|
||||
* [Signing out](https://docs.unraid.net/unraid-connect/overview-and-setup#signing-out)
|
||||
|
||||
* [Uninstalling the plugin](https://docs.unraid.net/unraid-connect/overview-and-setup#uninstalling-the-plugin)
|
||||
|
||||
* [Connection errors](https://docs.unraid.net/unraid-connect/overview-and-setup#connection-errors)
|
||||
180
docs/research/raw/connect-remote-access.md
Normal file
180
docs/research/raw/connect-remote-access.md
Normal file
@@ -0,0 +1,180 @@
|
||||
[Skip to main content](https://docs.unraid.net/unraid-connect/remote-access#__docusaurus_skipToContent_fallback)
|
||||
|
||||
On this page
|
||||
|
||||
Unlock secure, browser-based access to your Unraid WebGUI from anywhere with remote access. This feature is ideal for managing your server when you're away from home - no complicated networking or VPN Tunnel setup is required. For more advanced needs, such as connecting to Docker containers or accessing network drives, a VPN Tunnel remains the recommended solution.
|
||||
|
||||
Security reminder
|
||||
|
||||
Before enabling remote access, ensure your root password is strong and unique. Update it on the **Users** page if required. Additionally, keep your Unraid OS updated to the latest version to protect against security vulnerabilities. [Learn more about updating Unraid here](https://docs.unraid.net/unraid-os/system-administration/maintain-and-update/upgrading-unraid/)
|
||||
.
|
||||
|
||||
Remote access through Unraid Connect provides:
|
||||
|
||||
* **Convenience** - Quickly access your server’s management interface from anywhere, using a secure, cloud-managed connection.
|
||||
* **Security** - Dynamic access modes limit exposure by only allowing access to the internet when necessary, which helps reduce risks from automated attacks.
|
||||
* **Simplicity** - No need for manual port forwarding or VPN client setup for basic management tasks.
|
||||
|
||||
tip
|
||||
|
||||
For full network access or advanced use cases, consider setting up [Tailscale](https://docs.unraid.net/unraid-os/system-administration/secure-your-server/tailscale/)
|
||||
or a VPN solution.
|
||||
|
||||
* * *
|
||||
|
||||
Initial setup[](https://docs.unraid.net/unraid-connect/remote-access#initial-setup "Direct link to Initial setup")
|
||||
|
||||
--------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
To enable remote access:
|
||||
|
||||
1. In the Unraid WebGUI, navigate to _**Settings → Management Access**_.
|
||||
2. Check the **HTTPS port** (default: 443). If this port is in use (e.g., by Docker), select an unused port above 1000 (like 3443, 4443, or 5443).
|
||||
3. Click **Apply** if you changed any settings.
|
||||
4. Under **CA-signed certificate file**, click **Provision** to generate a trusted certificate.
|
||||
|
||||
Your Unraid server will be ready to accept secure remote connections via the WebGUI, using the configured port and a trusted certificate.
|
||||
|
||||
* * *
|
||||
|
||||
Choosing a remote access type[](https://docs.unraid.net/unraid-connect/remote-access#choosing-a-remote-access-type "Direct link to Choosing a remote access type")
|
||||
|
||||
--------------------------------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
Unraid Connect offers two modes:
|
||||
|
||||
* Dynamic remote access
|
||||
* Static remote access
|
||||
|
||||
**Dynamic remote access** provides secure, on-demand access to your WebGUI.
|
||||
|
||||
* **Access is enabled only when you need it.** The WebGUI remains closed to the internet by default, minimizing the attack surface.
|
||||
* **Works with UPnP or manual port forwarding.**
|
||||
* **Automatically opens and closes access** through the Connect dashboard or API, with sessions limited by time for added security.
|
||||
|
||||
**Static remote access** keeps your WebGUI continuously available from the internet.
|
||||
|
||||
* **Server is always accessible from the internet** on the configured port.
|
||||
* **Higher risk:** The WebGUI is exposed to WAN traffic at all times, increasing potential vulnerability.
|
||||
|
||||
| Feature | Dynamic remote access | Static remote access |
|
||||
| --- | --- | --- |
|
||||
| WebGUI open to internet | Only when enabled | Always |
|
||||
| Attack surface | Minimized | Maximized |
|
||||
| Automation | Auto open/close via Connect | Manual setup, always open |
|
||||
| UPnP support | Yes | Yes |
|
||||
| | **Recommended for most** | |
|
||||
|
||||
Dynamic remote access setup[](https://docs.unraid.net/unraid-connect/remote-access#dynamic-remote-access-setup "Direct link to Dynamic remote access setup")
|
||||
|
||||
--------------------------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
To set up dynamic remote access:
|
||||
|
||||
1. In _**Settings → Management Access → Unraid API**_, select a dynamic option from the Remote Access dropdown:
|
||||
|
||||
* **Dynamic - UPnP:** Uses UPnP to open and close a random port automatically (requires UPnP enabled on your router).
|
||||
* **Dynamic - Manual port forward:** Requires you to forward the selected port on your router manually.
|
||||
2. Navigate to [Unraid Connect](https://connect.myunraid.net/)
|
||||
, and go to the management or server details page.
|
||||
|
||||
3. The **Dynamic remote access** card will show a button if your server isn’t currently accessible from your location.
|
||||
|
||||
4. Click the button to enable WAN access. If using UPnP, a new port forward lease is created (typically for 30 minutes) and auto-renewed while active.
|
||||
|
||||
5. The card will display the current status and UPnP state.
|
||||
|
||||
6. After 10 minutes of inactivity - or if you click **Disable remote access** - internet access is automatically revoked. UPnP leases are removed as well.
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
Using UPnP (Universal Plug and Play)[](https://docs.unraid.net/unraid-connect/remote-access#using-upnp-universal-plug-and-play "Direct link to Using UPnP (Universal Plug and Play)")
|
||||
|
||||
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
UPnP automates port forwarding, simplifying remote access without requiring manual router configuration.
|
||||
|
||||
To configure UPnP:
|
||||
|
||||
1. **Enable UPnP on your router.** Ensure that your router supports UPnP and verify that it is enabled in the router settings.
|
||||
|
||||
2. **Enable UPnP in Unraid.** Navigate to _**Settings → Management Access**_ and change **Use UPnP** to **Yes**.
|
||||
|
||||
3. **Select UPnP in Unraid Connect.** On the Unraid Connect settings page, choose the remote access option as UPnP (select either Dynamic or Always On) and then click **Apply**.
|
||||
|
||||
4. **Verify port forwarding (Always On only).** Click the **Check** button. If successful, you'll see the message, "Your Unraid Server is reachable from the Internet."
|
||||
|
||||
For Dynamic forwarding, you need to click **Enable Dynamic Remote Access** in [Unraid Connect](https://connect.myunraid.net/)
|
||||
to allow access.
|
||||
|
||||
|
||||
Troubleshooting
|
||||
|
||||
If the setting changes from UPnP to Manual Port Forward upon reloading, Unraid might not be able to communicate with your router. Double-check that UPnP is enabled and consider updating your router's firmware.
|
||||
|
||||
* * *
|
||||
|
||||
Using manual port forwarding[](https://docs.unraid.net/unraid-connect/remote-access#using-manual-port-forwarding "Direct link to Using manual port forwarding")
|
||||
|
||||
-----------------------------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
Manual port forwarding provides greater control and is compatible with most routers.
|
||||
|
||||
To configure manual port forwarding:
|
||||
|
||||
1. **Choose a WAN port:** Pick a random port number above 1000 (for example, 13856 or 48653), rather than using the default 443.
|
||||
|
||||
2. **Apply settings in Unraid:** Click **Apply** to save the port you selected.
|
||||
|
||||
3. **Configure your router:** Set up a port forwarding rule on your router, directing your chosen WAN port to your server’s HTTPS port. The Unraid interface provides the correct ports and IP address.
|
||||
|
||||
Some routers may require the WAN port and HTTPS port to match. If so, use the same high random number for both.
|
||||
|
||||
4. **Verify port forwarding (Always On only):** Press the **Check** button. If everything is correct, you’ll see “Your Unraid Server is reachable from the Internet.”
|
||||
|
||||
For dynamic forwarding, ensure to click **Enable Dynamic Remote Access** in [Unraid Connect](https://connect.myunraid.net/)
|
||||
to enable access.
|
||||
|
||||
5. **Access your server:** Log in to [Unraid Connect](https://connect.myunraid.net/)
|
||||
and click the **Manage** link to connect to your server remotely.
|
||||
|
||||
|
||||
* * *
|
||||
|
||||
Enabling secure local access[](https://docs.unraid.net/unraid-connect/remote-access#enabling-secure-local-access "Direct link to Enabling secure local access")
|
||||
|
||||
-----------------------------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
Secure local access ensures that all connections to your Unraid WebGUI, even within your home or office network, are encrypted using HTTPS, thereby safeguarding any sensitive information, such as login credentials and configuration data.
|
||||
|
||||
Benefits of secure local access include:
|
||||
|
||||
* **Encryption** - All data exchanged between your browser and the server is protected.
|
||||
* **Consistency** - Use the same secure URL for both local and remote access.
|
||||
* **Compliance** - Adheres to security best practices for protecting administrative interfaces.
|
||||
|
||||
To enable secure local access:
|
||||
|
||||
1. Go to _**Settings → Management Access**_.
|
||||
2. In the **CA-signed certificate** section, check for DNS Rebinding warnings.
|
||||
* If no warnings show, set **Use SSL/TLS** to **Strict**.
|
||||
* If warnings are present, review [DNS Rebinding Protection](https://docs.unraid.net/unraid-os/system-administration/secure-your-server/securing-your-connection/#dns-rebinding-protection)
|
||||
.
|
||||
|
||||
important
|
||||
|
||||
With SSL/TLS set to Strict, client devices must resolve your server’s DNS name. If your Internet connection fails, access to the WebGUI may be lost. See [Accessing your server when DNS is down](https://docs.unraid.net/unraid-os/system-administration/secure-your-server/securing-your-connection/#accessing-your-server-when-dns-is-down)
|
||||
for recovery steps.
|
||||
|
||||
* [Initial setup](https://docs.unraid.net/unraid-connect/remote-access#initial-setup)
|
||||
|
||||
* [Choosing a remote access type](https://docs.unraid.net/unraid-connect/remote-access#choosing-a-remote-access-type)
|
||||
|
||||
* [Dynamic remote access setup](https://docs.unraid.net/unraid-connect/remote-access#dynamic-remote-access-setup)
|
||||
|
||||
* [Using UPnP (Universal Plug and Play)](https://docs.unraid.net/unraid-connect/remote-access#using-upnp-universal-plug-and-play)
|
||||
|
||||
* [Using manual port forwarding](https://docs.unraid.net/unraid-connect/remote-access#using-manual-port-forwarding)
|
||||
|
||||
* [Enabling secure local access](https://docs.unraid.net/unraid-connect/remote-access#enabling-secure-local-access)
|
||||
958
docs/research/raw/release-7.0.0.md
Normal file
958
docs/research/raw/release-7.0.0.md
Normal file
@@ -0,0 +1,958 @@
|
||||
[Skip to main content](https://docs.unraid.net/unraid-os/release-notes/7.0.0#__docusaurus_skipToContent_fallback)
|
||||
|
||||
On this page
|
||||
|
||||
This version of Unraid OS includes significant improvements across all subsystems, while attempting to maintain backward compatibility as much as possible.
|
||||
|
||||
Special thanks to:
|
||||
|
||||
* @bonienl, @dlandon, @ich777, @JorgeB, @SimonF, and @Squid for their direction, support, and development work on this release
|
||||
* @bonienl for merging their **Dynamix File Manager** plugin into the webgui
|
||||
* @Squid for merging their **GUI Search** and **Unlimited Width Plugin** plugins into the webgui
|
||||
* @ludoux (**Proxy Editor** plugin) and @Squid (**Community Applications** plugin) for pioneering the work on http proxy support, of which several ideas have been incorporated into the webgui
|
||||
* @ich777 for maintaining third-party driver plugins, and for the [Tailscale Docker integration](https://docs.unraid.net/unraid-os/release-notes/7.0.0#tailscale-integration)
|
||||
|
||||
* @SimonF for significant new features in the Unraid OS VM Manager
|
||||
* @EDACerton for development of the Tailscale plugin
|
||||
|
||||
View the [contributors to Unraid on GitHub](https://github.com/unraid/webgui/graphs/contributors?from=2023-09-08&to=2025-01-08&type=c)
|
||||
with shoutouts to these community members who have contributed PRs (these are GitHub ids):
|
||||
|
||||
* almightyYantao
|
||||
* baumerdev
|
||||
* Commifreak
|
||||
* desertwitch
|
||||
* dkaser
|
||||
* donbuehl
|
||||
* FunkeCoder23
|
||||
* Garbee
|
||||
* jbtwo
|
||||
* jski
|
||||
* Leseratte10
|
||||
* Mainfrezzer
|
||||
* mtongnz
|
||||
* othyn
|
||||
* serisman
|
||||
* suzukua
|
||||
* thecode
|
||||
|
||||
And sincere thanks to everyone who has requested features, reported bugs, and tested pre-releases!
|
||||
|
||||
Upgrading[](https://docs.unraid.net/unraid-os/release-notes/7.0.0#upgrading "Direct link to Upgrading")
|
||||
|
||||
---------------------------------------------------------------------------------------------------------
|
||||
|
||||
### Known issues[](https://docs.unraid.net/unraid-os/release-notes/7.0.0#known-issues "Direct link to Known issues")
|
||||
|
||||
#### ZFS pools[](https://docs.unraid.net/unraid-os/release-notes/7.0.0#zfs-pools "Direct link to ZFS pools")
|
||||
|
||||
If you are using ZFS pools, please take note of the following:
|
||||
|
||||
* You will see a warning about unsupported features in your existing ZFS pools. This is because the version of ZFS in 7.0 is upgraded vs. 6.12 and contains new features. This warning is harmless, meaning your pool will still function normally. A button will appear letting you upgrade a pool to support the new ZFS features; however, Unraid OS does not make use of these new features, and once upgraded previous versions of Unraid OS will not be able to mount the pool.
|
||||
* Similarly, new pools created in 7.0 will not mount in 6.12 due to ZFS not supporting downgrades. There is no way around this.
|
||||
* If you decide to downgrade from 7.0 to 6.12 any previously existing hybrid pools will not be recognized upon reboot into 6.12. To work around this, first click Tools/New Config in 7.0, preserving all slots, then reboot into 6.12 and your hybrid pools should import correctly.
|
||||
* ZFS spares are not supported in this release. If you have created a hybrid pool in 6.12 which includes spares, please remove the 'spares' vdev before upgrading to v7.0. This will be fixed in a future release.
|
||||
* Currently unable to import TrueNAS pools. This will be fixed in a future release.
|
||||
* If you are using **Docker data-root=directory** on a ZFS volume, see [Add support for overlay2 storage driver](https://docs.unraid.net/unraid-os/release-notes/7.0.0#add-support-for-overlay2-storage-driver)
|
||||
.
|
||||
* We check that VM names do not include characters that are not valid for ZFS. Existing VMs are not modified but will throw an error and disable update if invalid characters are found.
|
||||
|
||||
#### General pool issues[](https://docs.unraid.net/unraid-os/release-notes/7.0.0#general-pool-issues "Direct link to General pool issues")
|
||||
|
||||
If your existing pools fail to import with _Wrong Pool State, invalid expansion_ or _Wrong pool State. Too many wrong or missing devices_, see this [forum post](https://forums.unraid.net/topic/184435-unraid-os-version-700-available/#findComment-1508012)
|
||||
.
|
||||
|
||||
#### Drive spindown issues[](https://docs.unraid.net/unraid-os/release-notes/7.0.0#drive-spindown-issues "Direct link to Drive spindown issues")
|
||||
|
||||
Drives may not spin down when connected to older Marvell drive controllers that use the sata\_mv driver (i.e. Supermicro SASLP and SAS2LP) or to older Intel controllers (i.e. ICH7-ICH10). This may be resolved by a future kernel update.
|
||||
|
||||
#### Excessive flash drive activity slows the system down[](https://docs.unraid.net/unraid-os/release-notes/7.0.0#excessive-flash-drive-activity-slows-the-system-down "Direct link to Excessive flash drive activity slows the system down")
|
||||
|
||||
If the system is running slowly, check the Main page and see if it shows significant continuous reads from the flash drive during normal operation. If so, the system may be experiencing sufficient memory pressure to push the OS out of RAM and cause it to be re-read from the flash drive. From the web terminal type:
|
||||
|
||||
touch /boot/config/fastusr
|
||||
|
||||
and then reboot. This will use around 500 MB of RAM to ensure the OS files always stay in memory. Please let us know if this helps.
|
||||
|
||||
#### New Windows changes may result in loss of access to Public shares[](https://docs.unraid.net/unraid-os/release-notes/7.0.0#new-windows-changes-may-result-in-loss-of-access-to-public-shares "Direct link to New Windows changes may result in loss of access to Public shares")
|
||||
|
||||
Due to recent security changes in Windows 11 24H2, "guest" access of Unraid public shares may not work. The easiest way around this is to create a user in Unraid with the same name as the Windows account you are using to connect. If the Unraid user password is not the same as the Windows account password, Windows will prompt for credentials.
|
||||
|
||||
If you are using a Microsoft account, it may be better to create a user in Unraid with a simple username, set a password, then in Windows go to _**Control Panel → Credential Manager → Windows credentials → Add a Windows Credential**_ and add the correct Unraid server name and credentials.
|
||||
|
||||
Alternately you can [re-enable Windows guest fallback](https://techcommunity.microsoft.com/blog/filecab/accessing-a-third-party-nas-with-smb-in-windows-11-24h2-may-fail/4154300)
|
||||
(not recommended).
|
||||
|
||||
#### Problems due to Realtek network cards[](https://docs.unraid.net/unraid-os/release-notes/7.0.0#problems-due-to-realtek-network-cards "Direct link to Problems due to Realtek network cards")
|
||||
|
||||
There have been multiple reports of issues with the Realtek driver plugin after upgrading to recent kernels. You may want to preemptively uninstall it before upgrading, or remove it afterwards if you have networking issues.
|
||||
|
||||
#### A virtual NIC is being assigned to eth0 on certain systems[](https://docs.unraid.net/unraid-os/release-notes/7.0.0#a-virtual-nic-is-being-assigned-to-eth0-on-certain-systems "Direct link to A virtual NIC is being assigned to eth0 on certain systems")
|
||||
|
||||
On some systems with IPMI KVM, a virtual NIC is being assigned to eth0 instead of the expected NIC. See this [forum post](https://forums.unraid.net/bug-reports/stable-releases/61214-no-network-after-updating-eth0-assigned-to-virtual-usb-nic-cdc-ethernet-device-with-169-ip-instead-of-mellanox-10gbe-nic-r3407/)
|
||||
for options.
|
||||
|
||||
#### Issues using Docker custom networks[](https://docs.unraid.net/unraid-os/release-notes/7.0.0#issues-using-docker-custom-networks "Direct link to Issues using Docker custom networks")
|
||||
|
||||
If certain custom Docker networks are not available for use by your Docker containers, navigate to _**Settings → Docker**_ and fix the CIDR definitions for the subnet mask and DHCP pool on those custom networks. The underlying systems have gotten more strict and invalid CIDR definitions which worked in earlier releases no longer work.
|
||||
|
||||
### Rolling back[](https://docs.unraid.net/unraid-os/release-notes/7.0.0#rolling-back "Direct link to Rolling back")
|
||||
|
||||
See the warnings under **Known Issues** above.
|
||||
|
||||
The Dynamix File Manager, GUI Search, and Unlimited Width Plugin plugins are now built into Unraid. If you rollback to an earlier version you will need to reinstall those plugins to retain their functionality.
|
||||
|
||||
If you disabled the unRAID array we recommend enabling it again before rolling back.
|
||||
|
||||
If you previously had Outgoing Proxies set up using the Proxy Editor plugin or some other mechanism, you will need to re-enable that mechanism after rolling back.
|
||||
|
||||
If you roll back after enabling the [overlay2 storage driver](https://docs.unraid.net/unraid-os/release-notes/7.0.0#add-support-for-overlay2-storage-driver)
|
||||
you will need to delete the Docker directory and let Docker re-download the image layers.
|
||||
|
||||
If you roll back after installing [Tailscale in a Docker container](https://docs.unraid.net/unraid-os/release-notes/7.0.0#tailscale-integration)
|
||||
, you will need to edit the container, make a dummy change, and **Apply** to rebuild the container without the Tailscale integration.
|
||||
|
||||
After rolling back, make a dummy change to each WireGuard config to get the settings appropriate for that version of Unraid.
|
||||
|
||||
If rolling back earlier than 6.12.14, also see the [6.12.14 release notes](https://docs.unraid.net/unraid-os/release-notes/6.12.14/#rolling-back)
|
||||
.
|
||||
|
||||
Storage[](https://docs.unraid.net/unraid-os/release-notes/7.0.0#storage "Direct link to Storage")
|
||||
|
||||
---------------------------------------------------------------------------------------------------
|
||||
|
||||
### unRAID array optional[](https://docs.unraid.net/unraid-os/release-notes/7.0.0#unraid-array-optional "Direct link to unRAID array optional")
|
||||
|
||||
You can now set the number of unRAID array slots to 'none'. This will allow the array to Start without any devices assigned to the unRAID array itself.
|
||||
|
||||
If you are running an all-SSD/NMVe server, we recommend assigning all devices to one or more ZFS/BTRFS pools, since Trim/Discard is not supported with unRAID array devices.
|
||||
|
||||
To unassign the unRAID array from an existing server, first unassign all Array slots on the Main page, and then set the Slots to 'none'.
|
||||
|
||||
For new installs, the default number of slots to reserve for the unRAID array is now 'none'.
|
||||
|
||||
### Share secondary storage may be assigned to a pool[](https://docs.unraid.net/unraid-os/release-notes/7.0.0#share-secondary-storage-may-be-assigned-to-a-pool "Direct link to Share secondary storage may be assigned to a pool")
|
||||
|
||||
Shares can now be configured with pools for both primary and secondary storage, and mover will move files between those pools. As a result of this change, the maximum number of supported pools is now 34 (previously 35).
|
||||
|
||||
### ReiserFS file system option has been disabled[](https://docs.unraid.net/unraid-os/release-notes/7.0.0#reiserfs-file-system-option-has-been-disabled "Direct link to ReiserFS file system option has been disabled")
|
||||
|
||||
Since ReiserFS is scheduled to be removed from the Linux kernel, the option to format a device with ReiserFS has also been disabled. You may use this mover function to empty an array disk prior to reformatting with another file system, see below. We will add a webGUI button for this in a future release.
|
||||
|
||||
### Using 'mover' to empty an array disk[](https://docs.unraid.net/unraid-os/release-notes/7.0.0#using-mover-to-empty-an-array-disk "Direct link to Using 'mover' to empty an array disk")
|
||||
|
||||
Removed in Unraid 7.2.1
|
||||
|
||||
This command line option was removed in Unraid 7.2.1. On newer releases, use the WebGUI method instead. See [Converting to a new file system type](https://docs.unraid.net/unraid-os/using-unraid-to/manage-storage/file-systems/#converting-to-a-new-file-system-type)
|
||||
for details.
|
||||
|
||||
Mover can now be used to empty an array disk. With the array started, run this at a web terminal:
|
||||
|
||||
mover start -e diskN |& logger & # where N is [1..28]
|
||||
|
||||
Mover will look at each top-level director (share) and then move files one-by-one to other disks in the array, following the usual config settings (include/exclude, split-level, alloc method). Move targets are restricted to just the unRAID array.
|
||||
|
||||
Watch the syslog for status. When the mover process ends, the syslog will show a list of files which could not be moved:
|
||||
|
||||
* maybe file was in-use
|
||||
* maybe file is at the top-level of /mnt/diskN
|
||||
* maybe we ran out of space
|
||||
|
||||
### Predefined shares handling[](https://docs.unraid.net/unraid-os/release-notes/7.0.0#predefined-shares-handling "Direct link to Predefined shares handling")
|
||||
|
||||
The Unraid OS Docker Manager is configured by default to use these predefined shares:
|
||||
|
||||
* system - used to store Docker image layers in a loopback image stored in system/docker.
|
||||
* appdata - used by Docker applications to store application data.
|
||||
|
||||
The Unraid OS VM Manager is configured by default to use these predefined shares:
|
||||
|
||||
* system - used to store libvirt loopback image stored in system/libvirt
|
||||
* domains - used to store VM vdisk images
|
||||
* isos - used to store ISO boot images
|
||||
|
||||
When either Docker or VMs are enabled, the required predefined shares are created if necessary according to these rules:
|
||||
|
||||
* if a pool named 'cache' is present, predefined shares are created with 'cache' as the Primary storage with no Secondary storage.
|
||||
* if no pool named 'cache' is present, the predefined shares are created with the first alphabetically present pool as Primary with no Secondary storage.
|
||||
* if no pools are present, the predefined shares are created on the unRAID array as Primary with no Secondary storage.
|
||||
|
||||
### ZFS implementation[](https://docs.unraid.net/unraid-os/release-notes/7.0.0#zfs-implementation "Direct link to ZFS implementation")
|
||||
|
||||
* Support Hybrid ZFS pools aka subpools (except 'spares')
|
||||
* Support recovery from multiple drive failures in a ZFS pool with sufficient protection
|
||||
* Support LUKS encryption on ZFS pools and drives
|
||||
* Set reasonable default profiles for new ZFS pools and subpools
|
||||
* Support upgrading ZFS pools when viewing the pool status. Note: after upgrading, the volume may not be mountable in previous versions of Unraid
|
||||
|
||||
### Allocation profiles for btrfs, zfs, and zfs subpools[](https://docs.unraid.net/unraid-os/release-notes/7.0.0#allocation-profiles-for-btrfs-zfs-and-zfs-subpools "Direct link to Allocation profiles for btrfs, zfs, and zfs subpools")
|
||||
|
||||
When a btrfs or zfs pool/subpool is created, the default storage allocation is determined by the number of slots (devices) initially assigned to the pool:
|
||||
|
||||
* for zfs main (root) pool:
|
||||
|
||||
* slots == 1 => single
|
||||
* slots == 2 => mirror (1 group of 2 devices)
|
||||
* slots >= 3 => raidz1 (1 group of 'slots' devices)
|
||||
* for zfs special, logs, and dedup subpools:
|
||||
|
||||
* slots == 1 => single
|
||||
* slots%2 == 0 => mirror (slots/2 groups of 2 devices)
|
||||
* slots%3 == 0 => mirror (slots/3 groups of 3 devices)
|
||||
* otherwise => stripe (1 group of 'slots' devices)
|
||||
* for zfs cache and spare subpools:
|
||||
|
||||
* slots == 1 => single
|
||||
* slots >= 2 => stripe (1 group of 'slots' devices)
|
||||
* for btrfs pools:
|
||||
|
||||
* slots == 1 => single
|
||||
* slots >= 2 => raid1 (ie, what btrfs called "raid1")
|
||||
|
||||
### Pool considerations[](https://docs.unraid.net/unraid-os/release-notes/7.0.0#pool-considerations "Direct link to Pool considerations")
|
||||
|
||||
When adding devices to (expanding) a single-slot pool, these rules apply:
|
||||
|
||||
For btrfs: adding one or more devices to a single-slot pool will result in converting the pool to raid1 (that is, what btrfs defines as raid1). Adding any number of devices to an existing multiple-slot btrfs pool increases the storage capacity of the pool and does not change the storage profile.
|
||||
|
||||
For zfs: adding one, two, or three devices to a single-slot pool will result in converting the pool to 2-way, 3-way, or 4-way mirror. Adding a single device to an existing 2-way or 3-way mirror converts the pool to a 3-way or 4-way mirror.
|
||||
|
||||
Changing the file system type of a pool:
|
||||
|
||||
For all single-slot pools, the file system type can be changed when array is Stopped.
|
||||
|
||||
For btrfs/zfs multi-slot pools, the file system type cannot be changed. To repurpose the devices you must click the Erase pool buton.
|
||||
|
||||
### Other features[](https://docs.unraid.net/unraid-os/release-notes/7.0.0#other-features "Direct link to Other features")
|
||||
|
||||
* Add Spin up/down devices of a pool in parallel
|
||||
* Add "Delete Pool" button, which unassigns all devices of a pool and then removes the pool. The devices themselves are not modified. This is useful when physically removing devices from a server.
|
||||
* Add ability to change encryption phrase/keyfile for LUKS encrypted disks
|
||||
* Introduce 'config/share.cfg' variable 'shareNOFILE' which sets maximum open file descriptors for shfs process (see the Known Issues)
|
||||
|
||||
VM Manager[](https://docs.unraid.net/unraid-os/release-notes/7.0.0#vm-manager "Direct link to VM Manager")
|
||||
|
||||
------------------------------------------------------------------------------------------------------------
|
||||
|
||||
### Improvements[](https://docs.unraid.net/unraid-os/release-notes/7.0.0#improvements "Direct link to Improvements")
|
||||
|
||||
Added support for VM clones, snapshots, and evdev passthru.
|
||||
|
||||
The VM editor now has a new read-only inline XML mode for advanced users, making it clear how the GUI choices affect the underlying XML used by the VM.
|
||||
|
||||
Big thanks to @SimonF for his ongoing enhancements to VMs.
|
||||
|
||||
### Other changes[](https://docs.unraid.net/unraid-os/release-notes/7.0.0#other-changes "Direct link to Other changes")
|
||||
|
||||
* **VM Tab**
|
||||
* Show all graphics cards and IP addresses assigned to VMs
|
||||
* noVNC version: 1.5
|
||||
* **VM Manager Settings**
|
||||
* Added VM autostart disable option
|
||||
* **Add/edit VM template**
|
||||
* Added "inline xml view" option
|
||||
* Support user-created VM templates
|
||||
* Add qemu ppc64 target
|
||||
* Add qemu:override support
|
||||
* Add "QEMU command-line passthrough" feature
|
||||
* Add VM multifunction support, including "PCI Other"
|
||||
* VM template enhancements for Windows VMs, including hypervclock support
|
||||
* Add "migratable" on/off option for emulated CPU
|
||||
* Add offset and timer support
|
||||
* Add no keymap option and set Virtual GPU default keyboard to use it
|
||||
* Add nogpu option
|
||||
* Add SR-IOV support for Intel iGPU
|
||||
* Add storage override to specify where images are created at add VM
|
||||
* Add SSD flag for vdisks
|
||||
* Add Unmap Support
|
||||
* Check that VM name does not include characters that are not valid for ZFS.
|
||||
* **Dashboard**
|
||||
* Add VM usage statistics to the dashboard, enable on _**Settings → VM Manager → Show VM Usage**_
|
||||
|
||||
Docker[](https://docs.unraid.net/unraid-os/release-notes/7.0.0#docker "Direct link to Docker")
|
||||
|
||||
------------------------------------------------------------------------------------------------
|
||||
|
||||
### Docker fork bomb prevention[](https://docs.unraid.net/unraid-os/release-notes/7.0.0#docker-fork-bomb-prevention "Direct link to Docker fork bomb prevention")
|
||||
|
||||
To prevent "Docker fork bombs" we introduced a new setting, _**Settings → Docker → Docker PID Limit**_, which specifies the maximum number of Process ID's which any container may have active (with default 2048).
|
||||
|
||||
If you have a container that requires more PID's you may either increase this setting or you may override for a specific container by adding, for example, `--pids-limit 3000` to the Docker template _Extra Parameters_ setting.
|
||||
|
||||
### Add support for overlay2 storage driver[](https://docs.unraid.net/unraid-os/release-notes/7.0.0#add-support-for-overlay2-storage-driver "Direct link to Add support for overlay2 storage driver")
|
||||
|
||||
If you are using **Docker data-root=directory** on a ZFS volume, we recommend that you navigate to _**Settings → Docker**_ and switch the **Docker storage driver** to **overlay2**, then delete the directory contents and let Docker re-download the image layers. The legacy **native** setting causes significant stability issues on ZFS volumes.
|
||||
|
||||
If retaining the ability to downgrade to earlier releases is important, then switch to **Docker data-root=xfs vDisk** instead.
|
||||
|
||||
### Other changes[](https://docs.unraid.net/unraid-os/release-notes/7.0.0#other-changes-1 "Direct link to Other changes")
|
||||
|
||||
* See [Tailscale integration](https://docs.unraid.net/unraid-os/release-notes/7.0.0#tailscale-integration)
|
||||
|
||||
* Allow custom registry with a port specification
|
||||
* Use "lazy unmount" unmount of docker image to prevent blocking array stop
|
||||
* Updated to address multiple security issues (CVE-2024-21626, CVE-2024-24557)
|
||||
* Docker Manager:
|
||||
* Allow users to select Container networks in the WebUI
|
||||
* Correctly identify/show non dockerman Managed containers
|
||||
* rc.docker:
|
||||
* Only stop Unraid managed containers
|
||||
* Honor restart policy from 3rd party containers
|
||||
* Set MTU of Docker Wireguard bridge to match Wireguard default MTU
|
||||
|
||||
Networking[](https://docs.unraid.net/unraid-os/release-notes/7.0.0#networking "Direct link to Networking")
|
||||
|
||||
------------------------------------------------------------------------------------------------------------
|
||||
|
||||
### Tailscale integration[](https://docs.unraid.net/unraid-os/release-notes/7.0.0#tailscale-integration "Direct link to Tailscale integration")
|
||||
|
||||
Unraid OS supports [Tailscale](https://tailscale.com/)
|
||||
through the use of a plugin created by Community Developer EDACerton. When this plugin is installed, Tailscale certificates are supported for https webGUI access, and the Tailnet URLs will be displayed on the _**Settings → Management Access**_ page.
|
||||
|
||||
And in Unraid natively, you can optionally install Tailscale in almost any Docker container, giving you the ability to share containers with specific people, access them using valid https certificates, and give them alternate routes to the Internet via Exit Nodes.
|
||||
|
||||
For more details see [the docs](https://docs.unraid.net/unraid-os/system-administration/secure-your-server/tailscale/)
|
||||
|
||||
### Support iframing the webGUI[](https://docs.unraid.net/unraid-os/release-notes/7.0.0#support-iframing-the-webgui "Direct link to Support iframing the webGUI")
|
||||
|
||||
Added "Content-Security-Policy frame-ancestors" support to automatically allow the webGUI to be iframed by domains it has certificates for. It isn't exactly supported, but additional customization is possible by using a script to modify NGINX\_CUSTOMFA in `/etc/defaults/nginx`
|
||||
|
||||
### Other changes[](https://docs.unraid.net/unraid-os/release-notes/7.0.0#other-changes-2 "Direct link to Other changes")
|
||||
|
||||
* Upgraded to OpenSSL 3
|
||||
* Allow ALL IPv4/IPv6 addresses as listener. This solves the issue when IPv4 or IPv6 addresses change dynamically
|
||||
* Samba:
|
||||
* Add ipv6 listening address only when NetBIOS is disabled
|
||||
* Fix MacOS unable to write 'flash' share and restore Time Machine compatibility (fruit changes)
|
||||
* The VPN manager now adds all interfaces to WireGuard tunnels, make a dummy change to the tunnel after upgrading or changing network settings to update WireGuard tunnel configs.
|
||||
|
||||
webGUI[](https://docs.unraid.net/unraid-os/release-notes/7.0.0#webgui "Direct link to webGUI")
|
||||
|
||||
------------------------------------------------------------------------------------------------
|
||||
|
||||
### Integrated Dynamix File Manager plugin[](https://docs.unraid.net/unraid-os/release-notes/7.0.0#integrated-dynamix-file-manager-plugin "Direct link to Integrated Dynamix File Manager plugin")
|
||||
|
||||
Click the file manager icon and navigate through your directory structure with the ability to perform common operations such as copy, move, delete, and rename files and directories.
|
||||
|
||||
### Integrated GUI Search plugin[](https://docs.unraid.net/unraid-os/release-notes/7.0.0#integrated-gui-search-plugin "Direct link to Integrated GUI Search plugin")
|
||||
|
||||
Click the search icon on the Menu bar and type the name of the setting you are looking for.
|
||||
|
||||
### Outgoing Proxy Manager[](https://docs.unraid.net/unraid-os/release-notes/7.0.0#outgoing-proxy-manager "Direct link to Outgoing Proxy Manager")
|
||||
|
||||
If you previously used the Proxy Editor plugin or had an outgoing proxy setup for CA, those will automatically be removed/imported. You can then adjust them on _**Settings → Outgoing Proxy Manager**_.
|
||||
|
||||
For more details, see the [manual](https://docs.unraid.net/unraid-os/system-administration/secure-your-server/secure-your-outgoing-comms/)
|
||||
.
|
||||
|
||||
Note: this feature is completely unrelated to any reverse proxies you may be using.
|
||||
|
||||
### Notification Agents[](https://docs.unraid.net/unraid-os/release-notes/7.0.0#notification-agents "Direct link to Notification Agents")
|
||||
|
||||
Notification agents xml are now stored as individual xml files, making it easier to add notification agents via plugin.
|
||||
|
||||
See this [sample plugin](https://github.com/Squidly271/Wxwork-sample)
|
||||
by @Squid
|
||||
|
||||
* fix: Agent notifications do not work if there is a problem with email notifications
|
||||
|
||||
### NTP Configuration[](https://docs.unraid.net/unraid-os/release-notes/7.0.0#ntp-configuration "Direct link to NTP Configuration")
|
||||
|
||||
For new installs, a single default NTP server is set to 'time.google.com'.
|
||||
|
||||
If your server is using our previous NTP defaults of time1.google.com, time2.google.com etc, you may notice some confusing NTP-related messages in your syslog. To avoid this, consider changing to our new defaults: navigate to _**Settings → Date & Time**_ and configure **NTP server 1** to be time.google.com, leaving all the others blank.
|
||||
|
||||
Of course, you are welcome to use any time servers you prefer, this is just to let you know that we have tweaked our defaults.
|
||||
|
||||
### NFS Shares[](https://docs.unraid.net/unraid-os/release-notes/7.0.0#nfs-shares "Direct link to NFS Shares")
|
||||
|
||||
We have added a few new settings to help resolve issues with NFS shares. On _**Settings → Global Share Settings**_ you can adjust the number of fuse file descriptors and on _**Settings → NFS**_ you can adjust the NFS protocol version and number of threads it uses. See the inline help for details.
|
||||
|
||||
* Added support for NFS 4.1 and 4.2, and permit NFSv4 mounts by default
|
||||
* Add a text box to configure multi-line NFS rules
|
||||
* Bug fix: nfsd doesn't restart properly
|
||||
|
||||
### Dashboard[](https://docs.unraid.net/unraid-os/release-notes/7.0.0#dashboard "Direct link to Dashboard")
|
||||
|
||||
* Add server date and time to the Dashboard; click the time to edit related settings
|
||||
* Rework the **System** tile to clarify what is being shown, including tooltips
|
||||
* Show useful content when dashboard tiles are minimized
|
||||
* Show Docker RAM usage on Dashboard
|
||||
* Add Docker RAM usage to the Dashboard
|
||||
* Rename 'Services' to 'System'
|
||||
* Fix memory leak on the Dashboard, VM Manager and Docker Manager pages
|
||||
|
||||
### SMART improvements[](https://docs.unraid.net/unraid-os/release-notes/7.0.0#smart-improvements "Direct link to SMART improvements")
|
||||
|
||||
* Display KB/MB/GB/TB written in SMART Attributes for SSDs
|
||||
* Add 'SSD endurance remaining' SMART Attribute.
|
||||
|
||||
### Diagnostics[](https://docs.unraid.net/unraid-os/release-notes/7.0.0#diagnostics "Direct link to Diagnostics")
|
||||
|
||||
* Add gpujson from gpu\_statistics to diagnostics
|
||||
* Improved anonymization of LXC logs
|
||||
* If the FCP plugin is installed, run scan during diagnostics
|
||||
* Add phplog to identify PHP errors
|
||||
* Improved anonymization of IPv6 addresses
|
||||
* Removed ps.txt because it exposed passwords in the process list
|
||||
|
||||
### Other changes[](https://docs.unraid.net/unraid-os/release-notes/7.0.0#other-changes-3 "Direct link to Other changes")
|
||||
|
||||
* Support different warning/critical temperature thresholds for HDD/SSD/NVMe drives. NVMe thresholds are set automatically by the drive itself, see _**Settings → Disk Settings**_ to set the thresholds for HDDs and SSDs. All can still be overridden for individual drives.
|
||||
* Add _**Settings → Local Console Settings**_ page with options for keyboard layout, screen blank time, and persistent Bash history
|
||||
* Add _**Settings → Power Mode**_ to optimize the system for power efficiency, balanced, or performance
|
||||
* Hover over an entry on **Tools** and **Settings** to favorite an item, and quickly get back to it on the new top-level **Favorites** page. Or disable Favorites functionality on \***Settings → Display Settings**.
|
||||
* Enhanced shutdown/restart screen showing more details of the process
|
||||
* Simplify notifications by removing submenus - View, History, and Acknowledge now apply to all notification types
|
||||
* Move date & time settings from **Display Settings** to _**Settings → Date & Time Settings**_
|
||||
* _**Settings → Display settings**_: new setting "width" to take advantage of larger screens
|
||||
* Optionally display NVMe power usage; see _**Settings → Disk Settings**_
|
||||
* Web component enhancements – downgrades, updates, and registration
|
||||
* Prevent formatting new drives as ReiserFS
|
||||
* Use atomic writes for updates of config files
|
||||
* ZFS pool settings changes:
|
||||
* Create meaningful ZFS subpool descriptions
|
||||
* Change ZFS profile text 'raid0' to 'stripe'
|
||||
* Add additional USB device passthrough smartmontools options to webgui (thanks to GitHub user jski)
|
||||
* UPS Settings page (thanks to @othyn):
|
||||
* Add the ability to set a manual UPS capacity override.
|
||||
* UserEdit: in addition to Ed25519, FIDO/U2F Ed25519, and RSA, support SSH key types DSA, ECDSA, and FIDO/U2F ECDSA
|
||||
* OpenTerminal: use shell defined for root user in /etc/passwd file
|
||||
* Always display the "delete share" option, but disable it when the share is not empty
|
||||
|
||||
Misc[](https://docs.unraid.net/unraid-os/release-notes/7.0.0#misc "Direct link to Misc")
|
||||
|
||||
------------------------------------------------------------------------------------------
|
||||
|
||||
### Other changes[](https://docs.unraid.net/unraid-os/release-notes/7.0.0#other-changes-4 "Direct link to Other changes")
|
||||
|
||||
* Replace very old 'memtest' with Memtest86+ version 6.20
|
||||
* There are also [Boot Options](https://github.com/memtest86plus/memtest86plus#boot-options)
|
||||
available
|
||||
* Remove support for legacy unraid.net certs
|
||||
* Remove "UpdateDNS" functionality since no longer using legacy non-wildcard 'unraid.net' SSL certs
|
||||
* Strip proxy info and '&' from go script
|
||||
* passwd file handling correction
|
||||
* When avahidaemon running, add name.local to hosts file
|
||||
* Remove keys.lime-technology.com from hosts file
|
||||
* rc.S: remove wsync from XFS mount to prevent WebGUI from freezing during heavy I/O on /boot
|
||||
* make\_bootable\_linux: version 1.4
|
||||
* detect if mtools is installed
|
||||
* ntp.conf: set 'logconfig' to ignore LOG\_INFO
|
||||
* Speed things up: use AVAHI reload instead of restart
|
||||
* Linux kernel: force all buggy Seagate external USB enclosures to bind to usb-storage instead of UAS driver
|
||||
* Startup improvements in rc.S script:
|
||||
* Automatically repair boot sector backup
|
||||
* Explicitly unmount all file systems if cannot continue boot
|
||||
* Detect bad root value in syslinux.cfg
|
||||
* reboot should not invoke shutdown
|
||||
* Clean up empty cgroups
|
||||
* Samba smb.conf: set "nmbd bind explicit broadcast = no" if NetBIOS enabled
|
||||
* Add fastcgi\_path\_info to default nginx configuration
|
||||
* Ensure calls to pgrep or killall are restricted to the current namespace
|
||||
* (Advanced) Added ability to apply custom udev rules from `/boot/config/udev/` upon boot
|
||||
* Bug fix: Correct handling of empty Trial.key when download fails
|
||||
* Bug fix: Fix PHP warning for UPS status
|
||||
* Create meaningful /etc/os-release file
|
||||
* Misc translation fixes
|
||||
* Bug fix: JavaScript console logging functionality restored
|
||||
* Clicking Unraid version number loads release notes from Unraid Docs website
|
||||
|
||||
Linux kernel[](https://docs.unraid.net/unraid-os/release-notes/7.0.0#linux-kernel "Direct link to Linux kernel")
|
||||
|
||||
------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
* version 6.6.68
|
||||
* CONFIG\_MISC\_RTSX\_PCI: Realtek PCI-E card reader
|
||||
* CONFIG\_MISC\_RTSX\_USB: Realtek USB card reader
|
||||
* CONFIG\_DRM\_XE: Intel Xe Graphics
|
||||
* CONFIG\_DRM\_XE\_DISPLAY: Enable display support
|
||||
* CONFIG\_AUDIT: Auditing support
|
||||
* CONFIG\_USB\_SERIAL\_OPTION: USB driver for GSM and CDMA modems
|
||||
* CONFIG\_USB\_SERIAL\_SIMPLE: USB Serial Simple Driver
|
||||
* CONFIG\_USB\_UAS: USB Attached SCSI
|
||||
* CONFIG\_NFS\_V4\_1: NFS client support for NFSv4.1
|
||||
* CONFIG\_NFS\_V4\_1\_MIGRATION: NFSv4.1 client support for migration
|
||||
* CONFIG\_NFS\_V4\_2: NFS client support for NFSv4.2
|
||||
* CONFIG\_NFS\_V4\_2\_READ\_PLUS: NFS: Enable support for the NFSv4.2 READ\_PLUS operation
|
||||
* CONFIG\_NFSD\_V4\_2\_INTER\_SSC: NFSv4.2 inter server to server COPY
|
||||
* CONFIG\_USB\_NET\_CDC\_EEM: CDC EEM support
|
||||
* CONFIG\_USB\_NET\_CDC\_NCM: CDC NCM support
|
||||
* CONFIG\_USB\_SERIAL\_XR: USB MaxLinear/Exar USB to Serial driver
|
||||
* CONFIG\_CAN: CAN bus subsystem support
|
||||
* CONFIG\_CAN\_NETLINK: CAN device drivers with Netlink support
|
||||
* CONFIG\_CAN\_GS\_USB: Geschwister Schneider UG and candleLight compatible interfaces
|
||||
* CONFIG\_SCSI\_LPFC: Emulex LightPulse Fibre Channel Support
|
||||
* CONFIG\_DRM\_VIRTIO\_GPU: Virtio GPU driver
|
||||
* CONFIG\_DRM\_VIRTIO\_GPU\_KMS: Virtio GPU driver modesetting support
|
||||
* CONFIG\_LEDS\_TRIGGERS: LED Trigger support
|
||||
* CONFIG\_LEDS\_TRIGGER\_ONESHOT: LED One-shot Trigger
|
||||
* CONFIG\_LEDS\_TRIGGER\_NETDEV: LED Netdev Trigger
|
||||
* CONFIG\_QED: QLogic QED 25/40/100Gb core driver
|
||||
* CONFIG\_QED\_SRIOV: QLogic QED 25/40/100Gb SR-IOV support
|
||||
* CONFIG\_QEDE: QLogic QED 25/40/100Gb Ethernet NIC
|
||||
* CONFIG\_SCSI\_UFSHCD: Universal Flash Storage Controller
|
||||
* CONFIG\_SCSI\_UFS\_BSG: Universal Flash Storage BSG device node
|
||||
* CONFIG\_SCSI\_UFS\_HWMON: UFS Temperature Notification
|
||||
* CONFIG\_SCSI\_UFSHCD\_PCI: PCI bus based UFS Controller support
|
||||
* CONFIG\_SCSI\_UFS\_DWC\_TC\_PCI: DesignWare pci support using a G210 Test Chip
|
||||
* CONFIG\_SCSI\_UFSHCD\_PLATFORM: Platform bus based UFS Controller support
|
||||
* CONFIG\_SCSI\_UFS\_CDNS\_PLATFORM: Cadence UFS Controller platform driver
|
||||
* CONFIG\_SCSI\_QLA\_FC: QLogic QLA2XXX Fibre Channel Support
|
||||
* CONFIG\_LIQUIDIO: Cavium LiquidIO support
|
||||
* CONFIG\_LIQUIDIO\_VF: Cavium LiquidIO VF support
|
||||
* CONFIG\_NTFS\_FS: NTFS file system support \[removed - this is the old read-only vfs module\]
|
||||
* CONFIG\_NTFS3\_FS: NTFS Read-Write file system support
|
||||
* CONFIG\_NTFS3\_LZX\_XPRESS: activate support of external compressions lzx/xpress
|
||||
* CONFIG\_NTFS3\_FS\_POSIX\_ACL: NTFS POSIX Access Control Lists
|
||||
* CONFIG\_UHID: User-space I/O driver support for HID subsystem
|
||||
* md/unraid: version 2.9.33
|
||||
* fix regression: empty slots before first occupied slot returns NO\_DEVICES
|
||||
* fix handling of device failure during rebuild/sync
|
||||
* removed XEN support
|
||||
|
||||
Base distro[](https://docs.unraid.net/unraid-os/release-notes/7.0.0#base-distro "Direct link to Base distro")
|
||||
|
||||
---------------------------------------------------------------------------------------------------------------
|
||||
|
||||
* aaa\_base: version 15.1
|
||||
* aaa\_glibc-solibs: version 2.40
|
||||
* aaa\_libraries: version 15.1
|
||||
* acl: version 2.3.2
|
||||
* acpid: version 2.0.34
|
||||
* adwaita-icon-theme: version 47.0
|
||||
* apcupsd: version 3.14.14
|
||||
* appres: version 1.0.7
|
||||
* at: version 3.2.5
|
||||
* at-spi2-atk: version 2.38.0
|
||||
* at-spi2-core: version 2.54.0
|
||||
* atk: version 2.38.0
|
||||
* attr: version 2.5.2
|
||||
* avahi: version 0.8
|
||||
* bash: version 5.2.037
|
||||
* bash-completion: version 2.16.0
|
||||
* beep: version 1.3
|
||||
* bin: version 11.1
|
||||
* bind: version 9.20.4
|
||||
* bluez-firmware: version 1.2
|
||||
* bridge-utils: version 1.7.1
|
||||
* brotli: version 1.1.0
|
||||
* btrfs-progs: version 6.12
|
||||
* bzip2: version 1.0.8
|
||||
* ca-certificates: version 20241120
|
||||
* cairo: version 1.18.2
|
||||
* celt051: version 0.5.1.3
|
||||
* cifs-utils: version 7.1
|
||||
* coreutils: version 9.5
|
||||
* cpio: version 2.15
|
||||
* cpufrequtils: version 008
|
||||
* cracklib: version 2.10.3
|
||||
* cryptsetup: version 2.7.5
|
||||
* curl: version 8.11.1
|
||||
* cyrus-sasl: version 2.1.28
|
||||
* db48: version 4.8.30
|
||||
* dbus: version 1.16.0
|
||||
* dbus-glib: version 0.112
|
||||
* dcron: version 4.5
|
||||
* dejavu-fonts-ttf: version 2.37
|
||||
* devs: version 2.3.1
|
||||
* dhcpcd: version 10.0.10
|
||||
* diffutils: version 3.10
|
||||
* dmidecode: version 3.6
|
||||
* dnsmasq: version 2.90
|
||||
* docker: version 27.0.3
|
||||
* dosfstools: version 4.2
|
||||
* e2fsprogs: version 1.47.1
|
||||
* ebtables: version 2.0.11
|
||||
* editres: version 1.0.9
|
||||
* elfutils: version 0.192
|
||||
* elogind: version 255.5
|
||||
* elvis: version 2.2\_0
|
||||
* encodings: version 1.1.0
|
||||
* etc: version 15.1
|
||||
* ethtool: version 5.19
|
||||
* eudev: version 3.2.14
|
||||
* file: version 5.46
|
||||
* findutils: version 4.10.0
|
||||
* flex: version 2.6.4
|
||||
* floppy: version 5.5
|
||||
* fluxbox: version 1.3.7
|
||||
* fontconfig: version 2.15.0
|
||||
* freeglut: version 3.6.0
|
||||
* freetype: version 2.13.3
|
||||
* fribidi: version 1.0.16
|
||||
* fuse3: version 3.16.2
|
||||
* gawk: version 5.3.1
|
||||
* gd: version 2.3.3
|
||||
* gdbm: version 1.24
|
||||
* gdk-pixbuf2: version 2.42.12
|
||||
* genpower: version 1.0.5
|
||||
* git: version 2.47.1
|
||||
* glew: version 2.2.0
|
||||
* glib2: version 2.82.4
|
||||
* glibc: version 2.40
|
||||
* glibc-zoneinfo: version 2024b
|
||||
* glu: version 9.0.3
|
||||
* gmp: version 6.3.0
|
||||
* gnutls: version 3.8.8
|
||||
* gptfdisk: version 1.0.10
|
||||
* graphite2: version 1.3.14
|
||||
* grep: version 3.11
|
||||
* gtk+3: version 3.24.43
|
||||
* gzip: version 1.13
|
||||
* harfbuzz: version 10.1.0
|
||||
* hdparm: version 9.65
|
||||
* hicolor-icon-theme: version 0.18
|
||||
* hostname: version 3.25
|
||||
* htop: version 3.3.0
|
||||
* hwloc: version 2.2.0
|
||||
* icu4c: version 76.1
|
||||
* imlib2: version 1.7.1
|
||||
* inetd: version 1.79s
|
||||
* infozip: version 6.0
|
||||
* inih: version 58
|
||||
* inotify-tools: version 4.23.9.0
|
||||
* intel-microcode: version 20241112
|
||||
* iperf3: version 3.17.1
|
||||
* iproute2: version 6.12.0
|
||||
* iptables: version 1.8.11
|
||||
* iputils: version 20240905
|
||||
* irqbalance: version 1.7.0
|
||||
* jansson: version 2.14
|
||||
* jemalloc: version 5.3.0
|
||||
* jq: version 1.6
|
||||
* json-c: version 0.18\_20240915
|
||||
* json-glib: version 1.10.6
|
||||
* kbd: version 2.7.1
|
||||
* kernel-firmware: version 20241220\_9e1d9ae
|
||||
* keyutils: version 1.6.3
|
||||
* kmod: version 33
|
||||
* krb5: version 1.21.3
|
||||
* lbzip2: version 2.5
|
||||
* less: version 668
|
||||
* libICE: version 1.1.2
|
||||
* libSM: version 1.2.5
|
||||
* libX11: version 1.8.10
|
||||
* libXau: version 1.0.12
|
||||
* libXaw: version 1.0.16
|
||||
* libXcomposite: version 0.4.6
|
||||
* libXcursor: version 1.2.3
|
||||
* libXdamage: version 1.1.6
|
||||
* libXdmcp: version 1.1.5
|
||||
* libXevie: version 1.0.3
|
||||
* libXext: version 1.3.6
|
||||
* libXfixes: version 6.0.1
|
||||
* libXfont2: version 2.0.7
|
||||
* libXfontcache: version 1.0.5
|
||||
* libXft: version 2.3.8
|
||||
* libXi: version 1.8.2
|
||||
* libXinerama: version 1.1.5
|
||||
* libXmu: version 1.2.1
|
||||
* libXpm: version 3.5.17
|
||||
* libXrandr: version 1.5.4
|
||||
* libXrender: version 0.9.12
|
||||
* libXres: version 1.2.2
|
||||
* libXt: version 1.3.1
|
||||
* libXtst: version 1.2.5
|
||||
* libXxf86dga: version 1.1.6
|
||||
* libXxf86misc: version 1.0.4
|
||||
* libXxf86vm: version 1.1.6
|
||||
* libaio: version 0.3.113
|
||||
* libarchive: version 3.7.7
|
||||
* libcap-ng: version 0.8.5
|
||||
* libcgroup: version 0.41
|
||||
* libdaemon: version 0.14
|
||||
* libdeflate: version 1.23
|
||||
* libdmx: version 1.1.5
|
||||
* libdrm: version 2.4.124
|
||||
* libedit: version 20240808\_3.1
|
||||
* libepoxy: version 1.5.10
|
||||
* libestr: version 0.1.9
|
||||
* libevdev: version 1.13.3
|
||||
* libevent: version 2.1.12
|
||||
* libfastjson: version 0.99.9
|
||||
* libffi: version 3.4.6
|
||||
* libfontenc: version 1.1.8
|
||||
* libgcrypt: version 1.11.0
|
||||
* libglvnd: version 1.7.0
|
||||
* libgpg-error: version 1.51
|
||||
* libgudev: version 238
|
||||
* libidn: version 1.42
|
||||
* libjpeg-turbo: version 3.1.0
|
||||
* liblogging: version 1.0.6
|
||||
* libmnl: version 1.0.5
|
||||
* libnetfilter\_conntrack: version 1.1.0
|
||||
* libnfnetlink: version 1.0.2
|
||||
* libnftnl: version 1.2.8
|
||||
* libnl3: version 3.11.0
|
||||
* libnvme: version 1.11.1
|
||||
* libpcap: version 1.10.5
|
||||
* libpciaccess: version 0.18.1
|
||||
* libpng: version 1.6.44
|
||||
* libpsl: version 0.21.5
|
||||
* libpthread-stubs: version 0.5
|
||||
* libseccomp: version 2.5.5
|
||||
* libssh: version 0.11.1
|
||||
* libssh2: version 1.11.1
|
||||
* libtasn1: version 4.19.0
|
||||
* libtiff: version 4.7.0
|
||||
* libtirpc: version 1.3.6
|
||||
* libtpms: version 0.9.0
|
||||
* libunistring: version 1.3
|
||||
* libunwind: version 1.8.1
|
||||
* libusb: version 1.0.27
|
||||
* libusb-compat: version 0.1.8
|
||||
* libuv: version 1.49.2
|
||||
* libvirt: version 10.7.0
|
||||
* libvirt-php: version 0.5.8
|
||||
* libwebp: version 1.5.0
|
||||
* libwebsockets: version 4.3.2
|
||||
* libx86: version 1.1
|
||||
* libxcb: version 1.17.0
|
||||
* libxcvt: version 0.1.3
|
||||
* libxkbcommon: version 1.7.0
|
||||
* libxkbfile: version 1.1.3
|
||||
* libxml2: version 2.13.5
|
||||
* libxshmfence: version 1.3.3
|
||||
* libxslt: version 1.1.42
|
||||
* libzip: version 1.11.2
|
||||
* listres: version 1.0.6
|
||||
* lm\_sensors: version 3.6.0
|
||||
* lmdb: version 0.9.33
|
||||
* logrotate: version 3.22.0
|
||||
* lshw: version B.02.19.2
|
||||
* lsof: version 4.99.4
|
||||
* lsscsi: version 0.32
|
||||
* lvm2: version 2.03.29
|
||||
* lz4: version 1.10.0
|
||||
* lzip: version 1.24.1
|
||||
* lzlib: version 1.14
|
||||
* lzo: version 2.10
|
||||
* mbuffer: version 20240107
|
||||
* mc: version 4.8.31
|
||||
* mcelog: version 202
|
||||
* mesa: version 24.2.8
|
||||
* miniupnpc: version 2.1
|
||||
* mkfontscale: version 1.2.3
|
||||
* mpfr: version 4.2.1
|
||||
* mtdev: version 1.1.7
|
||||
* nano: version 8.3
|
||||
* ncompress: version 5.0
|
||||
* ncurses: version 6.5
|
||||
* net-tools: version 20181103\_0eebece
|
||||
* nettle: version 3.10
|
||||
* network-scripts: version 15.1
|
||||
* nfs-utils: version 2.8.2
|
||||
* nghttp2: version 1.64.0
|
||||
* nghttp3: version 1.7.0
|
||||
* nginx: version 1.27.2
|
||||
* noto-fonts-ttf: version 2024.12.01
|
||||
* nss-mdns: version 0.14.1
|
||||
* ntfs-3g: version 2022.10.3
|
||||
* ntp: version 4.2.8p18
|
||||
* numactl: version 2.0.13
|
||||
* nvme-cli: version 2.11
|
||||
* oniguruma: version 6.9.9
|
||||
* openssh: version 9.9p1
|
||||
* openssl: version 3.4.0
|
||||
* ovmf: version stable202411
|
||||
* p11-kit: version 0.25.5
|
||||
* pam: version 1.6.1
|
||||
* pango: version 1.54.0
|
||||
* patch: version 2.7.6
|
||||
* pciutils: version 3.13.0
|
||||
* pcre: version 8.45
|
||||
* pcre2: version 10.44
|
||||
* perl: version 5.40.0
|
||||
* php: version 8.3.8
|
||||
* pixman: version 0.44.2
|
||||
* pkgtools: version 15.1
|
||||
* procps-ng: version 4.0.4
|
||||
* pv: version 1.6.6
|
||||
* qemu: version 9.1.0
|
||||
* qrencode: version 4.1.1
|
||||
* readline: version 8.2.013
|
||||
* reiserfsprogs: version 3.6.27
|
||||
* rpcbind: version 1.2.6
|
||||
* rsync: version 3.3.0
|
||||
* rsyslog: version 8.2102.0
|
||||
* sakura: version 3.5.0
|
||||
* samba: version 4.21.1
|
||||
* sdparm: version 1.12
|
||||
* sed: version 4.9
|
||||
* sessreg: version 1.1.3
|
||||
* setxkbmap: version 1.3.4
|
||||
* sg3\_utils: version 1.48
|
||||
* shadow: version 4.16.0
|
||||
* shared-mime-info: version 2.4
|
||||
* slim: version 1.3.6
|
||||
* smartmontools: version 7.4
|
||||
* spice: version 0.15.0
|
||||
* spirv-llvm-translator: version 19.1.2
|
||||
* sqlite: version 3.46.1
|
||||
* ssmtp: version 2.64
|
||||
* startup-notification: version 0.12
|
||||
* sudo: version 1.9.16p2
|
||||
* swtpm: version 0.7.3
|
||||
* sysfsutils: version 2.1.1
|
||||
* sysstat: version 12.7.6
|
||||
* sysvinit: version 3.12
|
||||
* sysvinit-scripts: version 15.1
|
||||
* talloc: version 2.4.2
|
||||
* tar: version 1.35
|
||||
* tcp\_wrappers: version 7.6
|
||||
* tdb: version 1.4.12
|
||||
* telnet: version 0.17
|
||||
* tevent: version 0.16.1
|
||||
* traceroute: version 2.1.6
|
||||
* transset: version 1.0.4
|
||||
* tree: version 2.1.1
|
||||
* usbredir: version 0.8.0
|
||||
* usbutils: version 018
|
||||
* userspace-rcu: version 0.15.0
|
||||
* utempter: version 1.2.1
|
||||
* util-linux: version 2.40.2
|
||||
* vbetool: version 1.2.2
|
||||
* virtiofsd: version 1.11.1
|
||||
* vsftpd: version 3.0.5
|
||||
* vte3: version 0.50.2
|
||||
* wayland: version 1.23.1
|
||||
* wget: version 1.25.0
|
||||
* which: version 2.21
|
||||
* wireguard-tools: version 1.0.20210914
|
||||
* wqy-zenhei-font-ttf: version 0.8.38\_1
|
||||
* wsdd2: version 1.8.7
|
||||
* xauth: version 1.1.3
|
||||
* xcb-util: version 0.4.1
|
||||
* xcb-util-keysyms: version 0.4.1
|
||||
* xclock: version 1.1.1
|
||||
* xdpyinfo: version 1.3.4
|
||||
* xdriinfo: version 1.0.7
|
||||
* xev: version 1.2.6
|
||||
* xf86-input-evdev: version 2.11.0
|
||||
* xf86-input-keyboard: version 1.9.0
|
||||
* xf86-input-mouse: version 1.9.3
|
||||
* xf86-input-synaptics: version 1.9.2
|
||||
* xf86-video-ast: version 1.1.5
|
||||
* xf86-video-mga: version 2.1.0
|
||||
* xf86-video-vesa: version 2.6.0
|
||||
* xfsprogs: version 6.12.0
|
||||
* xhost: version 1.0.9
|
||||
* xinit: version 1.4.2
|
||||
* xkbcomp: version 1.4.7
|
||||
* xkbevd: version 1.1.6
|
||||
* xkbutils: version 1.0.6
|
||||
* xkeyboard-config: version 2.43
|
||||
* xkill: version 1.0.6
|
||||
* xload: version 1.2.0
|
||||
* xlsatoms: version 1.1.4
|
||||
* xlsclients: version 1.1.5
|
||||
* xmessage: version 1.0.7
|
||||
* xmodmap: version 1.0.11
|
||||
* xorg-server: version 21.1.15
|
||||
* xprop: version 1.2.8
|
||||
* xrandr: version 1.5.3
|
||||
* xrdb: version 1.2.2
|
||||
* xrefresh: version 1.1.0
|
||||
* xset: version 1.2.5
|
||||
* xsetroot: version 1.1.3
|
||||
* xsm: version 1.0.6
|
||||
* xterm: version 396
|
||||
* xtrans: version 1.5.2
|
||||
* xwd: version 1.0.9
|
||||
* xwininfo: version 1.1.6
|
||||
* xwud: version 1.0.7
|
||||
* xxHash: version 0.8.3
|
||||
* xz: version 5.6.3
|
||||
* yajl: version 2.1.0
|
||||
* zfs: version 2.2.7\_6.6.68\_Unraid
|
||||
* zlib: version 1.3.1
|
||||
* zstd: version 1.5.6
|
||||
|
||||
Patches[](https://docs.unraid.net/unraid-os/release-notes/7.0.0#patches "Direct link to Patches")
|
||||
|
||||
---------------------------------------------------------------------------------------------------
|
||||
|
||||
With the [Unraid Patch plugin](https://forums.unraid.net/topic/185560-unraid-patch-plugin/)
|
||||
installed, visit _**Tools → Unraid Patch**_ to get the following patches / hot fixes:
|
||||
|
||||
* mover was not moving shares with spaces in the name from array to pool
|
||||
* File Manager: allow access to UD remote shares
|
||||
* Share Listing: tool tip showed `%20` instead of a space
|
||||
* VM Manager: fix issue with blank Discard field on vDisk
|
||||
* Include installed patches in diagnostics
|
||||
|
||||
Note: if you have the Mover Tuning plugin installed, you will be prompted to reboot in order to apply these patches.
|
||||
|
||||
* [Upgrading](https://docs.unraid.net/unraid-os/release-notes/7.0.0#upgrading)
|
||||
* [Known issues](https://docs.unraid.net/unraid-os/release-notes/7.0.0#known-issues)
|
||||
|
||||
* [Rolling back](https://docs.unraid.net/unraid-os/release-notes/7.0.0#rolling-back)
|
||||
|
||||
* [Storage](https://docs.unraid.net/unraid-os/release-notes/7.0.0#storage)
|
||||
* [unRAID array optional](https://docs.unraid.net/unraid-os/release-notes/7.0.0#unraid-array-optional)
|
||||
|
||||
* [Share secondary storage may be assigned to a pool](https://docs.unraid.net/unraid-os/release-notes/7.0.0#share-secondary-storage-may-be-assigned-to-a-pool)
|
||||
|
||||
* [ReiserFS file system option has been disabled](https://docs.unraid.net/unraid-os/release-notes/7.0.0#reiserfs-file-system-option-has-been-disabled)
|
||||
|
||||
* [Using 'mover' to empty an array disk](https://docs.unraid.net/unraid-os/release-notes/7.0.0#using-mover-to-empty-an-array-disk)
|
||||
|
||||
* [Predefined shares handling](https://docs.unraid.net/unraid-os/release-notes/7.0.0#predefined-shares-handling)
|
||||
|
||||
* [ZFS implementation](https://docs.unraid.net/unraid-os/release-notes/7.0.0#zfs-implementation)
|
||||
|
||||
* [Allocation profiles for btrfs, zfs, and zfs subpools](https://docs.unraid.net/unraid-os/release-notes/7.0.0#allocation-profiles-for-btrfs-zfs-and-zfs-subpools)
|
||||
|
||||
* [Pool considerations](https://docs.unraid.net/unraid-os/release-notes/7.0.0#pool-considerations)
|
||||
|
||||
* [Other features](https://docs.unraid.net/unraid-os/release-notes/7.0.0#other-features)
|
||||
|
||||
* [VM Manager](https://docs.unraid.net/unraid-os/release-notes/7.0.0#vm-manager)
|
||||
* [Improvements](https://docs.unraid.net/unraid-os/release-notes/7.0.0#improvements)
|
||||
|
||||
* [Other changes](https://docs.unraid.net/unraid-os/release-notes/7.0.0#other-changes)
|
||||
|
||||
* [Docker](https://docs.unraid.net/unraid-os/release-notes/7.0.0#docker)
|
||||
* [Docker fork bomb prevention](https://docs.unraid.net/unraid-os/release-notes/7.0.0#docker-fork-bomb-prevention)
|
||||
|
||||
* [Add support for overlay2 storage driver](https://docs.unraid.net/unraid-os/release-notes/7.0.0#add-support-for-overlay2-storage-driver)
|
||||
|
||||
* [Other changes](https://docs.unraid.net/unraid-os/release-notes/7.0.0#other-changes-1)
|
||||
|
||||
* [Networking](https://docs.unraid.net/unraid-os/release-notes/7.0.0#networking)
|
||||
* [Tailscale integration](https://docs.unraid.net/unraid-os/release-notes/7.0.0#tailscale-integration)
|
||||
|
||||
* [Support iframing the webGUI](https://docs.unraid.net/unraid-os/release-notes/7.0.0#support-iframing-the-webgui)
|
||||
|
||||
* [Other changes](https://docs.unraid.net/unraid-os/release-notes/7.0.0#other-changes-2)
|
||||
|
||||
* [webGUI](https://docs.unraid.net/unraid-os/release-notes/7.0.0#webgui)
|
||||
* [Integrated Dynamix File Manager plugin](https://docs.unraid.net/unraid-os/release-notes/7.0.0#integrated-dynamix-file-manager-plugin)
|
||||
|
||||
* [Integrated GUI Search plugin](https://docs.unraid.net/unraid-os/release-notes/7.0.0#integrated-gui-search-plugin)
|
||||
|
||||
* [Outgoing Proxy Manager](https://docs.unraid.net/unraid-os/release-notes/7.0.0#outgoing-proxy-manager)
|
||||
|
||||
* [Notification Agents](https://docs.unraid.net/unraid-os/release-notes/7.0.0#notification-agents)
|
||||
|
||||
* [NTP Configuration](https://docs.unraid.net/unraid-os/release-notes/7.0.0#ntp-configuration)
|
||||
|
||||
* [NFS Shares](https://docs.unraid.net/unraid-os/release-notes/7.0.0#nfs-shares)
|
||||
|
||||
* [Dashboard](https://docs.unraid.net/unraid-os/release-notes/7.0.0#dashboard)
|
||||
|
||||
* [SMART improvements](https://docs.unraid.net/unraid-os/release-notes/7.0.0#smart-improvements)
|
||||
|
||||
* [Diagnostics](https://docs.unraid.net/unraid-os/release-notes/7.0.0#diagnostics)
|
||||
|
||||
* [Other changes](https://docs.unraid.net/unraid-os/release-notes/7.0.0#other-changes-3)
|
||||
|
||||
* [Misc](https://docs.unraid.net/unraid-os/release-notes/7.0.0#misc)
|
||||
* [Other changes](https://docs.unraid.net/unraid-os/release-notes/7.0.0#other-changes-4)
|
||||
|
||||
* [Linux kernel](https://docs.unraid.net/unraid-os/release-notes/7.0.0#linux-kernel)
|
||||
|
||||
* [Base distro](https://docs.unraid.net/unraid-os/release-notes/7.0.0#base-distro)
|
||||
|
||||
* [Patches](https://docs.unraid.net/unraid-os/release-notes/7.0.0#patches)
|
||||
374
docs/research/raw/release-7.1.0.md
Normal file
374
docs/research/raw/release-7.1.0.md
Normal file
@@ -0,0 +1,374 @@
|
||||
[Skip to main content](https://docs.unraid.net/unraid-os/release-notes/7.1.0#__docusaurus_skipToContent_fallback)
|
||||
|
||||
On this page
|
||||
|
||||
This release adds wireless networking, the ability to import TrueNAS and other foreign pools, multiple enhancements to VMs, early steps toward making the webGUI responsive, and more.
|
||||
|
||||
Upgrading[](https://docs.unraid.net/unraid-os/release-notes/7.1.0#upgrading "Direct link to Upgrading")
|
||||
|
||||
---------------------------------------------------------------------------------------------------------
|
||||
|
||||
### Known issues[](https://docs.unraid.net/unraid-os/release-notes/7.1.0#known-issues "Direct link to Known issues")
|
||||
|
||||
This release has a potential data-loss issue where the recent "mover empty disk" feature does not handle split levels on shares correctly. Resolved in 7.1.2.
|
||||
|
||||
#### Plugins[](https://docs.unraid.net/unraid-os/release-notes/7.1.0#plugins "Direct link to Plugins")
|
||||
|
||||
Please upgrade all plugins, particularly Unraid Connect and the Nvidia driver.
|
||||
|
||||
For other known issues, see the [7.0.0 release notes](https://docs.unraid.net/unraid-os/release-notes/7.0.0/#known-issues)
|
||||
.
|
||||
|
||||
### Rolling back[](https://docs.unraid.net/unraid-os/release-notes/7.1.0#rolling-back "Direct link to Rolling back")
|
||||
|
||||
We are making improvements to how we distribute patches between releases, so the standalone Patch Plugin will be uninstalled from this release. If rolling back to an earlier release we'd recommend reinstalling it. More details to come.
|
||||
|
||||
If rolling back earlier than 7.0.0, also see the [7.0.0 release notes](https://docs.unraid.net/unraid-os/release-notes/7.0.0/#rolling-back)
|
||||
.
|
||||
|
||||
Changes vs. [7.0.1](https://docs.unraid.net/unraid-os/release-notes/7.0.1/)
|
||||
[](https://docs.unraid.net/unraid-os/release-notes/7.1.0#changes-vs-701 "Direct link to changes-vs-701")
|
||||
|
||||
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
### Storage[](https://docs.unraid.net/unraid-os/release-notes/7.1.0#storage "Direct link to Storage")
|
||||
|
||||
* Import foreign ZFS pools such as TrueNAS, Proxmox, Ubuntu, QNAP.
|
||||
* Import the largest partition on disk instead of the first.
|
||||
* Removing device from btrfs raid1 or zfs single-vdev mirror will now reduce pool slot count.
|
||||
|
||||
#### Other storage changes[](https://docs.unraid.net/unraid-os/release-notes/7.1.0#other-storage-changes "Direct link to Other storage changes")
|
||||
|
||||
* Fix: Disabled disks were not shown on the Dashboard.
|
||||
* Fix: Initially, only the first pool device spins down after adding a custom spin down setting.
|
||||
* Fix: Array Start was permitted if only 2 Parity devices and no Data devices.
|
||||
* Fix: The parity check notification often shows the previous parity check and not the current parity check.
|
||||
* Fix: Resolved certain instances of _Wrong pool State. Too many wrong or missing devices_ when upgrading.
|
||||
* Fix: Not possible to replace a zfs device from a smaller vdev.
|
||||
* mover:
|
||||
* Fix: Resolved issue with older share.cfg files that prevented mover from running.
|
||||
* Fix: mover would fail to recreate hard link if parent directory did not already exist.
|
||||
* Fix: mover would hang on named pipes.
|
||||
* Fix: [Using mover to empty an array disk](https://docs.unraid.net/unraid-os/release-notes/7.0.0/#using-mover-to-empty-an-array-disk)
|
||||
now only moves top level folders that have a corresponding share.cfg file, also fixed a bug that prevented the list of files _not moved_ from displaying.
|
||||
|
||||
### Networking[](https://docs.unraid.net/unraid-os/release-notes/7.1.0#networking "Direct link to Networking")
|
||||
|
||||
#### Wireless Networking[](https://docs.unraid.net/unraid-os/release-notes/7.1.0#wireless-networking "Direct link to Wireless Networking")
|
||||
|
||||
Unraid now supports WiFi! A hard wired connection is typically preferred, but if that isn't possible for your situation you can now setup WiFi.
|
||||
|
||||
For the initial setup you will either need a local keyboard/monitor (boot into GUI mode) or a wired connection. In the future, the USB Creator will be able to configure wireless networking prior to the initial boot.
|
||||
|
||||
* Access the webGUI and visit _**Settings → Network Settings → Wireless wlan0**_
|
||||
* First, enable WiFi
|
||||
* The **Regulatory Region** can generally be left to **Automatic**, but set it to your location if the network you want to connect to is not available
|
||||
* Find your preferred network and click the **Connect to WiFi network** icon
|
||||
* Fill in your WiFi password and other settings, then press **Join this network**
|
||||
* Note: if your goal is to use Docker containers over WiFi, unplug any wired connection before starting Docker
|
||||
|
||||
Additional details
|
||||
|
||||
* WPA2/WPA3 and WPA2/WPA3 Enterprise are supported, if both WPA2 and WPA3 are available then WPA3 is used.
|
||||
* Having both wired and wireless isn't recommended for long term use, it should be one or the other. But if both connections use DHCP and you (un)plug a network cable while wireless is configured, the system (excluding Docker) should adjust within 45-60 seconds.
|
||||
* Wireless chipset support: We expect to have success with modern WiFi adapters, but older adapters may not work. If your WiFi adapter isn't detected, please start a new forum thread and provide your diagnostics so it can be investigated.
|
||||
* If you want to use a USB WiFi adapter, see this list of [USB WiFi adapters that are supported with Linux in-kernel drivers](https://github.com/morrownr/USB-WiFi/blob/main/home/USB_WiFi_Adapters_that_are_supported_with_Linux_in-kernel_drivers.md)
|
||||
|
||||
* Advanced: New firmware files placed in `/boot/config/firmware/` will be copied to `/lib/firmware/` before driver modules are loaded (existing files will not be overwritten).
|
||||
|
||||
Limitations: there are networking limitations when using wireless, as a wlan can only have a single mac address.
|
||||
|
||||
* Only one wireless NIC is supported, wlan0
|
||||
* wlan0 is not able to participate in a bond
|
||||
* Docker containers
|
||||
* On _**Settings → Docker**_, note that when wireless is enabled, the system will ignore the **Docker custom network type** setting and always use **ipvlan** (macvlan is not possible because wireless does not support multiple mac addresses on a single interface)
|
||||
* _**Settings → Docker**_, **Host access to custom networks** must be disabled
|
||||
* A Docker container's **Network Type** cannot use br0/bond0/eth0
|
||||
* Docker has a limitation that it cannot participate in two networks that share the same subnet. If switching between wired and wireless, you will need to restart Docker and reconfigure all existing containers to use the new interface. We recommend setting up either wired or wireless and not switching.
|
||||
* VMs
|
||||
* We recommend setting your VM **Network Source** to **virbr0**, there are no limits to how many VMs you can run in this mode. The VMs will have full network access, the downside is they will not be accessible from the network. You can still access them via VNC to the host.
|
||||
* With some manual configuration, a single VM can be made accessible on the network:
|
||||
* Configure the VM with a static IP address
|
||||
* Configure the same IP address on the ipvtap interface, type: `ip addr add IP-ADDRESS dev shim-wlan0`
|
||||
|
||||
#### Other networking changes[](https://docs.unraid.net/unraid-os/release-notes/7.1.0#other-networking-changes "Direct link to Other networking changes")
|
||||
|
||||
* On _**Settings → Network Settings**_, you can now adjust the server's DNS settings without stopping other services first. See the top of the **eth0** section.
|
||||
* When configuring a network interface, each interface has an **Info** button showing details for the current connection.
|
||||
* When configuring a network interface, the **Desired MTU** field is disabled until you click **Enable jumbo frames**. Hover over the icon for a warning about changing the MTU, in most cases it should be left at the default setting.
|
||||
* When configuring multiple network interfaces, by default the additional interfaces will have their gateway disabled, this is a safe default that works on most networks where a single gateway is required. If an additional gateway is enabled, it will be given a higher metric than existing gateways so there are no conflicts. You can override as needed.
|
||||
* Old network interfaces are automatically removed from config files when you save changes to _**Settings → Network Settings**_.
|
||||
* Fix various issues with DHCP.
|
||||
|
||||
### VM Manager[](https://docs.unraid.net/unraid-os/release-notes/7.1.0#vm-manager "Direct link to VM Manager")
|
||||
|
||||
#### Nouveau GPU driver[](https://docs.unraid.net/unraid-os/release-notes/7.1.0#nouveau-gpu-driver "Direct link to Nouveau GPU driver")
|
||||
|
||||
The Nouveau driver for Nvidia GPUs is now included, disabled by default as we expect most users to want the Nvidia driver instead. To enable it, uninstall the Nvidia driver plugin and run `touch /boot/config/modprobe.d/nouveau.conf` then reboot.
|
||||
|
||||
#### VirGL[](https://docs.unraid.net/unraid-os/release-notes/7.1.0#virgl "Direct link to VirGL")
|
||||
|
||||
You can now share Intel and AMD GPUs between multiple Linux VMs at the same time using VirGL, the virtual 3D OpenGL renderer. When used this way, the GPU will provide accelerated graphics but will not output on the monitor. Note that this does not yet work with Windows VMs or the standard Nvidia plugin (it does work with Nvidia GPUs using the Nouveau driver though).
|
||||
|
||||
To use the virtual GPU in a Linux VM, edit the VM template and set the **Graphics Card** to **Virtual**. Then set the **VM Console Video Driver** to **Virtio(3d)** and select the appropriate **Render GPU** from the list of available GPUs (note that GPUs bound to VFIO-PCI or passed through to other VMs cannot be chosen here, and Nvidia GPUs are available only if the Nouveau driver is enabled).
|
||||
|
||||
#### QXL Virtual GPUs[](https://docs.unraid.net/unraid-os/release-notes/7.1.0#qxl-virtual-gpus "Direct link to QXL Virtual GPUs")
|
||||
|
||||
To use this feature in a VM, edit the VM template and set the **Graphics Card** to **Virtual** and the **VM Console Video Driver** to **QXL (Best)**, you can then choose how many screens it supports and how much memory to allocate to it.
|
||||
|
||||
#### CPU Pinning is optional[](https://docs.unraid.net/unraid-os/release-notes/7.1.0#cpu-pinning-is-optional "Direct link to CPU Pinning is optional")
|
||||
|
||||
CPU pinning is now optional, if no cores are pinned to a VM then the OS chooses which cores to use.
|
||||
|
||||
From _**Settings → CPU Settings**_ or when editing a VM, press **Deselect All** to unpin all cores for this VM and set the number of vCPUs to 1, increase as needed.
|
||||
|
||||
### User VM Templates[](https://docs.unraid.net/unraid-os/release-notes/7.1.0#user-vm-templates "Direct link to User VM Templates")
|
||||
|
||||
To create a user template:
|
||||
|
||||
* Edit the VM, choose **Create Modify Template** and give it a name. It will now be stored as a **User Template**, available on the **Add VM** screen.
|
||||
|
||||
To use a user template:
|
||||
|
||||
* From the VM listing, press **Add VM**, then choose the template from the **User Templates** area.
|
||||
|
||||
Import/Export
|
||||
|
||||
* From the **Add VM** screen, hover over a user template and click the arrow to export the template to a location on the server or download it.
|
||||
* On another Unraid system press **Import from file** or **Upload** to use the template.
|
||||
|
||||
#### Other VM changes[](https://docs.unraid.net/unraid-os/release-notes/7.1.0#other-vm-changes "Direct link to Other VM changes")
|
||||
|
||||
* When the **Primary** GPU is assigned as passthrough for a VM, warn that it may not work without loading a compatible vBIOS.
|
||||
* Fix: Remove confusing _Path does not exist_ message when setting up the VM service
|
||||
* Feat: Unraid VMs can now boot into GUI mode, when using the QXL video driver
|
||||
* Fix: Could not change VM icon when using XML view
|
||||
|
||||
### WebGUI[](https://docs.unraid.net/unraid-os/release-notes/7.1.0#webgui "Direct link to WebGUI")
|
||||
|
||||
#### CSS changes[](https://docs.unraid.net/unraid-os/release-notes/7.1.0#css-changes "Direct link to CSS changes")
|
||||
|
||||
As a step toward making the webGUI responsive, we have reworked the CSS. For the most part, this should not be noticeable aside from some minor color adjustments. We expect that most plugins will be fine as well, although plugin authors may want to review [this documentation](https://github.com/unraid/webgui/blob/master/emhttp/plugins/dynamix/styles/themes/README.md)
|
||||
. Responsiveness will continue to be improved in future releases.
|
||||
|
||||
If you notice alignment issues or color problems in any official theme, please let us know.
|
||||
|
||||
#### nchan out of shared memory issues[](https://docs.unraid.net/unraid-os/release-notes/7.1.0#nchan-out-of-shared-memory-issues "Direct link to nchan out of shared memory issues")
|
||||
|
||||
We have made several changes that should prevent this issue, and if we detect that it happens, we restart nginx in an attempt to automatically recover from it.
|
||||
|
||||
If your Main page never populates, or if you see "nchan: Out of shared memory" in your logs, please start a new forum thread and provide your diagnostics. You can optionally navigate to _**Settings → Display Settings**_ and disable **Allow realtime updates on inactive browsers**; this prevents your browser from requesting certain updates once it loses focus. When in this state you will see a banner saying **Live Updates Paused**, simply click on the webGUI to bring it to the foreground and re-enable live updates. Certain pages will automatically reload to ensure they are displaying the latest information.
|
||||
|
||||
#### Other WebGUI changes[](https://docs.unraid.net/unraid-os/release-notes/7.1.0#other-webgui-changes "Direct link to Other WebGUI changes")
|
||||
|
||||
* Fix: AdBlockers could prevent Dashboard from loading
|
||||
* Fix: Under certain circumstances, browser memory utilization on the Dashboard could exponentially grow
|
||||
* Fix: Prevent corrupted config file from breaking the Dashboard
|
||||
|
||||
Misc[](https://docs.unraid.net/unraid-os/release-notes/7.1.0#misc "Direct link to Misc")
|
||||
|
||||
------------------------------------------------------------------------------------------
|
||||
|
||||
### Other changes[](https://docs.unraid.net/unraid-os/release-notes/7.1.0#other-changes "Direct link to Other changes")
|
||||
|
||||
* On _**Settings → Date and Time**_ you can now sync your clock with a **PTP** server (we expect most users will continue to use **NTP**)
|
||||
* Upgraded to jQuery 3.7.1 and jQuery UI 1.14.1
|
||||
* Fix: Visiting boot.php will no longer shutdown the server
|
||||
* Fix: On the Docker tab, the dropdown menu for the last container was truncated in certain situations
|
||||
* Fix: On _**Settings → Docker**_, deleting a **Docker directory** stored on a ZFS volume now works properly
|
||||
* Fix: On boot, custom ssh configuration copied from `/boot/config/ssh/` to `/etc/ssh/` again
|
||||
* Fix: File Manager can copy files from a User Share to an Unassigned Disk mount
|
||||
* Fix: Remove confusing _Path does not exist_ message when setting up the Docker service
|
||||
* Fix: update `rc.messagebus` to correct handling of `/etc/machine-id`
|
||||
* Diagnostics
|
||||
* Fix: Improved anonymization of IPv6 addresses in diagnostics
|
||||
* Fix: Improved anonymization of user names in certain config files in diagnostics
|
||||
* Fix: diagnostics could fail due to multibyte strings in syslog
|
||||
* Feat: diagnostics now logs errors in logs/diagnostics.error.log
|
||||
|
||||
### Linux kernel[](https://docs.unraid.net/unraid-os/release-notes/7.1.0#linux-kernel "Direct link to Linux kernel")
|
||||
|
||||
* version 6.12.24-Unraid
|
||||
|
||||
* Apply: \[PATCH\] [Revert "PCI: Avoid reset when disabled via sysfs"](https://lore.kernel.org/lkml/20250414211828.3530741-1-alex.williamson@redhat.com/)
|
||||
|
||||
* CONFIG\_NR\_CPUS: increased from 256 to 512
|
||||
* CONFIG\_TEHUTI\_TN40: Tehuti Networks TN40xx 10G Ethernet adapters
|
||||
* CONFIG\_DRM\_XE: Intel Xe Graphics
|
||||
* CONFIG\_UDMABUF: userspace dmabuf misc driver
|
||||
* CONFIG\_DRM\_NOUVEAU: Nouveau (NVIDIA) cards
|
||||
* CONFIG\_DRM\_QXL: QXL virtual GPU
|
||||
* CONFIG\_EXFAT\_FS: exFAT filesystem support
|
||||
* CONFIG\_PSI: Pressure stall information tracking
|
||||
* CONFIG\_PSI\_DEFAULT\_DISABLED: Require boot parameter to enable pressure stall information tracking, i.e., `psi=1`
|
||||
* CONFIG\_ENCLOSURE\_SERVICES: Enclosure Services
|
||||
* CONFIG\_SCSI\_ENCLOSURE: SCSI Enclosure Support
|
||||
* CONFIG\_DRM\_ACCEL: Compute Acceleration Framework
|
||||
* CONFIG\_DRM\_ACCEL\_HABANALABS: HabanaLabs AI accelerators
|
||||
* CONFIG\_DRM\_ACCEL\_IVPU: Intel NPU (Neural Processing Unit)
|
||||
* CONFIG\_DRM\_ACCEL\_QAIC: Qualcomm Cloud AI accelerators
|
||||
* zfs: version 2.3.1
|
||||
* Wireless support
|
||||
|
||||
* Atheros/Qualcomm
|
||||
* Broadcom
|
||||
* Intel
|
||||
* Marvell
|
||||
* Microtek
|
||||
* Realtek
|
||||
|
||||
### Base distro updates[](https://docs.unraid.net/unraid-os/release-notes/7.1.0#base-distro-updates "Direct link to Base distro updates")
|
||||
|
||||
* aaa\_glibc-solibs: version 2.41
|
||||
* adwaita-icon-theme: version 48.0
|
||||
* at-spi2-core: version 2.56.1
|
||||
* bind: version 9.20.8
|
||||
* btrfs-progs: version 6.14
|
||||
* ca-certificates: version 20250425
|
||||
* cairo: version 1.18.4
|
||||
* cifs-utils: version 7.3
|
||||
* coreutils: version 9.7
|
||||
* dbus: version 1.16.2
|
||||
* dbus-glib: version 0.114
|
||||
* dhcpcd: version 9.5.2
|
||||
* diffutils: version 3.12
|
||||
* dnsmasq: version 2.91
|
||||
* docker: version 27.5.1
|
||||
* e2fsprogs: version 1.47.2
|
||||
* elogind: version 255.17
|
||||
* elfutils: version 0.193
|
||||
* ethtool: version 6.14
|
||||
* firefox: version 128.10 (AppImage)
|
||||
* floppy: version 5.6
|
||||
* fontconfig: version 2.16.2
|
||||
* gdbm: version 1.25
|
||||
* git: version 2.49.0
|
||||
* glib2: version 2.84.1
|
||||
* glibc: version 2.41
|
||||
* glibc-zoneinfo: version 2025b
|
||||
* grep: version 3.12
|
||||
* gtk+3: version 3.24.49
|
||||
* gzip: version 1.14
|
||||
* harfbuzz: version 11.1.0
|
||||
* htop: version 3.4.1
|
||||
* icu4c: version 77.1
|
||||
* inih: version 60
|
||||
* intel-microcode: version 20250211
|
||||
* iperf3: version 3.18
|
||||
* iproute2: version 6.14.0
|
||||
* iw: version 6.9
|
||||
* jansson: version 2.14.1
|
||||
* kernel-firmware: version 20250425\_cf6ea3d
|
||||
* kmod: version 34.2
|
||||
* less: version 674
|
||||
* libSM: version 1.2.6
|
||||
* libX11: version 1.8.12
|
||||
* libarchive: version 3.7.8
|
||||
* libcgroup: version 3.2.0
|
||||
* libedit: version 20250104\_3.1
|
||||
* libevdev: version 1.13.4
|
||||
* libffi: version 3.4.8
|
||||
* libidn: version 1.43
|
||||
* libnftnl: version 1.2.9
|
||||
* libnvme: version 1.13
|
||||
* libgpg-error: version 1.55
|
||||
* libpng: version 1.6.47
|
||||
* libseccomp: version 2.6.0
|
||||
* liburing: version 2.9
|
||||
* libusb: version 1.0.28
|
||||
* libuv: version 1.51.0
|
||||
* libvirt: version 11.2.0
|
||||
* libXft: version 2.3.9
|
||||
* libxkbcommon: version 1.9.0
|
||||
* libxml2: version 2.13.8
|
||||
* libxslt: version 1.1.43
|
||||
* libzip: version 1.11.3
|
||||
* linuxptp: version 4.4
|
||||
* lvm2: version 2.03.31
|
||||
* lzip: version 1.25
|
||||
* lzlib: version 1.15
|
||||
* mcelog: version 204
|
||||
* mesa: version 25.0.4
|
||||
* mpfr: version 4.2.2
|
||||
* nano: version 8.4
|
||||
* ncurses: version 6.5\_20250419
|
||||
* nettle: version 3.10.1
|
||||
* nghttp2: version 1.65.0
|
||||
* nghttp3: version 1.9.0
|
||||
* noto-fonts-ttf: version 2025.03.01
|
||||
* nvme-cli: version 2.13
|
||||
* oniguruma: version 6.9.10
|
||||
* openssh: version 10.0p1
|
||||
* openssl: version 3.5.0
|
||||
* ovmf: version stable202502
|
||||
* pam: version 1.7.0
|
||||
* pango: version 1.56.3
|
||||
* parted: version 3.6
|
||||
* patch: version 2.8
|
||||
* pcre2: version 10.45
|
||||
* perl: version 5.40.2
|
||||
* php: version 8.3.19
|
||||
* procps-ng: version 4.0.5
|
||||
* qemu: version 9.2.3
|
||||
* rsync: version 3.4.1
|
||||
* samba: version 4.21.3
|
||||
* shadow: version 4.17.4
|
||||
* spice: version 0.15.2
|
||||
* spirv-llvm-translator: version 20.1.0
|
||||
* sqlite: version 3.49.1
|
||||
* sysstat: version 12.7.7
|
||||
* sysvinit: version 3.14
|
||||
* talloc: version 2.4.3
|
||||
* tdb: version 1.4.13
|
||||
* tevent: version 0.16.2
|
||||
* tree: version 2.2.1
|
||||
* userspace-rcu: version 0.15.2
|
||||
* utempter: version 1.2.3
|
||||
* util-linux: version 2.41
|
||||
* virglrenderer: version 1.1.1
|
||||
* virtiofsd: version 1.13.1
|
||||
* which: version 2.23
|
||||
* wireless-regdb: version 2025.02.20
|
||||
* wpa\_supplicant: version 2.11
|
||||
* xauth: version 1.1.4
|
||||
* xf86-input-synaptics: version 1.10.0
|
||||
* xfsprogs: version 6.14.0
|
||||
* xhost: version 1.0.10
|
||||
* xinit: version 1.4.4
|
||||
* xkeyboard-config: version 2.44
|
||||
* xorg-server: version 21.1.16
|
||||
* xterm: version 398
|
||||
* xtrans: version 1.6.0
|
||||
* xz: version 5.8.1
|
||||
* zstd: version 1.5.7
|
||||
|
||||
Patches[](https://docs.unraid.net/unraid-os/release-notes/7.1.0#patches "Direct link to Patches")
|
||||
|
||||
---------------------------------------------------------------------------------------------------
|
||||
|
||||
No patches are currently available for this release.
|
||||
|
||||
* [Upgrading](https://docs.unraid.net/unraid-os/release-notes/7.1.0#upgrading)
|
||||
* [Known issues](https://docs.unraid.net/unraid-os/release-notes/7.1.0#known-issues)
|
||||
|
||||
* [Rolling back](https://docs.unraid.net/unraid-os/release-notes/7.1.0#rolling-back)
|
||||
|
||||
* [Changes vs. 7.0.1](https://docs.unraid.net/unraid-os/release-notes/7.1.0#changes-vs-701)
|
||||
* [Storage](https://docs.unraid.net/unraid-os/release-notes/7.1.0#storage)
|
||||
|
||||
* [Networking](https://docs.unraid.net/unraid-os/release-notes/7.1.0#networking)
|
||||
|
||||
* [VM Manager](https://docs.unraid.net/unraid-os/release-notes/7.1.0#vm-manager)
|
||||
|
||||
* [User VM Templates](https://docs.unraid.net/unraid-os/release-notes/7.1.0#user-vm-templates)
|
||||
|
||||
* [WebGUI](https://docs.unraid.net/unraid-os/release-notes/7.1.0#webgui)
|
||||
|
||||
* [Misc](https://docs.unraid.net/unraid-os/release-notes/7.1.0#misc)
|
||||
* [Other changes](https://docs.unraid.net/unraid-os/release-notes/7.1.0#other-changes)
|
||||
|
||||
* [Linux kernel](https://docs.unraid.net/unraid-os/release-notes/7.1.0#linux-kernel)
|
||||
|
||||
* [Base distro updates](https://docs.unraid.net/unraid-os/release-notes/7.1.0#base-distro-updates)
|
||||
|
||||
* [Patches](https://docs.unraid.net/unraid-os/release-notes/7.1.0#patches)
|
||||
348
docs/research/raw/release-7.2.0.md
Normal file
348
docs/research/raw/release-7.2.0.md
Normal file
@@ -0,0 +1,348 @@
|
||||
[Skip to main content](https://docs.unraid.net/unraid-os/release-notes/7.2.0#__docusaurus_skipToContent_fallback)
|
||||
|
||||
On this page
|
||||
|
||||
The Unraid webGUI is now responsive! The interface automatically adapts to different screen sizes, making it usable on mobile devices, tablets, and desktop monitors alike. The Unraid API is now built in, and the release also brings RAIDZ expansion, Ext2/3/4, NTFS and exFAT support, and the (optional) ability to login to the webGUI via SSO, among other features and bug fixes.
|
||||
|
||||
Note that some plugins may have visual issues in this release; please give plugin authors time to make adjustments. Plugin authors, please see this post describing [how to update your plugins to make them responsive](https://forums.unraid.net/topic/192172-responsive-webgui-plugin-migration-guide/)
|
||||
.
|
||||
|
||||
Upgrading[](https://docs.unraid.net/unraid-os/release-notes/7.2.0#upgrading "Direct link to Upgrading")
|
||||
|
||||
---------------------------------------------------------------------------------------------------------
|
||||
|
||||
For step-by-step instructions, see [Upgrading Unraid](https://docs.unraid.net/unraid-os/system-administration/maintain-and-update/upgrading-unraid/)
|
||||
. Questions about your [license](https://docs.unraid.net/unraid-os/troubleshooting/licensing-faq/#license-types--features)
|
||||
?
|
||||
|
||||
### Known issues[](https://docs.unraid.net/unraid-os/release-notes/7.2.0#known-issues "Direct link to Known issues")
|
||||
|
||||
#### Plugins[](https://docs.unraid.net/unraid-os/release-notes/7.2.0#plugins "Direct link to Plugins")
|
||||
|
||||
The Theme Engine, Dark Theme, Dynamix Date Time, and Flash Remount plugins are incompatible and will be automatically uninstalled, as will outdated versions of Unraid Connect.
|
||||
|
||||
Please upgrade all plugins, particularly Unraid Connect and the Nvidia driver, before updating. Note that some plugins may have visual issues in this release; please give plugin authors time to make adjustments.
|
||||
|
||||
For other known issues, see the [7.1.4 release notes](https://docs.unraid.net/unraid-os/release-notes/7.1.4/#known-issues)
|
||||
.
|
||||
|
||||
### Rolling back[](https://docs.unraid.net/unraid-os/release-notes/7.2.0#rolling-back "Direct link to Rolling back")
|
||||
|
||||
If rolling back earlier than 7.1.4, also see the [7.1.4 release notes](https://docs.unraid.net/unraid-os/release-notes/7.1.4/#rolling-back)
|
||||
.
|
||||
|
||||
Changes vs. [7.1.4](https://docs.unraid.net/unraid-os/release-notes/7.1.4/)
|
||||
[](https://docs.unraid.net/unraid-os/release-notes/7.2.0#changes-vs-714 "Direct link to changes-vs-714")
|
||||
|
||||
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
|
||||
|
||||
### Storage[](https://docs.unraid.net/unraid-os/release-notes/7.2.0#storage "Direct link to Storage")
|
||||
|
||||
#### ZFS RAIDZ expansion[](https://docs.unraid.net/unraid-os/release-notes/7.2.0#zfs-raidz-expansion "Direct link to ZFS RAIDZ expansion")
|
||||
|
||||
You can now expand your single-vdev RAIDZ1/2/3 pools, one drive at a time. For detailed instructions, see [RAIDZ expansion](https://docs.unraid.net/unraid-os/release-notes/7.2.0/warn/)
|
||||
.
|
||||
|
||||
* With the array running, on **_Main → Pool Devices_**, select the pool name to view the details
|
||||
* In the **Pool Status** area, check for an **Upgrade Pool** button. If one exists, you'll need to click that before continuing. Note that upgrading the pool will limit your ability to downgrade to earlier releases of Unraid (7.1 should be OK, but not 7.0)
|
||||
* Stop the array
|
||||
* On **_Main → Pool Devices_**, add a slot to the pool
|
||||
* Select the appropriate drive (must be at least as large as the smallest drive in the pool)
|
||||
* Start the array
|
||||
|
||||
#### Enhancements[](https://docs.unraid.net/unraid-os/release-notes/7.2.0#enhancements "Direct link to Enhancements")
|
||||
|
||||
* Fix: There will now be an "invalid expansion" warning if the pool needs to be upgraded first
|
||||
* Improvement: Better defaults for ZFS RAIDZ vdevs
|
||||
|
||||
#### Ext2/3/4, NTFS, and exFAT Support[](https://docs.unraid.net/unraid-os/release-notes/7.2.0#ext234-ntfs-and-exfat-support "Direct link to Ext2/3/4, NTFS, and exFAT Support")
|
||||
|
||||
Unraid now supports Ext2/3/4, NTFS, and exFAT drive formats in addition to XFS, BTRFS, and ZFS.
|
||||
|
||||
Use case: say you are a content creator with a box full of hard drives containing all of your historical videos. When first creating an array (or after running **_Tools → New Config_**), add all of your existing data drives (blank, or with data in a supported drive format) to the array. Any parity drives will be overwritten but the data drives will retain their data. You can enjoy parity protection, share them on the network, and take full advantage of everything Unraid has to offer.
|
||||
|
||||
Critical note: you can continue adding filled data drives to the array up until you start the array with a parity drive installed. Once a parity drive has been added, any new data drives will be zeroed out when they are added to the array.
|
||||
|
||||
To clarify, Unraid has always worked this way; what is new is that Unraid now supports additional drive formats.
|
||||
|
||||
Additionally, you can create single drive pools using the new formats as well.
|
||||
|
||||
* Improved the usability of the **File System Type** dropdown as the list of available options is growing
|
||||
|
||||
#### Warn about deprecated file systems[](https://docs.unraid.net/unraid-os/release-notes/7.2.0#warn-about-deprecated-file-systems "Direct link to Warn about deprecated file systems")
|
||||
|
||||
The **_Main_** page will now warn if any array or pool drives are formatted with ReiserFS; these drives need to be migrated to another filesystem ASAP as they will not be usable in a future release of Unraid (likely Unraid 7.3). Similarly, it will warn if there are drives formatted in a deprecated version of XFS; those need to be migrated before 2030. See [Converting to a new file system type](https://docs.unraid.net/unraid-os/using-unraid-to/manage-storage/file-systems/#converting-to-a-new-file-system-type)
|
||||
in the docs for details.
|
||||
|
||||
#### Other storage changes[](https://docs.unraid.net/unraid-os/release-notes/7.2.0#other-storage-changes "Direct link to Other storage changes")
|
||||
|
||||
* Improvement: Two-device ZFS pools are mirrored by default, but you can make them RAIDZ1 if you plan to expand that vdev in the future
|
||||
* Improvement: Add **File system status** to **DeviceInfo** page, showing whether a drive is mounted/unmounted and empty/not empty
|
||||
* Fix: Display issue on Main page when two pools are named similarly
|
||||
* Fix: [glibc bug](https://github.com/openzfs/zfs/issues/17629)
|
||||
which could lead to data loss with ZFS
|
||||
* Fix: BTRFS array disks with multiple filesystem signatures don't mount
|
||||
* Fix: Resolved some issues for parity disks with existing 1MiB aligned partitions
|
||||
* Fix: When stopping array, do not attempt 'umount' on array devices that are not mounted
|
||||
* Improvement: Exclusive shares may be selected for NFS export
|
||||
* Improvement: Disallow shares named `homes`, `global`, and `printers` (these have special meaning in Samba)
|
||||
* Fix: Correct handling of case-insensitive share names
|
||||
* Fix: Shares with invalid characters in names could not be deleted or modified
|
||||
* Fix: Improvements to reading from/writing to SMB Security Settings
|
||||
* Improvement: A top-level `lost+found` directory will not be shared
|
||||
* Fix: In smb.conf, set `smb3 directory leases = no` to avoid issues with the current release of Samba
|
||||
* Fix: Restore comments in default `/etc/modprobe.d/*.conf` files
|
||||
* Fix: Windows fails to create a new folder for a share with primary=ZFS pool and secondary=EXT4 array disk
|
||||
* Fix: New devices added to an existing array with valid parity should be repartitioned
|
||||
* Fix: Do not spin down devices for which SMART self-test is in progress
|
||||
* Fix: New array device not available for shares until the array is restarted
|
||||
* Fix: ZFS allocation profile always shows one vdev only
|
||||
|
||||
### Networking[](https://docs.unraid.net/unraid-os/release-notes/7.2.0#networking "Direct link to Networking")
|
||||
|
||||
#### Other networking changes[](https://docs.unraid.net/unraid-os/release-notes/7.2.0#other-networking-changes "Direct link to Other networking changes")
|
||||
|
||||
* Feature: IPv6 Docker custom networks now support Unique Local Addresses (ULA) in addition to the more standard Global Unicast Addresses (GUA), assuming your router provides both subnets when the Unraid host gets an IPv6 address via DHCP or SLAAC. To use, assign a custom static IP from the appropriate subnet to the container.
|
||||
* Fix: The **_Settings → Network Settings → Interface Rules_** page sometimes showed the wrong network driver (was just a display issue)
|
||||
|
||||
### VM Manager[](https://docs.unraid.net/unraid-os/release-notes/7.2.0#vm-manager "Direct link to VM Manager")
|
||||
|
||||
* Feature: Save PCI hardware data, warn if hardware used by VM changes
|
||||
* Feature: Support virtual sound cards in VMs
|
||||
|
||||
#### Other VM changes[](https://docs.unraid.net/unraid-os/release-notes/7.2.0#other-vm-changes "Direct link to Other VM changes")
|
||||
|
||||
* Improvement: Enhance multi-monitor support, automatically enabling spicevmc when needed
|
||||
* Feature: Upgrade to noVNC v1.6
|
||||
* Removed historical OpenElec and LibreElec VM templates
|
||||
* Fix: VM Console did not work when user shares were disabled
|
||||
* Fix: Don't allow single quotes in Domains storage path
|
||||
* Fix: Change Windows 11 VM defaults
|
||||
* Fix: Unable to view vdisk locations in languages other than English
|
||||
* Fix: No capacity warning when editing a VM to add a 2nd vdisk
|
||||
* Fix: Cdrom Bus: select IDE for i440 and SATA for q35
|
||||
|
||||
### Unraid API[](https://docs.unraid.net/unraid-os/release-notes/7.2.0#unraid-api "Direct link to Unraid API")
|
||||
|
||||
The Unraid API is now built into Unraid! The new Notifications panel is the first major feature to use it, over time the entire webGUI will be updated to use it.
|
||||
|
||||
The Unraid API is fully open source: [https://github.com/unraid/api](https://github.com/unraid/api)
|
||||
. Get started in the [API docs](https://docs.unraid.net/API/)
|
||||
.
|
||||
|
||||
The Unraid Connect plugin adds functionality which communicates with our cloud servers; it remains completely optional.
|
||||
|
||||
#### Other Unraid API changes[](https://docs.unraid.net/unraid-os/release-notes/7.2.0#other-unraid-api-changes "Direct link to Other Unraid API changes")
|
||||
|
||||
* dynamix.unraid.net 4.25.3 - [see changes](https://github.com/unraid/api/releases)
|
||||
|
||||
|
||||
### WebGUI[](https://docs.unraid.net/unraid-os/release-notes/7.2.0#webgui "Direct link to WebGUI")
|
||||
|
||||
#### Responsive CSS[](https://docs.unraid.net/unraid-os/release-notes/7.2.0#responsive-css "Direct link to Responsive CSS")
|
||||
|
||||
The Unraid webGUI is now responsive! Most screens should now work as well on your phone as they do on your desktop monitor.
|
||||
|
||||
#### Login to the webGUI via SSO[](https://docs.unraid.net/unraid-os/release-notes/7.2.0#login-to-the-webgui-via-sso "Direct link to Login to the webGUI via SSO")
|
||||
|
||||
Login to the Unraid webGUI using Single Sign-On (SSO) with your Unraid.net account or any other OIDC-compliant provider. For details on this _optional_ feature, see [OIDC Provider Setup](https://docs.unraid.net/API/oidc-provider-setup/)
|
||||
in the Docs.
|
||||
|
||||
#### Other WebGUI changes[](https://docs.unraid.net/unraid-os/release-notes/7.2.0#other-webgui-changes "Direct link to Other WebGUI changes")
|
||||
|
||||
* Feature: Add new notifications management view, access via the bell in the upper right corner of the webGUI
|
||||
* Feature: Add progress indicator to Docker / Plugin / VM popup window
|
||||
* Feature: Show countdown timer on login page when locked out due to too many incorrect login attempts
|
||||
* Feature: Add _Force Install_ button to bypass version checks when manually installing plugins
|
||||
* Feature: Add **_Tools → Open Terminal_** page; can access it by searching for "terminal". Can optionally remove Terminal button from toolbar via **_Settings → Display Settings → Show Terminal Button in header_**
|
||||
* Feature: **_Users → Root → SSH authorized keys_** now supports more formats (thanks [wandercone](https://github.com/wandercone)
|
||||
)
|
||||
* Feature: Added a welcome screen for new systems, shown after setting the root password
|
||||
* Fix: Re-enable smart test buttons after completion of test
|
||||
* Fix: Prevent webGUI from crashing when dynamix.cfg is corrupt, log any issues
|
||||
* Fix: `blob:` links shouldn't be considered external
|
||||
* Feature: Differentiate between Intel E-Cores and P-Cores on the Dashboard
|
||||
* Feature: Dashboard now gets CPU usage stats from the Unraid API
|
||||
* Fix: Dashboard: More than 1TB of RAM was not reported correctly
|
||||
* Chore: Change charting libraries on the Dashboard
|
||||
* Fix: Prevent Firefox from showing resend/cancel popup when starting array (thanks [dkaser](https://github.com/dkaser)
|
||||
)
|
||||
* Fix: File Manager: stop spinner and show error when it fails (thanks [poroyo](https://github.com/poroyo)
|
||||
)
|
||||
* Feature: Speed up rendering of Plugins and Docker pages
|
||||
* Fix: Prevent issues when clicking an external link from within a changelog
|
||||
* Improvement: Show RAM and network speed in human-readable units
|
||||
* Fix: On _**Settings → Display Settings → Font size**_, remove extreme options that break the webGUI
|
||||
|
||||
Misc[](https://docs.unraid.net/unraid-os/release-notes/7.2.0#misc "Direct link to Misc")
|
||||
|
||||
------------------------------------------------------------------------------------------
|
||||
|
||||
* Feature: Do not execute `go` script when in safe mode, create `/boot/config/go.safemode` script if needed
|
||||
* Improvement: Require authentication on `http://localhost`. This improves security and allows Tailscale Funnel to work with the webGUI. Note that when booting in GUI mode, you will now need to login again to access the webGUI.
|
||||
* Feature: Add favicon and web app manifest support
|
||||
* Feature: License key upgrades are installed automatically, without needing to restart the array
|
||||
* Feature: Thunderbolt devices will be auto-authorized when connected
|
||||
* Feature: Improvements to custom udev rules and scripts, at boot:
|
||||
* `/boot/config/udev/*.rules` are copied to `/etc/udev/rules.d/`
|
||||
* `/boot/config/udev/*.sh` are copied to `/etc/udev/scripts/` where they can be used by your custom udev rules
|
||||
* Fix: Remove support for nonworking ipv6.hash.myunraid.net URLs
|
||||
* Fix: Docker custom network creation failed when IPv6 was enabled
|
||||
* Fix: Resolve issues with high CPU load due to nchan and lsof
|
||||
* Improvement: Removed option to disable live updates on inactive browsers; should no longer be needed
|
||||
* Improvement: Better messaging around mover and "dangling links"
|
||||
* Fix: Prevent errors related to _searchLink_ when installing plugins
|
||||
* Fix: PHP warnings importing WireGuard tunnels
|
||||
* Improvement: _Europe/Kiev_ timezone renamed to _Europe/Kyiv_ to align with the IANA Time Zone Database
|
||||
* Improvement: Enhance Discord notification agent; enable/disable the agent to get the updates (thanks [mgutt](https://github.com/mgutt)
|
||||
)
|
||||
* Fix: Further anonymization of diagnostics.zip
|
||||
* Improvement: Protect WebGUI from fatal PHP errors
|
||||
* Improvement: Adjust logging during plugin installs
|
||||
* Fix: CPU Pinning for Docker containers could crash in certain instances
|
||||
* Fix: Docker NAT failure due to missing br\_netfilter
|
||||
* Fix: Scheduled mover runs not logged
|
||||
|
||||
### Linux kernel[](https://docs.unraid.net/unraid-os/release-notes/7.2.0#linux-kernel "Direct link to Linux kernel")
|
||||
|
||||
* version 6.12.54-Unraid
|
||||
* built-in: CONFIG\_EFIVAR\_FS: EFI Variable filesystem
|
||||
* CONFIG\_INTEL\_RAPL: Intel RAPL support via MSR interface
|
||||
* CONFIG\_NLS\_DEFAULT: change from "iso8859-1" to "utf8"
|
||||
* Added eMMC support:
|
||||
* CONFIG\_MMC: MMC/SD/SDIO card support
|
||||
* CONFIG\_MMC\_BLOCK: MMC block device driver
|
||||
* CONFIG\_MMC\_SDHCI: Secure Digital Host Controller Interface support
|
||||
* CONFIG\_MMC\_SDHCI\_PCI: SDHCI support on PCI bus
|
||||
* CONFIG\_MMC\_SDHCI\_ACPI: SDHCI support for ACPI enumerated SDHCI controllers
|
||||
* CONFIG\_MMC\_SDHCI\_PLTFM: SDHCI platform and OF driver helper
|
||||
|
||||
### Base distro updates[](https://docs.unraid.net/unraid-os/release-notes/7.2.0#base-distro-updates "Direct link to Base distro updates")
|
||||
|
||||
* aaa\_glibc-solibs: version 2.42
|
||||
* adwaita-icon-theme: version 48.1
|
||||
* at-spi2-core: version 2.58.1
|
||||
* bash: version 5.3.003
|
||||
* bind: version 9.20.13
|
||||
* btrfs-progs: version 6.17
|
||||
* ca-certificates: version 20251003
|
||||
* cifs-utils: version 7.4
|
||||
* coreutils: version 9.8
|
||||
* cryptsetup: version 2.8.1
|
||||
* curl: version 8.16.0
|
||||
* e2fsprogs: version 1.47.3
|
||||
* ethtool: version 6.15
|
||||
* exfatprogs: version 1.3.0
|
||||
* fontconfig: version 2.17.1
|
||||
* freetype: version 2.14.0
|
||||
* gdbm: version 1.26
|
||||
* gdk-pixbuf2: version 2.44.3
|
||||
* git: version 2.51.1
|
||||
* glib2: version 2.86.0
|
||||
* glibc: version 2.42 (build 2)
|
||||
* gnutls: version 3.8.10
|
||||
* grub: version 2.12
|
||||
* gtk+3: version 3.24.51
|
||||
* harfbuzz: version 12.1.0
|
||||
* intel-microcode: version 20250812
|
||||
* iproute2: version 6.17.0
|
||||
* inih: version 61
|
||||
* inotify-tools: version 4.25.9.0
|
||||
* iputils: version 20250605
|
||||
* iw: version 6.17
|
||||
* json-glib: version 1.10.8
|
||||
* kbd: version 2.9.0
|
||||
* kernel-firmware: version 20251018\_8b4de42
|
||||
* krb5: version 1.22.1
|
||||
* less: version 685
|
||||
* libXfixes: version 6.0.2
|
||||
* libXpresent: version 1.0.2
|
||||
* libXres: version 1.2.3
|
||||
* libarchive: version 3.8.2
|
||||
* libdrm: version 2.4.127
|
||||
* libedit: version 20251016\_3.1
|
||||
* libevdev: version 1.13.5
|
||||
* libffi: version 3.5.2
|
||||
* libgpg-error: version 1.56
|
||||
* libjpeg-turbo: version 3.1.2
|
||||
* libnftnl: version 1.3.0
|
||||
* libnvme: version 1.15
|
||||
* libpng: version 1.6.50
|
||||
* libssh: version 0.11.3
|
||||
* libtiff: version 4.7.1
|
||||
* libtirpc: version 1.3.7
|
||||
* libunwind: version 1.8.3
|
||||
* liburing: version 2.12
|
||||
* libusb: version 1.0.29
|
||||
* libwebp: version 1.6.0
|
||||
* libvirt: version 11.7.0
|
||||
* libxkbcommon: version 1.11.0
|
||||
* libxml2: version 2.14.6
|
||||
* libzip: version 1.11.4
|
||||
* lsof: version 4.99.5
|
||||
* lvm2: version 2.03.35
|
||||
* mcelog: version 207
|
||||
* mesa: version 25.2.5
|
||||
* nano: version 8.6
|
||||
* ncurses: version 6.5\_20250816
|
||||
* nettle: version 3.10.2
|
||||
* nghttp2: version 1.67.1
|
||||
* nghttp3: version 1.12.0
|
||||
* noto-fonts-ttf: version 2025.10.01
|
||||
* nvme-cli: version 2.15
|
||||
* openssh: version 10.2p1
|
||||
* openssl: version 3.5.4
|
||||
* ovmf: version unraid202502
|
||||
* p11-kit: version 0.25.10
|
||||
* pam: version 1.7.1
|
||||
* pcre2: version 10.46
|
||||
* pango: version 1.56.4
|
||||
* pciutils: version 3.14.0
|
||||
* perl: version 5.42.0
|
||||
* php: version 8.3.26-x86\_64-1\_LT with gettext extension
|
||||
* pixman: version 0.46.4
|
||||
* rclone: version 1.70.1-x86\_64-1\_SBo\_LT.tgz
|
||||
* readline: version 8.3.001
|
||||
* samba: version 4.23.2
|
||||
* shadow: version 4.18.0
|
||||
* smartmontools: version 7.5
|
||||
* spirv-llvm-translator: version 21.1.1
|
||||
* sqlite: version 3.50.4
|
||||
* sudo: version 1.9.17p2
|
||||
* sysstat: version 12.7.8
|
||||
* sysvinit: version 3.15
|
||||
* tdb: version 1.4.14
|
||||
* tevent: version 0.17.1
|
||||
* userspace-rcu: version 0.15.3
|
||||
* util-linux: version 2.41.2
|
||||
* wayland: version 1.24.0
|
||||
* wireguard-tools: version 1.0.20250521
|
||||
* wireless-regdb: version 2025.10.07
|
||||
* xdpyinfo: version 1.4.0
|
||||
* xdriinfo: version 1.0.8
|
||||
* xfsprogs: version 6.16.0
|
||||
* xkeyboard-config: version 2.46
|
||||
* xorg-server: version 21.1.18
|
||||
* xterm: version 402
|
||||
* zfs: version zfs-2.3.4\_6.12.54\_Unraid-x86\_64-2\_LT
|
||||
|
||||
* [Upgrading](https://docs.unraid.net/unraid-os/release-notes/7.2.0#upgrading)
|
||||
* [Known issues](https://docs.unraid.net/unraid-os/release-notes/7.2.0#known-issues)
|
||||
|
||||
* [Rolling back](https://docs.unraid.net/unraid-os/release-notes/7.2.0#rolling-back)
|
||||
|
||||
* [Changes vs. 7.1.4](https://docs.unraid.net/unraid-os/release-notes/7.2.0#changes-vs-714)
|
||||
* [Storage](https://docs.unraid.net/unraid-os/release-notes/7.2.0#storage)
|
||||
|
||||
* [Networking](https://docs.unraid.net/unraid-os/release-notes/7.2.0#networking)
|
||||
|
||||
* [VM Manager](https://docs.unraid.net/unraid-os/release-notes/7.2.0#vm-manager)
|
||||
|
||||
* [Unraid API](https://docs.unraid.net/unraid-os/release-notes/7.2.0#unraid-api)
|
||||
|
||||
* [WebGUI](https://docs.unraid.net/unraid-os/release-notes/7.2.0#webgui)
|
||||
|
||||
* [Misc](https://docs.unraid.net/unraid-os/release-notes/7.2.0#misc)
|
||||
* [Linux kernel](https://docs.unraid.net/unraid-os/release-notes/7.2.0#linux-kernel)
|
||||
|
||||
* [Base distro updates](https://docs.unraid.net/unraid-os/release-notes/7.2.0#base-distro-updates)
|
||||
1451
docs/research/unraid-api-crawl.md
Normal file
1451
docs/research/unraid-api-crawl.md
Normal file
File diff suppressed because it is too large
Load Diff
569
docs/research/unraid-api-exa-research.md
Normal file
569
docs/research/unraid-api-exa-research.md
Normal file
@@ -0,0 +1,569 @@
|
||||
# ExaAI Research Findings: Unraid API Ecosystem
|
||||
|
||||
**Date:** 2026-02-07
|
||||
**Research Topic:** Unraid API Ecosystem - Architecture, Authentication, GraphQL Schema, Integrations, and MCP Server
|
||||
**Specialist:** ExaAI Semantic Search
|
||||
|
||||
## Methodology
|
||||
|
||||
- **Total queries executed:** 22
|
||||
- **Total unique URLs discovered:** 55+
|
||||
- **Sources deep-read:** 14
|
||||
- **Search strategy:** Multi-perspective semantic search covering official docs, source code analysis, community integrations, DeepWiki architecture analysis, feature roadmap, and third-party client libraries
|
||||
|
||||
---
|
||||
|
||||
## Key Findings
|
||||
|
||||
### 1. Unraid API Overview and Availability
|
||||
|
||||
The Unraid API provides a **GraphQL interface** for programmatic interaction with Unraid servers. Starting with **Unraid 7.2** (released 2025-10-29), the API comes **built into the operating system** with no plugin installation required ([source](https://docs.unraid.net/API/)).
|
||||
|
||||
Key capabilities include:
|
||||
- Automation, monitoring, and integration through a modern, strongly-typed API
|
||||
- Multiple authentication methods (API keys, session cookies, SSO/OIDC)
|
||||
- Comprehensive system coverage
|
||||
- Built-in developer tools including a GraphQL Sandbox
|
||||
|
||||
For **pre-7.2 versions**, the API is available via the Unraid Connect plugin from Community Applications. Users do **not** need to sign in to Unraid Connect to use the API locally ([source](https://docs.unraid.net/API/)).
|
||||
|
||||
The API was announced alongside Unraid 7.2.0 which also brought RAIDZ expansion, responsive WebGUI, and SSO login capabilities ([source](https://docs.unraid.net/unraid-os/release-notes/7.2.0/)).
|
||||
|
||||
### 2. Architecture and Technology Stack
|
||||
|
||||
The Unraid API is organized as a **pnpm workspace monorepo** containing 8+ packages ([source](https://deepwiki.com/unraid/api), [source](https://github.com/unraid/api)):
|
||||
|
||||
**Core Packages:**
|
||||
| Package | Location | Purpose |
|
||||
|---------|----------|---------|
|
||||
| `@unraid/api` | `api/` | NestJS-based GraphQL server, service layer, OS integration |
|
||||
| `@unraid/web` | `web/` | Vue 3 web application, Apollo Client integration |
|
||||
| `@unraid/ui` | `unraid-ui/` | Reusable Vue components, web component builds |
|
||||
| `@unraid/shared` | `packages/unraid-shared/` | Shared TypeScript types, utilities, constants |
|
||||
| `unraid-api-plugin-connect` | `packages/unraid-api-plugin-connect/` | Remote access, UPnP, dynamic DNS |
|
||||
|
||||
**Backend Technology Stack:**
|
||||
- **NestJS 11.1.6** with **Fastify 5.5.0** HTTP server
|
||||
- **Apollo Server 4.12.2** for GraphQL
|
||||
- **GraphQL 16.11.0** reference implementation
|
||||
- **graphql-ws 6.0.6** for WebSocket subscriptions
|
||||
- **TypeScript 5.9.2** (77.4% of codebase)
|
||||
- **Redux Toolkit** for state management
|
||||
- **Casbin 5.38.0** for RBAC authorization
|
||||
- **PM2 6.0.8** for process management
|
||||
- **dockerode 4.0.7** for Docker container management
|
||||
- **@unraid/libvirt 2.1.0** for VM lifecycle control
|
||||
- **systeminformation 5.27.8** for hardware metrics
|
||||
- **chokidar 4.0.3** for file watching
|
||||
|
||||
**Frontend Technology Stack:**
|
||||
- **Vue 3.5.20** with Composition API
|
||||
- **Apollo Client 3.14.0** with WebSocket subscriptions
|
||||
- **Pinia 3.0.3** for state management
|
||||
- **TailwindCSS 4.1.12** for styling
|
||||
- **Vite 7.1.3** as build tool
|
||||
|
||||
**Current Version:** 4.29.2 (core packages) ([source](https://deepwiki.com/unraid/api))
|
||||
|
||||
### 3. GraphQL API Layer
|
||||
|
||||
The API uses a **code-first approach** where the GraphQL schema is generated automatically from TypeScript decorators ([source](https://deepwiki.com/unraid/api/2.1-graphql-api-layer)):
|
||||
|
||||
- `@ObjectType()` - Defines GraphQL object types
|
||||
- `@InputType()` - Specifies input types for mutations
|
||||
- `@Resolver()` - Declares resolver classes
|
||||
- `@Query()`, `@Mutation()`, `@Subscription()` - Operation decorators
|
||||
|
||||
**Schema Generation Pipeline:**
|
||||
```
|
||||
TypeScript Classes with Decorators
|
||||
-> @nestjs/graphql processes decorators
|
||||
-> Schema generated at runtime
|
||||
-> @graphql-codegen extracts schema
|
||||
-> TypedDocumentNode generated for frontend
|
||||
-> Type-safe operations in Vue 3 client
|
||||
```
|
||||
|
||||
**Key Configuration:**
|
||||
- **autoSchemaFile**: Code-first generation enabled
|
||||
- **introspection**: Always enabled (controlled by security guards)
|
||||
- **subscriptions**: WebSocket via `graphql-ws` protocol
|
||||
- **fieldResolverEnhancers**: Guards enabled for field-level authorization
|
||||
- **transformSchema**: Applies permission checks and conditional field removal
|
||||
|
||||
The GraphQL Sandbox is accessible at `http://YOUR_SERVER_IP/graphql` when enabled through Settings -> Management Access -> Developer Options, or via CLI: `unraid-api developer --sandbox true` ([source](https://docs.unraid.net/API/how-to-use-the-api/)).
|
||||
|
||||
**Live API documentation** is available through Apollo GraphQL Studio for exploring the complete schema ([source](https://docs.unraid.net/API/how-to-use-the-api/)).
|
||||
|
||||
### 4. Authentication and Authorization
|
||||
|
||||
The API implements a **multi-layered security architecture** separating authentication from authorization ([source](https://deepwiki.com/unraid/api/2.2-authentication-and-authorization)):
|
||||
|
||||
#### Authentication Methods
|
||||
|
||||
1. **API Keys** - Programmatic access via `x-api-key` HTTP header
|
||||
- Created via WebGUI (Settings -> Management Access -> API Keys) or CLI
|
||||
- Validated using `passport-http-header-strategy`
|
||||
- JWT verification via `jose 6.0.13`
|
||||
|
||||
2. **Session Cookies** - Automatic when signed into WebGUI
|
||||
|
||||
3. **SSO/OIDC** - External identity providers via `openid-client 6.6.4`
|
||||
- Supported providers: Unraid.net, Google, Microsoft/Azure AD, Keycloak, Authelia, Authentik, Okta
|
||||
- Configuration via Settings -> Management Access -> API -> OIDC
|
||||
- Two authorization modes: Simple (email domain/address) and Advanced (claim-based rules)
|
||||
([source](https://docs.unraid.net/API/oidc-provider-setup/))
|
||||
|
||||
#### API Key Authorization Flow for Third-Party Apps
|
||||
|
||||
Applications can request API access via a self-service flow ([source](https://docs.unraid.net/API/api-key-app-developer-authorization-flow/)):
|
||||
|
||||
```
|
||||
https://[unraid-server]/ApiKeyAuthorize?name=MyApp&&scopes=docker:read,vm:*&&redirect_uri=https://myapp.com/callback&&state=abc123
|
||||
```
|
||||
|
||||
**Scope Format:** `resource:action` pattern
|
||||
- Resources: docker, vm, system, share, user, network, disk
|
||||
- Actions: create, read, update, delete, * (full access)
|
||||
|
||||
#### Programmatic API Key Management
|
||||
|
||||
CLI-based CRUD operations for automation ([source](https://docs.unraid.net/API/programmatic-api-key-management/)):
|
||||
|
||||
```bash
|
||||
# Create with granular permissions
|
||||
unraid-api apikey --create \
|
||||
--name "monitoring key" \
|
||||
--permissions "DOCKER:READ_ANY,ARRAY:READ_ANY" \
|
||||
--description "Read-only access" --json
|
||||
|
||||
# Delete
|
||||
unraid-api apikey --delete --name "monitoring key"
|
||||
```
|
||||
|
||||
**Available Roles:** ADMIN, CONNECT, VIEWER, GUEST
|
||||
|
||||
**Available Resources:** ACTIVATION_CODE, API_KEY, ARRAY, CLOUD, CONFIG, CONNECT, DOCKER, FLASH, INFO, LOGS, NETWORK, NOTIFICATIONS, OS, SERVICES, SHARE, VMS
|
||||
|
||||
**Available Actions:** CREATE_ANY, CREATE_OWN, READ_ANY, READ_OWN, UPDATE_ANY, UPDATE_OWN, DELETE_ANY, DELETE_OWN
|
||||
|
||||
#### RBAC Implementation
|
||||
|
||||
- **Casbin 5.38.0** with **nest-authz 2.17.0** for policy-based access control
|
||||
- **accesscontrol 2.2.1** maintains the permission matrix
|
||||
- **@UsePermissions() directive** provides field-level authorization by removing protected fields from the GraphQL schema dynamically
|
||||
- **Rate limiting:** 100 requests per 10 seconds via `@nestjs/throttler 6.4.0`
|
||||
- **Security headers:** `@fastify/helmet 13.0.1` with minimal CSP
|
||||
|
||||
### 5. CLI Reference
|
||||
|
||||
All commands follow the pattern: `unraid-api <command> [options]` ([source](https://docs.unraid.net/API/cli)):
|
||||
|
||||
| Command | Purpose |
|
||||
|---------|---------|
|
||||
| `unraid-api start [--log-level <level>]` | Start API service |
|
||||
| `unraid-api stop [--delete]` | Stop API service |
|
||||
| `unraid-api restart` | Restart API service |
|
||||
| `unraid-api logs [-l <lines>]` | View logs (default 100 lines) |
|
||||
| `unraid-api config` | Display configuration |
|
||||
| `unraid-api switch-env [-e <env>]` | Toggle production/staging |
|
||||
| `unraid-api developer [--sandbox true/false]` | Developer mode |
|
||||
| `unraid-api apikey [options]` | API key management |
|
||||
| `unraid-api sso add-user/remove-user/list-users` | SSO user management |
|
||||
| `unraid-api sso validate-token <token>` | Token validation |
|
||||
| `unraid-api report [-r] [-j]` | Generate system report |
|
||||
|
||||
Log levels: trace, debug, info, warn, error, fatal
|
||||
|
||||
### 6. Docker Container Management
|
||||
|
||||
The Docker Management Service provides comprehensive container lifecycle management through GraphQL ([source](https://deepwiki.com/unraid/api/2.4.2-notification-system)):
|
||||
|
||||
**Container Lifecycle Mutations:**
|
||||
- `start(id)` - Start a stopped container
|
||||
- `stop(id)` - Stop with 10-second timeout
|
||||
- `pause(id)` / `unpause(id)` - Suspend/resume
|
||||
- `removeContainer(id, options)` - Remove container and optionally images
|
||||
- `updateContainer(id)` - Upgrade to latest image version
|
||||
- `updateAllContainers()` - Batch update all containers
|
||||
|
||||
**Container Data Enrichment:**
|
||||
- Canonical name extraction via `autostartService`
|
||||
- Auto-start configuration details
|
||||
- Port deduplication (IPv4/IPv6)
|
||||
- LAN-accessible URL computation
|
||||
- State normalization: RUNNING, PAUSED, EXITED
|
||||
|
||||
**Update Detection:**
|
||||
- Compares local image digests against remote registry manifests
|
||||
- Returns `UpdateStatus`: UP_TO_DATE, UPDATE_AVAILABLE, REBUILD_READY, UNKNOWN
|
||||
- Legacy PHP script integration for status computation
|
||||
|
||||
**Real-Time Event Monitoring:**
|
||||
- Watches `/var/run` for Docker socket via chokidar
|
||||
- Filters: start, stop, die, kill, pause, unpause, restart, oom events
|
||||
- Publishes to `PUBSUB_CHANNEL.INFO` for subscription updates
|
||||
|
||||
**Container Organizer:**
|
||||
- Folder-based hierarchical organization
|
||||
- Operations: createFolder, setFolderChildren, deleteEntries, moveEntriesToFolder, renameFolder
|
||||
- Behind `ENABLE_NEXT_DOCKER_RELEASE` feature flag
|
||||
|
||||
**Statistics Streaming:**
|
||||
- Real-time resource metrics via subscriptions
|
||||
- CPU percent, memory usage/percent, network I/O, block I/O
|
||||
- Auto-start/stop streams based on subscription count
|
||||
|
||||
### 7. VM Management
|
||||
|
||||
VM management uses the `@unraid/libvirt` package (v2.1.0) for QEMU/KVM integration ([source](https://github.com/unraid/libvirt), [source](https://deepwiki.com/unraid/api)):
|
||||
|
||||
- Domain state management (start, stop, pause, resume)
|
||||
- Snapshot creation and restoration
|
||||
- Domain XML inspection
|
||||
- Retry logic (up to 2 minutes) for libvirt daemon initialization
|
||||
|
||||
Unraid 7.x enhancements include VM clones, snapshots, user-created VM templates, inline XML editing, and advanced GPU passthrough ([source](https://docs.unraid.net/unraid-os/manual/vm/vm-management/)).
|
||||
|
||||
### 8. Storage and Array Management
|
||||
|
||||
**Array Operations** (available via Python client library):
|
||||
- `start_array()` / `stop_array()`
|
||||
- `start_parity_check(correct)` / `pause_parity_check()` / `resume_parity_check()` / `cancel_parity_check()`
|
||||
- `spin_up_disk(id)` / `spin_down_disk(id)`
|
||||
|
||||
**GraphQL Queries for Storage:**
|
||||
|
||||
```graphql
|
||||
# Disk Information
|
||||
{ disks { device name type size vendor temperature smartStatus } }
|
||||
|
||||
# Share Information
|
||||
{ shares { name comment free size used } }
|
||||
|
||||
# Array Status (from official docs example)
|
||||
{ array { state capacity { free used total } disks { name size status temp } } }
|
||||
```
|
||||
|
||||
([source](https://deepwiki.com/domalab/unraid-api-client/4.3-network-and-storage-queries), [source](https://docs.unraid.net/API/how-to-use-the-api/))
|
||||
|
||||
**ZFS Support:** Unraid supports ZFS pools with automatic data integrity, built-in RAID (mirrors, RAIDZ), snapshots, and send/receive ([source](https://docs.unraid.net/unraid-os/advanced-configurations/optimize-storage/zfs-storage/)).
|
||||
|
||||
### 9. Network Management
|
||||
|
||||
**Network Query Fields:**
|
||||
|
||||
| Field | Type | Description |
|
||||
|-------|------|-------------|
|
||||
| iface | String | Interface identifier |
|
||||
| ifaceName | String | Interface name |
|
||||
| ipv4/ipv6 | String | IP addresses |
|
||||
| mac | String | MAC address |
|
||||
| operstate | String | Operational state (up/down) |
|
||||
| type | String | Interface type |
|
||||
| duplex | String | Duplex mode |
|
||||
| speed | Number | Interface speed |
|
||||
| accessUrls | Array | Access URLs for the interface |
|
||||
|
||||
```graphql
|
||||
{ network { iface ifaceName ipv4 ipv6 mac operstate type duplex speed accessUrls { type name ipv4 ipv6 } } }
|
||||
```
|
||||
|
||||
([source](https://deepwiki.com/domalab/unraid-api-client/4.3-network-and-storage-queries))
|
||||
|
||||
### 10. Notification System
|
||||
|
||||
The Unraid API exposes a notification system with the following features ([source](https://deepwiki.com/unraid/api)):
|
||||
|
||||
- File-based notifications stored in `/unread/` and `/archive/` directories
|
||||
- GraphQL queries for notification overview (counts by type)
|
||||
- Notification listing with filters
|
||||
- Notification agents: email, Discord, Slack (built-in); custom agents via scripts
|
||||
|
||||
Community solutions for additional notification targets include ntfy.sh, Matrix, and webhook-based approaches ([source](https://forums.unraid.net/topic/88464-webhook-notification-method/), [source](https://lder.dev/posts/ntfy-Notifications-With-unRAID/)).
|
||||
|
||||
### 11. WebSocket Subscriptions (Real-Time)
|
||||
|
||||
The API implements real-time subscriptions via the `graphql-ws` protocol (v6.0.6) ([source](https://deepwiki.com/unraid/api/2.1-graphql-api-layer)):
|
||||
|
||||
- **PubSub Engine:** `graphql-subscriptions@3.0.0` for event publishing
|
||||
- **Transport:** WebSocket via `graphql-ws` protocol
|
||||
- **Trigger:** Redux store updates from file watchers propagate to subscribed clients
|
||||
- **Available subscriptions include:**
|
||||
- Container state changes
|
||||
- Container statistics (CPU, memory, I/O)
|
||||
- System metrics updates
|
||||
- Array status changes
|
||||
|
||||
The subscription system is event-driven: file changes on disk (detected by chokidar) -> Redux store update -> PubSub event -> WebSocket push to clients.
|
||||
|
||||
### 12. MCP Server Integrations
|
||||
|
||||
**jmagar/unraid-mcp** (this project) is the primary MCP server for Unraid ([source](https://glama.ai/mcp/servers/@jmagar/unraid-mcp), [source](https://mcpmarket.com/server/unraid)):
|
||||
|
||||
- Python-based MCP server using FastMCP framework
|
||||
- 26 tools for comprehensive Unraid management
|
||||
- Read-only access by default for safety
|
||||
- Listed on Glama, MCP Market, MCPServers.com, LangDB, UBOS, JuheAPI
|
||||
- 21 GitHub stars
|
||||
- Communicates via stdio transport
|
||||
|
||||
**Alternative MCP implementations:**
|
||||
- `lwsinclair/unraid-mcp` - Another MCP implementation ([source](https://github.com/lwsinclair/unraid-mcp))
|
||||
- `ruaan-deysel/unraid-management-agent` - Go-based plugin with REST API + WebSocket + MCP integration ([source](https://github.com/ruaan-deysel/unraid-management-agent))
|
||||
|
||||
### 13. Third-Party Client Libraries
|
||||
|
||||
#### Python Client: `unraid-api` (PyPI)
|
||||
|
||||
**Author:** DomaLab (Ruaan Deysel)
|
||||
**Version:** 1.3.1 (as of Jan 2026)
|
||||
**Requirements:** Python 3.11+, Unraid 7.1.4+, API v4.21.0+
|
||||
|
||||
Features ([source](https://github.com/domalab/unraid-api-client), [source](https://unraid-api.domalab.net/)):
|
||||
- Async/await with aiohttp
|
||||
- Home Assistant ready (accepts external ClientSession)
|
||||
- Pydantic models for all responses
|
||||
- SSL auto-discovery
|
||||
- Redirect handling for myunraid.net
|
||||
|
||||
**Supported Operations:**
|
||||
- Docker: start/stop/restart containers
|
||||
- VMs: start/stop/force_stop/pause/resume
|
||||
- Array: start/stop, parity check (start/pause/resume/cancel), disk spin up/down
|
||||
- System: metrics, shares, UPS, services, plugins, log files, notifications
|
||||
- Custom GraphQL queries
|
||||
|
||||
#### Home Assistant Integration
|
||||
|
||||
`chris-mc1/unraid_api` (60 stars) - Full Home Assistant integration using the local GraphQL API ([source](https://github.com/chris-mc1/unraid_api)):
|
||||
- Monitors array state, disk status, temperatures
|
||||
- Docker container status
|
||||
- Network information
|
||||
- HACS compatible
|
||||
|
||||
#### Homey Smart Home
|
||||
|
||||
Unraid API integration available for the Homey smart home platform ([source](https://homey.app/no-no/app/community.unraid.api/Unraid-API/)).
|
||||
|
||||
#### Legacy APIs (Pre-GraphQL)
|
||||
|
||||
- `ElectricBrainUK/UnraidAPI` (127 stars) - Original Node.js API using web scraping ([source](https://github.com/ElectricBrainUK/UnraidAPI))
|
||||
- `BoKKeR/UnraidAPI-RE` (68 stars) - Reverse-engineered Node.js API ([source](https://github.com/BoKKeR/UnraidAPI-RE))
|
||||
- `ridenui/unraid` - TypeScript client via SSH ([source](https://github.com/ridenui/unraid))
|
||||
|
||||
### 14. Unraid Connect and Remote Access
|
||||
|
||||
Unraid Connect provides cloud-enabled server management ([source](https://docs.unraid.net/connect/), [source](https://unraid.net/connect)):
|
||||
|
||||
- **Dynamic Remote Access:** Toggle on/off server accessibility via UPnP
|
||||
- **Server Management:** Manage multiple servers from Connect web UI
|
||||
- **Deep Linking:** Links to relevant WebGUI sections
|
||||
- **Online Flash Backup:** Cloud-based configuration backups
|
||||
- **Real-time Monitoring:** Server health and resource usage monitoring
|
||||
- **Notifications:** Server health, storage status, critical events
|
||||
|
||||
The Connect plugin (`unraid-api-plugin-connect`) handles remote access, UPnP, dynamic DNS, and Mothership API communication ([source](https://deepwiki.com/unraid/api)).
|
||||
|
||||
### 15. Plugin Architecture
|
||||
|
||||
The API supports a plugin system for extending functionality ([source](https://deepwiki.com/unraid/api)):
|
||||
|
||||
- Plugins are NPM packages implementing the `UnraidPlugin` interface
|
||||
- Access to NestJS dependency injection
|
||||
- Can extend the GraphQL schema
|
||||
- Dynamic loading via `PluginLoaderService` at runtime
|
||||
- `@unraid/create-api-plugin` CLI scaffolding tool available
|
||||
- Plugin documentation at `api/docs/developer/api-plugins.md`
|
||||
|
||||
### 16. Feature Bounty Program
|
||||
|
||||
Unraid launched a **Feature Bounty Program** in September 2025 ([source](https://unraid.net/blog/api-feature-bounty-program)):
|
||||
|
||||
- Community developers implement specific API features for monetary rewards
|
||||
- Bounty board: `github.com/orgs/unraid/projects/3/views/1`
|
||||
- Accelerates feature development beyond core team capacity
|
||||
|
||||
**Notable Open Bounty: System Temperature Monitoring** ([source](https://github.com/unraid/api/issues/1597)):
|
||||
- Current API provides only disk temperatures via smartctl
|
||||
- Proposed comprehensive monitoring: CPU, motherboard, GPU, NVMe, chipset
|
||||
- Proposed GraphQL schema with TemperatureSensor, TemperatureSummary types
|
||||
- Would use lm-sensors, smartctl, nvidia-smi, IPMI
|
||||
|
||||
### 17. Monitoring and Grafana Integration
|
||||
|
||||
While the Unraid API does not natively expose Prometheus metrics, the community has established monitoring patterns ([source](https://unraid.net/blog/prometheus)):
|
||||
|
||||
- **Prometheus Node Exporter** plugin for Unraid
|
||||
- **Grafana dashboards** available:
|
||||
- Unraid System Dashboard V2 (ID: 7233) ([source](https://grafana.com/grafana/dashboards/7233-unraid-system-dashboard-v2/))
|
||||
- Unraid UPS Monitoring (ID: 19243) ([source](https://grafana.com/grafana/dashboards/19243-unraid-ups-monitoring/))
|
||||
- **cAdvisor** for container-level metrics
|
||||
|
||||
### 18. Development and Contribution
|
||||
|
||||
**Development Environment Requirements:**
|
||||
- Node.js 22.x (enforced)
|
||||
- pnpm 10.15.0
|
||||
- Bash, Docker, libvirt, jq
|
||||
|
||||
**Key Development Commands:**
|
||||
```bash
|
||||
pnpm dev # All dev servers in parallel
|
||||
pnpm build # Production builds
|
||||
pnpm codegen # Generate GraphQL types
|
||||
pnpm test # Run test suites (Vitest)
|
||||
pnpm lint # ESLint
|
||||
pnpm type-check # TypeScript checking
|
||||
```
|
||||
|
||||
**Deployment to Unraid:**
|
||||
```bash
|
||||
pnpm unraid:deploy <SERVER_IP>
|
||||
```
|
||||
|
||||
**CI/CD Pipeline:**
|
||||
1. PR previews with unique build URLs
|
||||
2. Staging deployment for merged PRs
|
||||
3. Production releases via release-please with semantic versioning
|
||||
|
||||
([source](https://github.com/unraid/api/blob/main/CLAUDE.md))
|
||||
|
||||
---
|
||||
|
||||
## Expert Opinions and Analysis
|
||||
|
||||
The DeepWiki auto-generated documentation characterizes the Unraid API as "a modern GraphQL API and web interface for managing Unraid servers" that "replaces portions of the legacy PHP-based WebGUI with a type-safe, real-time API built on NestJS and Vue 3, while maintaining backward compatibility through hybrid integration" ([source](https://deepwiki.com/unraid/api)).
|
||||
|
||||
The Feature Bounty Program blog post indicates Unraid is actively investing in the API ecosystem: "The new Unraid API has already come a long way as a powerful, open-source toolkit that unlocks endless possibilities for automation, integrations, and third-party applications" ([source](https://unraid.net/blog/api-feature-bounty-program)).
|
||||
|
||||
---
|
||||
|
||||
## Contradictions and Debates
|
||||
|
||||
1. **Code-first vs Schema-first:** The CLAUDE.md mentions "GraphQL schema-first approach with code generation" while the DeepWiki analysis describes a "code-first approach with NestJS decorators that generate the GraphQL schema." The DeepWiki analysis appears more accurate based on the `autoSchemaFile` configuration and NestJS decorator usage.
|
||||
|
||||
2. **File Manager API:** No dedicated file browser/upload/download API was found in the GraphQL schema. File operations appear to be handled through the legacy PHP WebGUI rather than the new API.
|
||||
|
||||
3. **RClone via API:** While our MCP server project has RClone tools, these appear to interface with rclone config files rather than a native GraphQL API for cloud storage management.
|
||||
|
||||
---
|
||||
|
||||
## Data Points and Statistics
|
||||
|
||||
| Metric | Value | Source |
|
||||
|--------|-------|--------|
|
||||
| Unraid API native since | v7.2.0 (2025-10-29) | [docs.unraid.net](https://docs.unraid.net/unraid-os/release-notes/7.2.0/) |
|
||||
| GitHub stars (official repo) | 86 | [github.com/unraid/api](https://github.com/unraid/api) |
|
||||
| Total releases | 102 | [github.com/unraid/api](https://github.com/unraid/api) |
|
||||
| Codebase language | TypeScript 77.4%, Vue 11.8%, PHP 5.6% | [github.com/unraid/api](https://github.com/unraid/api) |
|
||||
| Current package version | 4.29.2 | [deepwiki.com](https://deepwiki.com/unraid/api) |
|
||||
| Rate limit | 100 req/10 sec | [deepwiki.com](https://deepwiki.com/unraid/api/2.2-authentication-and-authorization) |
|
||||
| Python client PyPI version | 1.3.1 | [pypi.org](https://pypi.org/project/unraid-api/1.3.1/) |
|
||||
| Home Assistant integration stars | 60 | [github.com](https://github.com/chris-mc1/unraid_api) |
|
||||
| jmagar/unraid-mcp stars | 21 | [github.com](https://github.com/jmagar/unraid-mcp) |
|
||||
|
||||
---
|
||||
|
||||
## Gaps Identified
|
||||
|
||||
1. **Full GraphQL Schema Dump:** No publicly accessible introspection dump or SDL file was found. The live schema is only available via the GraphQL Sandbox on a running Unraid server.
|
||||
|
||||
2. **File Manager API:** No evidence of file browse/upload/download GraphQL mutations. This appears to remain in the PHP WebGUI layer.
|
||||
|
||||
3. **Temperature Monitoring:** Currently limited to disk temperatures via smartctl. Comprehensive temperature monitoring is an open feature bounty (not yet implemented).
|
||||
|
||||
4. **Parity/Array Operation Mutations:** While the Python client library implements `start_array()`/`stop_array()`, the specific GraphQL mutations and their schemas were not found in public documentation.
|
||||
|
||||
5. **RClone GraphQL API:** The extent of rclone integration through the GraphQL API versus legacy integration is unclear.
|
||||
|
||||
6. **Flash Backup API:** Flash backups appear to be handled through Unraid Connect (cloud-based) rather than a local GraphQL API.
|
||||
|
||||
7. **Network Configuration Mutations:** While network queries return interface data, mutations for VLAN/bonding configuration were not found in the API documentation.
|
||||
|
||||
8. **WebSocket Subscription Schema:** The specific subscription types and their exact GraphQL definitions are not publicly documented outside the running API.
|
||||
|
||||
9. **Plugin API Documentation:** The plugin developer guide (`api/docs/developer/api-plugins.md`) was not publicly accessible outside the repository.
|
||||
|
||||
10. **Rate Limiting Details:** Only the default rate (100 req/10 sec) was found; per-endpoint or per-role rate limits were not documented.
|
||||
|
||||
---
|
||||
|
||||
## All URLs Discovered
|
||||
|
||||
### Primary Sources (Official Unraid Documentation)
|
||||
- [Welcome to Unraid API](https://docs.unraid.net/API/) - API landing page
|
||||
- [Using the Unraid API](https://docs.unraid.net/API/how-to-use-the-api/) - Usage guide with examples
|
||||
- [API Key Authorization Flow](https://docs.unraid.net/API/api-key-app-developer-authorization-flow/) - Third-party auth flow
|
||||
- [Programmatic API Key Management](https://docs.unraid.net/API/programmatic-api-key-management/) - CLI key management
|
||||
- [CLI Reference](https://docs.unraid.net/API/cli) - Full CLI command reference
|
||||
- [OIDC Provider Setup](https://docs.unraid.net/API/oidc-provider-setup/) - SSO configuration
|
||||
- [Unraid 7.2.0 Release Notes](https://docs.unraid.net/unraid-os/release-notes/7.2.0/) - Release notes
|
||||
- [Automated Flash Backup](https://docs.unraid.net/connect/flash-backup/) - Flash backup docs
|
||||
- [Unraid Connect Overview](https://docs.unraid.net/connect/) - Connect service
|
||||
- [Remote Access](https://docs.unraid.net/unraid-connect/remote-access/) - Remote access docs
|
||||
- [Unraid Connect Setup](https://docs.unraid.net/unraid-connect/overview-and-setup/) - Setup guide
|
||||
- [Arrays Overview](https://docs.unraid.net/unraid-os/using-unraid-to/manage-storage/array/overview/) - Storage management
|
||||
- [ZFS Storage](https://docs.unraid.net/unraid-os/advanced-configurations/optimize-storage/zfs-storage/) - ZFS guide
|
||||
- [SMART Reports](https://docs.unraid.net/unraid-os/system-administration/monitor-performance/smart-reports-and-disk-health/) - Disk health
|
||||
- [User Management](https://docs.unraid.net/unraid-os/system-administration/secure-your-server/user-management/) - User system
|
||||
- [Array Health](https://docs.unraid.net/unraid-os/using-unraid-to/manage-storage/array/array-health-and-maintenance/) - Parity/maintenance
|
||||
- [VM Management](https://docs.unraid.net/unraid-os/manual/vm/vm-management/) - VM setup guide
|
||||
- [Plugins](https://docs.unraid.net/unraid-os/using-unraid-to/customize-your-experience/plugins/) - Plugin overview
|
||||
|
||||
### Official Source Code
|
||||
- [unraid/api GitHub](https://github.com/unraid/api) - Official monorepo (86 stars)
|
||||
- [unraid/api CLAUDE.md](https://github.com/unraid/api/blob/main/CLAUDE.md) - Development guidelines
|
||||
- [unraid/libvirt GitHub](https://github.com/unraid/libvirt) - Libvirt bindings
|
||||
- [unraid/api Issues](https://github.com/unraid/api/issues) - Issue tracker
|
||||
- [Temperature Monitoring Bounty](https://github.com/unraid/api/issues/1597) - Feature bounty issue
|
||||
- [API Feature Bounty Program](https://unraid.net/blog/api-feature-bounty-program) - Program announcement
|
||||
- [Unraid Connect](https://unraid.net/connect) - Connect product page
|
||||
- [Connect Dashboard](https://connect.myunraid.net/) - Live Connect dashboard
|
||||
|
||||
### Architecture Analysis (DeepWiki)
|
||||
- [Unraid API Overview](https://deepwiki.com/unraid/api) - Full architecture
|
||||
- [Backend API System](https://deepwiki.com/unraid/api/2-api-server) - Backend details
|
||||
- [GraphQL API Layer](https://deepwiki.com/unraid/api/2.1-graphql-api-layer) - GraphQL implementation
|
||||
- [Authentication and Authorization](https://deepwiki.com/unraid/api/2.2-authentication-and-authorization) - Auth system
|
||||
- [Core Services](https://deepwiki.com/unraid/api/2.4-docker-integration) - Docker/services
|
||||
- [Docker Management Service](https://deepwiki.com/unraid/api/2.4.2-notification-system) - Docker details
|
||||
- [Configuration Files](https://deepwiki.com/unraid/api/5.2-connect-settings-and-remote-access) - Config system
|
||||
|
||||
### Community Client Libraries
|
||||
- [domalab/unraid-api-client GitHub](https://github.com/domalab/unraid-api-client) - Python client
|
||||
- [unraid-api PyPI](https://pypi.org/project/unraid-api/1.3.1/) - PyPI package
|
||||
- [Unraid API Documentation (DomaLab)](https://unraid-api.domalab.net/) - Python docs
|
||||
- [Network and Storage Queries](https://deepwiki.com/domalab/unraid-api-client/4.3-network-and-storage-queries) - Query reference
|
||||
- [chris-mc1/unraid_api GitHub](https://github.com/chris-mc1/unraid_api) - Home Assistant integration (60 stars)
|
||||
- [Homey Unraid API](https://homey.app/no-no/app/community.unraid.api/Unraid-API/) - Homey integration
|
||||
|
||||
### MCP Server Listings
|
||||
- [jmagar/unraid-mcp GitHub](https://github.com/jmagar/unraid-mcp) - This project
|
||||
- [Glama MCP Listing](https://glama.ai/mcp/servers/@jmagar/unraid-mcp) - Glama listing
|
||||
- [MCP Market Listing](https://mcpmarket.com/server/unraid) - MCP Market
|
||||
- [MCPServers.com Listing](https://mcpservers.com/servers/jmagar-unraid) - MCPServers.com
|
||||
- [LangDB Listing](https://langdb.ai/app/mcp-servers/unraid-mcp-server-8605b018-ce29-48d5-8132-48cf0792501f) - LangDB
|
||||
- [UBOS Listing](https://ubos.tech/mcp/unraid-mcp-server/) - UBOS
|
||||
- [JuheAPI Listing](https://www.juheapi.com/mcp-servers/jmagar/unraid-mcp) - JuheAPI
|
||||
- [AIBase Listing](https://mcp.aibase.com/server/1916341265568079874) - AIBase
|
||||
- [lwsinclair/unraid-mcp GitHub](https://github.com/lwsinclair/unraid-mcp) - Alternative MCP
|
||||
|
||||
### Alternative/Legacy APIs
|
||||
- [ruaan-deysel/unraid-management-agent](https://github.com/ruaan-deysel/unraid-management-agent) - Go REST+WebSocket (5 stars)
|
||||
- [BoKKeR/UnraidAPI-RE](https://github.com/BoKKeR/UnraidAPI-RE) - Node.js API (68 stars)
|
||||
- [ElectricBrainUK/UnraidAPI](https://github.com/ElectricBrainUK/UnraidAPI) - Original API (127 stars)
|
||||
- [ridenui/unraid](https://github.com/ridenui/unraid) - TypeScript SSH client (3 stars)
|
||||
|
||||
### Monitoring Integration
|
||||
- [Unraid Prometheus Guide](https://unraid.net/blog/prometheus) - Official guide
|
||||
- [Grafana UPS Dashboard](https://grafana.com/grafana/dashboards/19243-unraid-ups-monitoring/) - Dashboard 19243
|
||||
- [Grafana System Dashboard V2](https://grafana.com/grafana/dashboards/7233-unraid-system-dashboard-v2/) - Dashboard 7233
|
||||
- [Prometheus/Grafana Forum Thread](https://forums.unraid.net/topic/77593-monitoring-unraid-with-prometheus-grafana-cadvisor-nodeexporter-and-alertmanager/) - Community guide
|
||||
|
||||
### Community Discussion
|
||||
- [Webhook Notification Forum Thread](https://forums.unraid.net/topic/88464-webhook-notification-method/) - Notification customization
|
||||
- [Matrix Notification Agent](https://forums.unraid.net/topic/122107-matrix-notification-agent/) - Matrix integration
|
||||
- [ntfy.sh Notifications](https://lder.dev/posts/ntfy-Notifications-With-unRAID/) - ntfy.sh setup
|
||||
- [MCP HomeLab Tutorial (YouTube)](https://www.youtube.com/watch?v=AydDDYn09QA) - Christian Lempa MCP tutorial
|
||||
- [Build with the Unraid API (YouTube)](https://www.youtube.com/shorts/0JJQdFfh4e0) - Short video
|
||||
819
docs/research/unraid-api-research.md
Normal file
819
docs/research/unraid-api-research.md
Normal file
@@ -0,0 +1,819 @@
|
||||
# Unraid API Research Findings
|
||||
|
||||
**Date:** 2026-02-07
|
||||
**Research Topic:** Unraid GraphQL API, Connect Cloud Service, MCP Integration
|
||||
**Specialist:** NotebookLM Deep Research
|
||||
**Notebook ID:** 4e217d5d-d68b-4bfa-881a-42f7c01d3e44
|
||||
|
||||
## Research Summary
|
||||
|
||||
- **Deep research mode:** deep (47 web sources discovered)
|
||||
- **Sources indexed:** 51 ready / 77 total (26 error)
|
||||
- **Q&A questions asked:** 23 comprehensive questions with follow-ups
|
||||
- **Deep research status:** completed
|
||||
- **Key source categories:** Official Unraid docs, GitHub repos, community forums, GraphQL references, third-party integrations
|
||||
|
||||
---
|
||||
|
||||
## Table of Contents
|
||||
|
||||
1. [Unraid API Overview](#1-unraid-api-overview)
|
||||
2. [Architecture and Deployment](#2-architecture-and-deployment)
|
||||
3. [Authentication and Security](#3-authentication-and-security)
|
||||
4. [GraphQL Schema and Endpoints](#4-graphql-schema-and-endpoints)
|
||||
5. [WebSocket Subscriptions](#5-websocket-subscriptions)
|
||||
6. [Unraid Connect Cloud Service](#6-unraid-connect-cloud-service)
|
||||
7. [Version History and API Changes](#7-version-history-and-api-changes)
|
||||
8. [Community Integrations](#8-community-integrations)
|
||||
9. [Known Issues and Limitations](#9-known-issues-and-limitations)
|
||||
10. [API Roadmap and Future Features](#10-api-roadmap-and-future-features)
|
||||
11. [Recommendations for unraid-mcp](#11-recommendations-for-unraid-mcp)
|
||||
12. [Source Bibliography](#12-source-bibliography)
|
||||
|
||||
---
|
||||
|
||||
## 1. Unraid API Overview
|
||||
|
||||
The **Unraid API** is a programmatic interface that provides automation, monitoring, and integration capabilities for Unraid servers. It uses a **GraphQL** interface, offering a modern, strongly-typed method for developers and third-party applications to interact directly with the Unraid operating system.
|
||||
|
||||
### Key Facts
|
||||
|
||||
- **Protocol:** GraphQL (queries, mutations, subscriptions)
|
||||
- **Endpoint:** `http(s)://[SERVER_IP]/graphql`
|
||||
- **Authentication:** API Keys, Session Cookies, SSO/OIDC
|
||||
- **Native since:** Unraid 7.2 (no plugin required)
|
||||
- **Pre-7.2:** Requires Unraid Connect plugin installation
|
||||
|
||||
The API exposes nearly all management functions available in the Unraid WebGUI, including server management, storage operations, Docker/VM lifecycle, remote access, and backup capabilities.
|
||||
|
||||
**Sources:**
|
||||
- [Welcome to Unraid API | Unraid Docs](https://docs.unraid.net/API/) -- Official API landing page [Tier: Primary]
|
||||
- [Using the Unraid API](https://docs.unraid.net/API/how-to-use-the-api/) -- Official usage guide [Tier: Primary]
|
||||
|
||||
---
|
||||
|
||||
## 2. Architecture and Deployment
|
||||
|
||||
### Monorepo Structure
|
||||
|
||||
The Unraid API is developed in the [unraid/api](https://github.com/unraid/api) monorepo which houses:
|
||||
|
||||
| Directory | Purpose |
|
||||
|-----------|---------|
|
||||
| `api/` | GraphQL backend server (TypeScript/Node.js) |
|
||||
| `web/` | Frontend interface (Nuxt/Vue.js) |
|
||||
| `plugin/` | Unraid plugin packaging (.plg format) |
|
||||
| `packages/` | Shared internal libraries |
|
||||
| `unraid-ui/` | UI component library |
|
||||
| `scripts/` | Build and maintenance utilities |
|
||||
|
||||
### Technology Stack
|
||||
|
||||
| Component | Technology |
|
||||
|-----------|------------|
|
||||
| Primary language | TypeScript (77.4%) |
|
||||
| Frontend | Vue.js (11.8%) via Nuxt |
|
||||
| Runtime | Node.js v22 |
|
||||
| Package manager | pnpm v9.0+ |
|
||||
| API protocol | GraphQL |
|
||||
| Dev environment | Nix (optional), Docker |
|
||||
| Build tool | Justfile |
|
||||
|
||||
### Deployment Modes
|
||||
|
||||
1. **Native (Unraid 7.2+):** API is built into the OS, starts automatically with the system. Managed via **Settings > Management Access > API**.
|
||||
2. **Plugin (Pre-7.2):** Requires installing the Unraid Connect plugin from Community Applications. Installing the plugin on 7.2+ provides access to newer API features before they are merged into the stable OS release.
|
||||
3. **Development:** Supports local Docker builds (`pnpm run docker:build-and-run` on port 5858), direct deployment to a running server (`pnpm unraid:deploy <SERVER_IP>`), and hot-reloading dev servers (API port 3001, Web port 3000).
|
||||
|
||||
### Integration with Nginx
|
||||
|
||||
The API integrates with Unraid's Nginx web server. Nginx acts as a reverse proxy, handling external requests on standard web ports (80/443) and routing `/graphql` traffic to the internal API backend. This means the API shares the same IP and port as the WebGUI.
|
||||
|
||||
**Sources:**
|
||||
- [GitHub - unraid/api: Unraid API / Connect / UI Monorepo](https://github.com/unraid/api) [Tier: Official]
|
||||
- [api/api/docs/developer/development.md](https://github.com/unraid/api/blob/main/api/docs/developer/development.md) [Tier: Official]
|
||||
|
||||
---
|
||||
|
||||
## 3. Authentication and Security
|
||||
|
||||
### Authentication Methods
|
||||
|
||||
The Unraid API supports three primary authentication mechanisms:
|
||||
|
||||
1. **API Keys** -- Standard method for programmatic access
|
||||
- Created via WebGUI: **Settings > Management Access > API Keys**
|
||||
- Created via CLI: `unraid-api apikey --create --name "mykey" --roles ADMIN --json`
|
||||
- Sent in HTTP header: `x-api-key: YOUR_API_KEY`
|
||||
- Displayed only once upon creation
|
||||
|
||||
2. **Session Cookies** -- Used for browser-based WebGUI access
|
||||
- Automatic when logged into WebGUI
|
||||
- Used internally by the GraphQL Sandbox
|
||||
|
||||
3. **SSO / OIDC (OpenID Connect)** -- Enterprise identity management
|
||||
- Added in API v4.0.0
|
||||
- Supports external identity providers
|
||||
|
||||
### API Key Authorization Flow (OAuth-like)
|
||||
|
||||
For third-party applications, Unraid provides an OAuth-like authorization flow:
|
||||
|
||||
1. App redirects user to: `https://[server]/ApiKeyAuthorize?name=MyApp&scopes=docker:read,vm:*&redirect_uri=https://myapp.com/callback&state=abc123`
|
||||
2. User authenticates (if not already logged in)
|
||||
3. User sees consent screen with requested permissions
|
||||
4. Upon approval, API key is created and shown to user once
|
||||
5. If `redirect_uri` provided, user is redirected with `?api_key=xxx&state=abc123`
|
||||
|
||||
**Query Parameters:**
|
||||
| Parameter | Required | Description |
|
||||
|-----------|----------|-------------|
|
||||
| `name` | Yes | Application name |
|
||||
| `scopes` | Yes | Comma-separated permissions (e.g., `docker:read,vm:*`) |
|
||||
| `redirect_uri` | No | HTTPS callback URL (localhost allowed for dev) |
|
||||
| `state` | No | CSRF prevention token |
|
||||
|
||||
### Programmatic API Key Management (CLI)
|
||||
|
||||
```bash
|
||||
# Create a key with admin role
|
||||
unraid-api apikey --create --name "workflow key" --roles ADMIN --json
|
||||
|
||||
# Create a key with specific permissions
|
||||
unraid-api apikey --create --name "monitor" --permissions "DOCKER:READ_ANY,ARRAY:READ_ANY" --json
|
||||
|
||||
# Overwrite existing key
|
||||
unraid-api apikey --create --name "workflow key" --roles ADMIN --overwrite --json
|
||||
|
||||
# Delete a key
|
||||
unraid-api apikey --delete --name "workflow key"
|
||||
```
|
||||
|
||||
### Roles and Permissions
|
||||
|
||||
**Roles (pre-defined access levels):**
|
||||
|
||||
| Role | Description |
|
||||
|------|-------------|
|
||||
| `ADMIN` | Full system access (all permissions) |
|
||||
| `VIEWER` | Read-only access |
|
||||
| `GUEST` | Limited access |
|
||||
| `CONNECT` | Unraid Connect cloud features |
|
||||
|
||||
**Permission Scope Format:** `RESOURCE:ACTION`
|
||||
|
||||
**Available Resources:**
|
||||
- Core: `ACTIVATION_CODE`, `API_KEY`, `CONFIG`, `CUSTOMIZATIONS`, `INFO`, `LOGS`, `OS`, `REGISTRATION`, `VARS`, `WELCOME`
|
||||
- Storage: `ARRAY`, `DISK`, `FLASH`
|
||||
- Services: `DOCKER`, `VMS`, `SERVICES`, `NETWORK`
|
||||
- Management: `DASHBOARD`, `DISPLAY`, `ME`, `NOTIFICATIONS`, `OWNER`, `PERMISSION`, `SHARE`, `USER`
|
||||
- Cloud: `CLOUD`, `CONNECT`, `CONNECT__REMOTE_ACCESS`, `ONLINE`, `SERVERS`
|
||||
|
||||
**Available Actions:**
|
||||
- `CREATE_ANY`, `CREATE_OWN`
|
||||
- `READ_ANY`, `READ_OWN`
|
||||
- `UPDATE_ANY`, `UPDATE_OWN`
|
||||
- `DELETE_ANY`, `DELETE_OWN`
|
||||
- `*` (wildcard for all actions)
|
||||
|
||||
### SSL/TLS Certificate Handling
|
||||
|
||||
| Scenario | Recommendation |
|
||||
|----------|---------------|
|
||||
| Self-signed cert (local IP) | Either trust the specific CA or disable SSL verification (dev only) |
|
||||
| `myunraid.net` cert (Let's Encrypt) | SSL verification works normally; use the `myunraid.net` URL |
|
||||
| Strict SSL mode | Enforces HTTPS for all connections including local |
|
||||
|
||||
For self-signed certs in client code:
|
||||
```bash
|
||||
curl -k "https://your-unraid-server/graphql" -H "x-api-key: YOUR_KEY"
|
||||
```
|
||||
|
||||
**Sources:**
|
||||
- [API key authorization flow | Unraid Docs](https://docs.unraid.net/API/api-key-app-developer-authorization-flow/) [Tier: Primary]
|
||||
- [Programmatic API key management | Unraid Docs](https://docs.unraid.net/API/programmatic-api-key-management/) [Tier: Primary]
|
||||
|
||||
---
|
||||
|
||||
## 4. GraphQL Schema and Endpoints
|
||||
|
||||
### Endpoint URLs
|
||||
|
||||
| Purpose | URL |
|
||||
|---------|-----|
|
||||
| GraphQL API | `http(s)://[SERVER_IP]/graphql` |
|
||||
| GraphQL Sandbox | `http(s)://[SERVER_IP]/graphql` (must be enabled) |
|
||||
| WebSocket (subscriptions) | `ws(s)://[SERVER_IP]/graphql` |
|
||||
| Internal dev API | `http://localhost:3001/graphql` |
|
||||
|
||||
### Enabling the GraphQL Sandbox
|
||||
|
||||
Two methods:
|
||||
1. **WebGUI:** Settings > Management Access > Developer Options > Toggle GraphQL Sandbox to "On"
|
||||
2. **CLI:** `unraid-api developer --sandbox true`
|
||||
|
||||
Then access at `http://YOUR_SERVER_IP/graphql` to explore the schema via Apollo Sandbox.
|
||||
|
||||
### Query Types
|
||||
|
||||
#### System Information (`info`)
|
||||
```graphql
|
||||
query {
|
||||
info {
|
||||
os { platform distro release uptime hostname arch kernel }
|
||||
cpu { manufacturer brand cores threads }
|
||||
memory { layout { bank type clockSpeed manufacturer } }
|
||||
baseboard { manufacturer model version serial }
|
||||
system { manufacturer model version serial uuid }
|
||||
versions { kernel docker unraid node }
|
||||
apps { installed started }
|
||||
machineId
|
||||
time
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### Array Status (`array`)
|
||||
```graphql
|
||||
query {
|
||||
array {
|
||||
id
|
||||
state
|
||||
capacity {
|
||||
kilobytes { free used total }
|
||||
disks { free used total }
|
||||
}
|
||||
boot { id name device size status temp fsType }
|
||||
parities { id name device size status temp numErrors }
|
||||
disks { id name device size status temp numReads numWrites numErrors }
|
||||
caches { id name device size status temp }
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### Docker Containers (`docker`)
|
||||
```graphql
|
||||
query {
|
||||
docker {
|
||||
containers(skipCache: false) {
|
||||
id names image state status autoStart
|
||||
ports { ip privatePort publicPort type }
|
||||
labels
|
||||
networkSettings
|
||||
mounts
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### Virtual Machines (`vms`)
|
||||
```graphql
|
||||
query {
|
||||
vms {
|
||||
id
|
||||
domains {
|
||||
id name state uuid
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### Network (`network`)
|
||||
```graphql
|
||||
query {
|
||||
network {
|
||||
id
|
||||
accessUrls { type name ipv4 ipv6 }
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### Registration (`registration`)
|
||||
```graphql
|
||||
query {
|
||||
registration {
|
||||
id type state expiration updateExpiration
|
||||
keyFile { location contents }
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### Settings (`settings`)
|
||||
```graphql
|
||||
query {
|
||||
settings {
|
||||
unified { values }
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### System Variables (`vars`)
|
||||
```graphql
|
||||
query {
|
||||
vars {
|
||||
id version name timeZone security workgroup
|
||||
useSsl port portssl
|
||||
shareSmbEnabled shareNfsEnabled
|
||||
mdState mdVersion
|
||||
csrfToken
|
||||
# Many more fields available -- some have Int overflow issues
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### RClone Remotes (`rclone`)
|
||||
```graphql
|
||||
query {
|
||||
rclone {
|
||||
remotes { name type parameters config }
|
||||
configForm(formOptions: { providerType: "s3" }) {
|
||||
id dataSchema uiSchema
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### Notifications
|
||||
```graphql
|
||||
query {
|
||||
notifications {
|
||||
id subject message importance unread
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### Shares
|
||||
```graphql
|
||||
query {
|
||||
shares {
|
||||
name comment free used
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Mutation Types
|
||||
|
||||
#### Docker Container Management
|
||||
```graphql
|
||||
mutation {
|
||||
docker {
|
||||
start(id: $id) { id names state status }
|
||||
stop(id: $id) { id names state status }
|
||||
}
|
||||
}
|
||||
```
|
||||
- Uses `PrefixedID` type for container identification
|
||||
- Mutations are idempotent (starting an already-running container returns success)
|
||||
|
||||
#### VM Management
|
||||
```graphql
|
||||
mutation {
|
||||
vm {
|
||||
start(id: $id) # Returns Boolean
|
||||
stop(id: $id)
|
||||
pause(id: $id)
|
||||
resume(id: $id)
|
||||
forceStop(id: $id)
|
||||
reboot(id: $id)
|
||||
reset(id: $id)
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### RClone Remote Management
|
||||
```graphql
|
||||
mutation {
|
||||
rclone {
|
||||
createRCloneRemote(input: { name: "...", type: "s3", config: {...} }) {
|
||||
name type parameters
|
||||
}
|
||||
deleteRCloneRemote(input: { name: "..." })
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### System Operations (via API)
|
||||
The following operations are confirmed available through the API (exact mutation names should be discovered via introspection):
|
||||
- Array start/stop
|
||||
- Parity check trigger
|
||||
- Server reboot/shutdown
|
||||
- Flash backup trigger
|
||||
- Notification management
|
||||
|
||||
### The `PrefixedID` Type
|
||||
|
||||
The API uses a `PrefixedID` custom scalar type for global object identification. This follows the GraphQL `Node` interface pattern, combining the object type and its internal ID (e.g., `DockerContainer:abc123`). Client libraries must handle this as a string.
|
||||
|
||||
### The `Long` Scalar Type
|
||||
|
||||
The API defines a custom `Long` scalar type for 64-bit integers to handle values that exceed the standard GraphQL `Int` (32-bit signed). This is used for:
|
||||
- Disk/array capacity values (size, free, used, total)
|
||||
- Memory values (total, free)
|
||||
- Disk operation counters (numReads, numWrites)
|
||||
|
||||
These are typically serialized as strings in JSON responses.
|
||||
|
||||
**Sources:**
|
||||
- [Welcome to Unraid API | Unraid Docs](https://docs.unraid.net/API/) [Tier: Primary]
|
||||
- [Using the Unraid API](https://docs.unraid.net/API/how-to-use-the-api/) [Tier: Primary]
|
||||
- [GitHub - jmagar/unraid-mcp](https://github.com/jmagar/unraid-mcp) [Tier: Official]
|
||||
|
||||
---
|
||||
|
||||
## 5. WebSocket Subscriptions
|
||||
|
||||
### Protocol
|
||||
|
||||
The Unraid API uses the **`graphql-transport-ws`** protocol (the modern standard, superseding the older `subscriptions-transport-ws`).
|
||||
|
||||
### Connection Flow
|
||||
|
||||
1. Client connects to `ws(s)://[SERVER_IP]/graphql`
|
||||
2. Client sends `connection_init` with auth payload:
|
||||
```json
|
||||
{
|
||||
"type": "connection_init",
|
||||
"payload": {
|
||||
"x-api-key": "YOUR_API_KEY"
|
||||
}
|
||||
}
|
||||
```
|
||||
3. Server responds with `connection_ack`
|
||||
4. Client sends `subscribe` message with GraphQL subscription query
|
||||
5. Server streams `next` messages with data as events occur
|
||||
6. Server sends `complete` when subscription ends
|
||||
|
||||
### Known Subscription Types
|
||||
|
||||
| Subscription | Purpose |
|
||||
|-------------|---------|
|
||||
| `syslog` / `logFile` | Real-time system log streaming |
|
||||
| Array events | State changes, parity check progress |
|
||||
| Docker events | Container state changes |
|
||||
| Notifications | Real-time alert streaming |
|
||||
|
||||
### Authentication for WebSockets
|
||||
|
||||
Since standard WebSocket APIs in browsers cannot set custom headers, the API key is passed in the `connectionParams` payload of the `connection_init` message. Alternatively, session cookies work automatically for WebGUI-based tools.
|
||||
|
||||
### Infrastructure Notes
|
||||
|
||||
- Unraid uses **Nchan** (Nginx module) for WebSocket connections internally
|
||||
- Unraid 7.0.1 fixed Nchan memory leaks affecting subscription stability
|
||||
- Unraid 7.1.0 added automatic Nchan shared memory recovery (restarts Nginx when memory runs out)
|
||||
- A setting was added in 7.1.0 to disable real-time updates on inactive browsers to prevent memory issues
|
||||
|
||||
**Sources:**
|
||||
- [Subscriptions - GraphQL](https://graphql.org/learn/subscriptions/) [Tier: Primary]
|
||||
- [Subscriptions - Apollo GraphQL Docs](https://www.apollographql.com/docs/react/data/subscriptions) [Tier: Official]
|
||||
|
||||
---
|
||||
|
||||
## 6. Unraid Connect Cloud Service
|
||||
|
||||
### Overview
|
||||
|
||||
**Unraid Connect** is a cloud-enabled companion service that functions as a centralized "remote command center" for Unraid servers. It provides:
|
||||
|
||||
- **Centralized Dashboard:** View status, uptime, storage, and license details for multiple servers
|
||||
- **Remote Management:** Start/stop arrays, manage Docker/VMs, reboot servers
|
||||
- **Flash Backup:** Automated cloud-based backups of USB flash drive configuration
|
||||
- **Deep Linking:** Jump directly from cloud dashboard to local WebGUI pages
|
||||
|
||||
### Relationship to Local API
|
||||
|
||||
- Pre-7.2: The Unraid Connect plugin provides both cloud features AND the local GraphQL API
|
||||
- Post-7.2: The API is native to the OS; the Connect plugin adds cloud features
|
||||
- The cloud dashboard communicates through a secure tunnel to execute commands locally
|
||||
|
||||
### Data Transmitted to Cloud
|
||||
|
||||
The local server transmits to `Unraid.net`:
|
||||
- Server hostname and keyfile details
|
||||
- Local/remote IP addresses
|
||||
- Array usage statistics (numbers only, no file names)
|
||||
- Container and VM counts
|
||||
|
||||
**Privacy:** The service explicitly does NOT collect or share user content, file details, or personal information beyond necessary metadata.
|
||||
|
||||
### Remote Access Mechanisms
|
||||
|
||||
1. **Dynamic Remote Access (Recommended):**
|
||||
- On-demand; WebGUI closed to internet by default
|
||||
- Uses UPnP for automatic port forwarding (or manual rules)
|
||||
- Port lease expires after inactivity (~10 minutes)
|
||||
|
||||
2. **Static Remote Access:**
|
||||
- Always-on; WebGUI continuously accessible
|
||||
- Requires forwarding WAN port (high random number >1000) to HTTPS port
|
||||
|
||||
3. **VPN Alternatives:**
|
||||
- WireGuard (built-in)
|
||||
- Tailscale (native since Unraid 7.0+)
|
||||
|
||||
### Flash Backup Details
|
||||
|
||||
- Configuration files are encrypted and uploaded
|
||||
- Excludes sensitive data: passwords, WireGuard keys
|
||||
- Retained as latest backup only; older/inactive backups are purged
|
||||
- Can be triggered and monitored via the API
|
||||
|
||||
**Sources:**
|
||||
- [Unraid Connect overview & setup | Unraid Docs](https://docs.unraid.net/connect/about/) [Tier: Primary]
|
||||
- [Remote access | Unraid Docs](https://docs.unraid.net/connect/remote-access/) [Tier: Primary]
|
||||
- [Automated flash backup | Unraid Docs](https://docs.unraid.net/connect/flash-backup/) [Tier: Primary]
|
||||
|
||||
---
|
||||
|
||||
## 7. Version History and API Changes
|
||||
|
||||
### Unraid 7.0.0 (2025-01-09)
|
||||
|
||||
**Developer & System Capabilities:**
|
||||
- Notification agents stored as individual XML files (easier programmatic management)
|
||||
- `Content-Security-Policy frame-ancestors` support (iframe embedding for dashboards)
|
||||
- JavaScript console logging restored
|
||||
- VM Manager inline XML mode (read-only libvirt XML view)
|
||||
- Docker PID limits (default 2048)
|
||||
- Full ZFS support (hybrid pools, subpools, encryption)
|
||||
- Native Tailscale integration
|
||||
- File Manager merged into core OS
|
||||
- QEMU snapshots and clones for VMs
|
||||
|
||||
**Note:** API was still plugin-based (Unraid Connect plugin required).
|
||||
|
||||
### Unraid 7.0.1 (2025-02-25)
|
||||
|
||||
- **Nchan memory leak fix** -- Critical for WebSocket subscription stability
|
||||
- Tailscale integration security restrictions for Host-network containers
|
||||
|
||||
### Unraid 7.1.0 (2025-05-05)
|
||||
|
||||
- **Nchan shared memory recovery** -- Automatic Nginx restart on memory exhaustion
|
||||
- **Real-time updates toggle** -- Disable updates on inactive browsers
|
||||
- Native WiFi support (`wlan0`) -- New network interface data
|
||||
- User VM templates (create, export, import)
|
||||
- CSS rework for WebGUI
|
||||
|
||||
### Unraid 7.2.0 (Stable Release)
|
||||
|
||||
**Major Milestone: API becomes native to the OS.**
|
||||
|
||||
- No plugin required for local API access
|
||||
- API starts automatically with system
|
||||
- Deep system integration
|
||||
- Settings accessible at **Settings > Management Access > API**
|
||||
- OIDC/SSO support added
|
||||
- Permissions system rewritten (API v4.0.0)
|
||||
- Built-in GraphQL Sandbox
|
||||
- CLI key management (`unraid-api apikey`)
|
||||
- Open-sourced API code
|
||||
|
||||
**Sources:**
|
||||
- [Version 7.0.0 | Unraid Docs](https://docs.unraid.net/unraid-os/release-notes/7.0.0/) [Tier: Primary]
|
||||
- [Version 7.0.1 | Unraid Docs](https://docs.unraid.net/unraid-os/release-notes/7.0.1/) [Tier: Primary]
|
||||
- [Version 7.1.0 | Unraid Docs](https://docs.unraid.net/unraid-os/release-notes/7.1.0/) [Tier: Primary]
|
||||
- [Unraid 7.2.0 Blog Post](https://unraid.net/blog/unraid-7-2-0) [Tier: Official]
|
||||
|
||||
---
|
||||
|
||||
## 8. Community Integrations
|
||||
|
||||
### Third-Party Projects Using the Unraid API
|
||||
|
||||
#### 1. unraid-mcp (Python MCP Server) -- This Project
|
||||
- **Interface:** Official Unraid GraphQL API via HTTP/HTTPS + WebSockets
|
||||
- **Auth:** `UNRAID_API_URL` + `UNRAID_API_KEY` environment variables
|
||||
- **Transport:** HTTP header `X-API-Key` for queries; WebSocket `connection_init` payload for subscriptions
|
||||
- **Tools:** 26+ MCP tools for Docker, VM, storage, system management
|
||||
|
||||
#### 2. PSUnraid (PowerShell Module)
|
||||
- **Developer:** Community member "Jagula"
|
||||
- **Status:** Alpha / proof of concept
|
||||
- **Interface:** Official Unraid GraphQL API
|
||||
- **Install:** `Install-Module PSUnraid`
|
||||
- **Capabilities:** Server/array/disk status, Docker/VM start/stop/restart, notifications
|
||||
- **Requires:** Unraid 7.2.2+ for full feature support
|
||||
- **Key insight:** Remote-only (no SSH needed), converts JSON to PowerShell objects
|
||||
|
||||
#### 3. unraid-management-agent (Go Plugin)
|
||||
- **Interface:** **NOT** the official GraphQL API -- independent REST API + WebSocket
|
||||
- **Port:** Default 8043
|
||||
- **Architecture:** Standalone Go binary, collects data via native libraries
|
||||
- **Endpoints:** 50+ REST endpoints, `/metrics` for Prometheus, WebSocket at `/api/v1/ws`
|
||||
- **Integrations:** Prometheus (41 metrics), MQTT, Home Assistant (auto-discovery), MCP (54 tools)
|
||||
- **Key insight:** Provides data the official API lacks (SMART data, container logs, process monitoring, GPU stats, UPS data)
|
||||
|
||||
#### 4. unraid-ssh-mcp
|
||||
- **Interface:** SSH (explicitly chose NOT to use GraphQL API)
|
||||
- **Reason:** API lacked container logs, SMART data, real-time CPU load, process monitoring
|
||||
- **Advantage:** Works on any Unraid version, no rate limits
|
||||
|
||||
#### Other Projects
|
||||
- **U-Manager:** Android app for remote Unraid management
|
||||
- **Unraid Deck:** Native iOS client (SwiftUI)
|
||||
- **hass-unraid:** Home Assistant integration with SMART attribute notifications
|
||||
|
||||
**Sources:**
|
||||
- [PSUnraid Reddit Thread](https://www.reddit.com/r/unRAID/comments/1ph08wi/psunraid_powershell_m) [Tier: Community]
|
||||
- [unraid-management-agent GitHub](https://github.com/ruaan-deysel/unraid-management-agent) [Tier: Official]
|
||||
- [Unraid MCP Reddit Thread](https://www.reddit.com/r/unRAID/comments/1pl4s4j/unraid_mcp_server_que) [Tier: Community]
|
||||
|
||||
---
|
||||
|
||||
## 9. Known Issues and Limitations
|
||||
|
||||
### GraphQL Schema Issues (Discovered in unraid-mcp Development)
|
||||
|
||||
Based on the existing unraid-mcp codebase, the following issues have been encountered:
|
||||
|
||||
1. **Int Overflow on Large Values:** Memory size fields (total, used, free) and some disk operation counters can overflow GraphQL's standard 32-bit `Int` type. The API uses a custom `Long` scalar but some fields still return problematic values.
|
||||
|
||||
2. **NaN Values:** Certain fields in the `vars` query (e.g., `sysArraySlots`, `sysCacheSlots`, `cacheNumDevices`, `cacheSbNumDisks`) can return NaN, causing type errors. The existing codebase works around this by querying a curated subset of fields.
|
||||
|
||||
3. **Non-nullable Fields Returning Null:** The `info.devices` section has non-nullable fields that may be null in practice. The codebase avoids querying this section entirely.
|
||||
|
||||
4. **Memory Layout Size Missing:** Individual memory stick `size` values are not returned by the API, preventing total memory calculation from layout data.
|
||||
|
||||
### API Coverage Gaps
|
||||
|
||||
According to the unraid-ssh-mcp developer, the GraphQL API currently lacks:
|
||||
- Docker container logs
|
||||
- Detailed SMART data for drives
|
||||
- Real-time CPU load averages
|
||||
- Process monitoring capabilities
|
||||
- Some system-level metrics available via `/proc` and `/sys`
|
||||
|
||||
### General Limitations
|
||||
|
||||
- **Rate Limiting:** The API implements rate limiting (specific limits not documented publicly)
|
||||
- **Version Dependency:** Full API requires Unraid 7.2+; pre-7.2 versions need the Connect plugin
|
||||
- **Self-Signed Certificates:** Client must handle SSL verification for local IP access
|
||||
- **Schema Volatility:** The API schema is still evolving; field names and types may change between versions
|
||||
|
||||
---
|
||||
|
||||
## 10. API Roadmap and Future Features
|
||||
|
||||
### Completed (as of 7.2)
|
||||
- API native to Unraid OS
|
||||
- Separated from Connect Plugin
|
||||
- Open-sourced
|
||||
- OIDC/SSO support
|
||||
- Permissions system rewrite (v4.0.0)
|
||||
|
||||
### Q1 2025
|
||||
- New Connect Settings Interface
|
||||
|
||||
### Q2 2025
|
||||
- New modernized Settings Pages
|
||||
- Storage Pool Creation Interface (simplified)
|
||||
- Storage Pool Status Interface (real-time)
|
||||
- Developer Tools for Plugins
|
||||
- Custom Theme Creator (start)
|
||||
|
||||
### Q3 2025
|
||||
- Custom Theme Creator (completion)
|
||||
- New Docker Status Interface
|
||||
- Docker Container Setup Interface (streamlined)
|
||||
- New Plugins Interface (redesigned)
|
||||
|
||||
### TBD (Planned but Unscheduled)
|
||||
- **Native Docker Compose support** -- Highly anticipated
|
||||
- Plugin Development SDK and tooling
|
||||
- Advanced Plugin Management interface
|
||||
- Storage Share Creation & Settings interfaces
|
||||
- Storage Share Management Dashboard
|
||||
|
||||
### In Development
|
||||
- User Interface Component Library (security components)
|
||||
|
||||
**Sources:**
|
||||
- [Roadmap & Features | Unraid Docs](https://docs.unraid.net/API/upcoming-features/) [Tier: Primary]
|
||||
|
||||
---
|
||||
|
||||
## 11. Recommendations for unraid-mcp
|
||||
|
||||
Based on this research, the following improvements are recommended for the unraid-mcp project:
|
||||
|
||||
### High Priority
|
||||
|
||||
1. **ZFS/Pool Management Tools**
|
||||
- Add `get_pool_status` for ZFS/BTRFS storage pools
|
||||
- Current `get_array_status` insufficient for multi-pool setups introduced in Unraid 7.0
|
||||
|
||||
2. **Scope-Based Tool Filtering**
|
||||
- Before registering tools with MCP, verify the API key has appropriate permissions
|
||||
- Prevent exposing tools the key cannot use (avoid hallucinated capabilities)
|
||||
- Query current key permissions at startup
|
||||
|
||||
3. **Improved Error Handling**
|
||||
- Implement exponential backoff for rate limit errors (HTTP 429)
|
||||
- Better handling of `Long` scalar type values
|
||||
- Graceful degradation for unavailable schema fields
|
||||
|
||||
4. **API Key Authorization Flow**
|
||||
- Consider implementing the OAuth-like flow (`/ApiKeyAuthorize`) for user-friendly key generation
|
||||
- Enables scope-based consent before key creation
|
||||
|
||||
### Medium Priority
|
||||
|
||||
5. **Real-Time Notification Streaming**
|
||||
- Add WebSocket subscription for notifications
|
||||
- Allows proactive alerting (e.g., "Disk 5 is overheating") without user request
|
||||
|
||||
6. **File Manager Integration**
|
||||
- Add `list_files`, `read_file` tools using the native File Manager API (merged in 7.0)
|
||||
- Enables LLM to organize media or clean up `appdata`
|
||||
|
||||
7. **Pagination for Large Queries**
|
||||
- Implement `limit` and `offset` for log listings and file browsing
|
||||
- Prevent timeouts from massive result sets
|
||||
|
||||
8. **Flash Backup Trigger**
|
||||
- Add tool to trigger flash backup via API mutation
|
||||
- Monitor backup status
|
||||
|
||||
### Low Priority
|
||||
|
||||
9. **VM Snapshot Management**
|
||||
- Add `create_vm_snapshot`, `revert_to_snapshot`, `clone_vm`
|
||||
- Leverages QEMU snapshot support from Unraid 7.0
|
||||
|
||||
10. **Tailscale/VPN Status**
|
||||
- Query network schemas for Tailnet IPs and VPN connection status
|
||||
- Useful for remote management diagnostics
|
||||
|
||||
11. **Query Complexity Optimization**
|
||||
- Separate list queries (lightweight) from detail queries (heavy)
|
||||
- `list_docker_containers` should fetch only id/names/state
|
||||
- Detail queries should be on-demand
|
||||
|
||||
### Implementation Notes
|
||||
|
||||
- **GraphQL Sandbox Discovery:** Use the built-in sandbox at `http://SERVER/graphql` to discover exact mutation names and field types for any new tools
|
||||
- **Version Compatibility:** Consider checking the Unraid API version at startup and adjusting available tools accordingly
|
||||
- **SSL Configuration:** The `UNRAID_VERIFY_SSL` environment variable is already implemented -- ensure documentation guides users toward `myunraid.net` certificates for proper SSL
|
||||
- **PrefixedID Handling:** Container and VM IDs use the `PrefixedID` custom scalar -- ensure all ID-based operations handle this string type correctly
|
||||
|
||||
---
|
||||
|
||||
## 12. Source Bibliography
|
||||
|
||||
### Primary Sources (Official Documentation)
|
||||
- [Welcome to Unraid API | Unraid Docs](https://docs.unraid.net/API/)
|
||||
- [Using the Unraid API](https://docs.unraid.net/API/how-to-use-the-api/)
|
||||
- [API key authorization flow | Unraid Docs](https://docs.unraid.net/API/api-key-app-developer-authorization-flow/)
|
||||
- [Programmatic API key management | Unraid Docs](https://docs.unraid.net/API/programmatic-api-key-management/)
|
||||
- [Roadmap & Features | Unraid Docs](https://docs.unraid.net/API/upcoming-features/)
|
||||
- [Unraid Connect overview & setup | Unraid Docs](https://docs.unraid.net/connect/about/)
|
||||
- [Remote access | Unraid Docs](https://docs.unraid.net/connect/remote-access/)
|
||||
- [Automated flash backup | Unraid Docs](https://docs.unraid.net/connect/flash-backup/)
|
||||
- [Version 7.0.0 Release Notes](https://docs.unraid.net/unraid-os/release-notes/7.0.0/)
|
||||
- [Version 7.0.1 Release Notes](https://docs.unraid.net/unraid-os/release-notes/7.0.1/)
|
||||
- [Version 7.1.0 Release Notes](https://docs.unraid.net/unraid-os/release-notes/7.1.0/)
|
||||
|
||||
### Official / GitHub Sources
|
||||
- [GitHub - unraid/api: Unraid API / Connect / UI Monorepo](https://github.com/unraid/api)
|
||||
- [GitHub - jmagar/unraid-mcp](https://github.com/jmagar/unraid-mcp)
|
||||
- [api/docs/developer/development.md](https://github.com/unraid/api/blob/main/api/docs/developer/development.md)
|
||||
- [Unraid OS 7.2.0 Blog Post](https://unraid.net/blog/unraid-7-2-0)
|
||||
|
||||
### Community Sources
|
||||
- [PSUnraid PowerShell Module (Reddit)](https://www.reddit.com/r/unRAID/comments/1ph08wi/psunraid_powershell_m)
|
||||
- [Unraid MCP Server (Reddit)](https://www.reddit.com/r/unRAID/comments/1pl4s4j/unraid_mcp_server_que)
|
||||
- [unraid-management-agent (GitHub)](https://github.com/ruaan-deysel/unraid-management-agent)
|
||||
- [Unraid API Discussion (Reddit)](https://www.reddit.com/r/unRAID/comments/1h7xkjr/unraid_api/)
|
||||
- [API Key Location Question (Reddit)](https://www.reddit.com/r/unRAID/comments/1nk2jjk/i_couldnt_find_the_ap)
|
||||
|
||||
### Reference Sources
|
||||
- [GraphQL Specification](https://spec.graphql.org/)
|
||||
- [Learn GraphQL](https://graphql.org/learn/)
|
||||
- [GraphQL Subscriptions](https://graphql.org/learn/subscriptions/)
|
||||
- [Apollo GraphQL Sandbox](https://www.apollographql.com/docs/graphos/platform/sandbox)
|
||||
- [Model Context Protocol (MCP)](https://modelcontextprotocol.io/introduction)
|
||||
|
||||
---
|
||||
|
||||
## Cross-Source Analysis
|
||||
|
||||
### Where Sources Agree
|
||||
- The API is GraphQL-based with queries, mutations, and subscriptions
|
||||
- Unraid 7.2 is the version where API became native
|
||||
- API Keys are the primary authentication method for programmatic access
|
||||
- The endpoint is at `/graphql` on the server
|
||||
- The API supports Docker/VM lifecycle management
|
||||
- The monorepo is TypeScript/Node.js based
|
||||
|
||||
### Where Sources Disagree or Have Gaps
|
||||
- **Exact mutation names** are not documented publicly -- must use GraphQL Sandbox introspection
|
||||
- **Rate limit specifics** (thresholds, headers) are not publicly documented
|
||||
- **Container logs** -- the unraid-ssh-mcp developer claims they're unavailable via API, but this may have changed in newer versions
|
||||
- **Schema type issues** (Int overflow, NaN) are documented only in the unraid-mcp codebase, not in official docs
|
||||
|
||||
### Notable Insights
|
||||
1. The unraid-management-agent project provides capabilities the official API lacks, suggesting areas for API expansion
|
||||
2. PSUnraid confirms the API schema includes mutations for Docker/VM lifecycle with boolean return types
|
||||
3. The OAuth-like authorization flow is a sophisticated feature not commonly found in self-hosted server APIs
|
||||
4. The `Long` scalar type and `PrefixedID` type are custom additions critical for proper client implementation
|
||||
998
docs/research/unraid-api-source-analysis.md
Normal file
998
docs/research/unraid-api-source-analysis.md
Normal file
@@ -0,0 +1,998 @@
|
||||
# Unraid API Source Code Analysis
|
||||
|
||||
> **Research Date:** 2026-02-07
|
||||
> **Repository:** https://github.com/unraid/api
|
||||
> **Latest Version:** v4.29.2 (December 19, 2025)
|
||||
> **License:** Open-sourced January 2025
|
||||
|
||||
---
|
||||
|
||||
## Table of Contents
|
||||
|
||||
1. [Repository Structure](#1-repository-structure)
|
||||
2. [Technology Stack](#2-technology-stack)
|
||||
3. [GraphQL Schema & Type System](#3-graphql-schema--type-system)
|
||||
4. [Authentication & Authorization](#4-authentication--authorization)
|
||||
5. [Resolver Implementations](#5-resolver-implementations)
|
||||
6. [Subscription System](#6-subscription-system)
|
||||
7. [State Management](#7-state-management)
|
||||
8. [Plugin Architecture](#8-plugin-architecture)
|
||||
9. [Release History](#9-release-history)
|
||||
10. [Roadmap & Upcoming Features](#10-roadmap--upcoming-features)
|
||||
11. [Open Issues & Community Requests](#11-open-issues--community-requests)
|
||||
12. [Community Projects & Integrations](#12-community-projects--integrations)
|
||||
13. [Architectural Insights for unraid-mcp](#13-architectural-insights-for-unraid-mcp)
|
||||
|
||||
---
|
||||
|
||||
## 1. Repository Structure
|
||||
|
||||
The Unraid API is a **monorepo** managed with pnpm workspaces containing eight interconnected packages:
|
||||
|
||||
```
|
||||
unraid/api/
|
||||
├── api/ # NestJS GraphQL backend (port 3001)
|
||||
│ ├── src/
|
||||
│ │ ├── __test__/
|
||||
│ │ ├── common/ # Shared utilities
|
||||
│ │ ├── core/ # Core infrastructure
|
||||
│ │ │ ├── errors/
|
||||
│ │ │ ├── modules/
|
||||
│ │ │ ├── notifiers/
|
||||
│ │ │ ├── types/
|
||||
│ │ │ ├── utils/
|
||||
│ │ │ ├── log.ts
|
||||
│ │ │ └── pubsub.ts # PubSub for GraphQL subscriptions
|
||||
│ │ ├── i18n/ # Internationalization
|
||||
│ │ ├── mothership/ # Unraid Connect relay communication
|
||||
│ │ ├── store/ # Redux state management
|
||||
│ │ │ ├── actions/
|
||||
│ │ │ ├── listeners/
|
||||
│ │ │ ├── modules/
|
||||
│ │ │ ├── services/
|
||||
│ │ │ ├── state-parsers/
|
||||
│ │ │ ├── watch/
|
||||
│ │ │ └── root-reducer.ts
|
||||
│ │ ├── types/
|
||||
│ │ ├── unraid-api/ # Main API implementation
|
||||
│ │ │ ├── app/
|
||||
│ │ │ ├── auth/ # Authentication system
|
||||
│ │ │ ├── cli/
|
||||
│ │ │ ├── config/
|
||||
│ │ │ ├── cron/
|
||||
│ │ │ ├── decorators/
|
||||
│ │ │ ├── exceptions/
|
||||
│ │ │ ├── graph/ # GraphQL resolvers & services
|
||||
│ │ │ ├── nginx/
|
||||
│ │ │ ├── observers/
|
||||
│ │ │ ├── organizer/
|
||||
│ │ │ ├── plugin/
|
||||
│ │ │ ├── rest/ # REST API endpoints
|
||||
│ │ │ ├── shared/
|
||||
│ │ │ ├── types/
|
||||
│ │ │ ├── unraid-file-modifier/
|
||||
│ │ │ └── utils/
|
||||
│ │ ├── upnp/ # UPnP protocol
|
||||
│ │ ├── cli.ts
|
||||
│ │ ├── consts.ts
|
||||
│ │ ├── environment.ts
|
||||
│ │ └── index.ts
|
||||
│ ├── generated-schema.graphql # Auto-generated GraphQL schema
|
||||
│ ├── codegen.ts # GraphQL code generation config
|
||||
│ ├── Dockerfile
|
||||
│ └── docker-compose.yml
|
||||
├── web/ # Nuxt 3 frontend (Vue 3)
|
||||
│ ├── composables/gql/ # GraphQL composables
|
||||
│ ├── layouts/
|
||||
│ ├── src/
|
||||
│ └── codegen.ts
|
||||
├── unraid-ui/ # Vue 3 component library
|
||||
├── plugin/ # Plugin packaging
|
||||
├── packages/
|
||||
│ ├── unraid-shared/ # Shared types & utilities
|
||||
│ │ └── src/
|
||||
│ │ ├── pubsub/ # PubSub channel definitions
|
||||
│ │ ├── types/
|
||||
│ │ ├── graphql-enums.ts # AuthAction, Resource, Role enums
|
||||
│ │ ├── graphql.model.ts
|
||||
│ │ └── use-permissions.directive.ts
|
||||
│ ├── unraid-api-plugin-connect/
|
||||
│ ├── unraid-api-plugin-generator/
|
||||
│ └── unraid-api-plugin-health/
|
||||
├── scripts/
|
||||
├── pnpm-workspace.yaml
|
||||
├── .nvmrc # Node.js v22
|
||||
└── flake.nix # Nix dev environment
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 2. Technology Stack
|
||||
|
||||
### Backend
|
||||
| Component | Technology | Version |
|
||||
|-----------|-----------|---------|
|
||||
| Runtime | Node.js | v22 |
|
||||
| Framework | NestJS | 11.1.6 |
|
||||
| HTTP Server | Fastify | 5.5.0 |
|
||||
| GraphQL | Apollo Server | 4.12.2 |
|
||||
| Package Manager | pnpm | 10.15.0 |
|
||||
| Build Tool | Vite | 7.1.3 |
|
||||
| Test Framework | Vitest | 3.2.4 |
|
||||
| Docker SDK | Dockerode | 4.0.7 |
|
||||
| VM Management | @unraid/libvirt | 2.1.0 |
|
||||
| System Info | systeminformation | 5.27.8 |
|
||||
| File Watcher | Chokidar | 4.0.3 |
|
||||
| Auth RBAC | Casbin + nest-authz | 5.38.0 |
|
||||
| Auth Passport | Passport.js | Multiple strategies |
|
||||
| State Mgmt | Redux Toolkit | - |
|
||||
| Subscriptions | graphql-subscriptions | PubSub with EventEmitter |
|
||||
|
||||
### Frontend
|
||||
| Component | Technology | Version |
|
||||
|-----------|-----------|---------|
|
||||
| Framework | Vue 3 + Nuxt | 3.5.20 |
|
||||
| GraphQL Client | Apollo Client | 3.14.0 |
|
||||
| State | Pinia | 3.0.3 |
|
||||
| Styling | Tailwind CSS | v4 |
|
||||
|
||||
### Key Patterns
|
||||
- **Schema-first GraphQL** (migrating to code-first with NestJS decorators)
|
||||
- NestJS dependency injection with decorators
|
||||
- TypeScript ESM imports (`.js` extensions)
|
||||
- Redux for ephemeral runtime state synced with INI config files
|
||||
- Chokidar filesystem watchers for reactive config synchronization
|
||||
|
||||
---
|
||||
|
||||
## 3. GraphQL Schema & Type System
|
||||
|
||||
### Custom Scalars
|
||||
- `DateTime` - ISO date/time
|
||||
- `BigInt` - Large integer values
|
||||
- `JSON` - Arbitrary JSON data
|
||||
- `Port` - Network port numbers
|
||||
- `URL` - URL strings
|
||||
- `PrefixedID` - Server-prefixed identifiers (format: `server-prefix:uuid`)
|
||||
|
||||
### Core Enums
|
||||
|
||||
#### ArrayState
|
||||
```
|
||||
STARTED, STOPPED, NEW_ARRAY, RECON_DISK, DISABLE_DISK,
|
||||
SWAP_DSBL, INVALID_EXPANSION, PARITY_NOT_BIGGEST,
|
||||
TOO_MANY_MISSING_DISKS, NEW_DISK_TOO_SMALL, NO_DATA_DISKS
|
||||
```
|
||||
|
||||
#### ArrayDiskStatus
|
||||
```
|
||||
DISK_NP, DISK_OK, DISK_NP_MISSING, DISK_INVALID, DISK_WRONG,
|
||||
DISK_DSBL, DISK_NP_DSBL, DISK_DSBL_NEW, DISK_NEW
|
||||
```
|
||||
|
||||
#### ArrayDiskType
|
||||
```
|
||||
DATA, PARITY, FLASH, CACHE
|
||||
```
|
||||
|
||||
#### ArrayDiskFsColor
|
||||
```
|
||||
GREEN_ON, GREEN_BLINK, BLUE_ON, BLUE_BLINK,
|
||||
YELLOW_ON, YELLOW_BLINK, RED_ON, RED_OFF, GREY_OFF
|
||||
```
|
||||
|
||||
#### ContainerState
|
||||
```
|
||||
RUNNING, PAUSED, EXITED
|
||||
```
|
||||
|
||||
#### ContainerPortType
|
||||
```
|
||||
TCP, UDP
|
||||
```
|
||||
|
||||
#### VmState
|
||||
```
|
||||
NOSTATE, RUNNING, IDLE, PAUSED, SHUTDOWN,
|
||||
SHUTOFF, CRASHED, PMSUSPENDED
|
||||
```
|
||||
|
||||
#### NotificationImportance / NotificationType
|
||||
- Importance: Defines severity levels
|
||||
- Type: Categorizes notification sources
|
||||
|
||||
#### Role
|
||||
```
|
||||
ADMIN - Full administrative access
|
||||
CONNECT - Read access with remote management
|
||||
GUEST - Basic profile access
|
||||
VIEWER - Read-only access
|
||||
```
|
||||
|
||||
#### AuthAction
|
||||
```
|
||||
CREATE_ANY, CREATE_OWN
|
||||
READ_ANY, READ_OWN
|
||||
UPDATE_ANY, UPDATE_OWN
|
||||
DELETE_ANY, DELETE_OWN
|
||||
```
|
||||
|
||||
#### Resource (35 total)
|
||||
```
|
||||
ACTIVATION_CODE, API_KEY, ARRAY, CLOUD, CONFIG, CONNECT,
|
||||
CUSTOMIZATIONS, DASHBOARD, DISK, DOCKER, FLASH, INFO,
|
||||
LOGS, ME, NETWORK, NOTIFICATIONS, ONLINE, OS, OWNER,
|
||||
PERMISSION, REGISTRATION, SERVERS, SERVICES, SHARE,
|
||||
VARS, VMS, WELCOME, ...
|
||||
```
|
||||
|
||||
### Core Type Definitions
|
||||
|
||||
#### UnraidArray
|
||||
```graphql
|
||||
type UnraidArray {
|
||||
state: ArrayState!
|
||||
capacity: ArrayCapacity
|
||||
boot: ArrayDisk
|
||||
parities: [ArrayDisk!]!
|
||||
parityCheckStatus: ParityCheck
|
||||
disks: [ArrayDisk!]!
|
||||
caches: [ArrayDisk!]!
|
||||
}
|
||||
```
|
||||
|
||||
#### ArrayDisk
|
||||
```graphql
|
||||
type ArrayDisk implements Node {
|
||||
id: PrefixedID!
|
||||
idx: Int
|
||||
name: String
|
||||
device: String
|
||||
size: BigInt
|
||||
fsSize: String
|
||||
fsFree: String
|
||||
fsUsed: String
|
||||
status: ArrayDiskStatus
|
||||
rotational: Boolean
|
||||
temp: Int
|
||||
numReads: BigInt
|
||||
numWrites: BigInt
|
||||
numErrors: BigInt
|
||||
type: ArrayDiskType
|
||||
exportable: Boolean
|
||||
warning: Int
|
||||
critical: Int
|
||||
fsType: String
|
||||
comment: String
|
||||
format: String
|
||||
transport: String
|
||||
color: ArrayDiskFsColor
|
||||
isSpinning: Boolean
|
||||
}
|
||||
```
|
||||
|
||||
#### DockerContainer
|
||||
```graphql
|
||||
type DockerContainer implements Node {
|
||||
id: PrefixedID!
|
||||
names: [String!]
|
||||
image: String
|
||||
imageId: String
|
||||
command: String
|
||||
created: DateTime
|
||||
ports: [ContainerPort!]
|
||||
lanIpPorts: [String] # LAN-accessible host:port values
|
||||
sizeRootFs: BigInt
|
||||
sizeRw: BigInt
|
||||
sizeLog: BigInt
|
||||
labels: JSON
|
||||
state: ContainerState
|
||||
status: String
|
||||
hostConfig: JSON
|
||||
networkSettings: JSON
|
||||
mounts: JSON
|
||||
autoStart: Boolean
|
||||
autoStartOrder: Int
|
||||
autoStartWait: Int
|
||||
templatePath: String
|
||||
projectUrl: String
|
||||
registryUrl: String
|
||||
supportUrl: String
|
||||
iconUrl: String
|
||||
webUiUrl: String
|
||||
shell: String
|
||||
templatePorts: JSON
|
||||
isOrphaned: Boolean
|
||||
}
|
||||
```
|
||||
|
||||
#### VmDomain
|
||||
```graphql
|
||||
type VmDomain implements Node {
|
||||
id: PrefixedID! # UUID-based identifier
|
||||
name: String # Friendly name
|
||||
state: VmState! # Current state
|
||||
uuid: String @deprecated # Use id instead
|
||||
}
|
||||
```
|
||||
|
||||
#### Share
|
||||
```graphql
|
||||
type Share implements Node {
|
||||
id: PrefixedID!
|
||||
name: String
|
||||
comment: String
|
||||
free: String
|
||||
used: String
|
||||
total: String
|
||||
include: [String]
|
||||
exclude: [String]
|
||||
# Additional capacity/config fields
|
||||
}
|
||||
```
|
||||
|
||||
#### Info (System Information)
|
||||
```graphql
|
||||
type Info {
|
||||
time: DateTime
|
||||
baseboard: Baseboard
|
||||
cpu: CpuInfo
|
||||
devices: Devices
|
||||
display: DisplayInfo
|
||||
machineId: String
|
||||
memory: MemoryInfo
|
||||
os: OsInfo
|
||||
system: SystemInfo
|
||||
versions: Versions
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 4. Authentication & Authorization
|
||||
|
||||
### Authentication Methods
|
||||
|
||||
#### 1. API Key Authentication
|
||||
- **Header**: `x-api-key: YOUR_API_KEY`
|
||||
- Keys stored as JSON files in `/boot/config/plugins/unraid-api/`
|
||||
- Generated via WebGUI (Settings > Management Access > API Keys) or CLI (`unraid-api apikey --create`)
|
||||
- 32-byte hexadecimal keys generated using `crypto.randomBytes`
|
||||
- File system watcher (Chokidar) syncs in-memory cache with disk changes
|
||||
- Keys support both **roles** (simplified) and **permissions** (granular resource:action pairs)
|
||||
|
||||
**API Key Service (`api-key.service.ts`):**
|
||||
```typescript
|
||||
// Key creation validates:
|
||||
// - Name via Unicode-aware regex
|
||||
// - At least one role or permission required
|
||||
// - 32-byte hex key generation
|
||||
// - Overwrite support for existing keys
|
||||
|
||||
// Lookup methods:
|
||||
findById(id) // UUID-based lookup
|
||||
findByField(field, value) // Generic field search
|
||||
findByKey(key) // Direct secret key lookup for auth
|
||||
```
|
||||
|
||||
#### 2. Cookie-Based Sessions
|
||||
- CSRF token validation for non-GET requests
|
||||
- `timingSafeEqual` comparison prevents timing attacks
|
||||
- Session user ID: `-1`
|
||||
- Returns admin role privileges
|
||||
|
||||
#### 3. Local Sessions (CLI/System)
|
||||
- For CLI and system-level operations
|
||||
- Local session user ID: `-2`
|
||||
- Returns local admin with elevated privileges
|
||||
|
||||
#### 4. SSO/OIDC
|
||||
- OpenID Connect client implementation
|
||||
- Separate SSO module with auth, client, core, models, session, and utils subdirectories
|
||||
- JWT validation using Jose library
|
||||
|
||||
### Authorization (RBAC via Casbin)
|
||||
|
||||
**Model:** Resource-based access control with `_ANY` (universal) and `_OWN` (owner-limited) permission modifiers.
|
||||
|
||||
```typescript
|
||||
// Permission enforcement via decorators:
|
||||
@UsePermissions({
|
||||
action: AuthAction.READ_ANY,
|
||||
resource: Resource.ARRAY,
|
||||
})
|
||||
```
|
||||
|
||||
**Casbin Implementation (`api/src/unraid-api/auth/casbin/`):**
|
||||
- `casbin.service.ts` - Core RBAC service
|
||||
- `policy.ts` - Policy configuration
|
||||
- `model.ts` - RBAC model definitions
|
||||
- `resolve-subject.util.ts` - Subject resolution utility
|
||||
- Wildcard permission expansion (`*` -> full CRUD)
|
||||
- Role hierarchy with inherited permissions
|
||||
|
||||
### Auth Files Structure
|
||||
```
|
||||
api/src/unraid-api/auth/
|
||||
├── casbin/
|
||||
│ ├── casbin.module.ts
|
||||
│ ├── casbin.service.ts
|
||||
│ ├── model.ts
|
||||
│ ├── policy.ts
|
||||
│ └── resolve-subject.util.ts
|
||||
├── api-key.service.ts # API key CRUD operations
|
||||
├── auth.interceptor.ts # HTTP auth interceptor
|
||||
├── auth.module.ts # NestJS auth module
|
||||
├── auth.service.ts # Core auth logic (3 strategies)
|
||||
├── authentication.guard.ts # Route protection guard
|
||||
├── cookie.service.ts # Cookie handling
|
||||
├── cookie.strategy.ts # Cookie auth strategy
|
||||
├── fastify-throttler.guard.ts # Rate limiting
|
||||
├── header.strategy.ts # Header-based auth (API keys)
|
||||
├── local-session-lifecycle.service.ts
|
||||
├── local-session.service.ts
|
||||
├── local-session.strategy.ts
|
||||
├── public.decorator.ts # Mark endpoints as public
|
||||
└── user.decorator.ts # User injection decorator
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 5. Resolver Implementations
|
||||
|
||||
### Resolver Directory Structure
|
||||
```
|
||||
api/src/unraid-api/graph/resolvers/
|
||||
├── api-key/ # API key management (10 files)
|
||||
├── array/ # Array operations + parity (11 files)
|
||||
├── cloud/ # Cloud/Connect operations
|
||||
├── config/ # System configuration
|
||||
├── customization/ # UI customization
|
||||
├── disks/ # Disk management (6 files)
|
||||
├── display/ # Display settings
|
||||
├── docker/ # Docker management (36 files)
|
||||
├── flash/ # Flash drive operations
|
||||
├── flash-backup/ # Flash backup management
|
||||
├── info/ # System information (7 subdirs)
|
||||
│ ├── cpu/
|
||||
│ ├── devices/
|
||||
│ ├── display/
|
||||
│ ├── memory/
|
||||
│ ├── os/
|
||||
│ ├── system/
|
||||
│ └── versions/
|
||||
├── logs/ # Log management (8 files)
|
||||
├── metrics/ # System metrics (5 files)
|
||||
├── mutation/ # Root mutation resolver
|
||||
├── notifications/ # Notification management (7 files)
|
||||
├── online/ # Online status
|
||||
├── owner/ # Server owner info
|
||||
├── rclone/ # Cloud storage (8 files)
|
||||
├── registration/ # License/registration
|
||||
├── servers/ # Server management
|
||||
├── settings/ # Settings management (5 files)
|
||||
├── sso/ # SSO/OIDC (8 subdirs)
|
||||
├── ups/ # UPS monitoring (7 files)
|
||||
├── vars/ # Unraid variables
|
||||
└── vms/ # VM management (7 files)
|
||||
```
|
||||
|
||||
### Complete API Surface
|
||||
|
||||
#### Queries
|
||||
|
||||
| Domain | Query | Description | Permission |
|
||||
|--------|-------|-------------|------------|
|
||||
| **Array** | `array` | Get array data (state, capacity, disks, parities, caches) | READ_ANY:ARRAY |
|
||||
| **Disks** | `disks` | List all disks with temp, spin state, capacity | READ_ANY:DISK |
|
||||
| **Disks** | `disk(id)` | Get specific disk by PrefixedID | READ_ANY:DISK |
|
||||
| **Docker** | `docker` | Get Docker instance | READ_ANY:DOCKER |
|
||||
| **Docker** | `container(id)` | Get specific container | READ_ANY:DOCKER |
|
||||
| **Docker** | `containers` | List all containers (optional size info) | READ_ANY:DOCKER |
|
||||
| **Docker** | `logs(id, since, tail)` | Container logs with filtering | READ_ANY:DOCKER |
|
||||
| **Docker** | `networks` | Docker networks | READ_ANY:DOCKER |
|
||||
| **Docker** | `portConflicts` | Port conflict detection | READ_ANY:DOCKER |
|
||||
| **Docker** | `organizer` | Container organization structure | READ_ANY:DOCKER |
|
||||
| **Docker** | `containerUpdateStatuses` | Check update availability | READ_ANY:DOCKER |
|
||||
| **VMs** | `vms` | Get all VM domains | READ_ANY:VMS |
|
||||
| **Info** | `info` | System info (CPU, memory, OS, baseboard, devices, versions) | READ_ANY:INFO |
|
||||
| **Metrics** | `metrics` | System performance metrics | READ_ANY:INFO |
|
||||
| **Logs** | `logFiles` | List available log files | READ_ANY:LOGS |
|
||||
| **Logs** | `logFile(path, lines, startLine)` | Get specific log file content | READ_ANY:LOGS |
|
||||
| **Notifications** | `notifications` | Get all notifications | READ_ANY:NOTIFICATIONS |
|
||||
| **Notifications** | `overview` | Notification statistics | READ_ANY:NOTIFICATIONS |
|
||||
| **Notifications** | `list` | Filtered notification list | READ_ANY:NOTIFICATIONS |
|
||||
| **Notifications** | `warningsAndAlerts` | Deduplicated unread warnings/alerts | READ_ANY:NOTIFICATIONS |
|
||||
| **RClone** | `rclone` | Cloud storage backup settings | READ_ANY:FLASH |
|
||||
| **RClone** | `configForm(formOptions)` | Config form schemas | READ_ANY:FLASH |
|
||||
| **RClone** | `remotes` | List configured remote storage | READ_ANY:FLASH |
|
||||
| **UPS** | `upsDevices` | List UPS devices with status | READ_ANY:* |
|
||||
| **UPS** | `upsDeviceById(id)` | Specific UPS device | READ_ANY:* |
|
||||
| **UPS** | `upsConfiguration` | UPS configuration settings | READ_ANY:* |
|
||||
| **Settings** | `settings` | System settings + SSO config | READ_ANY:CONFIG |
|
||||
| **Shares** | `shares` | Storage shares with capacity | READ_ANY:SHARE |
|
||||
|
||||
#### Mutations
|
||||
|
||||
| Domain | Mutation | Description | Permission |
|
||||
|--------|---------|-------------|------------|
|
||||
| **Array** | `setState(input)` | Set array state (start/stop) | UPDATE_ANY:ARRAY |
|
||||
| **Array** | `addDiskToArray(input)` | Add disk to array | UPDATE_ANY:ARRAY |
|
||||
| **Array** | `removeDiskFromArray(input)` | Remove disk (array must be stopped) | UPDATE_ANY:ARRAY |
|
||||
| **Array** | `mountArrayDisk(id)` | Mount a disk | UPDATE_ANY:ARRAY |
|
||||
| **Array** | `unmountArrayDisk(id)` | Unmount a disk | UPDATE_ANY:ARRAY |
|
||||
| **Array** | `clearArrayDiskStatistics(id)` | Clear disk statistics | UPDATE_ANY:ARRAY |
|
||||
| **Parity** | `start(correct)` | Start parity check | UPDATE_ANY:ARRAY |
|
||||
| **Parity** | `pause` | Pause parity check | UPDATE_ANY:ARRAY |
|
||||
| **Parity** | `resume` | Resume parity check | UPDATE_ANY:ARRAY |
|
||||
| **Parity** | `cancel` | Cancel parity check | UPDATE_ANY:ARRAY |
|
||||
| **Docker** | `start(id)` | Start container | UPDATE_ANY:DOCKER |
|
||||
| **Docker** | `stop(id)` | Stop container | UPDATE_ANY:DOCKER |
|
||||
| **Docker** | `pause(id)` | Pause container | UPDATE_ANY:DOCKER |
|
||||
| **Docker** | `unpause(id)` | Unpause container | UPDATE_ANY:DOCKER |
|
||||
| **Docker** | `removeContainer(id, withImage?)` | Remove container (optionally with image) | DELETE_ANY:DOCKER |
|
||||
| **Docker** | `updateContainer(id)` | Update to latest image | UPDATE_ANY:DOCKER |
|
||||
| **Docker** | `updateContainers(ids)` | Update multiple containers | UPDATE_ANY:DOCKER |
|
||||
| **Docker** | `updateAllContainers` | Update all with available updates | UPDATE_ANY:DOCKER |
|
||||
| **Docker** | `updateAutostartConfiguration` | Update auto-start config (feature flag) | UPDATE_ANY:DOCKER |
|
||||
| **Docker** | `createDockerFolder` | Create organizational folder | UPDATE_ANY:DOCKER |
|
||||
| **Docker** | `setDockerFolderChildren` | Manage folder contents | UPDATE_ANY:DOCKER |
|
||||
| **Docker** | `deleteDockerEntries` | Remove folders | UPDATE_ANY:DOCKER |
|
||||
| **Docker** | `moveDockerEntriesToFolder` | Reorganize containers | UPDATE_ANY:DOCKER |
|
||||
| **Docker** | `moveDockerItemsToPosition` | Position items | UPDATE_ANY:DOCKER |
|
||||
| **Docker** | `renameDockerFolder` | Rename folder | UPDATE_ANY:DOCKER |
|
||||
| **Docker** | `createDockerFolderWithItems` | Create folder with items | UPDATE_ANY:DOCKER |
|
||||
| **Docker** | `syncDockerTemplatePaths` | Sync template data | UPDATE_ANY:DOCKER |
|
||||
| **Docker** | `resetDockerTemplateMappings` | Reset to defaults | UPDATE_ANY:DOCKER |
|
||||
| **VMs** | `start(id)` | Start VM | UPDATE_ANY:VMS |
|
||||
| **VMs** | `stop(id)` | Stop VM | UPDATE_ANY:VMS |
|
||||
| **VMs** | `pause(id)` | Pause VM | UPDATE_ANY:VMS |
|
||||
| **VMs** | `resume(id)` | Resume VM | UPDATE_ANY:VMS |
|
||||
| **VMs** | `forceStop(id)` | Force stop VM | UPDATE_ANY:VMS |
|
||||
| **VMs** | `reboot(id)` | Reboot VM | UPDATE_ANY:VMS |
|
||||
| **VMs** | `reset(id)` | Reset VM | UPDATE_ANY:VMS |
|
||||
| **Notifications** | `createNotification(input)` | Create notification | CREATE_ANY:NOTIFICATIONS |
|
||||
| **Notifications** | `deleteNotification(id, type)` | Delete notification | DELETE_ANY:NOTIFICATIONS |
|
||||
| **Notifications** | `deleteArchivedNotifications` | Clear all archived | DELETE_ANY:NOTIFICATIONS |
|
||||
| **Notifications** | `archiveNotification(id)` | Archive single | UPDATE_ANY:NOTIFICATIONS |
|
||||
| **Notifications** | `archiveNotifications(ids)` | Archive multiple | UPDATE_ANY:NOTIFICATIONS |
|
||||
| **Notifications** | `archiveAll(importance?)` | Archive all (optional filter) | UPDATE_ANY:NOTIFICATIONS |
|
||||
| **Notifications** | `unreadNotification(id)` | Mark as unread | UPDATE_ANY:NOTIFICATIONS |
|
||||
| **Notifications** | `unarchiveNotifications(ids)` | Restore archived | UPDATE_ANY:NOTIFICATIONS |
|
||||
| **Notifications** | `unarchiveAll(importance?)` | Restore all archived | UPDATE_ANY:NOTIFICATIONS |
|
||||
| **Notifications** | `notifyIfUnique(input)` | Create if no equivalent exists | CREATE_ANY:NOTIFICATIONS |
|
||||
| **Notifications** | `recalculateOverview` | Recompute overview stats | UPDATE_ANY:NOTIFICATIONS |
|
||||
| **RClone** | `createRCloneRemote(input)` | Create remote storage | CREATE_ANY:FLASH |
|
||||
| **RClone** | `deleteRCloneRemote(input)` | Delete remote storage | DELETE_ANY:FLASH |
|
||||
| **UPS** | `configureUps(config)` | Update UPS configuration | UPDATE_ANY:* |
|
||||
| **API Keys** | `createApiKey(input)` | Create API key | CREATE_ANY:API_KEY |
|
||||
| **API Keys** | `addRoleForApiKey(input)` | Add role to key | UPDATE_ANY:API_KEY |
|
||||
| **API Keys** | `removeRoleFromApiKey(input)` | Remove role from key | UPDATE_ANY:API_KEY |
|
||||
| **API Keys** | `deleteApiKeys(input)` | Delete API keys | DELETE_ANY:API_KEY |
|
||||
| **API Keys** | `updateApiKey(input)` | Update API key | UPDATE_ANY:API_KEY |
|
||||
|
||||
---
|
||||
|
||||
## 6. Subscription System
|
||||
|
||||
### PubSub Architecture
|
||||
|
||||
The subscription system uses `graphql-subscriptions` PubSub with a Node.js EventEmitter (max 30 listeners).
|
||||
|
||||
**Core PubSub (`api/src/core/pubsub.ts`):**
|
||||
```typescript
|
||||
import EventEmitter from 'events';
|
||||
import { GRAPHQL_PUBSUB_CHANNEL } from '@unraid/shared/pubsub/graphql.pubsub.js';
|
||||
import { PubSub } from 'graphql-subscriptions';
|
||||
|
||||
const eventEmitter = new EventEmitter();
|
||||
eventEmitter.setMaxListeners(30);
|
||||
|
||||
export const pubsub = new PubSub({ eventEmitter });
|
||||
|
||||
export const createSubscription = <T = any>(
|
||||
channel: GRAPHQL_PUBSUB_CHANNEL | string
|
||||
): AsyncIterableIterator<T> => {
|
||||
return pubsub.asyncIterableIterator<T>(channel);
|
||||
};
|
||||
```
|
||||
|
||||
### PubSub Channel Definitions
|
||||
|
||||
**Source:** `packages/unraid-shared/src/pubsub/graphql.pubsub.ts`
|
||||
|
||||
```typescript
|
||||
export const GRAPHQL_PUBSUB_TOKEN = "GRAPHQL_PUBSUB";
|
||||
|
||||
export enum GRAPHQL_PUBSUB_CHANNEL {
|
||||
ARRAY = "ARRAY",
|
||||
CPU_UTILIZATION = "CPU_UTILIZATION",
|
||||
CPU_TELEMETRY = "CPU_TELEMETRY",
|
||||
DASHBOARD = "DASHBOARD",
|
||||
DISPLAY = "DISPLAY",
|
||||
INFO = "INFO",
|
||||
MEMORY_UTILIZATION = "MEMORY_UTILIZATION",
|
||||
NOTIFICATION = "NOTIFICATION",
|
||||
NOTIFICATION_ADDED = "NOTIFICATION_ADDED",
|
||||
NOTIFICATION_OVERVIEW = "NOTIFICATION_OVERVIEW",
|
||||
NOTIFICATION_WARNINGS_AND_ALERTS = "NOTIFICATION_WARNINGS_AND_ALERTS",
|
||||
OWNER = "OWNER",
|
||||
SERVERS = "SERVERS",
|
||||
VMS = "VMS",
|
||||
DOCKER_STATS = "DOCKER_STATS",
|
||||
LOG_FILE = "LOG_FILE",
|
||||
PARITY = "PARITY",
|
||||
}
|
||||
```
|
||||
|
||||
### Available Subscriptions
|
||||
|
||||
| Subscription | Channel | Interval | Description |
|
||||
|-------------|---------|----------|-------------|
|
||||
| `arraySubscription` | ARRAY | Event-based | Real-time array state changes |
|
||||
| `systemMetricsCpu` | CPU_UTILIZATION | 1 second | CPU utilization data |
|
||||
| `systemMetricsCpuTelemetry` | CPU_TELEMETRY | 5 seconds | CPU power & temperature |
|
||||
| `systemMetricsMemory` | MEMORY_UTILIZATION | 2 seconds | Memory utilization |
|
||||
| `dockerContainerStats` | DOCKER_STATS | Polling | Container performance stats |
|
||||
| `logFileSubscription(path)` | LOG_FILE (dynamic) | Event-based | Real-time log file updates |
|
||||
| `notificationAdded` | NOTIFICATION_ADDED | Event-based | New notification created |
|
||||
| `notificationsOverview` | NOTIFICATION_OVERVIEW | Event-based | Overview stats updates |
|
||||
| `notificationsWarningsAndAlerts` | NOTIFICATION_WARNINGS_AND_ALERTS | Event-based | Warning/alert changes |
|
||||
| `upsUpdates` | - | Event-based | UPS device status changes |
|
||||
|
||||
### Subscription Management Services
|
||||
|
||||
Three-tier subscription management:
|
||||
|
||||
1. **SubscriptionManagerService** (low-level, internal)
|
||||
- Manages both polling and event-based subscriptions
|
||||
- Polling: Creates intervals via NestJS SchedulerRegistry with overlap guards
|
||||
- Event-based: Persistent listeners until explicitly stopped
|
||||
- Methods: `startSubscription()`, `stopSubscription()`, `stopAll()`, `isSubscriptionActive()`
|
||||
|
||||
2. **SubscriptionTrackerService** (mid-level)
|
||||
- Reference-counted subscriptions (auto-cleanup when no subscribers)
|
||||
|
||||
3. **SubscriptionHelperService** (high-level, for resolvers)
|
||||
- GraphQL subscriptions with automatic cleanup
|
||||
- Used directly in resolver decorators
|
||||
|
||||
**Dynamic Topics:** The LOG_FILE channel supports dynamic paths like `LOG_FILE:/var/log/test.log` for monitoring specific log files.
|
||||
|
||||
---
|
||||
|
||||
## 7. State Management
|
||||
|
||||
### Redux Store Architecture
|
||||
|
||||
The API uses Redux Toolkit for ephemeral runtime state derived from persistent INI configuration files stored in `/boot/config/`.
|
||||
|
||||
```
|
||||
api/src/store/
|
||||
├── actions/ # Redux action creators
|
||||
├── listeners/ # State change event listeners
|
||||
├── modules/ # Modular state slices
|
||||
├── services/ # Business logic
|
||||
├── state-parsers/ # INI file parsing utilities
|
||||
├── watch/ # Filesystem watchers (Chokidar)
|
||||
├── index.ts # Store initialization
|
||||
├── root-reducer.ts # Combined reducer
|
||||
└── types.ts # State type definitions
|
||||
```
|
||||
|
||||
**Key Design:** The StateManager singleton uses Chokidar to watch filesystem changes on INI config files, enabling reactive synchronization without polling. This accommodates legacy CLI tools and scripts that modify configuration outside the API.
|
||||
|
||||
---
|
||||
|
||||
## 8. Plugin Architecture
|
||||
|
||||
### Dynamic Plugin System
|
||||
|
||||
The API supports dynamic plugin loading at runtime through NestJS:
|
||||
|
||||
```
|
||||
packages/
|
||||
├── unraid-api-plugin-connect/ # Remote access, UPnP integration
|
||||
├── unraid-api-plugin-generator/ # Code generation
|
||||
├── unraid-api-plugin-health/ # Health monitoring
|
||||
└── unraid-shared/ # Shared types, enums, utilities
|
||||
```
|
||||
|
||||
**Plugin Loading:** Plugins load conditionally based on installation state. The `unraid-api-plugin-connect` handles remote access as an optional peer dependency.
|
||||
|
||||
### Schema Migration Status
|
||||
|
||||
The API is **actively migrating** from schema-first to code-first GraphQL:
|
||||
|
||||
- **Completed:** API Key Resolver (1/21)
|
||||
- **Pending (20 resolvers):** Docker, Array, Disks, VMs, Connect, Display, Info, Owner, Unassigned Devices, Cloud, Flash, Config, Vars, Logs, Users, Notifications, Network, Registration, Servers, Services, Shares
|
||||
|
||||
**Migration pattern per resolver:**
|
||||
1. Create model files with `@ObjectType()` and `@InputType()` decorators
|
||||
2. Define return types and input parameters as classes
|
||||
3. Update resolver to use new model classes
|
||||
4. Create module file for dependency registration
|
||||
5. Test functionality
|
||||
|
||||
---
|
||||
|
||||
## 9. Release History
|
||||
|
||||
### Recent Releases (Reverse Chronological)
|
||||
|
||||
| Version | Date | Highlights |
|
||||
|---------|------|------------|
|
||||
| **v4.29.2** | Dec 19, 2025 | Fix: connect plugin not loaded when connect installed |
|
||||
| **v4.29.1** | Dec 19, 2025 | Reverted docker overview web component; fixed GUID/license race |
|
||||
| **v4.29.0** | Dec 19, 2025 | Feature: Docker overview web component for 7.3+ |
|
||||
| **v4.28.2** | Dec 16, 2025 | API startup timeout for v7.0 and v6.12 |
|
||||
| **v4.28.0** | Dec 15, 2025 | Feature: Plugin cleanup on OS upgrade cancel; keyfile polling; dark mode |
|
||||
| **v4.27.2** | Nov 21, 2025 | Fix: header flashing and trial date display |
|
||||
| **v4.27.0** | Nov 19, 2025 | Feature: Removed API log download; fixed connect plugin uninstall |
|
||||
| **v4.26.0** | Nov 17, 2025 | Feature: CPU power query/subscription; Apollo Studio schema publish |
|
||||
| **v4.25.0** | Sep 26, 2025 | Feature: Tailwind scoping; notification filter pills |
|
||||
| **v4.24.0** | Sep 18, 2025 | Feature: Optimized DOM content loading |
|
||||
| **v4.23.0** | Sep 16, 2025 | Feature: API status manager |
|
||||
|
||||
### Milestone Releases
|
||||
- **Open-sourced:** January 2025
|
||||
- **v4.0.0:** OIDC/SSO support and permissions system
|
||||
- **Native in Unraid 7.2+:** October 29, 2025
|
||||
|
||||
---
|
||||
|
||||
## 10. Roadmap & Upcoming Features
|
||||
|
||||
### Near-Term (Q1-Q2 2025, some may be completed)
|
||||
- Developer Tools for Plugins (Q2)
|
||||
- New modernized settings pages (Q2)
|
||||
- Redesigned Unraid Connect configuration (Q1)
|
||||
- Custom theme creation (Q2-Q3)
|
||||
- Storage pool management (Q2)
|
||||
|
||||
### Mid-Term (Q3 2025)
|
||||
- Modern Docker status interface redesign
|
||||
- New plugins interface with redesigned management UI
|
||||
- Streamlined Docker container deployment
|
||||
- Real-time pool health monitoring
|
||||
|
||||
### Under Consideration (TBD)
|
||||
- Docker Compose native support
|
||||
- Advanced plugin configuration/development tools
|
||||
- Storage share creation, settings, and unified management dashboard
|
||||
|
||||
---
|
||||
|
||||
## 11. Open Issues & Community Requests
|
||||
|
||||
### Open Issues: 32 total
|
||||
|
||||
#### Feature Requests (Enhancements)
|
||||
| Issue | Title | Description |
|
||||
|-------|-------|-------------|
|
||||
| #1873 | Invoke Mover through API | Programmatic access to the Mover tool |
|
||||
| #1872 | CLI list with creation dates | Timestamp data in CLI operations |
|
||||
| #1871 | Container restart/update mutation | Single operation to restart+update containers |
|
||||
| #1839 | SMART disk data | Detailed disk health monitoring via SMART |
|
||||
| #1827-1828 | Nuxt UI upgrades | Interface modernization |
|
||||
|
||||
#### Reported Bugs
|
||||
| Issue | Title | Impact |
|
||||
|-------|-------|--------|
|
||||
| #1861 | VM suspension issues | Cannot unsuspend PMSUSPENDED VMs |
|
||||
| #1842 | Temperature inconsistency | SSD temps unavailable in Disk queries but accessible via Array |
|
||||
| #1840 | Cache invalidation | Docker container data stale after external changes |
|
||||
| #1837 | GraphQL partial failures | Entire queries fail when VMs/Docker unavailable |
|
||||
| #1859 | Notification counting errors | Archive counts include duplicates |
|
||||
| #1818 | Network query failures | GraphQL returns empty lists for network data |
|
||||
| #1825 | UPS false data | Hardcoded values returned when no UPS connected |
|
||||
|
||||
#### Key Takeaways for unraid-mcp
|
||||
1. **#1837 is critical**: We should handle partial GraphQL failures gracefully
|
||||
2. **#1842**: Temperature data should be queried from Array endpoint, not Disk
|
||||
3. **#1840**: Docker cache may return stale data; consider cache-busting strategies
|
||||
4. **#1825**: UPS data validation needed - API returns fake data with no UPS
|
||||
5. **#1861**: VM `PMSUSPENDED` state needs special handling
|
||||
6. **#1871**: Container restart+update is a common need not yet in the API
|
||||
|
||||
---
|
||||
|
||||
## 12. Community Projects & Integrations
|
||||
|
||||
### 1. Unraid Management Agent (Go)
|
||||
**Repository:** https://github.com/ruaan-deysel/unraid-management-agent
|
||||
**Author:** Ruaan Deysel
|
||||
**Language:** Go
|
||||
|
||||
A comprehensive third-party plugin providing:
|
||||
- **57 REST endpoints** at `http://localhost:8043/api/v1`
|
||||
- **54 MCP tools** for AI agent integration
|
||||
- **41 Prometheus metrics** for monitoring
|
||||
- **WebSocket** real-time event streaming
|
||||
- **MQTT** publishing for IoT integration
|
||||
|
||||
**Architecture:** Event-driven with collectors -> event bus -> API cache pattern
|
||||
- System Collector (15s): CPU, RAM, temperatures
|
||||
- Array/Disk Collectors (30s): Storage metrics
|
||||
- Docker/VM Collectors (30s): Container/VM data
|
||||
- Native Go libraries (Docker SDK, libvirt bindings, /proc/sys access)
|
||||
|
||||
**Key Endpoints:**
|
||||
```
|
||||
/api/v1/health # Health check
|
||||
/api/v1/system # System info
|
||||
/api/v1/array # Array status
|
||||
/api/v1/disks # Disk info
|
||||
/api/v1/docker # Docker containers
|
||||
/api/v1/vm # Virtual machines
|
||||
/api/v1/network # Network interfaces
|
||||
/api/v1/shares # User shares
|
||||
/api/v1/gpu # GPU metrics
|
||||
/api/v1/ups # UPS status
|
||||
/api/v1/settings/* # Disk thresholds, mover config
|
||||
/api/v1/plugins # Plugin info
|
||||
/api/v1/updates # Update status
|
||||
```
|
||||
|
||||
### 2. Home Assistant - domalab/ha-unraid
|
||||
**Repository:** https://github.com/domalab/ha-unraid
|
||||
**Status:** Active (rebuilt in 2025.12.0 for GraphQL)
|
||||
**Requires:** Unraid 7.2.0+, API key
|
||||
|
||||
**Features:**
|
||||
- CPU usage, temperature, power consumption monitoring
|
||||
- Memory utilization tracking
|
||||
- Array state, per-disk and per-share metrics
|
||||
- Docker container start/stop switches
|
||||
- VM management controls
|
||||
- UPS monitoring with energy dashboard integration
|
||||
- Notification counts
|
||||
- Dynamic entity creation (only creates entities for available services)
|
||||
|
||||
**Polling:** System data 30s, storage data 5min
|
||||
|
||||
### 3. Home Assistant - chris-mc1/unraid_api
|
||||
**Repository:** https://github.com/chris-mc1/unraid_api
|
||||
**Status:** Active
|
||||
**Requires:** Unraid 7.2+, API key with Info/Servers/Array/Disk/Share read permissions
|
||||
|
||||
**Features:**
|
||||
- Array status, storage utilization
|
||||
- RAM and CPU usage
|
||||
- Per-share free space (optional)
|
||||
- Per-disk metrics: temperature, spin state, capacity
|
||||
- Python-based (99.9%)
|
||||
|
||||
### 4. Home Assistant - ruaan-deysel/ha-unraid
|
||||
**Repository:** https://github.com/ruaan-deysel/ha-unraid
|
||||
**Status:** Active
|
||||
**Note:** Uses the management agent's REST API rather than official GraphQL
|
||||
|
||||
### 5. Home Assistant - IDmedia/hass-unraid
|
||||
**Repository:** https://github.com/IDmedia/hass-unraid
|
||||
**Approach:** Docker container that parses WebSocket messages and forwards to HA via MQTT
|
||||
|
||||
### 6. unraid-mcp (This Project)
|
||||
**Repository:** https://github.com/jmagar/unraid-mcp
|
||||
**Language:** Python (FastMCP)
|
||||
**Features:** 26 MCP tools, GraphQL client, WebSocket subscriptions
|
||||
|
||||
---
|
||||
|
||||
## 13. Architectural Insights for unraid-mcp
|
||||
|
||||
### Gaps in Our Current Implementation
|
||||
|
||||
Based on this research, potential improvements for unraid-mcp:
|
||||
|
||||
#### Missing Queries We Could Add
|
||||
1. **Metrics subscriptions** - CPU (1s), CPU telemetry (5s), memory (2s) real-time data
|
||||
2. **Docker port conflicts** - `portConflicts` query
|
||||
3. **Docker organizer** - Folder management queries/mutations
|
||||
4. **Docker update statuses** - Check for container image updates
|
||||
5. **Parity check operations** - Start (with correct flag), pause, resume, cancel
|
||||
6. **UPS monitoring** - Devices, configuration, real-time updates subscription
|
||||
7. **API key management** - Full CRUD on API keys
|
||||
8. **Settings management** - System settings queries
|
||||
9. **SSO/OIDC configuration** - SSO settings
|
||||
10. **Disk mount/unmount** - `mountArrayDisk` and `unmountArrayDisk` mutations
|
||||
11. **Container removal** - `removeContainer` with optional image cleanup
|
||||
12. **Container bulk updates** - `updateContainers` and `updateAllContainers`
|
||||
13. **Flash backup** - Flash drive backup operations
|
||||
|
||||
#### GraphQL Query Patterns to Match
|
||||
|
||||
**Official query examples from Unraid docs:**
|
||||
```graphql
|
||||
# System Status
|
||||
query {
|
||||
info {
|
||||
os { platform, distro, release, uptime }
|
||||
cpu { manufacturer, brand, cores, threads }
|
||||
}
|
||||
}
|
||||
|
||||
# Array Monitoring
|
||||
query {
|
||||
array {
|
||||
state
|
||||
capacity { disks { free, used, total } }
|
||||
disks { name, size, status, temp }
|
||||
}
|
||||
}
|
||||
|
||||
# Docker Containers
|
||||
query {
|
||||
dockerContainers {
|
||||
id, names, state, status, autoStart
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### Authentication Best Practices
|
||||
- Use `x-api-key` header (not query parameters)
|
||||
- API keys need specific resource:action permissions
|
||||
- For our MCP server, recommend keys with: `READ_ANY` on all resources + `UPDATE_ANY` on DOCKER, VMS, ARRAY for management operations
|
||||
- Keys are stored at `/boot/config/plugins/unraid-api/`
|
||||
|
||||
#### Known Issues to Handle
|
||||
1. **Partial query failures (#1837):** Wrap individual sections in try/catch; don't let VM failures crash Docker queries
|
||||
2. **Temperature inconsistency (#1842):** Prefer Array endpoint for temperature data
|
||||
3. **Docker cache staleness (#1840):** Use cache-busting options when available
|
||||
4. **UPS phantom data (#1825):** Validate UPS data before presenting
|
||||
5. **VM PMSUSPENDED (#1861):** Handle this state explicitly; unsuspend may fail
|
||||
6. **Increased timeouts for disks:** The official API uses 90s read timeouts for disk operations
|
||||
|
||||
#### Subscription Channel Mapping
|
||||
|
||||
Our subscription implementation should align with the official channels:
|
||||
```
|
||||
ARRAY -> array state changes
|
||||
CPU_UTILIZATION -> 1s CPU metrics
|
||||
CPU_TELEMETRY -> 5s CPU power/temp
|
||||
MEMORY_UTILIZATION -> 2s memory metrics
|
||||
DOCKER_STATS -> container stats
|
||||
LOG_FILE + dynamic path -> log file tailing
|
||||
NOTIFICATION_ADDED -> new notifications
|
||||
NOTIFICATION_OVERVIEW -> notification counts
|
||||
NOTIFICATION_WARNINGS_AND_ALERTS -> warnings/alerts
|
||||
PARITY -> parity check progress
|
||||
VMS -> VM state changes
|
||||
```
|
||||
|
||||
#### Performance Considerations
|
||||
- Max 30 concurrent subscription connections (EventEmitter limit)
|
||||
- Disk operations need extended timeouts (90s+)
|
||||
- Docker `sizeRootFs` query is expensive; make it optional
|
||||
- Storage data polling at 5min intervals (not faster) due to SMART query overhead
|
||||
- cache-manager v7 expects TTL in milliseconds (not seconds)
|
||||
|
||||
---
|
||||
|
||||
## Appendix: Key Source File References
|
||||
|
||||
| File | Purpose |
|
||||
|------|---------|
|
||||
| `packages/unraid-shared/src/pubsub/graphql.pubsub.ts` | PubSub channel enum (17 channels) |
|
||||
| `packages/unraid-shared/src/graphql-enums.ts` | AuthAction, Resource (35), Role enums |
|
||||
| `packages/unraid-shared/src/graphql.model.ts` | Shared GraphQL models |
|
||||
| `packages/unraid-shared/src/use-permissions.directive.ts` | Permission enforcement decorator |
|
||||
| `api/src/core/pubsub.ts` | PubSub singleton + subscription factory |
|
||||
| `api/src/unraid-api/auth/auth.service.ts` | 3-strategy auth (API key, cookie, local) |
|
||||
| `api/src/unraid-api/auth/api-key.service.ts` | API key CRUD + validation |
|
||||
| `api/src/unraid-api/auth/casbin/policy.ts` | RBAC policy definitions |
|
||||
| `api/src/unraid-api/graph/resolvers/docker/docker.resolver.ts` | Docker queries + organizer |
|
||||
| `api/src/unraid-api/graph/resolvers/docker/docker.mutations.resolver.ts` | Docker mutations (9 ops) |
|
||||
| `api/src/unraid-api/graph/resolvers/vms/vms.resolver.ts` | VM queries |
|
||||
| `api/src/unraid-api/graph/resolvers/vms/vms.mutations.resolver.ts` | VM mutations (7 ops) |
|
||||
| `api/src/unraid-api/graph/resolvers/array/array.resolver.ts` | Array query + subscription |
|
||||
| `api/src/unraid-api/graph/resolvers/array/array.mutations.resolver.ts` | Array mutations (6 ops) |
|
||||
| `api/src/unraid-api/graph/resolvers/array/parity.mutations.resolver.ts` | Parity mutations (4 ops) |
|
||||
| `api/src/unraid-api/graph/resolvers/notifications/notifications.resolver.ts` | Notification CRUD + subs |
|
||||
| `api/src/unraid-api/graph/resolvers/metrics/metrics.resolver.ts` | System metrics + subs |
|
||||
| `api/src/unraid-api/graph/resolvers/logs/logs.resolver.ts` | Log queries + subscription |
|
||||
| `api/src/unraid-api/graph/resolvers/rclone/rclone.resolver.ts` | RClone queries |
|
||||
| `api/src/unraid-api/graph/resolvers/rclone/rclone.mutation.resolver.ts` | RClone mutations |
|
||||
| `api/src/unraid-api/graph/resolvers/ups/ups.resolver.ts` | UPS queries + mutations + sub |
|
||||
| `api/src/unraid-api/graph/resolvers/api-key/api-key.mutation.ts` | API key mutations (5 ops) |
|
||||
| `api/generated-schema.graphql` | Complete auto-generated schema |
|
||||
282
pyproject.toml
282
pyproject.toml
@@ -1,54 +1,177 @@
|
||||
# ============================================================================
|
||||
# Build System Configuration
|
||||
# ============================================================================
|
||||
[build-system]
|
||||
requires = ["hatchling"]
|
||||
requires = ["hatchling>=1.25.0"]
|
||||
build-backend = "hatchling.build"
|
||||
|
||||
# ============================================================================
|
||||
# Project Metadata
|
||||
# ============================================================================
|
||||
[project]
|
||||
name = "unraid-mcp"
|
||||
version = "0.2.0"
|
||||
description = "MCP Server for Unraid API - provides tools to interact with an Unraid server's GraphQL API"
|
||||
readme = "README.md"
|
||||
license = {file = "LICENSE"}
|
||||
requires-python = ">=3.10"
|
||||
authors = [
|
||||
{name = "jmagar", email = "jmagar@users.noreply.github.com"}
|
||||
]
|
||||
readme = "README.md"
|
||||
license = {text = "MIT"}
|
||||
requires-python = ">=3.10"
|
||||
maintainers = [
|
||||
{name = "jmagar", email = "jmagar@users.noreply.github.com"}
|
||||
]
|
||||
keywords = [
|
||||
"unraid",
|
||||
"mcp",
|
||||
"model-context-protocol",
|
||||
"graphql",
|
||||
"api",
|
||||
"server",
|
||||
"docker",
|
||||
"automation",
|
||||
"monitoring",
|
||||
"homelab",
|
||||
]
|
||||
classifiers = [
|
||||
# Development Status
|
||||
"Development Status :: 4 - Beta",
|
||||
|
||||
# Audience
|
||||
"Intended Audience :: Developers",
|
||||
"Intended Audience :: System Administrators",
|
||||
|
||||
# License
|
||||
"License :: OSI Approved :: MIT License",
|
||||
|
||||
# Python Versions
|
||||
"Programming Language :: Python :: 3",
|
||||
"Programming Language :: Python :: 3.10",
|
||||
"Programming Language :: Python :: 3.11",
|
||||
"Programming Language :: Python :: 3.12",
|
||||
"Programming Language :: Python :: 3.13",
|
||||
]
|
||||
keywords = ["unraid", "mcp", "graphql", "api", "server"]
|
||||
"Programming Language :: Python :: 3 :: Only",
|
||||
|
||||
# Framework
|
||||
"Framework :: FastAPI",
|
||||
"Framework :: Pydantic",
|
||||
|
||||
# Topics
|
||||
"Topic :: Home Automation",
|
||||
"Topic :: System :: Monitoring",
|
||||
"Topic :: System :: Systems Administration",
|
||||
"Topic :: Software Development :: Libraries :: Python Modules",
|
||||
|
||||
# Environment
|
||||
"Operating System :: OS Independent",
|
||||
"Environment :: Console",
|
||||
"Typing :: Typed",
|
||||
]
|
||||
|
||||
# ============================================================================
|
||||
# Dependencies
|
||||
# ============================================================================
|
||||
dependencies = [
|
||||
"python-dotenv>=1.1.1",
|
||||
"fastmcp>=2.11.2",
|
||||
"httpx>=0.28.1",
|
||||
"fastapi>=0.116.1",
|
||||
"uvicorn>=0.35.0",
|
||||
"uvicorn[standard]>=0.35.0",
|
||||
"websockets>=13.1,<14.0",
|
||||
"rich>=14.1.0",
|
||||
"pytz>=2025.2",
|
||||
]
|
||||
|
||||
[project.optional-dependencies]
|
||||
# Development dependencies
|
||||
dev = [
|
||||
"pytest>=8.4.2",
|
||||
"pytest-asyncio>=1.2.0",
|
||||
"pytest-cov>=7.0.0",
|
||||
"types-pytz>=2025.2.0.20250809",
|
||||
"ty>=0.0.15",
|
||||
"ruff>=0.12.8",
|
||||
"black>=25.1.0",
|
||||
"build>=1.2.2",
|
||||
"twine>=6.0.1",
|
||||
]
|
||||
|
||||
# Testing only
|
||||
test = [
|
||||
"pytest>=8.4.2",
|
||||
"pytest-asyncio>=1.2.0",
|
||||
"pytest-cov>=7.0.0",
|
||||
]
|
||||
|
||||
# Linting and formatting only
|
||||
lint = [
|
||||
"ruff>=0.12.8",
|
||||
"black>=25.1.0",
|
||||
"ty>=0.0.15",
|
||||
]
|
||||
|
||||
# Type checking stubs
|
||||
types = [
|
||||
"types-pytz>=2025.2.0.20250809",
|
||||
]
|
||||
|
||||
# All dev dependencies
|
||||
all = [
|
||||
"unraid-mcp[dev,test,lint,types]",
|
||||
]
|
||||
|
||||
# ============================================================================
|
||||
# Project URLs
|
||||
# ============================================================================
|
||||
[project.urls]
|
||||
Homepage = "https://github.com/jmagar/unraid-mcp"
|
||||
Documentation = "https://github.com/jmagar/unraid-mcp#readme"
|
||||
Repository = "https://github.com/jmagar/unraid-mcp"
|
||||
Issues = "https://github.com/jmagar/unraid-mcp/issues"
|
||||
Changelog = "https://github.com/jmagar/unraid-mcp/releases"
|
||||
Source = "https://github.com/jmagar/unraid-mcp"
|
||||
|
||||
# ============================================================================
|
||||
# Entry Points
|
||||
# ============================================================================
|
||||
[project.scripts]
|
||||
unraid-mcp-server = "unraid_mcp.main:main"
|
||||
unraid-mcp = "unraid_mcp.main:main"
|
||||
|
||||
# ============================================================================
|
||||
# Build Configuration
|
||||
# ============================================================================
|
||||
[tool.hatch.build.targets.wheel]
|
||||
only-include = ["unraid_mcp/"]
|
||||
packages = ["unraid_mcp"]
|
||||
only-include = ["unraid_mcp"]
|
||||
|
||||
[tool.hatch.build.targets.sdist]
|
||||
include = [
|
||||
"/unraid_mcp",
|
||||
"/tests",
|
||||
"/README.md",
|
||||
"/LICENSE",
|
||||
"/pyproject.toml",
|
||||
"/.env.example",
|
||||
]
|
||||
exclude = [
|
||||
"/.git",
|
||||
"/.github",
|
||||
"/.venv",
|
||||
"/.cache",
|
||||
"/.docs",
|
||||
"/.full-review",
|
||||
"/docs",
|
||||
"*.pyc",
|
||||
"__pycache__",
|
||||
]
|
||||
|
||||
# ============================================================================
|
||||
# Tool Configuration: Black (Code Formatting)
|
||||
# ============================================================================
|
||||
[tool.black]
|
||||
line-length = 100
|
||||
target-version = ['py310']
|
||||
target-version = ['py310', 'py311', 'py312', 'py313']
|
||||
include = '\.pyi?$'
|
||||
extend-exclude = '''
|
||||
/(
|
||||
@@ -56,51 +179,104 @@ extend-exclude = '''
|
||||
\.eggs
|
||||
| \.git
|
||||
| \.hg
|
||||
| \.mypy_cache
|
||||
| \.ty_cache
|
||||
| \.tox
|
||||
| \.venv
|
||||
| \.cache
|
||||
| build
|
||||
| dist
|
||||
| __pycache__
|
||||
)/
|
||||
'''
|
||||
|
||||
# ============================================================================
|
||||
# Tool Configuration: Ruff (Linting)
|
||||
# ============================================================================
|
||||
[tool.ruff]
|
||||
target-version = "py310"
|
||||
line-length = 100
|
||||
cache-dir = ".cache/.ruff_cache"
|
||||
|
||||
[tool.ruff.lint]
|
||||
select = [
|
||||
"E", # pycodestyle errors
|
||||
"W", # pycodestyle warnings
|
||||
"F", # pyflakes
|
||||
"I", # isort
|
||||
"B", # flake8-bugbear
|
||||
"C4", # flake8-comprehensions
|
||||
"UP", # pyupgrade
|
||||
# Pyflakes
|
||||
"F",
|
||||
# pycodestyle
|
||||
"E",
|
||||
"W",
|
||||
# isort
|
||||
"I",
|
||||
# pep8-naming
|
||||
"N",
|
||||
# pydocstyle
|
||||
"D",
|
||||
# pyupgrade
|
||||
"UP",
|
||||
# flake8-2020
|
||||
"YTT",
|
||||
# flake8-bugbear
|
||||
"B",
|
||||
# flake8-quotes
|
||||
"Q",
|
||||
# flake8-comprehensions
|
||||
"C4",
|
||||
# flake8-simplify
|
||||
"SIM",
|
||||
# flake8-type-checking
|
||||
"TCH",
|
||||
# flake8-use-pathlib
|
||||
"PTH",
|
||||
# flake8-async
|
||||
"ASYNC",
|
||||
# flake8-return
|
||||
"RET",
|
||||
# Perflint
|
||||
"PERF",
|
||||
# Ruff-specific rules
|
||||
"RUF",
|
||||
]
|
||||
ignore = [
|
||||
"E501", # line too long, handled by black
|
||||
"B008", # do not perform function calls in argument defaults
|
||||
"C901", # too complex
|
||||
"E501", # line too long (handled by black)
|
||||
"B008", # function calls in argument defaults
|
||||
"C901", # too complex
|
||||
"D100", # missing docstring in public module
|
||||
"D101", # missing docstring in public class
|
||||
"D102", # missing docstring in public method
|
||||
"D103", # missing docstring in public function
|
||||
"D104", # missing docstring in public package
|
||||
"D105", # missing docstring in magic method
|
||||
"D107", # missing docstring in __init__
|
||||
"D203", # 1 blank line required before class docstring (conflicts with D211)
|
||||
"D213", # multi-line docstring summary should start at the second line (conflicts with D212)
|
||||
]
|
||||
|
||||
[tool.ruff.lint.per-file-ignores]
|
||||
"__init__.py" = ["F401"]
|
||||
"__init__.py" = ["F401", "D104"]
|
||||
"tests/**/*.py" = ["D", "S101", "PLR2004"] # Allow asserts and magic values in tests
|
||||
|
||||
[tool.mypy]
|
||||
python_version = "3.10"
|
||||
check_untyped_defs = true
|
||||
disallow_any_generics = true
|
||||
disallow_incomplete_defs = true
|
||||
disallow_untyped_defs = true
|
||||
no_implicit_optional = true
|
||||
warn_redundant_casts = true
|
||||
warn_unused_ignores = true
|
||||
warn_return_any = true
|
||||
strict_equality = true
|
||||
[tool.ruff.lint.pydocstyle]
|
||||
convention = "google"
|
||||
|
||||
[tool.ruff.lint.isort]
|
||||
known-first-party = ["unraid_mcp"]
|
||||
force-single-line = false
|
||||
lines-after-imports = 2
|
||||
|
||||
# ============================================================================
|
||||
# Tool Configuration: ty (Type Checking)
|
||||
# ============================================================================
|
||||
[tool.ty.environment]
|
||||
python-version = "3.10"
|
||||
|
||||
[tool.ty.analysis]
|
||||
respect-type-ignore-comments = true
|
||||
|
||||
# ============================================================================
|
||||
# Tool Configuration: pytest (Testing)
|
||||
# ============================================================================
|
||||
[tool.pytest.ini_options]
|
||||
asyncio_mode = "auto"
|
||||
cache_dir = ".cache/.pytest_cache"
|
||||
testpaths = ["tests"]
|
||||
python_files = ["test_*.py", "*_test.py"]
|
||||
python_classes = ["Test*"]
|
||||
@@ -109,41 +285,73 @@ addopts = [
|
||||
"-ra",
|
||||
"--strict-markers",
|
||||
"--strict-config",
|
||||
"--cov=unraid_mcp",
|
||||
"--cov-report=term-missing",
|
||||
"--cov-report=html",
|
||||
"--cov-report=xml",
|
||||
"--tb=short",
|
||||
"-v",
|
||||
]
|
||||
markers = [
|
||||
"slow: marks tests as slow (deselect with '-m \"not slow\"')",
|
||||
"integration: marks tests as integration tests",
|
||||
"unit: marks tests as unit tests",
|
||||
]
|
||||
filterwarnings = [
|
||||
"error",
|
||||
"ignore::DeprecationWarning",
|
||||
"ignore::PendingDeprecationWarning",
|
||||
]
|
||||
|
||||
# ============================================================================
|
||||
# Tool Configuration: Coverage
|
||||
# ============================================================================
|
||||
[tool.coverage.run]
|
||||
source = ["unraid_mcp"]
|
||||
branch = true
|
||||
parallel = true
|
||||
data_file = ".cache/.coverage"
|
||||
omit = [
|
||||
"*/tests/*",
|
||||
"*/__pycache__/*",
|
||||
"*/.venv/*",
|
||||
]
|
||||
|
||||
[tool.coverage.report]
|
||||
precision = 2
|
||||
show_missing = true
|
||||
skip_covered = false
|
||||
exclude_lines = [
|
||||
"pragma: no cover",
|
||||
"def __repr__",
|
||||
"def __str__",
|
||||
"if self.debug:",
|
||||
"if settings.DEBUG",
|
||||
"raise AssertionError",
|
||||
"raise NotImplementedError",
|
||||
"if 0:",
|
||||
"if False:",
|
||||
"if __name__ == .__main__.:",
|
||||
"if TYPE_CHECKING:",
|
||||
"class .*\\bProtocol\\):",
|
||||
"@(abc\\.)?abstractmethod",
|
||||
"@(typing\\.)?overload",
|
||||
]
|
||||
|
||||
[tool.coverage.html]
|
||||
directory = ".cache/htmlcov"
|
||||
|
||||
[tool.coverage.xml]
|
||||
output = ".cache/coverage.xml"
|
||||
|
||||
# ============================================================================
|
||||
# Tool Configuration: Dependency Groups (uv-specific)
|
||||
# ============================================================================
|
||||
[dependency-groups]
|
||||
dev = [
|
||||
"pytest>=8.4.2",
|
||||
"pytest-asyncio>=1.2.0",
|
||||
"pytest-cov>=7.0.0",
|
||||
"types-pytz>=2025.2.0.20250809",
|
||||
"mypy>=1.17.1",
|
||||
"ty>=0.0.15",
|
||||
"ruff>=0.12.8",
|
||||
"black>=25.1.0",
|
||||
"build>=1.2.2",
|
||||
"twine>=6.0.1",
|
||||
]
|
||||
|
||||
@@ -70,6 +70,32 @@ class TestArrayActions:
|
||||
assert result["success"] is True
|
||||
assert result["action"] == "shutdown"
|
||||
|
||||
async def test_stop_array(self, _mock_graphql: AsyncMock) -> None:
|
||||
_mock_graphql.return_value = {"setState": {"state": "STOPPED"}}
|
||||
tool_fn = _make_tool()
|
||||
result = await tool_fn(action="stop", confirm=True)
|
||||
assert result["success"] is True
|
||||
assert result["action"] == "stop"
|
||||
|
||||
async def test_reboot(self, _mock_graphql: AsyncMock) -> None:
|
||||
_mock_graphql.return_value = {"reboot": True}
|
||||
tool_fn = _make_tool()
|
||||
result = await tool_fn(action="reboot", confirm=True)
|
||||
assert result["success"] is True
|
||||
assert result["action"] == "reboot"
|
||||
|
||||
async def test_parity_pause(self, _mock_graphql: AsyncMock) -> None:
|
||||
_mock_graphql.return_value = {"parityCheck": {"pause": True}}
|
||||
tool_fn = _make_tool()
|
||||
result = await tool_fn(action="parity_pause")
|
||||
assert result["success"] is True
|
||||
|
||||
async def test_unmount_disk(self, _mock_graphql: AsyncMock) -> None:
|
||||
_mock_graphql.return_value = {"unmountArrayDisk": True}
|
||||
tool_fn = _make_tool()
|
||||
result = await tool_fn(action="unmount_disk", disk_id="disk:1")
|
||||
assert result["success"] is True
|
||||
|
||||
async def test_generic_exception_wraps(self, _mock_graphql: AsyncMock) -> None:
|
||||
_mock_graphql.side_effect = RuntimeError("disk error")
|
||||
tool_fn = _make_tool()
|
||||
|
||||
@@ -171,6 +171,34 @@ class TestDockerActions:
|
||||
result = await tool_fn(action="remove", container_id="old-app", confirm=True)
|
||||
assert result["success"] is True
|
||||
|
||||
async def test_details_found(self, _mock_graphql: AsyncMock) -> None:
|
||||
_mock_graphql.return_value = {
|
||||
"docker": {"containers": [{"id": "c1", "names": ["plex"], "state": "running", "image": "plexinc/pms"}]}
|
||||
}
|
||||
tool_fn = _make_tool()
|
||||
result = await tool_fn(action="details", container_id="plex")
|
||||
assert result["names"] == ["plex"]
|
||||
|
||||
async def test_logs(self, _mock_graphql: AsyncMock) -> None:
|
||||
cid = "a" * 64 + ":local"
|
||||
_mock_graphql.side_effect = [
|
||||
{"docker": {"containers": [{"id": cid, "names": ["plex"]}]}},
|
||||
{"docker": {"logs": "2026-02-08 log line here"}},
|
||||
]
|
||||
tool_fn = _make_tool()
|
||||
result = await tool_fn(action="logs", container_id="plex")
|
||||
assert "log line" in result["logs"]
|
||||
|
||||
async def test_pause_container(self, _mock_graphql: AsyncMock) -> None:
|
||||
cid = "a" * 64 + ":local"
|
||||
_mock_graphql.side_effect = [
|
||||
{"docker": {"containers": [{"id": cid, "names": ["plex"]}]}},
|
||||
{"docker": {"pause": {"id": cid, "state": "paused"}}},
|
||||
]
|
||||
tool_fn = _make_tool()
|
||||
result = await tool_fn(action="pause", container_id="plex")
|
||||
assert result["success"] is True
|
||||
|
||||
async def test_generic_exception_wraps_in_tool_error(self, _mock_graphql: AsyncMock) -> None:
|
||||
_mock_graphql.side_effect = RuntimeError("unexpected failure")
|
||||
tool_fn = _make_tool()
|
||||
|
||||
@@ -108,6 +108,16 @@ class TestHealthActions:
|
||||
with pytest.raises(ToolError, match="broken"):
|
||||
await tool_fn(action="diagnose")
|
||||
|
||||
async def test_diagnose_success(self, _mock_graphql: AsyncMock) -> None:
|
||||
"""Diagnose returns subscription status when modules are available."""
|
||||
tool_fn = _make_tool()
|
||||
mock_status = {
|
||||
"cpu_sub": {"runtime": {"connection_state": "connected", "last_error": None}},
|
||||
}
|
||||
with patch("unraid_mcp.tools.health._diagnose_subscriptions", return_value=mock_status):
|
||||
result = await tool_fn(action="diagnose")
|
||||
assert "cpu_sub" in result
|
||||
|
||||
async def test_diagnose_import_error_internal(self) -> None:
|
||||
"""_diagnose_subscriptions catches ImportError and returns error dict."""
|
||||
import builtins
|
||||
|
||||
@@ -3,6 +3,7 @@
|
||||
from unittest.mock import AsyncMock, patch
|
||||
|
||||
import pytest
|
||||
from conftest import make_tool_fn
|
||||
|
||||
from unraid_mcp.core.exceptions import ToolError
|
||||
from unraid_mcp.tools.info import (
|
||||
@@ -89,13 +90,17 @@ class TestProcessArrayStatus:
|
||||
# --- Integration tests for the tool function ---
|
||||
|
||||
|
||||
class TestUnraidInfoTool:
|
||||
@pytest.fixture
|
||||
def _mock_graphql(self) -> AsyncMock:
|
||||
with patch("unraid_mcp.tools.info.make_graphql_request", new_callable=AsyncMock) as mock:
|
||||
yield mock
|
||||
@pytest.fixture
|
||||
def _mock_graphql() -> AsyncMock:
|
||||
with patch("unraid_mcp.tools.info.make_graphql_request", new_callable=AsyncMock) as mock:
|
||||
yield mock
|
||||
|
||||
@pytest.mark.asyncio
|
||||
|
||||
def _make_tool():
|
||||
return make_tool_fn("unraid_mcp.tools.info", "register_info_tool", "unraid_info")
|
||||
|
||||
|
||||
class TestUnraidInfoTool:
|
||||
async def test_overview_action(self, _mock_graphql: AsyncMock) -> None:
|
||||
_mock_graphql.return_value = {
|
||||
"info": {
|
||||
@@ -103,57 +108,78 @@ class TestUnraidInfoTool:
|
||||
"cpu": {"manufacturer": "Intel", "brand": "i7", "cores": 4, "threads": 8},
|
||||
}
|
||||
}
|
||||
# Import and call the inner function by simulating registration
|
||||
from fastmcp import FastMCP
|
||||
test_mcp = FastMCP("test")
|
||||
from unraid_mcp.tools.info import register_info_tool
|
||||
register_info_tool(test_mcp)
|
||||
tool_fn = test_mcp._tool_manager._tools["unraid_info"].fn
|
||||
tool_fn = _make_tool()
|
||||
result = await tool_fn(action="overview")
|
||||
assert "summary" in result
|
||||
_mock_graphql.assert_called_once()
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_ups_device_requires_device_id(self, _mock_graphql: AsyncMock) -> None:
|
||||
from fastmcp import FastMCP
|
||||
test_mcp = FastMCP("test")
|
||||
from unraid_mcp.tools.info import register_info_tool
|
||||
register_info_tool(test_mcp)
|
||||
tool_fn = test_mcp._tool_manager._tools["unraid_info"].fn
|
||||
tool_fn = _make_tool()
|
||||
with pytest.raises(ToolError, match="device_id is required"):
|
||||
await tool_fn(action="ups_device")
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_network_action(self, _mock_graphql: AsyncMock) -> None:
|
||||
_mock_graphql.return_value = {"network": {"id": "net:1", "accessUrls": []}}
|
||||
from fastmcp import FastMCP
|
||||
test_mcp = FastMCP("test")
|
||||
from unraid_mcp.tools.info import register_info_tool
|
||||
register_info_tool(test_mcp)
|
||||
tool_fn = test_mcp._tool_manager._tools["unraid_info"].fn
|
||||
tool_fn = _make_tool()
|
||||
result = await tool_fn(action="network")
|
||||
assert result["id"] == "net:1"
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_connect_action(self, _mock_graphql: AsyncMock) -> None:
|
||||
_mock_graphql.return_value = {
|
||||
"connect": {"status": "connected", "sandbox": False, "flashGuid": "abc123"}
|
||||
}
|
||||
from fastmcp import FastMCP
|
||||
test_mcp = FastMCP("test")
|
||||
from unraid_mcp.tools.info import register_info_tool
|
||||
register_info_tool(test_mcp)
|
||||
tool_fn = test_mcp._tool_manager._tools["unraid_info"].fn
|
||||
tool_fn = _make_tool()
|
||||
result = await tool_fn(action="connect")
|
||||
assert result["status"] == "connected"
|
||||
|
||||
@pytest.mark.asyncio
|
||||
async def test_generic_exception_wraps(self, _mock_graphql: AsyncMock) -> None:
|
||||
_mock_graphql.side_effect = RuntimeError("unexpected")
|
||||
from fastmcp import FastMCP
|
||||
test_mcp = FastMCP("test")
|
||||
from unraid_mcp.tools.info import register_info_tool
|
||||
register_info_tool(test_mcp)
|
||||
tool_fn = test_mcp._tool_manager._tools["unraid_info"].fn
|
||||
tool_fn = _make_tool()
|
||||
with pytest.raises(ToolError, match="unexpected"):
|
||||
await tool_fn(action="online")
|
||||
|
||||
async def test_metrics(self, _mock_graphql: AsyncMock) -> None:
|
||||
_mock_graphql.return_value = {"metrics": {"cpu": {"used": 25.5}, "memory": {"used": 8192, "total": 32768}}}
|
||||
tool_fn = _make_tool()
|
||||
result = await tool_fn(action="metrics")
|
||||
assert result["cpu"]["used"] == 25.5
|
||||
|
||||
async def test_services(self, _mock_graphql: AsyncMock) -> None:
|
||||
_mock_graphql.return_value = {"services": [{"name": "docker", "state": "running"}]}
|
||||
tool_fn = _make_tool()
|
||||
result = await tool_fn(action="services")
|
||||
assert len(result["services"]) == 1
|
||||
assert result["services"][0]["name"] == "docker"
|
||||
|
||||
async def test_settings(self, _mock_graphql: AsyncMock) -> None:
|
||||
_mock_graphql.return_value = {"settings": {"unified": {"values": {"timezone": "US/Eastern"}}}}
|
||||
tool_fn = _make_tool()
|
||||
result = await tool_fn(action="settings")
|
||||
assert result["timezone"] == "US/Eastern"
|
||||
|
||||
async def test_settings_non_dict_values(self, _mock_graphql: AsyncMock) -> None:
|
||||
"""Settings values that are not a dict should be wrapped in {'raw': ...}."""
|
||||
_mock_graphql.return_value = {"settings": {"unified": {"values": "raw_string"}}}
|
||||
tool_fn = _make_tool()
|
||||
result = await tool_fn(action="settings")
|
||||
assert result == {"raw": "raw_string"}
|
||||
|
||||
async def test_servers(self, _mock_graphql: AsyncMock) -> None:
|
||||
_mock_graphql.return_value = {"servers": [{"id": "s:1", "name": "tower", "status": "online"}]}
|
||||
tool_fn = _make_tool()
|
||||
result = await tool_fn(action="servers")
|
||||
assert len(result["servers"]) == 1
|
||||
assert result["servers"][0]["name"] == "tower"
|
||||
|
||||
async def test_flash(self, _mock_graphql: AsyncMock) -> None:
|
||||
_mock_graphql.return_value = {"flash": {"id": "f:1", "guid": "abc", "product": "SanDisk", "vendor": "SanDisk", "size": 32000000000}}
|
||||
tool_fn = _make_tool()
|
||||
result = await tool_fn(action="flash")
|
||||
assert result["product"] == "SanDisk"
|
||||
|
||||
async def test_ups_devices(self, _mock_graphql: AsyncMock) -> None:
|
||||
_mock_graphql.return_value = {"upsDevices": [{"id": "ups:1", "model": "APC", "status": "online", "charge": 100}]}
|
||||
tool_fn = _make_tool()
|
||||
result = await tool_fn(action="ups_devices")
|
||||
assert len(result["ups_devices"]) == 1
|
||||
assert result["ups_devices"][0]["model"] == "APC"
|
||||
|
||||
@@ -138,6 +138,13 @@ class TestNotificationsActions:
|
||||
assert filter_var["limit"] == 10
|
||||
assert filter_var["offset"] == 5
|
||||
|
||||
async def test_delete_archived(self, _mock_graphql: AsyncMock) -> None:
|
||||
_mock_graphql.return_value = {"notifications": {"deleteArchivedNotifications": True}}
|
||||
tool_fn = _make_tool()
|
||||
result = await tool_fn(action="delete_archived", confirm=True)
|
||||
assert result["success"] is True
|
||||
assert result["action"] == "delete_archived"
|
||||
|
||||
async def test_generic_exception_wraps(self, _mock_graphql: AsyncMock) -> None:
|
||||
_mock_graphql.side_effect = RuntimeError("boom")
|
||||
tool_fn = _make_tool()
|
||||
|
||||
@@ -55,6 +55,17 @@ class TestStorageValidation:
|
||||
with pytest.raises(ToolError, match="log_path"):
|
||||
await tool_fn(action="logs")
|
||||
|
||||
async def test_logs_rejects_invalid_path(self, _mock_graphql: AsyncMock) -> None:
|
||||
tool_fn = _make_tool()
|
||||
with pytest.raises(ToolError, match="log_path must start with"):
|
||||
await tool_fn(action="logs", log_path="/etc/shadow")
|
||||
|
||||
async def test_logs_allows_valid_paths(self, _mock_graphql: AsyncMock) -> None:
|
||||
_mock_graphql.return_value = {"logFile": {"path": "/var/log/syslog", "content": "ok"}}
|
||||
tool_fn = _make_tool()
|
||||
result = await tool_fn(action="logs", log_path="/var/log/syslog")
|
||||
assert result["content"] == "ok"
|
||||
|
||||
|
||||
class TestStorageActions:
|
||||
async def test_shares(self, _mock_graphql: AsyncMock) -> None:
|
||||
|
||||
@@ -32,9 +32,9 @@ class TestVmValidation:
|
||||
await tool_fn(action=action, vm_id="uuid-1")
|
||||
|
||||
async def test_destructive_vm_id_check_before_confirm(self, _mock_graphql: AsyncMock) -> None:
|
||||
"""Destructive actions without vm_id should fail on confirm first."""
|
||||
"""Destructive actions without vm_id should fail on vm_id first (validated before confirm)."""
|
||||
tool_fn = _make_tool()
|
||||
with pytest.raises(ToolError, match="destructive"):
|
||||
with pytest.raises(ToolError, match="vm_id"):
|
||||
await tool_fn(action="force_stop")
|
||||
|
||||
|
||||
@@ -102,6 +102,27 @@ class TestVmActions:
|
||||
assert result["success"] is True
|
||||
assert result["action"] == "force_stop"
|
||||
|
||||
async def test_stop_vm(self, _mock_graphql: AsyncMock) -> None:
|
||||
_mock_graphql.return_value = {"vm": {"stop": True}}
|
||||
tool_fn = _make_tool()
|
||||
result = await tool_fn(action="stop", vm_id="uuid-1")
|
||||
assert result["success"] is True
|
||||
assert result["action"] == "stop"
|
||||
|
||||
async def test_pause_vm(self, _mock_graphql: AsyncMock) -> None:
|
||||
_mock_graphql.return_value = {"vm": {"pause": True}}
|
||||
tool_fn = _make_tool()
|
||||
result = await tool_fn(action="pause", vm_id="uuid-1")
|
||||
assert result["success"] is True
|
||||
assert result["action"] == "pause"
|
||||
|
||||
async def test_resume_vm(self, _mock_graphql: AsyncMock) -> None:
|
||||
_mock_graphql.return_value = {"vm": {"resume": True}}
|
||||
tool_fn = _make_tool()
|
||||
result = await tool_fn(action="resume", vm_id="uuid-1")
|
||||
assert result["success"] is True
|
||||
assert result["action"] == "resume"
|
||||
|
||||
async def test_mutation_unexpected_response(self, _mock_graphql: AsyncMock) -> None:
|
||||
_mock_graphql.return_value = {"vm": {}}
|
||||
tool_fn = _make_tool()
|
||||
|
||||
@@ -55,7 +55,6 @@ class OverwriteFileHandler(logging.FileHandler):
|
||||
# Close current stream
|
||||
if self.stream:
|
||||
self.stream.close()
|
||||
self.stream = None
|
||||
|
||||
# Remove the old file and start fresh
|
||||
if os.path.exists(self.baseFilename):
|
||||
|
||||
@@ -20,6 +20,19 @@ from ..config.settings import (
|
||||
)
|
||||
from ..core.exceptions import ToolError
|
||||
|
||||
# Sensitive keys to redact from debug logs
|
||||
_SENSITIVE_KEYS = {"password", "key", "secret", "token", "apikey"}
|
||||
|
||||
|
||||
def _redact_sensitive(obj: Any) -> Any:
|
||||
"""Recursively redact sensitive values from nested dicts/lists."""
|
||||
if isinstance(obj, dict):
|
||||
return {k: ("***" if k.lower() in _SENSITIVE_KEYS else _redact_sensitive(v)) for k, v in obj.items()}
|
||||
if isinstance(obj, list):
|
||||
return [_redact_sensitive(item) for item in obj]
|
||||
return obj
|
||||
|
||||
|
||||
# HTTP timeout configuration
|
||||
DEFAULT_TIMEOUT = httpx.Timeout(10.0, read=30.0, connect=5.0)
|
||||
DISK_TIMEOUT = httpx.Timeout(10.0, read=TIMEOUT_CONFIG['disk_operations'], connect=5.0)
|
||||
@@ -142,12 +155,7 @@ async def make_graphql_request(
|
||||
logger.debug(f"Making GraphQL request to {UNRAID_API_URL}:")
|
||||
logger.debug(f"Query: {query[:200]}{'...' if len(query) > 200 else ''}") # Log truncated query
|
||||
if variables:
|
||||
_SENSITIVE_KEYS = {"password", "key", "secret", "token", "apiKey"}
|
||||
redacted = {
|
||||
k: ("***" if k.lower() in _SENSITIVE_KEYS else v)
|
||||
for k, v in (variables.get("input", variables) if isinstance(variables.get("input"), dict) else variables).items()
|
||||
}
|
||||
logger.debug(f"Variables: {redacted}")
|
||||
logger.debug(f"Variables: {_redact_sensitive(variables)}")
|
||||
|
||||
try:
|
||||
# Get the shared HTTP client with connection pooling
|
||||
|
||||
@@ -107,7 +107,7 @@ DOCKER_ACTIONS = Literal[
|
||||
]
|
||||
|
||||
# Docker container IDs: 64 hex chars + optional suffix (e.g., ":local")
|
||||
_DOCKER_ID_PATTERN = re.compile(r"^[a-f0-9]{64}(:[a-z0-9]+)?$", re.IGNORECASE)
|
||||
_DOCKER_ID_PATTERN = re.compile(r"^[a-f0-9]{64}(:[a-z0-9]+)?$")
|
||||
|
||||
|
||||
def find_container_by_identifier(
|
||||
@@ -126,7 +126,7 @@ def find_container_by_identifier(
|
||||
id_lower = identifier.lower()
|
||||
for c in containers:
|
||||
for name in c.get("names", []):
|
||||
if id_lower in name.lower() or name.lower() in id_lower:
|
||||
if id_lower in name.lower():
|
||||
logger.info(f"Fuzzy match: '{identifier}' -> '{name}'")
|
||||
return c
|
||||
|
||||
@@ -273,7 +273,10 @@ def register_docker_tool(mcp: FastMCP) -> None:
|
||||
MUTATIONS["start"], {"id": actual_id},
|
||||
operation_context={"operation": "start"},
|
||||
)
|
||||
result = start_data.get("docker", {}).get("start", {})
|
||||
if start_data.get("idempotent_success"):
|
||||
result = {}
|
||||
else:
|
||||
result = start_data.get("docker", {}).get("start", {})
|
||||
response: dict[str, Any] = {
|
||||
"success": True, "action": "restart", "container": result,
|
||||
}
|
||||
@@ -312,7 +315,7 @@ def register_docker_tool(mcp: FastMCP) -> None:
|
||||
"container": result,
|
||||
}
|
||||
|
||||
return {}
|
||||
raise ToolError(f"Unhandled action '{action}' — this is a bug")
|
||||
|
||||
except ToolError:
|
||||
raise
|
||||
|
||||
@@ -65,7 +65,7 @@ def register_health_tool(mcp: FastMCP) -> None:
|
||||
if action == "diagnose":
|
||||
return await _diagnose_subscriptions()
|
||||
|
||||
return {}
|
||||
raise ToolError(f"Unhandled action '{action}' — this is a bug")
|
||||
|
||||
except ToolError:
|
||||
raise
|
||||
|
||||
@@ -59,7 +59,7 @@ QUERIES: dict[str, str] = {
|
||||
query GetRegistrationInfo {
|
||||
registration {
|
||||
id type
|
||||
keyFile { location contents }
|
||||
keyFile { location }
|
||||
state expiration updateExpiration
|
||||
}
|
||||
}
|
||||
@@ -366,7 +366,8 @@ def register_info_tool(mcp: FastMCP) -> None:
|
||||
if action == "settings":
|
||||
settings = data.get("settings", {})
|
||||
if settings and settings.get("unified"):
|
||||
return dict(settings["unified"].get("values", {}))
|
||||
values = settings["unified"].get("values", {})
|
||||
return dict(values) if isinstance(values, dict) else {"raw": values}
|
||||
return {}
|
||||
|
||||
if action == "server":
|
||||
@@ -389,7 +390,7 @@ def register_info_tool(mcp: FastMCP) -> None:
|
||||
if action == "ups_config":
|
||||
return dict(data.get("upsConfiguration", {}))
|
||||
|
||||
return data
|
||||
raise ToolError(f"Unhandled action '{action}' — this is a bug")
|
||||
|
||||
except ToolError:
|
||||
raise
|
||||
|
||||
@@ -135,7 +135,7 @@ def register_keys_tool(mcp: FastMCP) -> None:
|
||||
"message": f"API key '{key_id}' deleted",
|
||||
}
|
||||
|
||||
return {}
|
||||
raise ToolError(f"Unhandled action '{action}' — this is a bug")
|
||||
|
||||
except ToolError:
|
||||
raise
|
||||
|
||||
@@ -157,7 +157,7 @@ def register_notifications_tool(mcp: FastMCP) -> None:
|
||||
"title": title,
|
||||
"subject": subject,
|
||||
"description": description,
|
||||
"importance": importance.upper() if importance else "INFO",
|
||||
"importance": importance.upper(),
|
||||
}
|
||||
data = await make_graphql_request(
|
||||
MUTATIONS["create"], {"input": input_data}
|
||||
@@ -194,7 +194,7 @@ def register_notifications_tool(mcp: FastMCP) -> None:
|
||||
data = await make_graphql_request(MUTATIONS["archive_all"], variables)
|
||||
return {"success": True, "action": "archive_all", "data": data}
|
||||
|
||||
return {}
|
||||
raise ToolError(f"Unhandled action '{action}' — this is a bug")
|
||||
|
||||
except ToolError:
|
||||
raise
|
||||
|
||||
@@ -121,7 +121,7 @@ def register_rclone_tool(mcp: FastMCP) -> None:
|
||||
"message": f"Remote '{name}' deleted successfully",
|
||||
}
|
||||
|
||||
return {}
|
||||
raise ToolError(f"Unhandled action '{action}' — this is a bug")
|
||||
|
||||
except ToolError:
|
||||
raise
|
||||
|
||||
@@ -95,8 +95,15 @@ def register_storage_tool(mcp: FastMCP) -> None:
|
||||
if action == "disk_details" and not disk_id:
|
||||
raise ToolError("disk_id is required for 'disk_details' action")
|
||||
|
||||
if action == "logs" and not log_path:
|
||||
raise ToolError("log_path is required for 'logs' action")
|
||||
if action == "logs":
|
||||
if not log_path:
|
||||
raise ToolError("log_path is required for 'logs' action")
|
||||
_ALLOWED_LOG_PREFIXES = ("/var/log/", "/boot/logs/", "/mnt/")
|
||||
if not any(log_path.startswith(p) for p in _ALLOWED_LOG_PREFIXES):
|
||||
raise ToolError(
|
||||
f"log_path must start with one of: {', '.join(_ALLOWED_LOG_PREFIXES)}. "
|
||||
f"Use log_files action to discover valid paths."
|
||||
)
|
||||
|
||||
query = QUERIES[action]
|
||||
variables: dict[str, Any] | None = None
|
||||
@@ -148,7 +155,7 @@ def register_storage_tool(mcp: FastMCP) -> None:
|
||||
if action == "logs":
|
||||
return dict(data.get("logFile", {}))
|
||||
|
||||
return data
|
||||
raise ToolError(f"Unhandled action '{action}' — this is a bug")
|
||||
|
||||
except ToolError:
|
||||
raise
|
||||
|
||||
@@ -30,7 +30,7 @@ QUERIES: dict[str, str] = {
|
||||
""",
|
||||
"cloud": """
|
||||
query GetCloud {
|
||||
cloud { status apiKey error }
|
||||
cloud { status error }
|
||||
}
|
||||
""",
|
||||
"remote_access": """
|
||||
@@ -152,7 +152,7 @@ def register_users_tool(mcp: FastMCP) -> None:
|
||||
origins = data.get("allowedOrigins", [])
|
||||
return {"origins": list(origins) if isinstance(origins, list) else []}
|
||||
|
||||
return {}
|
||||
raise ToolError(f"Unhandled action '{action}' — this is a bug")
|
||||
|
||||
except ToolError:
|
||||
raise
|
||||
|
||||
@@ -94,12 +94,12 @@ def register_vm_tool(mcp: FastMCP) -> None:
|
||||
if action not in all_actions:
|
||||
raise ToolError(f"Invalid action '{action}'. Must be one of: {sorted(all_actions)}")
|
||||
|
||||
if action in DESTRUCTIVE_ACTIONS and not confirm:
|
||||
raise ToolError(f"Action '{action}' is destructive. Set confirm=True to proceed.")
|
||||
|
||||
if action != "list" and not vm_id:
|
||||
raise ToolError(f"vm_id is required for '{action}' action")
|
||||
|
||||
if action in DESTRUCTIVE_ACTIONS and not confirm:
|
||||
raise ToolError(f"Action '{action}' is destructive. Set confirm=True to proceed.")
|
||||
|
||||
try:
|
||||
logger.info(f"Executing unraid_vm action={action}")
|
||||
|
||||
@@ -143,7 +143,7 @@ def register_vm_tool(mcp: FastMCP) -> None:
|
||||
}
|
||||
raise ToolError(f"Failed to {action} VM or unexpected response")
|
||||
|
||||
return {}
|
||||
raise ToolError(f"Unhandled action '{action}' — this is a bug")
|
||||
|
||||
except ToolError:
|
||||
raise
|
||||
|
||||
577
uv.lock
generated
577
uv.lock
generated
@@ -56,6 +56,15 @@ wheels = [
|
||||
{ url = "https://files.pythonhosted.org/packages/a0/59/76ab57e3fe74484f48a53f8e337171b4a2349e506eabe136d7e01d059086/backports_asyncio_runner-1.2.0-py3-none-any.whl", hash = "sha256:0da0a936a8aeb554eccb426dc55af3ba63bcdc69fa1a600b5bb305413a4477b5", size = 12313, upload-time = "2025-07-02T02:27:14.263Z" },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "backports-tarfile"
|
||||
version = "1.2.0"
|
||||
source = { registry = "https://pypi.org/simple" }
|
||||
sdist = { url = "https://files.pythonhosted.org/packages/86/72/cd9b395f25e290e633655a100af28cb253e4393396264a98bd5f5951d50f/backports_tarfile-1.2.0.tar.gz", hash = "sha256:d75e02c268746e1b8144c278978b6e98e85de6ad16f8e4b0844a154557eca991", size = 86406, upload-time = "2024-05-28T17:01:54.731Z" }
|
||||
wheels = [
|
||||
{ url = "https://files.pythonhosted.org/packages/b9/fa/123043af240e49752f1c4bd24da5053b6bd00cad78c2be53c0d1e8b975bc/backports.tarfile-1.2.0-py3-none-any.whl", hash = "sha256:77e284d754527b01fb1e6fa8a1afe577858ebe4e9dad8919e34c862cb399bc34", size = 30181, upload-time = "2024-05-28T17:01:53.112Z" },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "black"
|
||||
version = "25.9.0"
|
||||
@@ -91,6 +100,22 @@ wheels = [
|
||||
{ url = "https://files.pythonhosted.org/packages/1b/46/863c90dcd3f9d41b109b7f19032ae0db021f0b2a81482ba0a1e28c84de86/black-25.9.0-py3-none-any.whl", hash = "sha256:474b34c1342cdc157d307b56c4c65bce916480c4a8f6551fdc6bf9b486a7c4ae", size = 203363, upload-time = "2025-09-19T00:27:35.724Z" },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "build"
|
||||
version = "1.4.0"
|
||||
source = { registry = "https://pypi.org/simple" }
|
||||
dependencies = [
|
||||
{ name = "colorama", marker = "os_name == 'nt'" },
|
||||
{ name = "importlib-metadata", marker = "python_full_version < '3.10.2'" },
|
||||
{ name = "packaging" },
|
||||
{ name = "pyproject-hooks" },
|
||||
{ name = "tomli", marker = "python_full_version < '3.11'" },
|
||||
]
|
||||
sdist = { url = "https://files.pythonhosted.org/packages/42/18/94eaffda7b329535d91f00fe605ab1f1e5cd68b2074d03f255c7d250687d/build-1.4.0.tar.gz", hash = "sha256:f1b91b925aa322be454f8330c6fb48b465da993d1e7e7e6fa35027ec49f3c936", size = 50054, upload-time = "2026-01-08T16:41:47.696Z" }
|
||||
wheels = [
|
||||
{ url = "https://files.pythonhosted.org/packages/c5/0d/84a4380f930db0010168e0aa7b7a8fed9ba1835a8fbb1472bc6d0201d529/build-1.4.0-py3-none-any.whl", hash = "sha256:6a07c1b8eb6f2b311b96fcbdbce5dab5fe637ffda0fd83c9cac622e927501596", size = 24141, upload-time = "2026-01-08T16:41:46.453Z" },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "certifi"
|
||||
version = "2025.8.3"
|
||||
@@ -562,6 +587,49 @@ wheels = [
|
||||
{ url = "https://files.pythonhosted.org/packages/7e/f5/f66802a942d491edb555dd61e3a9961140fd64c90bce1eafd741609d334d/httpcore-1.0.9-py3-none-any.whl", hash = "sha256:2d400746a40668fc9dec9810239072b40b4484b640a8c38fd654a024c7a1bf55", size = 78784, upload-time = "2025-04-24T22:06:20.566Z" },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "httptools"
|
||||
version = "0.7.1"
|
||||
source = { registry = "https://pypi.org/simple" }
|
||||
sdist = { url = "https://files.pythonhosted.org/packages/b5/46/120a669232c7bdedb9d52d4aeae7e6c7dfe151e99dc70802e2fc7a5e1993/httptools-0.7.1.tar.gz", hash = "sha256:abd72556974f8e7c74a259655924a717a2365b236c882c3f6f8a45fe94703ac9", size = 258961, upload-time = "2025-10-10T03:55:08.559Z" }
|
||||
wheels = [
|
||||
{ url = "https://files.pythonhosted.org/packages/c7/e5/c07e0bcf4ec8db8164e9f6738c048b2e66aabf30e7506f440c4cc6953f60/httptools-0.7.1-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:11d01b0ff1fe02c4c32d60af61a4d613b74fad069e47e06e9067758c01e9ac78", size = 204531, upload-time = "2025-10-10T03:54:20.887Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/7e/4f/35e3a63f863a659f92ffd92bef131f3e81cf849af26e6435b49bd9f6f751/httptools-0.7.1-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:84d86c1e5afdc479a6fdabf570be0d3eb791df0ae727e8dbc0259ed1249998d4", size = 109408, upload-time = "2025-10-10T03:54:22.455Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/f5/71/b0a9193641d9e2471ac541d3b1b869538a5fb6419d52fd2669fa9c79e4b8/httptools-0.7.1-cp310-cp310-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl", hash = "sha256:c8c751014e13d88d2be5f5f14fc8b89612fcfa92a9cc480f2bc1598357a23a05", size = 440889, upload-time = "2025-10-10T03:54:23.753Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/eb/d9/2e34811397b76718750fea44658cb0205b84566e895192115252e008b152/httptools-0.7.1-cp310-cp310-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:654968cb6b6c77e37b832a9be3d3ecabb243bbe7a0b8f65fbc5b6b04c8fcabed", size = 440460, upload-time = "2025-10-10T03:54:25.313Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/01/3f/a04626ebeacc489866bb4d82362c0657b2262bef381d68310134be7f40bb/httptools-0.7.1-cp310-cp310-musllinux_1_2_aarch64.whl", hash = "sha256:b580968316348b474b020edf3988eecd5d6eec4634ee6561e72ae3a2a0e00a8a", size = 425267, upload-time = "2025-10-10T03:54:26.81Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/a5/99/adcd4f66614db627b587627c8ad6f4c55f18881549bab10ecf180562e7b9/httptools-0.7.1-cp310-cp310-musllinux_1_2_x86_64.whl", hash = "sha256:d496e2f5245319da9d764296e86c5bb6fcf0cf7a8806d3d000717a889c8c0b7b", size = 424429, upload-time = "2025-10-10T03:54:28.174Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/d5/72/ec8fc904a8fd30ba022dfa85f3bbc64c3c7cd75b669e24242c0658e22f3c/httptools-0.7.1-cp310-cp310-win_amd64.whl", hash = "sha256:cbf8317bfccf0fed3b5680c559d3459cccf1abe9039bfa159e62e391c7270568", size = 86173, upload-time = "2025-10-10T03:54:29.5Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/9c/08/17e07e8d89ab8f343c134616d72eebfe03798835058e2ab579dcc8353c06/httptools-0.7.1-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:474d3b7ab469fefcca3697a10d11a32ee2b9573250206ba1e50d5980910da657", size = 206521, upload-time = "2025-10-10T03:54:31.002Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/aa/06/c9c1b41ff52f16aee526fd10fbda99fa4787938aa776858ddc4a1ea825ec/httptools-0.7.1-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:a3c3b7366bb6c7b96bd72d0dbe7f7d5eead261361f013be5f6d9590465ea1c70", size = 110375, upload-time = "2025-10-10T03:54:31.941Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/cc/cc/10935db22fda0ee34c76f047590ca0a8bd9de531406a3ccb10a90e12ea21/httptools-0.7.1-cp311-cp311-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl", hash = "sha256:379b479408b8747f47f3b253326183d7c009a3936518cdb70db58cffd369d9df", size = 456621, upload-time = "2025-10-10T03:54:33.176Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/0e/84/875382b10d271b0c11aa5d414b44f92f8dd53e9b658aec338a79164fa548/httptools-0.7.1-cp311-cp311-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:cad6b591a682dcc6cf1397c3900527f9affef1e55a06c4547264796bbd17cf5e", size = 454954, upload-time = "2025-10-10T03:54:34.226Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/30/e1/44f89b280f7e46c0b1b2ccee5737d46b3bb13136383958f20b580a821ca0/httptools-0.7.1-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:eb844698d11433d2139bbeeb56499102143beb582bd6c194e3ba69c22f25c274", size = 440175, upload-time = "2025-10-10T03:54:35.942Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/6f/7e/b9287763159e700e335028bc1824359dc736fa9b829dacedace91a39b37e/httptools-0.7.1-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:f65744d7a8bdb4bda5e1fa23e4ba16832860606fcc09d674d56e425e991539ec", size = 440310, upload-time = "2025-10-10T03:54:37.1Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/b3/07/5b614f592868e07f5c94b1f301b5e14a21df4e8076215a3bccb830a687d8/httptools-0.7.1-cp311-cp311-win_amd64.whl", hash = "sha256:135fbe974b3718eada677229312e97f3b31f8a9c8ffa3ae6f565bf808d5b6bcb", size = 86875, upload-time = "2025-10-10T03:54:38.421Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/53/7f/403e5d787dc4942316e515e949b0c8a013d84078a915910e9f391ba9b3ed/httptools-0.7.1-cp312-cp312-macosx_10_13_universal2.whl", hash = "sha256:38e0c83a2ea9746ebbd643bdfb521b9aa4a91703e2cd705c20443405d2fd16a5", size = 206280, upload-time = "2025-10-10T03:54:39.274Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/2a/0d/7f3fd28e2ce311ccc998c388dd1c53b18120fda3b70ebb022b135dc9839b/httptools-0.7.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:f25bbaf1235e27704f1a7b86cd3304eabc04f569c828101d94a0e605ef7205a5", size = 110004, upload-time = "2025-10-10T03:54:40.403Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/84/a6/b3965e1e146ef5762870bbe76117876ceba51a201e18cc31f5703e454596/httptools-0.7.1-cp312-cp312-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl", hash = "sha256:2c15f37ef679ab9ecc06bfc4e6e8628c32a8e4b305459de7cf6785acd57e4d03", size = 517655, upload-time = "2025-10-10T03:54:41.347Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/11/7d/71fee6f1844e6fa378f2eddde6c3e41ce3a1fb4b2d81118dd544e3441ec0/httptools-0.7.1-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:7fe6e96090df46b36ccfaf746f03034e5ab723162bc51b0a4cf58305324036f2", size = 511440, upload-time = "2025-10-10T03:54:42.452Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/22/a5/079d216712a4f3ffa24af4a0381b108aa9c45b7a5cc6eb141f81726b1823/httptools-0.7.1-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:f72fdbae2dbc6e68b8239defb48e6a5937b12218e6ffc2c7846cc37befa84362", size = 495186, upload-time = "2025-10-10T03:54:43.937Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/e9/9e/025ad7b65278745dee3bd0ebf9314934c4592560878308a6121f7f812084/httptools-0.7.1-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:e99c7b90a29fd82fea9ef57943d501a16f3404d7b9ee81799d41639bdaae412c", size = 499192, upload-time = "2025-10-10T03:54:45.003Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/6d/de/40a8f202b987d43afc4d54689600ff03ce65680ede2f31df348d7f368b8f/httptools-0.7.1-cp312-cp312-win_amd64.whl", hash = "sha256:3e14f530fefa7499334a79b0cf7e7cd2992870eb893526fb097d51b4f2d0f321", size = 86694, upload-time = "2025-10-10T03:54:45.923Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/09/8f/c77b1fcbfd262d422f12da02feb0d218fa228d52485b77b953832105bb90/httptools-0.7.1-cp313-cp313-macosx_10_13_universal2.whl", hash = "sha256:6babce6cfa2a99545c60bfef8bee0cc0545413cb0018f617c8059a30ad985de3", size = 202889, upload-time = "2025-10-10T03:54:47.089Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/0a/1a/22887f53602feaa066354867bc49a68fc295c2293433177ee90870a7d517/httptools-0.7.1-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:601b7628de7504077dd3dcb3791c6b8694bbd967148a6d1f01806509254fb1ca", size = 108180, upload-time = "2025-10-10T03:54:48.052Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/32/6a/6aaa91937f0010d288d3d124ca2946d48d60c3a5ee7ca62afe870e3ea011/httptools-0.7.1-cp313-cp313-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl", hash = "sha256:04c6c0e6c5fb0739c5b8a9eb046d298650a0ff38cf42537fc372b28dc7e4472c", size = 478596, upload-time = "2025-10-10T03:54:48.919Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/6d/70/023d7ce117993107be88d2cbca566a7c1323ccbaf0af7eabf2064fe356f6/httptools-0.7.1-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:69d4f9705c405ae3ee83d6a12283dc9feba8cc6aaec671b412917e644ab4fa66", size = 473268, upload-time = "2025-10-10T03:54:49.993Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/32/4d/9dd616c38da088e3f436e9a616e1d0cc66544b8cdac405cc4e81c8679fc7/httptools-0.7.1-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:44c8f4347d4b31269c8a9205d8a5ee2df5322b09bbbd30f8f862185bb6b05346", size = 455517, upload-time = "2025-10-10T03:54:51.066Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/1d/3a/a6c595c310b7df958e739aae88724e24f9246a514d909547778d776799be/httptools-0.7.1-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:465275d76db4d554918aba40bf1cbebe324670f3dfc979eaffaa5d108e2ed650", size = 458337, upload-time = "2025-10-10T03:54:52.196Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/fd/82/88e8d6d2c51edc1cc391b6e044c6c435b6aebe97b1abc33db1b0b24cd582/httptools-0.7.1-cp313-cp313-win_amd64.whl", hash = "sha256:322d00c2068d125bd570f7bf78b2d367dad02b919d8581d7476d8b75b294e3e6", size = 85743, upload-time = "2025-10-10T03:54:53.448Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/34/50/9d095fcbb6de2d523e027a2f304d4551855c2f46e0b82befd718b8b20056/httptools-0.7.1-cp314-cp314-macosx_10_13_universal2.whl", hash = "sha256:c08fe65728b8d70b6923ce31e3956f859d5e1e8548e6f22ec520a962c6757270", size = 203619, upload-time = "2025-10-10T03:54:54.321Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/07/f0/89720dc5139ae54b03f861b5e2c55a37dba9a5da7d51e1e824a1f343627f/httptools-0.7.1-cp314-cp314-macosx_11_0_arm64.whl", hash = "sha256:7aea2e3c3953521c3c51106ee11487a910d45586e351202474d45472db7d72d3", size = 108714, upload-time = "2025-10-10T03:54:55.163Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/b3/cb/eea88506f191fb552c11787c23f9a405f4c7b0c5799bf73f2249cd4f5228/httptools-0.7.1-cp314-cp314-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl", hash = "sha256:0e68b8582f4ea9166be62926077a3334064d422cf08ab87d8b74664f8e9058e1", size = 472909, upload-time = "2025-10-10T03:54:56.056Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/e0/4a/a548bdfae6369c0d078bab5769f7b66f17f1bfaa6fa28f81d6be6959066b/httptools-0.7.1-cp314-cp314-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:df091cf961a3be783d6aebae963cc9b71e00d57fa6f149025075217bc6a55a7b", size = 470831, upload-time = "2025-10-10T03:54:57.219Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/4d/31/14df99e1c43bd132eec921c2e7e11cda7852f65619bc0fc5bdc2d0cb126c/httptools-0.7.1-cp314-cp314-musllinux_1_2_aarch64.whl", hash = "sha256:f084813239e1eb403ddacd06a30de3d3e09a9b76e7894dcda2b22f8a726e9c60", size = 452631, upload-time = "2025-10-10T03:54:58.219Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/22/d2/b7e131f7be8d854d48cb6d048113c30f9a46dca0c9a8b08fcb3fcd588cdc/httptools-0.7.1-cp314-cp314-musllinux_1_2_x86_64.whl", hash = "sha256:7347714368fb2b335e9063bc2b96f2f87a9ceffcd9758ac295f8bbcd3ffbc0ca", size = 452910, upload-time = "2025-10-10T03:54:59.366Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/53/cf/878f3b91e4e6e011eff6d1fa9ca39f7eb17d19c9d7971b04873734112f30/httptools-0.7.1-cp314-cp314-win_amd64.whl", hash = "sha256:cfabda2a5bb85aa2a904ce06d974a3f30fb36cc63d7feaddec05d2050acede96", size = 88205, upload-time = "2025-10-10T03:55:00.389Z" },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "httpx"
|
||||
version = "0.28.1"
|
||||
@@ -586,6 +654,18 @@ wheels = [
|
||||
{ url = "https://files.pythonhosted.org/packages/25/0a/6269e3473b09aed2dab8aa1a600c70f31f00ae1349bee30658f7e358a159/httpx_sse-0.4.1-py3-none-any.whl", hash = "sha256:cba42174344c3a5b06f255ce65b350880f962d99ead85e776f23c6618a377a37", size = 8054, upload-time = "2025-06-24T13:21:04.772Z" },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "id"
|
||||
version = "1.6.1"
|
||||
source = { registry = "https://pypi.org/simple" }
|
||||
dependencies = [
|
||||
{ name = "urllib3" },
|
||||
]
|
||||
sdist = { url = "https://files.pythonhosted.org/packages/6d/04/c2156091427636080787aac190019dc64096e56a23b7364d3c1764ee3a06/id-1.6.1.tar.gz", hash = "sha256:d0732d624fb46fd4e7bc4e5152f00214450953b9e772c182c1c22964def1a069", size = 18088, upload-time = "2026-02-04T16:19:41.26Z" }
|
||||
wheels = [
|
||||
{ url = "https://files.pythonhosted.org/packages/42/77/de194443bf38daed9452139e960c632b0ef9f9a5dd9ce605fdf18ca9f1b1/id-1.6.1-py3-none-any.whl", hash = "sha256:f5ec41ed2629a508f5d0988eda142e190c9c6da971100612c4de9ad9f9b237ca", size = 14689, upload-time = "2026-02-04T16:19:40.051Z" },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "idna"
|
||||
version = "3.10"
|
||||
@@ -595,6 +675,18 @@ wheels = [
|
||||
{ url = "https://files.pythonhosted.org/packages/76/c6/c88e154df9c4e1a2a66ccf0005a88dfb2650c1dffb6f5ce603dfbd452ce3/idna-3.10-py3-none-any.whl", hash = "sha256:946d195a0d259cbba61165e88e65941f16e9b36ea6ddb97f00452bae8b1287d3", size = 70442, upload-time = "2024-09-15T18:07:37.964Z" },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "importlib-metadata"
|
||||
version = "8.7.1"
|
||||
source = { registry = "https://pypi.org/simple" }
|
||||
dependencies = [
|
||||
{ name = "zipp" },
|
||||
]
|
||||
sdist = { url = "https://files.pythonhosted.org/packages/f3/49/3b30cad09e7771a4982d9975a8cbf64f00d4a1ececb53297f1d9a7be1b10/importlib_metadata-8.7.1.tar.gz", hash = "sha256:49fef1ae6440c182052f407c8d34a68f72efc36db9ca90dc0113398f2fdde8bb", size = 57107, upload-time = "2025-12-21T10:00:19.278Z" }
|
||||
wheels = [
|
||||
{ url = "https://files.pythonhosted.org/packages/fa/5e/f8e9a1d23b9c20a551a8a02ea3637b4642e22c2626e3a13a9a29cdea99eb/importlib_metadata-8.7.1-py3-none-any.whl", hash = "sha256:5a1f80bf1daa489495071efbb095d75a634cf28a8bc299581244063b53176151", size = 27865, upload-time = "2025-12-21T10:00:18.329Z" },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "iniconfig"
|
||||
version = "2.1.0"
|
||||
@@ -613,6 +705,51 @@ wheels = [
|
||||
{ url = "https://files.pythonhosted.org/packages/15/aa/0aca39a37d3c7eb941ba736ede56d689e7be91cab5d9ca846bde3999eba6/isodate-0.7.2-py3-none-any.whl", hash = "sha256:28009937d8031054830160fce6d409ed342816b543597cece116d966c6d99e15", size = 22320, upload-time = "2024-10-08T23:04:09.501Z" },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "jaraco-classes"
|
||||
version = "3.4.0"
|
||||
source = { registry = "https://pypi.org/simple" }
|
||||
dependencies = [
|
||||
{ name = "more-itertools" },
|
||||
]
|
||||
sdist = { url = "https://files.pythonhosted.org/packages/06/c0/ed4a27bc5571b99e3cff68f8a9fa5b56ff7df1c2251cc715a652ddd26402/jaraco.classes-3.4.0.tar.gz", hash = "sha256:47a024b51d0239c0dd8c8540c6c7f484be3b8fcf0b2d85c13825780d3b3f3acd", size = 11780, upload-time = "2024-03-31T07:27:36.643Z" }
|
||||
wheels = [
|
||||
{ url = "https://files.pythonhosted.org/packages/7f/66/b15ce62552d84bbfcec9a4873ab79d993a1dd4edb922cbfccae192bd5b5f/jaraco.classes-3.4.0-py3-none-any.whl", hash = "sha256:f662826b6bed8cace05e7ff873ce0f9283b5c924470fe664fff1c2f00f581790", size = 6777, upload-time = "2024-03-31T07:27:34.792Z" },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "jaraco-context"
|
||||
version = "6.1.0"
|
||||
source = { registry = "https://pypi.org/simple" }
|
||||
dependencies = [
|
||||
{ name = "backports-tarfile", marker = "python_full_version < '3.12'" },
|
||||
]
|
||||
sdist = { url = "https://files.pythonhosted.org/packages/cb/9c/a788f5bb29c61e456b8ee52ce76dbdd32fd72cd73dd67bc95f42c7a8d13c/jaraco_context-6.1.0.tar.gz", hash = "sha256:129a341b0a85a7db7879e22acd66902fda67882db771754574338898b2d5d86f", size = 15850, upload-time = "2026-01-13T02:53:53.847Z" }
|
||||
wheels = [
|
||||
{ url = "https://files.pythonhosted.org/packages/8d/48/aa685dbf1024c7bd82bede569e3a85f82c32fd3d79ba5fea578f0159571a/jaraco_context-6.1.0-py3-none-any.whl", hash = "sha256:a43b5ed85815223d0d3cfdb6d7ca0d2bc8946f28f30b6f3216bda070f68badda", size = 7065, upload-time = "2026-01-13T02:53:53.031Z" },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "jaraco-functools"
|
||||
version = "4.4.0"
|
||||
source = { registry = "https://pypi.org/simple" }
|
||||
dependencies = [
|
||||
{ name = "more-itertools" },
|
||||
]
|
||||
sdist = { url = "https://files.pythonhosted.org/packages/0f/27/056e0638a86749374d6f57d0b0db39f29509cce9313cf91bdc0ac4d91084/jaraco_functools-4.4.0.tar.gz", hash = "sha256:da21933b0417b89515562656547a77b4931f98176eb173644c0d35032a33d6bb", size = 19943, upload-time = "2025-12-21T09:29:43.6Z" }
|
||||
wheels = [
|
||||
{ url = "https://files.pythonhosted.org/packages/fd/c4/813bb09f0985cb21e959f21f2464169eca882656849adf727ac7bb7e1767/jaraco_functools-4.4.0-py3-none-any.whl", hash = "sha256:9eec1e36f45c818d9bf307c8948eb03b2b56cd44087b3cdc989abca1f20b9176", size = 10481, upload-time = "2025-12-21T09:29:42.27Z" },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "jeepney"
|
||||
version = "0.9.0"
|
||||
source = { registry = "https://pypi.org/simple" }
|
||||
sdist = { url = "https://files.pythonhosted.org/packages/7b/6f/357efd7602486741aa73ffc0617fb310a29b588ed0fd69c2399acbb85b0c/jeepney-0.9.0.tar.gz", hash = "sha256:cf0e9e845622b81e4a28df94c40345400256ec608d0e55bb8a3feaa9163f5732", size = 106758, upload-time = "2025-02-27T18:51:01.684Z" }
|
||||
wheels = [
|
||||
{ url = "https://files.pythonhosted.org/packages/b2/a3/e137168c9c44d18eff0376253da9f1e9234d0239e0ee230d2fee6cea8e55/jeepney-0.9.0-py3-none-any.whl", hash = "sha256:97e5714520c16fc0a45695e5365a2e11b81ea79bba796e26f9f1d178cb182683", size = 49010, upload-time = "2025-02-27T18:51:00.104Z" },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "jsonschema"
|
||||
version = "4.25.1"
|
||||
@@ -655,6 +792,24 @@ wheels = [
|
||||
{ url = "https://files.pythonhosted.org/packages/41/45/1a4ed80516f02155c51f51e8cedb3c1902296743db0bbc66608a0db2814f/jsonschema_specifications-2025.9.1-py3-none-any.whl", hash = "sha256:98802fee3a11ee76ecaca44429fda8a41bff98b00a0f2838151b113f210cc6fe", size = 18437, upload-time = "2025-09-08T01:34:57.871Z" },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "keyring"
|
||||
version = "25.7.0"
|
||||
source = { registry = "https://pypi.org/simple" }
|
||||
dependencies = [
|
||||
{ name = "importlib-metadata", marker = "python_full_version < '3.12'" },
|
||||
{ name = "jaraco-classes" },
|
||||
{ name = "jaraco-context" },
|
||||
{ name = "jaraco-functools" },
|
||||
{ name = "jeepney", marker = "sys_platform == 'linux'" },
|
||||
{ name = "pywin32-ctypes", marker = "sys_platform == 'win32'" },
|
||||
{ name = "secretstorage", marker = "sys_platform == 'linux'" },
|
||||
]
|
||||
sdist = { url = "https://files.pythonhosted.org/packages/43/4b/674af6ef2f97d56f0ab5153bf0bfa28ccb6c3ed4d1babf4305449668807b/keyring-25.7.0.tar.gz", hash = "sha256:fe01bd85eb3f8fb3dd0405defdeac9a5b4f6f0439edbb3149577f244a2e8245b", size = 63516, upload-time = "2025-11-16T16:26:09.482Z" }
|
||||
wheels = [
|
||||
{ url = "https://files.pythonhosted.org/packages/81/db/e655086b7f3a705df045bf0933bdd9c2f79bb3c97bfef1384598bb79a217/keyring-25.7.0-py3-none-any.whl", hash = "sha256:be4a0b195f149690c166e850609a477c532ddbfbaed96a404d4e43f8d5e2689f", size = 39160, upload-time = "2025-11-16T16:26:08.402Z" },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "lazy-object-proxy"
|
||||
version = "1.12.0"
|
||||
@@ -837,51 +992,6 @@ wheels = [
|
||||
{ url = "https://files.pythonhosted.org/packages/a4/8e/469e5a4a2f5855992e425f3cb33804cc07bf18d48f2db061aec61ce50270/more_itertools-10.8.0-py3-none-any.whl", hash = "sha256:52d4362373dcf7c52546bc4af9a86ee7c4579df9a8dc268be0a2f949d376cc9b", size = 69667, upload-time = "2025-09-02T15:23:09.635Z" },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "mypy"
|
||||
version = "1.18.2"
|
||||
source = { registry = "https://pypi.org/simple" }
|
||||
dependencies = [
|
||||
{ name = "mypy-extensions" },
|
||||
{ name = "pathspec" },
|
||||
{ name = "tomli", marker = "python_full_version < '3.11'" },
|
||||
{ name = "typing-extensions" },
|
||||
]
|
||||
sdist = { url = "https://files.pythonhosted.org/packages/c0/77/8f0d0001ffad290cef2f7f216f96c814866248a0b92a722365ed54648e7e/mypy-1.18.2.tar.gz", hash = "sha256:06a398102a5f203d7477b2923dda3634c36727fa5c237d8f859ef90c42a9924b", size = 3448846, upload-time = "2025-09-19T00:11:10.519Z" }
|
||||
wheels = [
|
||||
{ url = "https://files.pythonhosted.org/packages/03/6f/657961a0743cff32e6c0611b63ff1c1970a0b482ace35b069203bf705187/mypy-1.18.2-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:c1eab0cf6294dafe397c261a75f96dc2c31bffe3b944faa24db5def4e2b0f77c", size = 12807973, upload-time = "2025-09-19T00:10:35.282Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/10/e9/420822d4f661f13ca8900f5fa239b40ee3be8b62b32f3357df9a3045a08b/mypy-1.18.2-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:7a780ca61fc239e4865968ebc5240bb3bf610ef59ac398de9a7421b54e4a207e", size = 11896527, upload-time = "2025-09-19T00:10:55.791Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/aa/73/a05b2bbaa7005f4642fcfe40fb73f2b4fb6bb44229bd585b5878e9a87ef8/mypy-1.18.2-cp310-cp310-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:448acd386266989ef11662ce3c8011fd2a7b632e0ec7d61a98edd8e27472225b", size = 12507004, upload-time = "2025-09-19T00:11:05.411Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/4f/01/f6e4b9f0d031c11ccbd6f17da26564f3a0f3c4155af344006434b0a05a9d/mypy-1.18.2-cp310-cp310-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:f9e171c465ad3901dc652643ee4bffa8e9fef4d7d0eece23b428908c77a76a66", size = 13245947, upload-time = "2025-09-19T00:10:46.923Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/d7/97/19727e7499bfa1ae0773d06afd30ac66a58ed7437d940c70548634b24185/mypy-1.18.2-cp310-cp310-musllinux_1_2_x86_64.whl", hash = "sha256:592ec214750bc00741af1f80cbf96b5013d81486b7bb24cb052382c19e40b428", size = 13499217, upload-time = "2025-09-19T00:09:39.472Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/9f/4f/90dc8c15c1441bf31cf0f9918bb077e452618708199e530f4cbd5cede6ff/mypy-1.18.2-cp310-cp310-win_amd64.whl", hash = "sha256:7fb95f97199ea11769ebe3638c29b550b5221e997c63b14ef93d2e971606ebed", size = 9766753, upload-time = "2025-09-19T00:10:49.161Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/88/87/cafd3ae563f88f94eec33f35ff722d043e09832ea8530ef149ec1efbaf08/mypy-1.18.2-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:807d9315ab9d464125aa9fcf6d84fde6e1dc67da0b6f80e7405506b8ac72bc7f", size = 12731198, upload-time = "2025-09-19T00:09:44.857Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/0f/e0/1e96c3d4266a06d4b0197ace5356d67d937d8358e2ee3ffac71faa843724/mypy-1.18.2-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:776bb00de1778caf4db739c6e83919c1d85a448f71979b6a0edd774ea8399341", size = 11817879, upload-time = "2025-09-19T00:09:47.131Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/72/ef/0c9ba89eb03453e76bdac5a78b08260a848c7bfc5d6603634774d9cd9525/mypy-1.18.2-cp311-cp311-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:1379451880512ffce14505493bd9fe469e0697543717298242574882cf8cdb8d", size = 12427292, upload-time = "2025-09-19T00:10:22.472Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/1a/52/ec4a061dd599eb8179d5411d99775bec2a20542505988f40fc2fee781068/mypy-1.18.2-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:1331eb7fd110d60c24999893320967594ff84c38ac6d19e0a76c5fd809a84c86", size = 13163750, upload-time = "2025-09-19T00:09:51.472Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/c4/5f/2cf2ceb3b36372d51568f2208c021870fe7834cf3186b653ac6446511839/mypy-1.18.2-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:3ca30b50a51e7ba93b00422e486cbb124f1c56a535e20eff7b2d6ab72b3b2e37", size = 13351827, upload-time = "2025-09-19T00:09:58.311Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/c8/7d/2697b930179e7277529eaaec1513f8de622818696857f689e4a5432e5e27/mypy-1.18.2-cp311-cp311-win_amd64.whl", hash = "sha256:664dc726e67fa54e14536f6e1224bcfce1d9e5ac02426d2326e2bb4e081d1ce8", size = 9757983, upload-time = "2025-09-19T00:10:09.071Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/07/06/dfdd2bc60c66611dd8335f463818514733bc763e4760dee289dcc33df709/mypy-1.18.2-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:33eca32dd124b29400c31d7cf784e795b050ace0e1f91b8dc035672725617e34", size = 12908273, upload-time = "2025-09-19T00:10:58.321Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/81/14/6a9de6d13a122d5608e1a04130724caf9170333ac5a924e10f670687d3eb/mypy-1.18.2-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:a3c47adf30d65e89b2dcd2fa32f3aeb5e94ca970d2c15fcb25e297871c8e4764", size = 11920910, upload-time = "2025-09-19T00:10:20.043Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/5f/a9/b29de53e42f18e8cc547e38daa9dfa132ffdc64f7250e353f5c8cdd44bee/mypy-1.18.2-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:5d6c838e831a062f5f29d11c9057c6009f60cb294fea33a98422688181fe2893", size = 12465585, upload-time = "2025-09-19T00:10:33.005Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/77/ae/6c3d2c7c61ff21f2bee938c917616c92ebf852f015fb55917fd6e2811db2/mypy-1.18.2-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:01199871b6110a2ce984bde85acd481232d17413868c9807e95c1b0739a58914", size = 13348562, upload-time = "2025-09-19T00:10:11.51Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/4d/31/aec68ab3b4aebdf8f36d191b0685d99faa899ab990753ca0fee60fb99511/mypy-1.18.2-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:a2afc0fa0b0e91b4599ddfe0f91e2c26c2b5a5ab263737e998d6817874c5f7c8", size = 13533296, upload-time = "2025-09-19T00:10:06.568Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/9f/83/abcb3ad9478fca3ebeb6a5358bb0b22c95ea42b43b7789c7fb1297ca44f4/mypy-1.18.2-cp312-cp312-win_amd64.whl", hash = "sha256:d8068d0afe682c7c4897c0f7ce84ea77f6de953262b12d07038f4d296d547074", size = 9828828, upload-time = "2025-09-19T00:10:28.203Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/5f/04/7f462e6fbba87a72bc8097b93f6842499c428a6ff0c81dd46948d175afe8/mypy-1.18.2-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:07b8b0f580ca6d289e69209ec9d3911b4a26e5abfde32228a288eb79df129fcc", size = 12898728, upload-time = "2025-09-19T00:10:01.33Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/99/5b/61ed4efb64f1871b41fd0b82d29a64640f3516078f6c7905b68ab1ad8b13/mypy-1.18.2-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:ed4482847168439651d3feee5833ccedbf6657e964572706a2adb1f7fa4dfe2e", size = 11910758, upload-time = "2025-09-19T00:10:42.607Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/3c/46/d297d4b683cc89a6e4108c4250a6a6b717f5fa96e1a30a7944a6da44da35/mypy-1.18.2-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:c3ad2afadd1e9fea5cf99a45a822346971ede8685cc581ed9cd4d42eaf940986", size = 12475342, upload-time = "2025-09-19T00:11:00.371Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/83/45/4798f4d00df13eae3bfdf726c9244bcb495ab5bd588c0eed93a2f2dd67f3/mypy-1.18.2-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:a431a6f1ef14cf8c144c6b14793a23ec4eae3db28277c358136e79d7d062f62d", size = 13338709, upload-time = "2025-09-19T00:11:03.358Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/d7/09/479f7358d9625172521a87a9271ddd2441e1dab16a09708f056e97007207/mypy-1.18.2-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:7ab28cc197f1dd77a67e1c6f35cd1f8e8b73ed2217e4fc005f9e6a504e46e7ba", size = 13529806, upload-time = "2025-09-19T00:10:26.073Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/71/cf/ac0f2c7e9d0ea3c75cd99dff7aec1c9df4a1376537cb90e4c882267ee7e9/mypy-1.18.2-cp313-cp313-win_amd64.whl", hash = "sha256:0e2785a84b34a72ba55fb5daf079a1003a34c05b22238da94fcae2bbe46f3544", size = 9833262, upload-time = "2025-09-19T00:10:40.035Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/5a/0c/7d5300883da16f0063ae53996358758b2a2df2a09c72a5061fa79a1f5006/mypy-1.18.2-cp314-cp314-macosx_10_13_x86_64.whl", hash = "sha256:62f0e1e988ad41c2a110edde6c398383a889d95b36b3e60bcf155f5164c4fdce", size = 12893775, upload-time = "2025-09-19T00:10:03.814Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/50/df/2cffbf25737bdb236f60c973edf62e3e7b4ee1c25b6878629e88e2cde967/mypy-1.18.2-cp314-cp314-macosx_11_0_arm64.whl", hash = "sha256:8795a039bab805ff0c1dfdb8cd3344642c2b99b8e439d057aba30850b8d3423d", size = 11936852, upload-time = "2025-09-19T00:10:51.631Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/be/50/34059de13dd269227fb4a03be1faee6e2a4b04a2051c82ac0a0b5a773c9a/mypy-1.18.2-cp314-cp314-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:6ca1e64b24a700ab5ce10133f7ccd956a04715463d30498e64ea8715236f9c9c", size = 12480242, upload-time = "2025-09-19T00:11:07.955Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/5b/11/040983fad5132d85914c874a2836252bbc57832065548885b5bb5b0d4359/mypy-1.18.2-cp314-cp314-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:d924eef3795cc89fecf6bedc6ed32b33ac13e8321344f6ddbf8ee89f706c05cb", size = 13326683, upload-time = "2025-09-19T00:09:55.572Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/e9/ba/89b2901dd77414dd7a8c8729985832a5735053be15b744c18e4586e506ef/mypy-1.18.2-cp314-cp314-musllinux_1_2_x86_64.whl", hash = "sha256:20c02215a080e3a2be3aa50506c67242df1c151eaba0dcbc1e4e557922a26075", size = 13514749, upload-time = "2025-09-19T00:10:44.827Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/25/bc/cc98767cffd6b2928ba680f3e5bc969c4152bf7c2d83f92f5a504b92b0eb/mypy-1.18.2-cp314-cp314-win_amd64.whl", hash = "sha256:749b5f83198f1ca64345603118a6f01a4e99ad4bf9d103ddc5a3200cc4614adf", size = 9982959, upload-time = "2025-09-19T00:10:37.344Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/87/e3/be76d87158ebafa0309946c4a73831974d4d6ab4f4ef40c3b53a385a66fd/mypy-1.18.2-py3-none-any.whl", hash = "sha256:22a1748707dd62b58d2ae53562ffc4d7f8bcc727e8ac7cbc69c053ddc874d47e", size = 2352367, upload-time = "2025-09-19T00:10:15.489Z" },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "mypy-extensions"
|
||||
version = "1.1.0"
|
||||
@@ -891,6 +1001,39 @@ wheels = [
|
||||
{ url = "https://files.pythonhosted.org/packages/79/7b/2c79738432f5c924bef5071f933bcc9efd0473bac3b4aa584a6f7c1c8df8/mypy_extensions-1.1.0-py3-none-any.whl", hash = "sha256:1be4cccdb0f2482337c4743e60421de3a356cd97508abadd57d47403e94f5505", size = 4963, upload-time = "2025-04-22T14:54:22.983Z" },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "nh3"
|
||||
version = "0.3.2"
|
||||
source = { registry = "https://pypi.org/simple" }
|
||||
sdist = { url = "https://files.pythonhosted.org/packages/ca/a5/34c26015d3a434409f4d2a1cd8821a06c05238703f49283ffeb937bef093/nh3-0.3.2.tar.gz", hash = "sha256:f394759a06df8b685a4ebfb1874fb67a9cbfd58c64fc5ed587a663c0e63ec376", size = 19288, upload-time = "2025-10-30T11:17:45.948Z" }
|
||||
wheels = [
|
||||
{ url = "https://files.pythonhosted.org/packages/5b/01/a1eda067c0ba823e5e2bb033864ae4854549e49fb6f3407d2da949106bfb/nh3-0.3.2-cp314-cp314t-macosx_10_12_x86_64.macosx_11_0_arm64.macosx_10_12_universal2.whl", hash = "sha256:d18957a90806d943d141cc5e4a0fefa1d77cf0d7a156878bf9a66eed52c9cc7d", size = 1419839, upload-time = "2025-10-30T11:17:09.956Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/30/57/07826ff65d59e7e9cc789ef1dc405f660cabd7458a1864ab58aefa17411b/nh3-0.3.2-cp314-cp314t-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:45c953e57028c31d473d6b648552d9cab1efe20a42ad139d78e11d8f42a36130", size = 791183, upload-time = "2025-10-30T11:17:11.99Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/af/2f/e8a86f861ad83f3bb5455f596d5c802e34fcdb8c53a489083a70fd301333/nh3-0.3.2-cp314-cp314t-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:2c9850041b77a9147d6bbd6dbbf13eeec7009eb60b44e83f07fcb2910075bf9b", size = 829127, upload-time = "2025-10-30T11:17:13.192Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/d8/97/77aef4daf0479754e8e90c7f8f48f3b7b8725a3b8c0df45f2258017a6895/nh3-0.3.2-cp314-cp314t-musllinux_1_2_aarch64.whl", hash = "sha256:403c11563e50b915d0efdb622866d1d9e4506bce590ef7da57789bf71dd148b5", size = 997131, upload-time = "2025-10-30T11:17:14.677Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/41/ee/fd8140e4df9d52143e89951dd0d797f5546004c6043285289fbbe3112293/nh3-0.3.2-cp314-cp314t-musllinux_1_2_armv7l.whl", hash = "sha256:0dca4365db62b2d71ff1620ee4f800c4729849906c5dd504ee1a7b2389558e31", size = 1068783, upload-time = "2025-10-30T11:17:15.861Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/87/64/bdd9631779e2d588b08391f7555828f352e7f6427889daf2fa424bfc90c9/nh3-0.3.2-cp314-cp314t-musllinux_1_2_i686.whl", hash = "sha256:0fe7ee035dd7b2290715baf29cb27167dddd2ff70ea7d052c958dbd80d323c99", size = 994732, upload-time = "2025-10-30T11:17:17.155Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/79/66/90190033654f1f28ca98e3d76b8be1194505583f9426b0dcde782a3970a2/nh3-0.3.2-cp314-cp314t-musllinux_1_2_x86_64.whl", hash = "sha256:a40202fd58e49129764f025bbaae77028e420f1d5b3c8e6f6fd3a6490d513868", size = 975997, upload-time = "2025-10-30T11:17:18.77Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/34/30/ebf8e2e8d71fdb5a5d5d8836207177aed1682df819cbde7f42f16898946c/nh3-0.3.2-cp314-cp314t-win32.whl", hash = "sha256:1f9ba555a797dbdcd844b89523f29cdc90973d8bd2e836ea6b962cf567cadd93", size = 583364, upload-time = "2025-10-30T11:17:20.286Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/94/ae/95c52b5a75da429f11ca8902c2128f64daafdc77758d370e4cc310ecda55/nh3-0.3.2-cp314-cp314t-win_amd64.whl", hash = "sha256:dce4248edc427c9b79261f3e6e2b3ecbdd9b88c267012168b4a7b3fc6fd41d13", size = 589982, upload-time = "2025-10-30T11:17:21.384Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/b4/bd/c7d862a4381b95f2469704de32c0ad419def0f4a84b7a138a79532238114/nh3-0.3.2-cp314-cp314t-win_arm64.whl", hash = "sha256:019ecbd007536b67fdf76fab411b648fb64e2257ca3262ec80c3425c24028c80", size = 577126, upload-time = "2025-10-30T11:17:22.755Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/b6/3e/f5a5cc2885c24be13e9b937441bd16a012ac34a657fe05e58927e8af8b7a/nh3-0.3.2-cp38-abi3-macosx_10_12_x86_64.macosx_11_0_arm64.macosx_10_12_universal2.whl", hash = "sha256:7064ccf5ace75825bd7bf57859daaaf16ed28660c1c6b306b649a9eda4b54b1e", size = 1431980, upload-time = "2025-10-30T11:17:25.457Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/7f/f7/529a99324d7ef055de88b690858f4189379708abae92ace799365a797b7f/nh3-0.3.2-cp38-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:c8745454cdd28bbbc90861b80a0111a195b0e3961b9fa2e672be89eb199fa5d8", size = 820805, upload-time = "2025-10-30T11:17:26.98Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/3d/62/19b7c50ccd1fa7d0764822d2cea8f2a320f2fd77474c7a1805cb22cf69b0/nh3-0.3.2-cp38-abi3-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:72d67c25a84579f4a432c065e8b4274e53b7cf1df8f792cf846abfe2c3090866", size = 803527, upload-time = "2025-10-30T11:17:28.284Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/4a/ca/f022273bab5440abff6302731a49410c5ef66b1a9502ba3fbb2df998d9ff/nh3-0.3.2-cp38-abi3-manylinux_2_17_ppc64.manylinux2014_ppc64.whl", hash = "sha256:13398e676a14d6233f372c75f52d5ae74f98210172991f7a3142a736bd92b131", size = 1051674, upload-time = "2025-10-30T11:17:29.909Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/fa/f7/5728e3b32a11daf5bd21cf71d91c463f74305938bc3eb9e0ac1ce141646e/nh3-0.3.2-cp38-abi3-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:03d617e5c8aa7331bd2659c654e021caf9bba704b109e7b2b28b039a00949fe5", size = 1004737, upload-time = "2025-10-30T11:17:31.205Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/53/7f/f17e0dba0a99cee29e6cee6d4d52340ef9cb1f8a06946d3a01eb7ec2fb01/nh3-0.3.2-cp38-abi3-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:f2f55c4d2d5a207e74eefe4d828067bbb01300e06e2a7436142f915c5928de07", size = 911745, upload-time = "2025-10-30T11:17:32.945Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/42/0f/c76bf3dba22c73c38e9b1113b017cf163f7696f50e003404ec5ecdb1e8a6/nh3-0.3.2-cp38-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7bb18403f02b655a1bbe4e3a4696c2ae1d6ae8f5991f7cacb684b1ae27e6c9f7", size = 797184, upload-time = "2025-10-30T11:17:34.226Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/08/a1/73d8250f888fb0ddf1b119b139c382f8903d8bb0c5bd1f64afc7e38dad1d/nh3-0.3.2-cp38-abi3-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:6d66f41672eb4060cf87c037f760bdbc6847852ca9ef8e9c5a5da18f090abf87", size = 838556, upload-time = "2025-10-30T11:17:35.875Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/d1/09/deb57f1fb656a7a5192497f4a287b0ade5a2ff6b5d5de4736d13ef6d2c1f/nh3-0.3.2-cp38-abi3-musllinux_1_2_aarch64.whl", hash = "sha256:f97f8b25cb2681d25e2338148159447e4d689aafdccfcf19e61ff7db3905768a", size = 1006695, upload-time = "2025-10-30T11:17:37.071Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/b6/61/8f4d41c4ccdac30e4b1a4fa7be4b0f9914d8314a5058472f84c8e101a418/nh3-0.3.2-cp38-abi3-musllinux_1_2_armv7l.whl", hash = "sha256:2ab70e8c6c7d2ce953d2a58102eefa90c2d0a5ed7aa40c7e29a487bc5e613131", size = 1075471, upload-time = "2025-10-30T11:17:38.225Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/b0/c6/966aec0cb4705e69f6c3580422c239205d5d4d0e50fac380b21e87b6cf1b/nh3-0.3.2-cp38-abi3-musllinux_1_2_i686.whl", hash = "sha256:1710f3901cd6440ca92494ba2eb6dc260f829fa8d9196b659fa10de825610ce0", size = 1002439, upload-time = "2025-10-30T11:17:39.553Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/e2/c8/97a2d5f7a314cce2c5c49f30c6f161b7f3617960ade4bfc2fd1ee092cb20/nh3-0.3.2-cp38-abi3-musllinux_1_2_x86_64.whl", hash = "sha256:91e9b001101fb4500a2aafe3e7c92928d85242d38bf5ac0aba0b7480da0a4cd6", size = 987439, upload-time = "2025-10-30T11:17:40.81Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/0d/95/2d6fc6461687d7a171f087995247dec33e8749a562bfadd85fb5dbf37a11/nh3-0.3.2-cp38-abi3-win32.whl", hash = "sha256:169db03df90da63286e0560ea0efa9b6f3b59844a9735514a1d47e6bb2c8c61b", size = 589826, upload-time = "2025-10-30T11:17:42.239Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/64/9a/1a1c154f10a575d20dd634e5697805e589bbdb7673a0ad00e8da90044ba7/nh3-0.3.2-cp38-abi3-win_amd64.whl", hash = "sha256:562da3dca7a17f9077593214a9781a94b8d76de4f158f8c895e62f09573945fe", size = 596406, upload-time = "2025-10-30T11:17:43.773Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/9e/7e/a96255f63b7aef032cbee8fc4d6e37def72e3aaedc1f72759235e8f13cb1/nh3-0.3.2-cp38-abi3-win_arm64.whl", hash = "sha256:cf5964d54edd405e68583114a7cba929468bcd7db5e676ae38ee954de1cfc104", size = 584162, upload-time = "2025-10-30T11:17:44.96Z" },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "openapi-core"
|
||||
version = "0.19.5"
|
||||
@@ -1154,6 +1297,15 @@ wheels = [
|
||||
{ url = "https://files.pythonhosted.org/packages/df/80/fc9d01d5ed37ba4c42ca2b55b4339ae6e200b456be3a1aaddf4a9fa99b8c/pyperclip-1.11.0-py3-none-any.whl", hash = "sha256:299403e9ff44581cb9ba2ffeed69c7aa96a008622ad0c46cb575ca75b5b84273", size = 11063, upload-time = "2025-09-26T14:40:36.069Z" },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "pyproject-hooks"
|
||||
version = "1.2.0"
|
||||
source = { registry = "https://pypi.org/simple" }
|
||||
sdist = { url = "https://files.pythonhosted.org/packages/e7/82/28175b2414effca1cdac8dc99f76d660e7a4fb0ceefa4b4ab8f5f6742925/pyproject_hooks-1.2.0.tar.gz", hash = "sha256:1e859bd5c40fae9448642dd871adf459e5e2084186e8d2c2a79a824c970da1f8", size = 19228, upload-time = "2024-09-29T09:24:13.293Z" }
|
||||
wheels = [
|
||||
{ url = "https://files.pythonhosted.org/packages/bd/24/12818598c362d7f300f18e74db45963dbcb85150324092410c8b49405e42/pyproject_hooks-1.2.0-py3-none-any.whl", hash = "sha256:9e5c6bfa8dcc30091c74b0cf803c81fdd29d94f01992a7707bc97babb1141913", size = 10216, upload-time = "2024-09-29T09:24:11.978Z" },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "pytest"
|
||||
version = "8.4.2"
|
||||
@@ -1258,6 +1410,15 @@ wheels = [
|
||||
{ url = "https://files.pythonhosted.org/packages/c0/d2/21af5c535501a7233e734b8af901574572da66fcc254cb35d0609c9080dd/pywin32-311-cp314-cp314-win_arm64.whl", hash = "sha256:a508e2d9025764a8270f93111a970e1d0fbfc33f4153b388bb649b7eec4f9b42", size = 8932540, upload-time = "2025-07-14T20:13:36.379Z" },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "pywin32-ctypes"
|
||||
version = "0.2.3"
|
||||
source = { registry = "https://pypi.org/simple" }
|
||||
sdist = { url = "https://files.pythonhosted.org/packages/85/9f/01a1a99704853cb63f253eea009390c88e7131c67e66a0a02099a8c917cb/pywin32-ctypes-0.2.3.tar.gz", hash = "sha256:d162dc04946d704503b2edc4d55f3dba5c1d539ead017afa00142c38b9885755", size = 29471, upload-time = "2024-08-14T10:15:34.626Z" }
|
||||
wheels = [
|
||||
{ url = "https://files.pythonhosted.org/packages/de/3d/8161f7711c017e01ac9f008dfddd9410dff3674334c233bde66e7ba65bbf/pywin32_ctypes-0.2.3-py3-none-any.whl", hash = "sha256:8a1513379d709975552d202d942d9837758905c8d01eb82b8bcc30918929e7b8", size = 30756, upload-time = "2024-08-14T10:15:33.187Z" },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "pyyaml"
|
||||
version = "6.0.3"
|
||||
@@ -1322,6 +1483,20 @@ wheels = [
|
||||
{ url = "https://files.pythonhosted.org/packages/f1/12/de94a39c2ef588c7e6455cfbe7343d3b2dc9d6b6b2f40c4c6565744c873d/pyyaml-6.0.3-cp314-cp314t-win_arm64.whl", hash = "sha256:ebc55a14a21cb14062aa4162f906cd962b28e2e9ea38f9b4391244cd8de4ae0b", size = 149341, upload-time = "2025-09-25T21:32:56.828Z" },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "readme-renderer"
|
||||
version = "44.0"
|
||||
source = { registry = "https://pypi.org/simple" }
|
||||
dependencies = [
|
||||
{ name = "docutils" },
|
||||
{ name = "nh3" },
|
||||
{ name = "pygments" },
|
||||
]
|
||||
sdist = { url = "https://files.pythonhosted.org/packages/5a/a9/104ec9234c8448c4379768221ea6df01260cd6c2ce13182d4eac531c8342/readme_renderer-44.0.tar.gz", hash = "sha256:8712034eabbfa6805cacf1402b4eeb2a73028f72d1166d6f5cb7f9c047c5d1e1", size = 32056, upload-time = "2024-07-08T15:00:57.805Z" }
|
||||
wheels = [
|
||||
{ url = "https://files.pythonhosted.org/packages/e1/67/921ec3024056483db83953ae8e48079ad62b92db7880013ca77632921dd0/readme_renderer-44.0-py3-none-any.whl", hash = "sha256:2fbca89b81a08526aadf1357a8c2ae889ec05fb03f5da67f9769c9a592166151", size = 13310, upload-time = "2024-07-08T15:00:56.577Z" },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "referencing"
|
||||
version = "0.36.2"
|
||||
@@ -1351,6 +1526,18 @@ wheels = [
|
||||
{ url = "https://files.pythonhosted.org/packages/1e/db/4254e3eabe8020b458f1a747140d32277ec7a271daf1d235b70dc0b4e6e3/requests-2.32.5-py3-none-any.whl", hash = "sha256:2462f94637a34fd532264295e186976db0f5d453d1cdd31473c85a6a161affb6", size = 64738, upload-time = "2025-08-18T20:46:00.542Z" },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "requests-toolbelt"
|
||||
version = "1.0.0"
|
||||
source = { registry = "https://pypi.org/simple" }
|
||||
dependencies = [
|
||||
{ name = "requests" },
|
||||
]
|
||||
sdist = { url = "https://files.pythonhosted.org/packages/f3/61/d7545dafb7ac2230c70d38d31cbfe4cc64f7144dc41f6e4e4b78ecd9f5bb/requests-toolbelt-1.0.0.tar.gz", hash = "sha256:7681a0a3d047012b5bdc0ee37d7f8f07ebe76ab08caeccfc3921ce23c88d5bc6", size = 206888, upload-time = "2023-05-01T04:11:33.229Z" }
|
||||
wheels = [
|
||||
{ url = "https://files.pythonhosted.org/packages/3f/51/d4db610ef29373b879047326cbf6fa98b6c1969d6f6dc423279de2b1be2c/requests_toolbelt-1.0.0-py2.py3-none-any.whl", hash = "sha256:cccfdd665f0a24fcf4726e690f65639d272bb0637b9b92dfd91a5568ccf6bd06", size = 54481, upload-time = "2023-05-01T04:11:28.427Z" },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "rfc3339-validator"
|
||||
version = "0.1.4"
|
||||
@@ -1363,6 +1550,15 @@ wheels = [
|
||||
{ url = "https://files.pythonhosted.org/packages/7b/44/4e421b96b67b2daff264473f7465db72fbdf36a07e05494f50300cc7b0c6/rfc3339_validator-0.1.4-py2.py3-none-any.whl", hash = "sha256:24f6ec1eda14ef823da9e36ec7113124b39c04d50a4d3d3a3c2859577e7791fa", size = 3490, upload-time = "2021-05-12T16:37:52.536Z" },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "rfc3986"
|
||||
version = "2.0.0"
|
||||
source = { registry = "https://pypi.org/simple" }
|
||||
sdist = { url = "https://files.pythonhosted.org/packages/85/40/1520d68bfa07ab5a6f065a186815fb6610c86fe957bc065754e47f7b0840/rfc3986-2.0.0.tar.gz", hash = "sha256:97aacf9dbd4bfd829baad6e6309fa6573aaf1be3f6fa735c8ab05e46cecb261c", size = 49026, upload-time = "2022-01-10T00:52:30.832Z" }
|
||||
wheels = [
|
||||
{ url = "https://files.pythonhosted.org/packages/ff/9a/9afaade874b2fa6c752c36f1548f718b5b83af81ed9b76628329dab81c1b/rfc3986-2.0.0-py2.py3-none-any.whl", hash = "sha256:50b1502b60e289cb37883f3dfd34532b8873c7de9f49bb546641ce9cbd256ebd", size = 31326, upload-time = "2022-01-10T00:52:29.594Z" },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "rich"
|
||||
version = "14.1.0"
|
||||
@@ -1550,6 +1746,19 @@ wheels = [
|
||||
{ url = "https://files.pythonhosted.org/packages/c3/12/28fa2f597a605884deb0f65c1b1ae05111051b2a7030f5d8a4ff7f4599ba/ruff-0.13.2-py3-none-win_arm64.whl", hash = "sha256:da711b14c530412c827219312b7d7fbb4877fb31150083add7e8c5336549cea7", size = 12484437, upload-time = "2025-09-25T14:54:08.022Z" },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "secretstorage"
|
||||
version = "3.5.0"
|
||||
source = { registry = "https://pypi.org/simple" }
|
||||
dependencies = [
|
||||
{ name = "cryptography" },
|
||||
{ name = "jeepney" },
|
||||
]
|
||||
sdist = { url = "https://files.pythonhosted.org/packages/1c/03/e834bcd866f2f8a49a85eaff47340affa3bfa391ee9912a952a1faa68c7b/secretstorage-3.5.0.tar.gz", hash = "sha256:f04b8e4689cbce351744d5537bf6b1329c6fc68f91fa666f60a380edddcd11be", size = 19884, upload-time = "2025-11-23T19:02:53.191Z" }
|
||||
wheels = [
|
||||
{ url = "https://files.pythonhosted.org/packages/b7/46/f5af3402b579fd5e11573ce652019a67074317e18c1935cc0b4ba9b35552/secretstorage-3.5.0-py3-none-any.whl", hash = "sha256:0ce65888c0725fcb2c5bc0fdb8e5438eece02c523557ea40ce0703c266248137", size = 15554, upload-time = "2025-11-23T19:02:51.545Z" },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "six"
|
||||
version = "1.17.0"
|
||||
@@ -1632,6 +1841,50 @@ wheels = [
|
||||
{ url = "https://files.pythonhosted.org/packages/6e/c2/61d3e0f47e2b74ef40a68b9e6ad5984f6241a942f7cd3bbfbdbd03861ea9/tomli-2.2.1-py3-none-any.whl", hash = "sha256:cb55c73c5f4408779d0cf3eef9f762b9c9f147a77de7b258bef0a5628adc85cc", size = 14257, upload-time = "2024-11-27T22:38:35.385Z" },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "twine"
|
||||
version = "6.2.0"
|
||||
source = { registry = "https://pypi.org/simple" }
|
||||
dependencies = [
|
||||
{ name = "id" },
|
||||
{ name = "keyring", marker = "platform_machine != 'ppc64le' and platform_machine != 's390x'" },
|
||||
{ name = "packaging" },
|
||||
{ name = "readme-renderer" },
|
||||
{ name = "requests" },
|
||||
{ name = "requests-toolbelt" },
|
||||
{ name = "rfc3986" },
|
||||
{ name = "rich" },
|
||||
{ name = "urllib3" },
|
||||
]
|
||||
sdist = { url = "https://files.pythonhosted.org/packages/e0/a8/949edebe3a82774c1ec34f637f5dd82d1cf22c25e963b7d63771083bbee5/twine-6.2.0.tar.gz", hash = "sha256:e5ed0d2fd70c9959770dce51c8f39c8945c574e18173a7b81802dab51b4b75cf", size = 172262, upload-time = "2025-09-04T15:43:17.255Z" }
|
||||
wheels = [
|
||||
{ url = "https://files.pythonhosted.org/packages/3a/7a/882d99539b19b1490cac5d77c67338d126e4122c8276bf640e411650c830/twine-6.2.0-py3-none-any.whl", hash = "sha256:418ebf08ccda9a8caaebe414433b0ba5e25eb5e4a927667122fbe8f829f985d8", size = 42727, upload-time = "2025-09-04T15:43:15.994Z" },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "ty"
|
||||
version = "0.0.15"
|
||||
source = { registry = "https://pypi.org/simple" }
|
||||
sdist = { url = "https://files.pythonhosted.org/packages/4e/25/257602d316b9333089b688a7a11b33ebc660b74e8dacf400dc3dfdea1594/ty-0.0.15.tar.gz", hash = "sha256:4f9a5b8df208c62dba56e91b93bed8b5bb714839691b8cff16d12c983bfa1174", size = 5101936, upload-time = "2026-02-05T01:06:34.922Z" }
|
||||
wheels = [
|
||||
{ url = "https://files.pythonhosted.org/packages/ce/c5/35626e732b79bf0e6213de9f79aff59b5f247c0a1e3ce0d93e675ab9b728/ty-0.0.15-py3-none-linux_armv6l.whl", hash = "sha256:68e092458516c61512dac541cde0a5e4e5842df00b4e81881ead8f745ddec794", size = 10138374, upload-time = "2026-02-05T01:07:03.804Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/d5/8a/48fd81664604848f79d03879b3ca3633762d457a069b07e09fb1b87edd6e/ty-0.0.15-py3-none-macosx_10_12_x86_64.whl", hash = "sha256:79f2e75289eae3cece94c51118b730211af4ba5762906f52a878041b67e54959", size = 9947858, upload-time = "2026-02-05T01:06:47.453Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/b6/85/c1ac8e97bcd930946f4c94db85b675561d590b4e72703bf3733419fc3973/ty-0.0.15-py3-none-macosx_11_0_arm64.whl", hash = "sha256:112a7b26e63e48cc72c8c5b03227d1db280cfa57a45f2df0e264c3a016aa8c3c", size = 9443220, upload-time = "2026-02-05T01:06:44.98Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/3c/d9/244bc02599d950f7a4298fbc0c1b25cc808646b9577bdf7a83470b2d1cec/ty-0.0.15-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:71f62a2644972975a657d9dc867bf901235cde51e8d24c20311067e7afd44a56", size = 9949976, upload-time = "2026-02-05T01:07:01.515Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/7e/ab/3a0daad66798c91a33867a3ececf17d314ac65d4ae2bbbd28cbfde94da63/ty-0.0.15-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:9e48b42be2d257317c85b78559233273b655dd636fc61e7e1d69abd90fd3cba4", size = 9965918, upload-time = "2026-02-05T01:06:54.283Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/39/4e/e62b01338f653059a7c0cd09d1a326e9a9eedc351a0f0de9db0601658c3d/ty-0.0.15-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:27dd5b52a421e6871c5bfe9841160331b60866ed2040250cb161886478ab3e4f", size = 10424943, upload-time = "2026-02-05T01:07:08.777Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/65/b5/7aa06655ce69c0d4f3e845d2d85e79c12994b6d84c71699cfb437e0bc8cf/ty-0.0.15-py3-none-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:76b85c9ec2219e11c358a7db8e21b7e5c6674a1fb9b6f633836949de98d12286", size = 10964692, upload-time = "2026-02-05T01:06:37.103Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/13/04/36fdfe1f3c908b471e246e37ce3d011175584c26d3853e6c5d9a0364564c/ty-0.0.15-py3-none-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:a9e8204c61d8ede4f21f2975dce74efdb80fafb2fae1915c666cceb33ea3c90b", size = 10692225, upload-time = "2026-02-05T01:06:49.714Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/13/41/5bf882649bd8b64ded5fbce7fb8d77fb3b868de1a3b1a6c4796402b47308/ty-0.0.15-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:af87c3be7c944bb4d6609d6c63e4594944b0028c7bd490a525a82b88fe010d6d", size = 10516776, upload-time = "2026-02-05T01:06:52.047Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/56/75/66852d7e004f859839c17ffe1d16513c1e7cc04bcc810edb80ca022a9124/ty-0.0.15-py3-none-musllinux_1_2_aarch64.whl", hash = "sha256:50dccf7398505e5966847d366c9e4c650b8c225411c2a68c32040a63b9521eea", size = 9928828, upload-time = "2026-02-05T01:06:56.647Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/65/72/96bc16c7b337a3ef358fd227b3c8ef0c77405f3bfbbfb59ee5915f0d9d71/ty-0.0.15-py3-none-musllinux_1_2_armv7l.whl", hash = "sha256:bd797b8f231a4f4715110259ad1ad5340a87b802307f3e06d92bfb37b858a8f3", size = 9978960, upload-time = "2026-02-05T01:06:29.567Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/a0/18/d2e316a35b626de2227f832cd36d21205e4f5d96fd036a8af84c72ecec1b/ty-0.0.15-py3-none-musllinux_1_2_i686.whl", hash = "sha256:9deb7f20e18b25440a9aa4884f934ba5628ef456dbde91819d5af1a73da48af3", size = 10135903, upload-time = "2026-02-05T01:06:59.256Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/02/d3/b617a79c9dad10c888d7c15cd78859e0160b8772273637b9c4241a049491/ty-0.0.15-py3-none-musllinux_1_2_x86_64.whl", hash = "sha256:7b31b3de031255b90a5f4d9cb3d050feae246067c87130e5a6861a8061c71754", size = 10615879, upload-time = "2026-02-05T01:07:06.661Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/fb/b0/2652a73c71c77296a6343217063f05745da60c67b7e8a8e25f2064167fce/ty-0.0.15-py3-none-win32.whl", hash = "sha256:9362c528ceb62c89d65c216336d28d500bc9f4c10418413f63ebc16886e16cc1", size = 9578058, upload-time = "2026-02-05T01:06:42.928Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/84/6e/08a4aedebd2a6ce2784b5bc3760e43d1861f1a184734a78215c2d397c1df/ty-0.0.15-py3-none-win_amd64.whl", hash = "sha256:4db040695ae67c5524f59cb8179a8fa277112e69042d7dfdac862caa7e3b0d9c", size = 10457112, upload-time = "2026-02-05T01:06:39.885Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/b3/be/1991f2bc12847ae2d4f1e3ac5dcff8bb7bc1261390645c0755bb55616355/ty-0.0.15-py3-none-win_arm64.whl", hash = "sha256:e5a98d4119e77d6136461e16ae505f8f8069002874ab073de03fbcb1a5e8bf25", size = 9937490, upload-time = "2026-02-05T01:06:32.388Z" },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "types-pytz"
|
||||
version = "2025.2.0.20250809"
|
||||
@@ -1673,41 +1926,100 @@ dependencies = [
|
||||
{ name = "python-dotenv" },
|
||||
{ name = "pytz" },
|
||||
{ name = "rich" },
|
||||
{ name = "uvicorn" },
|
||||
{ name = "uvicorn", extra = ["standard"] },
|
||||
{ name = "websockets" },
|
||||
]
|
||||
|
||||
[package.optional-dependencies]
|
||||
all = [
|
||||
{ name = "black" },
|
||||
{ name = "build" },
|
||||
{ name = "pytest" },
|
||||
{ name = "pytest-asyncio" },
|
||||
{ name = "pytest-cov" },
|
||||
{ name = "ruff" },
|
||||
{ name = "twine" },
|
||||
{ name = "ty" },
|
||||
{ name = "types-pytz" },
|
||||
]
|
||||
dev = [
|
||||
{ name = "black" },
|
||||
{ name = "build" },
|
||||
{ name = "pytest" },
|
||||
{ name = "pytest-asyncio" },
|
||||
{ name = "pytest-cov" },
|
||||
{ name = "ruff" },
|
||||
{ name = "twine" },
|
||||
{ name = "ty" },
|
||||
{ name = "types-pytz" },
|
||||
]
|
||||
lint = [
|
||||
{ name = "black" },
|
||||
{ name = "ruff" },
|
||||
{ name = "ty" },
|
||||
]
|
||||
test = [
|
||||
{ name = "pytest" },
|
||||
{ name = "pytest-asyncio" },
|
||||
{ name = "pytest-cov" },
|
||||
]
|
||||
types = [
|
||||
{ name = "types-pytz" },
|
||||
]
|
||||
|
||||
[package.dev-dependencies]
|
||||
dev = [
|
||||
{ name = "black" },
|
||||
{ name = "mypy" },
|
||||
{ name = "build" },
|
||||
{ name = "pytest" },
|
||||
{ name = "pytest-asyncio" },
|
||||
{ name = "pytest-cov" },
|
||||
{ name = "ruff" },
|
||||
{ name = "twine" },
|
||||
{ name = "ty" },
|
||||
{ name = "types-pytz" },
|
||||
]
|
||||
|
||||
[package.metadata]
|
||||
requires-dist = [
|
||||
{ name = "black", marker = "extra == 'dev'", specifier = ">=25.1.0" },
|
||||
{ name = "black", marker = "extra == 'lint'", specifier = ">=25.1.0" },
|
||||
{ name = "build", marker = "extra == 'dev'", specifier = ">=1.2.2" },
|
||||
{ name = "fastapi", specifier = ">=0.116.1" },
|
||||
{ name = "fastmcp", specifier = ">=2.11.2" },
|
||||
{ name = "httpx", specifier = ">=0.28.1" },
|
||||
{ name = "pytest", marker = "extra == 'dev'", specifier = ">=8.4.2" },
|
||||
{ name = "pytest", marker = "extra == 'test'", specifier = ">=8.4.2" },
|
||||
{ name = "pytest-asyncio", marker = "extra == 'dev'", specifier = ">=1.2.0" },
|
||||
{ name = "pytest-asyncio", marker = "extra == 'test'", specifier = ">=1.2.0" },
|
||||
{ name = "pytest-cov", marker = "extra == 'dev'", specifier = ">=7.0.0" },
|
||||
{ name = "pytest-cov", marker = "extra == 'test'", specifier = ">=7.0.0" },
|
||||
{ name = "python-dotenv", specifier = ">=1.1.1" },
|
||||
{ name = "pytz", specifier = ">=2025.2" },
|
||||
{ name = "rich", specifier = ">=14.1.0" },
|
||||
{ name = "uvicorn", specifier = ">=0.35.0" },
|
||||
{ name = "ruff", marker = "extra == 'dev'", specifier = ">=0.12.8" },
|
||||
{ name = "ruff", marker = "extra == 'lint'", specifier = ">=0.12.8" },
|
||||
{ name = "twine", marker = "extra == 'dev'", specifier = ">=6.0.1" },
|
||||
{ name = "ty", marker = "extra == 'dev'", specifier = ">=0.0.15" },
|
||||
{ name = "ty", marker = "extra == 'lint'", specifier = ">=0.0.15" },
|
||||
{ name = "types-pytz", marker = "extra == 'dev'", specifier = ">=2025.2.0.20250809" },
|
||||
{ name = "types-pytz", marker = "extra == 'types'", specifier = ">=2025.2.0.20250809" },
|
||||
{ name = "unraid-mcp", extras = ["dev", "test", "lint", "types"], marker = "extra == 'all'" },
|
||||
{ name = "uvicorn", extras = ["standard"], specifier = ">=0.35.0" },
|
||||
{ name = "websockets", specifier = ">=13.1,<14.0" },
|
||||
]
|
||||
provides-extras = ["dev", "test", "lint", "types", "all"]
|
||||
|
||||
[package.metadata.requires-dev]
|
||||
dev = [
|
||||
{ name = "black", specifier = ">=25.1.0" },
|
||||
{ name = "mypy", specifier = ">=1.17.1" },
|
||||
{ name = "build", specifier = ">=1.2.2" },
|
||||
{ name = "pytest", specifier = ">=8.4.2" },
|
||||
{ name = "pytest-asyncio", specifier = ">=1.2.0" },
|
||||
{ name = "pytest-cov", specifier = ">=7.0.0" },
|
||||
{ name = "ruff", specifier = ">=0.12.8" },
|
||||
{ name = "twine", specifier = ">=6.0.1" },
|
||||
{ name = "ty", specifier = ">=0.0.15" },
|
||||
{ name = "types-pytz", specifier = ">=2025.2.0.20250809" },
|
||||
]
|
||||
|
||||
@@ -1734,6 +2046,164 @@ wheels = [
|
||||
{ url = "https://files.pythonhosted.org/packages/85/cd/584a2ceb5532af99dd09e50919e3615ba99aa127e9850eafe5f31ddfdb9a/uvicorn-0.37.0-py3-none-any.whl", hash = "sha256:913b2b88672343739927ce381ff9e2ad62541f9f8289664fa1d1d3803fa2ce6c", size = 67976, upload-time = "2025-09-23T13:33:45.842Z" },
|
||||
]
|
||||
|
||||
[package.optional-dependencies]
|
||||
standard = [
|
||||
{ name = "colorama", marker = "sys_platform == 'win32'" },
|
||||
{ name = "httptools" },
|
||||
{ name = "python-dotenv" },
|
||||
{ name = "pyyaml" },
|
||||
{ name = "uvloop", marker = "platform_python_implementation != 'PyPy' and sys_platform != 'cygwin' and sys_platform != 'win32'" },
|
||||
{ name = "watchfiles" },
|
||||
{ name = "websockets" },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "uvloop"
|
||||
version = "0.22.1"
|
||||
source = { registry = "https://pypi.org/simple" }
|
||||
sdist = { url = "https://files.pythonhosted.org/packages/06/f0/18d39dbd1971d6d62c4629cc7fa67f74821b0dc1f5a77af43719de7936a7/uvloop-0.22.1.tar.gz", hash = "sha256:6c84bae345b9147082b17371e3dd5d42775bddce91f885499017f4607fdaf39f", size = 2443250, upload-time = "2025-10-16T22:17:19.342Z" }
|
||||
wheels = [
|
||||
{ url = "https://files.pythonhosted.org/packages/eb/14/ecceb239b65adaaf7fde510aa8bd534075695d1e5f8dadfa32b5723d9cfb/uvloop-0.22.1-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:ef6f0d4cc8a9fa1f6a910230cd53545d9a14479311e87e3cb225495952eb672c", size = 1343335, upload-time = "2025-10-16T22:16:11.43Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/ba/ae/6f6f9af7f590b319c94532b9567409ba11f4fa71af1148cab1bf48a07048/uvloop-0.22.1-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:7cd375a12b71d33d46af85a3343b35d98e8116134ba404bd657b3b1d15988792", size = 742903, upload-time = "2025-10-16T22:16:12.979Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/09/bd/3667151ad0702282a1f4d5d29288fce8a13c8b6858bf0978c219cd52b231/uvloop-0.22.1-cp310-cp310-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:ac33ed96229b7790eb729702751c0e93ac5bc3bcf52ae9eccbff30da09194b86", size = 3648499, upload-time = "2025-10-16T22:16:14.451Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/b3/f6/21657bb3beb5f8c57ce8be3b83f653dd7933c2fd00545ed1b092d464799a/uvloop-0.22.1-cp310-cp310-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:481c990a7abe2c6f4fc3d98781cc9426ebd7f03a9aaa7eb03d3bfc68ac2a46bd", size = 3700133, upload-time = "2025-10-16T22:16:16.272Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/09/e0/604f61d004ded805f24974c87ddd8374ef675644f476f01f1df90e4cdf72/uvloop-0.22.1-cp310-cp310-musllinux_1_2_aarch64.whl", hash = "sha256:a592b043a47ad17911add5fbd087c76716d7c9ccc1d64ec9249ceafd735f03c2", size = 3512681, upload-time = "2025-10-16T22:16:18.07Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/bb/ce/8491fd370b0230deb5eac69c7aae35b3be527e25a911c0acdffb922dc1cd/uvloop-0.22.1-cp310-cp310-musllinux_1_2_x86_64.whl", hash = "sha256:1489cf791aa7b6e8c8be1c5a080bae3a672791fcb4e9e12249b05862a2ca9cec", size = 3615261, upload-time = "2025-10-16T22:16:19.596Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/c7/d5/69900f7883235562f1f50d8184bb7dd84a2fb61e9ec63f3782546fdbd057/uvloop-0.22.1-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:c60ebcd36f7b240b30788554b6f0782454826a0ed765d8430652621b5de674b9", size = 1352420, upload-time = "2025-10-16T22:16:21.187Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/a8/73/c4e271b3bce59724e291465cc936c37758886a4868787da0278b3b56b905/uvloop-0.22.1-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:3b7f102bf3cb1995cfeaee9321105e8f5da76fdb104cdad8986f85461a1b7b77", size = 748677, upload-time = "2025-10-16T22:16:22.558Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/86/94/9fb7fad2f824d25f8ecac0d70b94d0d48107ad5ece03769a9c543444f78a/uvloop-0.22.1-cp311-cp311-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:53c85520781d84a4b8b230e24a5af5b0778efdb39142b424990ff1ef7c48ba21", size = 3753819, upload-time = "2025-10-16T22:16:23.903Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/74/4f/256aca690709e9b008b7108bc85fba619a2bc37c6d80743d18abad16ee09/uvloop-0.22.1-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:56a2d1fae65fd82197cb8c53c367310b3eabe1bbb9fb5a04d28e3e3520e4f702", size = 3804529, upload-time = "2025-10-16T22:16:25.246Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/7f/74/03c05ae4737e871923d21a76fe28b6aad57f5c03b6e6bfcfa5ad616013e4/uvloop-0.22.1-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:40631b049d5972c6755b06d0bfe8233b1bd9a8a6392d9d1c45c10b6f9e9b2733", size = 3621267, upload-time = "2025-10-16T22:16:26.819Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/75/be/f8e590fe61d18b4a92070905497aec4c0e64ae1761498cad09023f3f4b3e/uvloop-0.22.1-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:535cc37b3a04f6cd2c1ef65fa1d370c9a35b6695df735fcff5427323f2cd5473", size = 3723105, upload-time = "2025-10-16T22:16:28.252Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/3d/ff/7f72e8170be527b4977b033239a83a68d5c881cc4775fca255c677f7ac5d/uvloop-0.22.1-cp312-cp312-macosx_10_13_universal2.whl", hash = "sha256:fe94b4564e865d968414598eea1a6de60adba0c040ba4ed05ac1300de402cd42", size = 1359936, upload-time = "2025-10-16T22:16:29.436Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/c3/c6/e5d433f88fd54d81ef4be58b2b7b0cea13c442454a1db703a1eea0db1a59/uvloop-0.22.1-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:51eb9bd88391483410daad430813d982010f9c9c89512321f5b60e2cddbdddd6", size = 752769, upload-time = "2025-10-16T22:16:30.493Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/24/68/a6ac446820273e71aa762fa21cdcc09861edd3536ff47c5cd3b7afb10eeb/uvloop-0.22.1-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:700e674a166ca5778255e0e1dc4e9d79ab2acc57b9171b79e65feba7184b3370", size = 4317413, upload-time = "2025-10-16T22:16:31.644Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/5f/6f/e62b4dfc7ad6518e7eff2516f680d02a0f6eb62c0c212e152ca708a0085e/uvloop-0.22.1-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:7b5b1ac819a3f946d3b2ee07f09149578ae76066d70b44df3fa990add49a82e4", size = 4426307, upload-time = "2025-10-16T22:16:32.917Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/90/60/97362554ac21e20e81bcef1150cb2a7e4ffdaf8ea1e5b2e8bf7a053caa18/uvloop-0.22.1-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:e047cc068570bac9866237739607d1313b9253c3051ad84738cbb095be0537b2", size = 4131970, upload-time = "2025-10-16T22:16:34.015Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/99/39/6b3f7d234ba3964c428a6e40006340f53ba37993f46ed6e111c6e9141d18/uvloop-0.22.1-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:512fec6815e2dd45161054592441ef76c830eddaad55c8aa30952e6fe1ed07c0", size = 4296343, upload-time = "2025-10-16T22:16:35.149Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/89/8c/182a2a593195bfd39842ea68ebc084e20c850806117213f5a299dfc513d9/uvloop-0.22.1-cp313-cp313-macosx_10_13_universal2.whl", hash = "sha256:561577354eb94200d75aca23fbde86ee11be36b00e52a4eaf8f50fb0c86b7705", size = 1358611, upload-time = "2025-10-16T22:16:36.833Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/d2/14/e301ee96a6dc95224b6f1162cd3312f6d1217be3907b79173b06785f2fe7/uvloop-0.22.1-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:1cdf5192ab3e674ca26da2eada35b288d2fa49fdd0f357a19f0e7c4e7d5077c8", size = 751811, upload-time = "2025-10-16T22:16:38.275Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/b7/02/654426ce265ac19e2980bfd9ea6590ca96a56f10c76e63801a2df01c0486/uvloop-0.22.1-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:6e2ea3d6190a2968f4a14a23019d3b16870dd2190cd69c8180f7c632d21de68d", size = 4288562, upload-time = "2025-10-16T22:16:39.375Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/15/c0/0be24758891ef825f2065cd5db8741aaddabe3e248ee6acc5e8a80f04005/uvloop-0.22.1-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:0530a5fbad9c9e4ee3f2b33b148c6a64d47bbad8000ea63704fa8260f4cf728e", size = 4366890, upload-time = "2025-10-16T22:16:40.547Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/d2/53/8369e5219a5855869bcee5f4d317f6da0e2c669aecf0ef7d371e3d084449/uvloop-0.22.1-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:bc5ef13bbc10b5335792360623cc378d52d7e62c2de64660616478c32cd0598e", size = 4119472, upload-time = "2025-10-16T22:16:41.694Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/f8/ba/d69adbe699b768f6b29a5eec7b47dd610bd17a69de51b251126a801369ea/uvloop-0.22.1-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:1f38ec5e3f18c8a10ded09742f7fb8de0108796eb673f30ce7762ce1b8550cad", size = 4239051, upload-time = "2025-10-16T22:16:43.224Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/90/cd/b62bdeaa429758aee8de8b00ac0dd26593a9de93d302bff3d21439e9791d/uvloop-0.22.1-cp314-cp314-macosx_10_13_universal2.whl", hash = "sha256:3879b88423ec7e97cd4eba2a443aa26ed4e59b45e6b76aabf13fe2f27023a142", size = 1362067, upload-time = "2025-10-16T22:16:44.503Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/0d/f8/a132124dfda0777e489ca86732e85e69afcd1ff7686647000050ba670689/uvloop-0.22.1-cp314-cp314-macosx_10_13_x86_64.whl", hash = "sha256:4baa86acedf1d62115c1dc6ad1e17134476688f08c6efd8a2ab076e815665c74", size = 752423, upload-time = "2025-10-16T22:16:45.968Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/a3/94/94af78c156f88da4b3a733773ad5ba0b164393e357cc4bd0ab2e2677a7d6/uvloop-0.22.1-cp314-cp314-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:297c27d8003520596236bdb2335e6b3f649480bd09e00d1e3a99144b691d2a35", size = 4272437, upload-time = "2025-10-16T22:16:47.451Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/b5/35/60249e9fd07b32c665192cec7af29e06c7cd96fa1d08b84f012a56a0b38e/uvloop-0.22.1-cp314-cp314-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:c1955d5a1dd43198244d47664a5858082a3239766a839b2102a269aaff7a4e25", size = 4292101, upload-time = "2025-10-16T22:16:49.318Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/02/62/67d382dfcb25d0a98ce73c11ed1a6fba5037a1a1d533dcbb7cab033a2636/uvloop-0.22.1-cp314-cp314-musllinux_1_2_aarch64.whl", hash = "sha256:b31dc2fccbd42adc73bc4e7cdbae4fc5086cf378979e53ca5d0301838c5682c6", size = 4114158, upload-time = "2025-10-16T22:16:50.517Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/f0/7a/f1171b4a882a5d13c8b7576f348acfe6074d72eaf52cccef752f748d4a9f/uvloop-0.22.1-cp314-cp314-musllinux_1_2_x86_64.whl", hash = "sha256:93f617675b2d03af4e72a5333ef89450dfaa5321303ede6e67ba9c9d26878079", size = 4177360, upload-time = "2025-10-16T22:16:52.646Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/79/7b/b01414f31546caf0919da80ad57cbfe24c56b151d12af68cee1b04922ca8/uvloop-0.22.1-cp314-cp314t-macosx_10_13_universal2.whl", hash = "sha256:37554f70528f60cad66945b885eb01f1bb514f132d92b6eeed1c90fd54ed6289", size = 1454790, upload-time = "2025-10-16T22:16:54.355Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/d4/31/0bb232318dd838cad3fa8fb0c68c8b40e1145b32025581975e18b11fab40/uvloop-0.22.1-cp314-cp314t-macosx_10_13_x86_64.whl", hash = "sha256:b76324e2dc033a0b2f435f33eb88ff9913c156ef78e153fb210e03c13da746b3", size = 796783, upload-time = "2025-10-16T22:16:55.906Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/42/38/c9b09f3271a7a723a5de69f8e237ab8e7803183131bc57c890db0b6bb872/uvloop-0.22.1-cp314-cp314t-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:badb4d8e58ee08dad957002027830d5c3b06aea446a6a3744483c2b3b745345c", size = 4647548, upload-time = "2025-10-16T22:16:57.008Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/c1/37/945b4ca0ac27e3dc4952642d4c900edd030b3da6c9634875af6e13ae80e5/uvloop-0.22.1-cp314-cp314t-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:b91328c72635f6f9e0282e4a57da7470c7350ab1c9f48546c0f2866205349d21", size = 4467065, upload-time = "2025-10-16T22:16:58.206Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/97/cc/48d232f33d60e2e2e0b42f4e73455b146b76ebe216487e862700457fbf3c/uvloop-0.22.1-cp314-cp314t-musllinux_1_2_aarch64.whl", hash = "sha256:daf620c2995d193449393d6c62131b3fbd40a63bf7b307a1527856ace637fe88", size = 4328384, upload-time = "2025-10-16T22:16:59.36Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/e4/16/c1fd27e9549f3c4baf1dc9c20c456cd2f822dbf8de9f463824b0c0357e06/uvloop-0.22.1-cp314-cp314t-musllinux_1_2_x86_64.whl", hash = "sha256:6cde23eeda1a25c75b2e07d39970f3374105d5eafbaab2a4482be82f272d5a5e", size = 4296730, upload-time = "2025-10-16T22:17:00.744Z" },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "watchfiles"
|
||||
version = "1.1.1"
|
||||
source = { registry = "https://pypi.org/simple" }
|
||||
dependencies = [
|
||||
{ name = "anyio" },
|
||||
]
|
||||
sdist = { url = "https://files.pythonhosted.org/packages/c2/c9/8869df9b2a2d6c59d79220a4db37679e74f807c559ffe5265e08b227a210/watchfiles-1.1.1.tar.gz", hash = "sha256:a173cb5c16c4f40ab19cecf48a534c409f7ea983ab8fed0741304a1c0a31b3f2", size = 94440, upload-time = "2025-10-14T15:06:21.08Z" }
|
||||
wheels = [
|
||||
{ url = "https://files.pythonhosted.org/packages/a7/1a/206e8cf2dd86fddf939165a57b4df61607a1e0add2785f170a3f616b7d9f/watchfiles-1.1.1-cp310-cp310-macosx_10_12_x86_64.whl", hash = "sha256:eef58232d32daf2ac67f42dea51a2c80f0d03379075d44a587051e63cc2e368c", size = 407318, upload-time = "2025-10-14T15:04:18.753Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/b3/0f/abaf5262b9c496b5dad4ed3c0e799cbecb1f8ea512ecb6ddd46646a9fca3/watchfiles-1.1.1-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:03fa0f5237118a0c5e496185cafa92878568b652a2e9a9382a5151b1a0380a43", size = 394478, upload-time = "2025-10-14T15:04:20.297Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/b1/04/9cc0ba88697b34b755371f5ace8d3a4d9a15719c07bdc7bd13d7d8c6a341/watchfiles-1.1.1-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:8ca65483439f9c791897f7db49202301deb6e15fe9f8fe2fed555bf986d10c31", size = 449894, upload-time = "2025-10-14T15:04:21.527Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/d2/9c/eda4615863cd8621e89aed4df680d8c3ec3da6a4cf1da113c17decd87c7f/watchfiles-1.1.1-cp310-cp310-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:f0ab1c1af0cb38e3f598244c17919fb1a84d1629cc08355b0074b6d7f53138ac", size = 459065, upload-time = "2025-10-14T15:04:22.795Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/84/13/f28b3f340157d03cbc8197629bc109d1098764abe1e60874622a0be5c112/watchfiles-1.1.1-cp310-cp310-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:3bc570d6c01c206c46deb6e935a260be44f186a2f05179f52f7fcd2be086a94d", size = 488377, upload-time = "2025-10-14T15:04:24.138Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/86/93/cfa597fa9389e122488f7ffdbd6db505b3b915ca7435ecd7542e855898c2/watchfiles-1.1.1-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:e84087b432b6ac94778de547e08611266f1f8ffad28c0ee4c82e028b0fc5966d", size = 595837, upload-time = "2025-10-14T15:04:25.057Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/57/1e/68c1ed5652b48d89fc24d6af905d88ee4f82fa8bc491e2666004e307ded1/watchfiles-1.1.1-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:620bae625f4cb18427b1bb1a2d9426dc0dd5a5ba74c7c2cdb9de405f7b129863", size = 473456, upload-time = "2025-10-14T15:04:26.497Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/d5/dc/1a680b7458ffa3b14bb64878112aefc8f2e4f73c5af763cbf0bd43100658/watchfiles-1.1.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:544364b2b51a9b0c7000a4b4b02f90e9423d97fbbf7e06689236443ebcad81ab", size = 455614, upload-time = "2025-10-14T15:04:27.539Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/61/a5/3d782a666512e01eaa6541a72ebac1d3aae191ff4a31274a66b8dd85760c/watchfiles-1.1.1-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:bbe1ef33d45bc71cf21364df962af171f96ecaeca06bd9e3d0b583efb12aec82", size = 630690, upload-time = "2025-10-14T15:04:28.495Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/9b/73/bb5f38590e34687b2a9c47a244aa4dd50c56a825969c92c9c5fc7387cea1/watchfiles-1.1.1-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:1a0bb430adb19ef49389e1ad368450193a90038b5b752f4ac089ec6942c4dff4", size = 622459, upload-time = "2025-10-14T15:04:29.491Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/f1/ac/c9bb0ec696e07a20bd58af5399aeadaef195fb2c73d26baf55180fe4a942/watchfiles-1.1.1-cp310-cp310-win32.whl", hash = "sha256:3f6d37644155fb5beca5378feb8c1708d5783145f2a0f1c4d5a061a210254844", size = 272663, upload-time = "2025-10-14T15:04:30.435Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/11/a0/a60c5a7c2ec59fa062d9a9c61d02e3b6abd94d32aac2d8344c4bdd033326/watchfiles-1.1.1-cp310-cp310-win_amd64.whl", hash = "sha256:a36d8efe0f290835fd0f33da35042a1bb5dc0e83cbc092dcf69bce442579e88e", size = 287453, upload-time = "2025-10-14T15:04:31.53Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/1f/f8/2c5f479fb531ce2f0564eda479faecf253d886b1ab3630a39b7bf7362d46/watchfiles-1.1.1-cp311-cp311-macosx_10_12_x86_64.whl", hash = "sha256:f57b396167a2565a4e8b5e56a5a1c537571733992b226f4f1197d79e94cf0ae5", size = 406529, upload-time = "2025-10-14T15:04:32.899Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/fe/cd/f515660b1f32f65df671ddf6f85bfaca621aee177712874dc30a97397977/watchfiles-1.1.1-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:421e29339983e1bebc281fab40d812742268ad057db4aee8c4d2bce0af43b741", size = 394384, upload-time = "2025-10-14T15:04:33.761Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/7b/c3/28b7dc99733eab43fca2d10f55c86e03bd6ab11ca31b802abac26b23d161/watchfiles-1.1.1-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:6e43d39a741e972bab5d8100b5cdacf69db64e34eb19b6e9af162bccf63c5cc6", size = 448789, upload-time = "2025-10-14T15:04:34.679Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/4a/24/33e71113b320030011c8e4316ccca04194bf0cbbaeee207f00cbc7d6b9f5/watchfiles-1.1.1-cp311-cp311-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:f537afb3276d12814082a2e9b242bdcf416c2e8fd9f799a737990a1dbe906e5b", size = 460521, upload-time = "2025-10-14T15:04:35.963Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/f4/c3/3c9a55f255aa57b91579ae9e98c88704955fa9dac3e5614fb378291155df/watchfiles-1.1.1-cp311-cp311-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:b2cd9e04277e756a2e2d2543d65d1e2166d6fd4c9b183f8808634fda23f17b14", size = 488722, upload-time = "2025-10-14T15:04:37.091Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/49/36/506447b73eb46c120169dc1717fe2eff07c234bb3232a7200b5f5bd816e9/watchfiles-1.1.1-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:5f3f58818dc0b07f7d9aa7fe9eb1037aecb9700e63e1f6acfed13e9fef648f5d", size = 596088, upload-time = "2025-10-14T15:04:38.39Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/82/ab/5f39e752a9838ec4d52e9b87c1e80f1ee3ccdbe92e183c15b6577ab9de16/watchfiles-1.1.1-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:9bb9f66367023ae783551042d31b1d7fd422e8289eedd91f26754a66f44d5cff", size = 472923, upload-time = "2025-10-14T15:04:39.666Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/af/b9/a419292f05e302dea372fa7e6fda5178a92998411f8581b9830d28fb9edb/watchfiles-1.1.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:aebfd0861a83e6c3d1110b78ad54704486555246e542be3e2bb94195eabb2606", size = 456080, upload-time = "2025-10-14T15:04:40.643Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/b0/c3/d5932fd62bde1a30c36e10c409dc5d54506726f08cb3e1d8d0ba5e2bc8db/watchfiles-1.1.1-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:5fac835b4ab3c6487b5dbad78c4b3724e26bcc468e886f8ba8cc4306f68f6701", size = 629432, upload-time = "2025-10-14T15:04:41.789Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/f7/77/16bddd9779fafb795f1a94319dc965209c5641db5bf1edbbccace6d1b3c0/watchfiles-1.1.1-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:399600947b170270e80134ac854e21b3ccdefa11a9529a3decc1327088180f10", size = 623046, upload-time = "2025-10-14T15:04:42.718Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/46/ef/f2ecb9a0f342b4bfad13a2787155c6ee7ce792140eac63a34676a2feeef2/watchfiles-1.1.1-cp311-cp311-win32.whl", hash = "sha256:de6da501c883f58ad50db3a32ad397b09ad29865b5f26f64c24d3e3281685849", size = 271473, upload-time = "2025-10-14T15:04:43.624Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/94/bc/f42d71125f19731ea435c3948cad148d31a64fccde3867e5ba4edee901f9/watchfiles-1.1.1-cp311-cp311-win_amd64.whl", hash = "sha256:35c53bd62a0b885bf653ebf6b700d1bf05debb78ad9292cf2a942b23513dc4c4", size = 287598, upload-time = "2025-10-14T15:04:44.516Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/57/c9/a30f897351f95bbbfb6abcadafbaca711ce1162f4db95fc908c98a9165f3/watchfiles-1.1.1-cp311-cp311-win_arm64.whl", hash = "sha256:57ca5281a8b5e27593cb7d82c2ac927ad88a96ed406aa446f6344e4328208e9e", size = 277210, upload-time = "2025-10-14T15:04:45.883Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/74/d5/f039e7e3c639d9b1d09b07ea412a6806d38123f0508e5f9b48a87b0a76cc/watchfiles-1.1.1-cp312-cp312-macosx_10_12_x86_64.whl", hash = "sha256:8c89f9f2f740a6b7dcc753140dd5e1ab9215966f7a3530d0c0705c83b401bd7d", size = 404745, upload-time = "2025-10-14T15:04:46.731Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/a5/96/a881a13aa1349827490dab2d363c8039527060cfcc2c92cc6d13d1b1049e/watchfiles-1.1.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:bd404be08018c37350f0d6e34676bd1e2889990117a2b90070b3007f172d0610", size = 391769, upload-time = "2025-10-14T15:04:48.003Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/4b/5b/d3b460364aeb8da471c1989238ea0e56bec24b6042a68046adf3d9ddb01c/watchfiles-1.1.1-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:8526e8f916bb5b9a0a777c8317c23ce65de259422bba5b31325a6fa6029d33af", size = 449374, upload-time = "2025-10-14T15:04:49.179Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/b9/44/5769cb62d4ed055cb17417c0a109a92f007114a4e07f30812a73a4efdb11/watchfiles-1.1.1-cp312-cp312-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:2edc3553362b1c38d9f06242416a5d8e9fe235c204a4072e988ce2e5bb1f69f6", size = 459485, upload-time = "2025-10-14T15:04:50.155Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/19/0c/286b6301ded2eccd4ffd0041a1b726afda999926cf720aab63adb68a1e36/watchfiles-1.1.1-cp312-cp312-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:30f7da3fb3f2844259cba4720c3fc7138eb0f7b659c38f3bfa65084c7fc7abce", size = 488813, upload-time = "2025-10-14T15:04:51.059Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/c7/2b/8530ed41112dd4a22f4dcfdb5ccf6a1baad1ff6eed8dc5a5f09e7e8c41c7/watchfiles-1.1.1-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:f8979280bdafff686ba5e4d8f97840f929a87ed9cdf133cbbd42f7766774d2aa", size = 594816, upload-time = "2025-10-14T15:04:52.031Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/ce/d2/f5f9fb49489f184f18470d4f99f4e862a4b3e9ac2865688eb2099e3d837a/watchfiles-1.1.1-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:dcc5c24523771db3a294c77d94771abcfcb82a0e0ee8efd910c37c59ec1b31bb", size = 475186, upload-time = "2025-10-14T15:04:53.064Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/cf/68/5707da262a119fb06fbe214d82dd1fe4a6f4af32d2d14de368d0349eb52a/watchfiles-1.1.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:1db5d7ae38ff20153d542460752ff397fcf5c96090c1230803713cf3147a6803", size = 456812, upload-time = "2025-10-14T15:04:55.174Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/66/ab/3cbb8756323e8f9b6f9acb9ef4ec26d42b2109bce830cc1f3468df20511d/watchfiles-1.1.1-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:28475ddbde92df1874b6c5c8aaeb24ad5be47a11f87cde5a28ef3835932e3e94", size = 630196, upload-time = "2025-10-14T15:04:56.22Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/78/46/7152ec29b8335f80167928944a94955015a345440f524d2dfe63fc2f437b/watchfiles-1.1.1-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:36193ed342f5b9842edd3532729a2ad55c4160ffcfa3700e0d54be496b70dd43", size = 622657, upload-time = "2025-10-14T15:04:57.521Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/0a/bf/95895e78dd75efe9a7f31733607f384b42eb5feb54bd2eb6ed57cc2e94f4/watchfiles-1.1.1-cp312-cp312-win32.whl", hash = "sha256:859e43a1951717cc8de7f4c77674a6d389b106361585951d9e69572823f311d9", size = 272042, upload-time = "2025-10-14T15:04:59.046Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/87/0a/90eb755f568de2688cb220171c4191df932232c20946966c27a59c400850/watchfiles-1.1.1-cp312-cp312-win_amd64.whl", hash = "sha256:91d4c9a823a8c987cce8fa2690923b069966dabb196dd8d137ea2cede885fde9", size = 288410, upload-time = "2025-10-14T15:05:00.081Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/36/76/f322701530586922fbd6723c4f91ace21364924822a8772c549483abed13/watchfiles-1.1.1-cp312-cp312-win_arm64.whl", hash = "sha256:a625815d4a2bdca61953dbba5a39d60164451ef34c88d751f6c368c3ea73d404", size = 278209, upload-time = "2025-10-14T15:05:01.168Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/bb/f4/f750b29225fe77139f7ae5de89d4949f5a99f934c65a1f1c0b248f26f747/watchfiles-1.1.1-cp313-cp313-macosx_10_12_x86_64.whl", hash = "sha256:130e4876309e8686a5e37dba7d5e9bc77e6ed908266996ca26572437a5271e18", size = 404321, upload-time = "2025-10-14T15:05:02.063Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/2b/f9/f07a295cde762644aa4c4bb0f88921d2d141af45e735b965fb2e87858328/watchfiles-1.1.1-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:5f3bde70f157f84ece3765b42b4a52c6ac1a50334903c6eaf765362f6ccca88a", size = 391783, upload-time = "2025-10-14T15:05:03.052Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/bc/11/fc2502457e0bea39a5c958d86d2cb69e407a4d00b85735ca724bfa6e0d1a/watchfiles-1.1.1-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:14e0b1fe858430fc0251737ef3824c54027bedb8c37c38114488b8e131cf8219", size = 449279, upload-time = "2025-10-14T15:05:04.004Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/e3/1f/d66bc15ea0b728df3ed96a539c777acfcad0eb78555ad9efcaa1274688f0/watchfiles-1.1.1-cp313-cp313-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:f27db948078f3823a6bb3b465180db8ebecf26dd5dae6f6180bd87383b6b4428", size = 459405, upload-time = "2025-10-14T15:05:04.942Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/be/90/9f4a65c0aec3ccf032703e6db02d89a157462fbb2cf20dd415128251cac0/watchfiles-1.1.1-cp313-cp313-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:059098c3a429f62fc98e8ec62b982230ef2c8df68c79e826e37b895bc359a9c0", size = 488976, upload-time = "2025-10-14T15:05:05.905Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/37/57/ee347af605d867f712be7029bb94c8c071732a4b44792e3176fa3c612d39/watchfiles-1.1.1-cp313-cp313-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:bfb5862016acc9b869bb57284e6cb35fdf8e22fe59f7548858e2f971d045f150", size = 595506, upload-time = "2025-10-14T15:05:06.906Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/a8/78/cc5ab0b86c122047f75e8fc471c67a04dee395daf847d3e59381996c8707/watchfiles-1.1.1-cp313-cp313-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:319b27255aacd9923b8a276bb14d21a5f7ff82564c744235fc5eae58d95422ae", size = 474936, upload-time = "2025-10-14T15:05:07.906Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/62/da/def65b170a3815af7bd40a3e7010bf6ab53089ef1b75d05dd5385b87cf08/watchfiles-1.1.1-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:c755367e51db90e75b19454b680903631d41f9e3607fbd941d296a020c2d752d", size = 456147, upload-time = "2025-10-14T15:05:09.138Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/57/99/da6573ba71166e82d288d4df0839128004c67d2778d3b566c138695f5c0b/watchfiles-1.1.1-cp313-cp313-musllinux_1_1_aarch64.whl", hash = "sha256:c22c776292a23bfc7237a98f791b9ad3144b02116ff10d820829ce62dff46d0b", size = 630007, upload-time = "2025-10-14T15:05:10.117Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/a8/51/7439c4dd39511368849eb1e53279cd3454b4a4dbace80bab88feeb83c6b5/watchfiles-1.1.1-cp313-cp313-musllinux_1_1_x86_64.whl", hash = "sha256:3a476189be23c3686bc2f4321dd501cb329c0a0469e77b7b534ee10129ae6374", size = 622280, upload-time = "2025-10-14T15:05:11.146Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/95/9c/8ed97d4bba5db6fdcdb2b298d3898f2dd5c20f6b73aee04eabe56c59677e/watchfiles-1.1.1-cp313-cp313-win32.whl", hash = "sha256:bf0a91bfb5574a2f7fc223cf95eeea79abfefa404bf1ea5e339c0c1560ae99a0", size = 272056, upload-time = "2025-10-14T15:05:12.156Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/1f/f3/c14e28429f744a260d8ceae18bf58c1d5fa56b50d006a7a9f80e1882cb0d/watchfiles-1.1.1-cp313-cp313-win_amd64.whl", hash = "sha256:52e06553899e11e8074503c8e716d574adeeb7e68913115c4b3653c53f9bae42", size = 288162, upload-time = "2025-10-14T15:05:13.208Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/dc/61/fe0e56c40d5cd29523e398d31153218718c5786b5e636d9ae8ae79453d27/watchfiles-1.1.1-cp313-cp313-win_arm64.whl", hash = "sha256:ac3cc5759570cd02662b15fbcd9d917f7ecd47efe0d6b40474eafd246f91ea18", size = 277909, upload-time = "2025-10-14T15:05:14.49Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/79/42/e0a7d749626f1e28c7108a99fb9bf524b501bbbeb9b261ceecde644d5a07/watchfiles-1.1.1-cp313-cp313t-macosx_10_12_x86_64.whl", hash = "sha256:563b116874a9a7ce6f96f87cd0b94f7faf92d08d0021e837796f0a14318ef8da", size = 403389, upload-time = "2025-10-14T15:05:15.777Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/15/49/08732f90ce0fbbc13913f9f215c689cfc9ced345fb1bcd8829a50007cc8d/watchfiles-1.1.1-cp313-cp313t-macosx_11_0_arm64.whl", hash = "sha256:3ad9fe1dae4ab4212d8c91e80b832425e24f421703b5a42ef2e4a1e215aff051", size = 389964, upload-time = "2025-10-14T15:05:16.85Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/27/0d/7c315d4bd5f2538910491a0393c56bf70d333d51bc5b34bee8e68e8cea19/watchfiles-1.1.1-cp313-cp313t-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ce70f96a46b894b36eba678f153f052967a0d06d5b5a19b336ab0dbbd029f73e", size = 448114, upload-time = "2025-10-14T15:05:17.876Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/c3/24/9e096de47a4d11bc4df41e9d1e61776393eac4cb6eb11b3e23315b78b2cc/watchfiles-1.1.1-cp313-cp313t-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:cb467c999c2eff23a6417e58d75e5828716f42ed8289fe6b77a7e5a91036ca70", size = 460264, upload-time = "2025-10-14T15:05:18.962Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/cc/0f/e8dea6375f1d3ba5fcb0b3583e2b493e77379834c74fd5a22d66d85d6540/watchfiles-1.1.1-cp313-cp313t-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:836398932192dae4146c8f6f737d74baeac8b70ce14831a239bdb1ca882fc261", size = 487877, upload-time = "2025-10-14T15:05:20.094Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/ac/5b/df24cfc6424a12deb41503b64d42fbea6b8cb357ec62ca84a5a3476f654a/watchfiles-1.1.1-cp313-cp313t-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:743185e7372b7bc7c389e1badcc606931a827112fbbd37f14c537320fca08620", size = 595176, upload-time = "2025-10-14T15:05:21.134Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/8f/b5/853b6757f7347de4e9b37e8cc3289283fb983cba1ab4d2d7144694871d9c/watchfiles-1.1.1-cp313-cp313t-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:afaeff7696e0ad9f02cbb8f56365ff4686ab205fcf9c4c5b6fdfaaa16549dd04", size = 473577, upload-time = "2025-10-14T15:05:22.306Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/e1/f7/0a4467be0a56e80447c8529c9fce5b38eab4f513cb3d9bf82e7392a5696b/watchfiles-1.1.1-cp313-cp313t-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:3f7eb7da0eb23aa2ba036d4f616d46906013a68caf61b7fdbe42fc8b25132e77", size = 455425, upload-time = "2025-10-14T15:05:23.348Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/8e/e0/82583485ea00137ddf69bc84a2db88bd92ab4a6e3c405e5fb878ead8d0e7/watchfiles-1.1.1-cp313-cp313t-musllinux_1_1_aarch64.whl", hash = "sha256:831a62658609f0e5c64178211c942ace999517f5770fe9436be4c2faeba0c0ef", size = 628826, upload-time = "2025-10-14T15:05:24.398Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/28/9a/a785356fccf9fae84c0cc90570f11702ae9571036fb25932f1242c82191c/watchfiles-1.1.1-cp313-cp313t-musllinux_1_1_x86_64.whl", hash = "sha256:f9a2ae5c91cecc9edd47e041a930490c31c3afb1f5e6d71de3dc671bfaca02bf", size = 622208, upload-time = "2025-10-14T15:05:25.45Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/c3/f4/0872229324ef69b2c3edec35e84bd57a1289e7d3fe74588048ed8947a323/watchfiles-1.1.1-cp314-cp314-macosx_10_12_x86_64.whl", hash = "sha256:d1715143123baeeaeadec0528bb7441103979a1d5f6fd0e1f915383fea7ea6d5", size = 404315, upload-time = "2025-10-14T15:05:26.501Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/7b/22/16d5331eaed1cb107b873f6ae1b69e9ced582fcf0c59a50cd84f403b1c32/watchfiles-1.1.1-cp314-cp314-macosx_11_0_arm64.whl", hash = "sha256:39574d6370c4579d7f5d0ad940ce5b20db0e4117444e39b6d8f99db5676c52fd", size = 390869, upload-time = "2025-10-14T15:05:27.649Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/b2/7e/5643bfff5acb6539b18483128fdc0ef2cccc94a5b8fbda130c823e8ed636/watchfiles-1.1.1-cp314-cp314-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:7365b92c2e69ee952902e8f70f3ba6360d0d596d9299d55d7d386df84b6941fb", size = 449919, upload-time = "2025-10-14T15:05:28.701Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/51/2e/c410993ba5025a9f9357c376f48976ef0e1b1aefb73b97a5ae01a5972755/watchfiles-1.1.1-cp314-cp314-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:bfff9740c69c0e4ed32416f013f3c45e2ae42ccedd1167ef2d805c000b6c71a5", size = 460845, upload-time = "2025-10-14T15:05:30.064Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/8e/a4/2df3b404469122e8680f0fcd06079317e48db58a2da2950fb45020947734/watchfiles-1.1.1-cp314-cp314-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:b27cf2eb1dda37b2089e3907d8ea92922b673c0c427886d4edc6b94d8dfe5db3", size = 489027, upload-time = "2025-10-14T15:05:31.064Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/ea/84/4587ba5b1f267167ee715b7f66e6382cca6938e0a4b870adad93e44747e6/watchfiles-1.1.1-cp314-cp314-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:526e86aced14a65a5b0ec50827c745597c782ff46b571dbfe46192ab9e0b3c33", size = 595615, upload-time = "2025-10-14T15:05:32.074Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/6a/0f/c6988c91d06e93cd0bb3d4a808bcf32375ca1904609835c3031799e3ecae/watchfiles-1.1.1-cp314-cp314-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:04e78dd0b6352db95507fd8cb46f39d185cf8c74e4cf1e4fbad1d3df96faf510", size = 474836, upload-time = "2025-10-14T15:05:33.209Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/b4/36/ded8aebea91919485b7bbabbd14f5f359326cb5ec218cd67074d1e426d74/watchfiles-1.1.1-cp314-cp314-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:5c85794a4cfa094714fb9c08d4a218375b2b95b8ed1666e8677c349906246c05", size = 455099, upload-time = "2025-10-14T15:05:34.189Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/98/e0/8c9bdba88af756a2fce230dd365fab2baf927ba42cd47521ee7498fd5211/watchfiles-1.1.1-cp314-cp314-musllinux_1_1_aarch64.whl", hash = "sha256:74d5012b7630714b66be7b7b7a78855ef7ad58e8650c73afc4c076a1f480a8d6", size = 630626, upload-time = "2025-10-14T15:05:35.216Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/2a/84/a95db05354bf2d19e438520d92a8ca475e578c647f78f53197f5a2f17aaf/watchfiles-1.1.1-cp314-cp314-musllinux_1_1_x86_64.whl", hash = "sha256:8fbe85cb3201c7d380d3d0b90e63d520f15d6afe217165d7f98c9c649654db81", size = 622519, upload-time = "2025-10-14T15:05:36.259Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/1d/ce/d8acdc8de545de995c339be67711e474c77d643555a9bb74a9334252bd55/watchfiles-1.1.1-cp314-cp314-win32.whl", hash = "sha256:3fa0b59c92278b5a7800d3ee7733da9d096d4aabcfabb9a928918bd276ef9b9b", size = 272078, upload-time = "2025-10-14T15:05:37.63Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/c4/c9/a74487f72d0451524be827e8edec251da0cc1fcf111646a511ae752e1a3d/watchfiles-1.1.1-cp314-cp314-win_amd64.whl", hash = "sha256:c2047d0b6cea13b3316bdbafbfa0c4228ae593d995030fda39089d36e64fc03a", size = 287664, upload-time = "2025-10-14T15:05:38.95Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/df/b8/8ac000702cdd496cdce998c6f4ee0ca1f15977bba51bdf07d872ebdfc34c/watchfiles-1.1.1-cp314-cp314-win_arm64.whl", hash = "sha256:842178b126593addc05acf6fce960d28bc5fae7afbaa2c6c1b3a7b9460e5be02", size = 277154, upload-time = "2025-10-14T15:05:39.954Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/47/a8/e3af2184707c29f0f14b1963c0aace6529f9d1b8582d5b99f31bbf42f59e/watchfiles-1.1.1-cp314-cp314t-macosx_10_12_x86_64.whl", hash = "sha256:88863fbbc1a7312972f1c511f202eb30866370ebb8493aef2812b9ff28156a21", size = 403820, upload-time = "2025-10-14T15:05:40.932Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/c0/ec/e47e307c2f4bd75f9f9e8afbe3876679b18e1bcec449beca132a1c5ffb2d/watchfiles-1.1.1-cp314-cp314t-macosx_11_0_arm64.whl", hash = "sha256:55c7475190662e202c08c6c0f4d9e345a29367438cf8e8037f3155e10a88d5a5", size = 390510, upload-time = "2025-10-14T15:05:41.945Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/d5/a0/ad235642118090f66e7b2f18fd5c42082418404a79205cdfca50b6309c13/watchfiles-1.1.1-cp314-cp314t-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:3f53fa183d53a1d7a8852277c92b967ae99c2d4dcee2bfacff8868e6e30b15f7", size = 448408, upload-time = "2025-10-14T15:05:43.385Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/df/85/97fa10fd5ff3332ae17e7e40e20784e419e28521549780869f1413742e9d/watchfiles-1.1.1-cp314-cp314t-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:6aae418a8b323732fa89721d86f39ec8f092fc2af67f4217a2b07fd3e93c6101", size = 458968, upload-time = "2025-10-14T15:05:44.404Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/47/c2/9059c2e8966ea5ce678166617a7f75ecba6164375f3b288e50a40dc6d489/watchfiles-1.1.1-cp314-cp314t-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:f096076119da54a6080e8920cbdaac3dbee667eb91dcc5e5b78840b87415bd44", size = 488096, upload-time = "2025-10-14T15:05:45.398Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/94/44/d90a9ec8ac309bc26db808a13e7bfc0e4e78b6fc051078a554e132e80160/watchfiles-1.1.1-cp314-cp314t-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:00485f441d183717038ed2e887a7c868154f216877653121068107b227a2f64c", size = 596040, upload-time = "2025-10-14T15:05:46.502Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/95/68/4e3479b20ca305cfc561db3ed207a8a1c745ee32bf24f2026a129d0ddb6e/watchfiles-1.1.1-cp314-cp314t-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:a55f3e9e493158d7bfdb60a1165035f1cf7d320914e7b7ea83fe22c6023b58fc", size = 473847, upload-time = "2025-10-14T15:05:47.484Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/4f/55/2af26693fd15165c4ff7857e38330e1b61ab8c37d15dc79118cdba115b7a/watchfiles-1.1.1-cp314-cp314t-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:8c91ed27800188c2ae96d16e3149f199d62f86c7af5f5f4d2c61a3ed8cd3666c", size = 455072, upload-time = "2025-10-14T15:05:48.928Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/66/1d/d0d200b10c9311ec25d2273f8aad8c3ef7cc7ea11808022501811208a750/watchfiles-1.1.1-cp314-cp314t-musllinux_1_1_aarch64.whl", hash = "sha256:311ff15a0bae3714ffb603e6ba6dbfba4065ab60865d15a6ec544133bdb21099", size = 629104, upload-time = "2025-10-14T15:05:49.908Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/e3/bd/fa9bb053192491b3867ba07d2343d9f2252e00811567d30ae8d0f78136fe/watchfiles-1.1.1-cp314-cp314t-musllinux_1_1_x86_64.whl", hash = "sha256:a916a2932da8f8ab582f242c065f5c81bed3462849ca79ee357dd9551b0e9b01", size = 622112, upload-time = "2025-10-14T15:05:50.941Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/ba/4c/a888c91e2e326872fa4705095d64acd8aa2fb9c1f7b9bd0588f33850516c/watchfiles-1.1.1-pp310-pypy310_pp73-macosx_10_12_x86_64.whl", hash = "sha256:17ef139237dfced9da49fb7f2232c86ca9421f666d78c264c7ffca6601d154c3", size = 409611, upload-time = "2025-10-14T15:06:05.809Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/1e/c7/5420d1943c8e3ce1a21c0a9330bcf7edafb6aa65d26b21dbb3267c9e8112/watchfiles-1.1.1-pp310-pypy310_pp73-macosx_11_0_arm64.whl", hash = "sha256:672b8adf25b1a0d35c96b5888b7b18699d27d4194bac8beeae75be4b7a3fc9b2", size = 396889, upload-time = "2025-10-14T15:06:07.035Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/0c/e5/0072cef3804ce8d3aaddbfe7788aadff6b3d3f98a286fdbee9fd74ca59a7/watchfiles-1.1.1-pp310-pypy310_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:77a13aea58bc2b90173bc69f2a90de8e282648939a00a602e1dc4ee23e26b66d", size = 451616, upload-time = "2025-10-14T15:06:08.072Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/83/4e/b87b71cbdfad81ad7e83358b3e447fedd281b880a03d64a760fe0a11fc2e/watchfiles-1.1.1-pp310-pypy310_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:0b495de0bb386df6a12b18335a0285dda90260f51bdb505503c02bcd1ce27a8b", size = 458413, upload-time = "2025-10-14T15:06:09.209Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/d3/8e/e500f8b0b77be4ff753ac94dc06b33d8f0d839377fee1b78e8c8d8f031bf/watchfiles-1.1.1-pp311-pypy311_pp73-macosx_10_12_x86_64.whl", hash = "sha256:db476ab59b6765134de1d4fe96a1a9c96ddf091683599be0f26147ea1b2e4b88", size = 408250, upload-time = "2025-10-14T15:06:10.264Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/bd/95/615e72cd27b85b61eec764a5ca51bd94d40b5adea5ff47567d9ebc4d275a/watchfiles-1.1.1-pp311-pypy311_pp73-macosx_11_0_arm64.whl", hash = "sha256:89eef07eee5e9d1fda06e38822ad167a044153457e6fd997f8a858ab7564a336", size = 396117, upload-time = "2025-10-14T15:06:11.28Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/c9/81/e7fe958ce8a7fb5c73cc9fb07f5aeaf755e6aa72498c57d760af760c91f8/watchfiles-1.1.1-pp311-pypy311_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ce19e06cbda693e9e7686358af9cd6f5d61312ab8b00488bc36f5aabbaf77e24", size = 450493, upload-time = "2025-10-14T15:06:12.321Z" },
|
||||
{ url = "https://files.pythonhosted.org/packages/6e/d4/ed38dd3b1767193de971e694aa544356e63353c33a85d948166b5ff58b9e/watchfiles-1.1.1-pp311-pypy311_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:3e6f39af2eab0118338902798b5aa6664f46ff66bc0280de76fca67a7f262a49", size = 457546, upload-time = "2025-10-14T15:06:13.372Z" },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "websockets"
|
||||
version = "13.1"
|
||||
@@ -1804,3 +2274,12 @@ sdist = { url = "https://files.pythonhosted.org/packages/32/af/d4502dc713b4ccea7
|
||||
wheels = [
|
||||
{ url = "https://files.pythonhosted.org/packages/ee/ea/c67e1dee1ba208ed22c06d1d547ae5e293374bfc43e0eb0ef5e262b68561/werkzeug-3.1.1-py3-none-any.whl", hash = "sha256:a71124d1ef06008baafa3d266c02f56e1836a5984afd6dd6c9230669d60d9fb5", size = 224371, upload-time = "2024-11-01T16:40:43.994Z" },
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "zipp"
|
||||
version = "3.23.0"
|
||||
source = { registry = "https://pypi.org/simple" }
|
||||
sdist = { url = "https://files.pythonhosted.org/packages/e3/02/0f2892c661036d50ede074e376733dca2ae7c6eb617489437771209d4180/zipp-3.23.0.tar.gz", hash = "sha256:a07157588a12518c9d4034df3fbbee09c814741a33ff63c05fa29d26a2404166", size = 25547, upload-time = "2025-06-08T17:06:39.4Z" }
|
||||
wheels = [
|
||||
{ url = "https://files.pythonhosted.org/packages/2e/54/647ade08bf0db230bfea292f893923872fd20be6ac6f53b2b936ba839d75/zipp-3.23.0-py3-none-any.whl", hash = "sha256:071652d6115ed432f5ce1d34c336c0adfd6a884660d1e9712a256d3d3bd4b14e", size = 10276, upload-time = "2025-06-08T17:06:38.034Z" },
|
||||
]
|
||||
|
||||
Reference in New Issue
Block a user