mirror/api

mirror of https://github.com/unraid/api.git synced 2026-01-02 14:40:01 -06:00

Files

Eli Bosley 16b922c3af feat(onboarding): add test harness for onboarding overrides

- Introduced a new `<unraid-onboarding-test-harness>` component to the Onboarding page, allowing for the application and clearing of onboarding overrides.
- This addition enhances the onboarding interface by providing a dedicated tool for testing and managing onboarding state overrides, improving the overall development and testing experience.

2025-12-27 12:03:22 -05:00

.vscode

…

builder

chore(deps): update conventional commit (#1693 )

2025-09-12 14:24:49 -04:00

plugins

fix(plg): explicitly stop an existing api before installation (#1841 )

2025-12-15 16:27:51 -05:00

scripts

chore: fix local plugin builds & docs (#1851 )

2025-12-18 16:33:37 -05:00

source/dynamix.unraid.net

feat(onboarding): add test harness for onboarding overrides

2025-12-27 12:03:22 -05:00

tests

fix: enhance dark mode support in theme handling (#1808 )

2025-12-15 12:52:47 -05:00

.dockerignore

…

.env.example

…

.gitattributes

…

.gitignore

chore: extract connect to an API plugin (#1367 )

2025-06-10 15:16:26 -04:00

.nvmrc

…

.prettierrc.mjs

…

docker-compose.yml

Feat/vue (#1655 )

2025-09-08 10:04:49 -04:00

Dockerfile

chore: Revert "fix(deps): update all non-major dependencies" (#1675 )

2025-09-09 08:25:30 -04:00

package.json

chore(main): release 4.29.2 (#1857 )

2025-12-19 15:13:29 -05:00

pnpm-lock.yaml

…

README.md

chore: fix local plugin builds & docs (#1851 )

2025-12-18 16:33:37 -05:00

vitest.config.ts

feat: mount vue apps, not web components (#1639 )

2025-09-03 15:42:21 -04:00

README.md

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 container
docker:run - Run the builder in Docker
docker:build-and-run - Build dependencies and start Docker container

Environment Commands

env:init - Create initial .env file
env:validate - Validate environment setup
env: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