mirror/api

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

Files

Eli Bosley 31c338373c feat(onboarding): implement onboarding reset functionality and new admin panel

- Added a new `resetUpgradeOnboarding` mutation to reset onboarding progress for the current OS version.
- Introduced an `OnboardingAdminPanel` component for managing onboarding states and resetting progress.
- Created a test harness for simulating onboarding flows with client-side overrides.
- Updated GraphQL schema to include the new `ThemeName` enum and onboarding reset mutation.
- Enhanced existing components to support the new onboarding features and improve user experience.

This update significantly enhances the onboarding process by providing tools for managing and resetting onboarding states, improving overall usability.

2025-12-23 15:34:40 -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): implement onboarding reset functionality and new admin panel

2025-12-23 15:34:40 -05:00

tests

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

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

.dockerignore

feat: split plugin builds

2025-03-04 15:18:04 -05:00

.env.example

feat: improve local dev with install path (#1221 )

2025-03-17 09:44:10 -04:00

.gitattributes

fix: replace files lost during pruning

2025-03-27 15:47:29 -04:00

.gitignore

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

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

.nvmrc

feat: slightly better watch mode (#1398 )

2025-05-22 13:42:08 -04:00

.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

feat: split plugin builds

2025-03-04 15:18:04 -05:00

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