mirror of
https://github.com/unraid/api.git
synced 2025-12-31 05:29:48 -06:00
d6055f102b
🤖 I have created a release *beep* *boop* --- ## [4.29.0](https://github.com/unraid/api/compare/v4.28.2...v4.29.0) (2025-12-19) ### Features * replace docker overview table with web component (7.3+) ([#1764](https://github.com/unraid/api/issues/1764)) ([277ac42](277ac42046)) ### Bug Fixes * handle race condition between guid loading and license check ([#1847](https://github.com/unraid/api/issues/1847)) ([8b155d1](8b155d1f1c)) * resolve issue with "Continue" button when updating ([#1852](https://github.com/unraid/api/issues/1852)) ([d099e75](d099e7521d)) * update myservers config references to connect config references ([#1810](https://github.com/unraid/api/issues/1810)) ([e1e3ea7](e1e3ea7eb6)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Unraid Plugin Builder
Tool for building and testing Unraid plugins locally as well as packaging them for deployment.
Development Workflow
1. Build the Plugin
Note: Building the plugin requires Docker.
Once your changes are ready, build the plugin package:
# Start Docker container (builds dependencies automatically)
pnpm run docker:build-and-run
# Inside the container, build the plugin
pnpm build
This will:
- Build the API release (
api/deploy/release/) - Build the web standalone components (
web/dist/) - Start Docker container with HTTP server on port 5858
- Build the plugin package (when you run
pnpm build)
The plugin files will be created in ./deploy/ and served automatically.
2. Install on Unraid
Install the plugin on your Unraid development machine by visiting:
http://SERVER_NAME.local/Plugins
Then paste the following URL into the Unraid Plugins page:
http://YOUR_LOCAL_DEV_MACHINE_IP:5858/plugins/local/dynamix.unraid.net.plg
Replace SERVER_NAME with your development machine's hostname.
Development Tips
- The HTTP server includes CORS headers for local development
- Check the Unraid system log for plugin installation issues
Environment Setup
-
Initialize environment:
pnpm run env:init -
Validate environment:
pnpm run env:validate
Available Commands
Build Commands
build- Build the plugin package (run inside Docker container)docker:build- Build the Docker containerdocker:run- Run the builder in Dockerdocker:build-and-run- Build dependencies and start Docker container
Environment Commands
env:init- Create initial .env fileenv:validate- Validate environment setupenv:clean- Remove .env file
Troubleshooting
-
Watch not updating files
- Check that source directories exist
- Verify file permissions
-
Build failures
- Ensure .env file exists
- Check Docker setup if using containerized build
- Verify source files are present
-
Installation issues
- Confirm http-server is running
- Check your local IP is correct
- Verify plugin file permissions