mirror/api

mirror of https://github.com/unraid/api.git synced 2025-12-31 05:29:48 -06:00

Files

Pujit Mehrotra 97ab6fbe32 refactor(api): vendor node_modules instead of pnpm store (#1346 )

due to issues and redundancies in vendoring postinstall side-effects, such as compiled bindings for libvirt, we reverted to vendoring `node_modules`, installed via `npm` instead of a global pnpm store generated by `pnpm`.

This should resolve runtime issues with e.g. the libvirt bindings because `node_modules` will contain the correct "side-effects."

## Summary by CodeRabbit

- **New Features**
- Introduced a command to remove stale archive files during the cleanup
process.
  - Added functionality to archive the `node_modules` directory.
- Enhanced dependency resolution with new overrides for specific
packages.

- **Chores**
- Updated dependency settings by replacing one key dependency with an
alternative and removing two unused ones, ensuring optimal deployment.
- Enhanced the installation process to operate strictly in offline mode.
- Updated artifact naming conventions for clarity and consistency in
workflows.
- Modified volume mappings in the Docker Compose configuration to
reflect new artifact names.
- Improved error handling in the GitHub Actions workflow by adding
checks for required files.
- Updated references in the build process to use a vendor store instead
of the PNPM store.
- Removed the management of PNPM store archives from the build process.

2025-04-09 15:17:50 -04:00

.vscode

feat: begin building plugin with node instead of bash (#1120 )

2025-02-06 12:32:41 -05:00

builder

refactor(api): vendor node_modules instead of pnpm store (#1346 )

2025-04-09 15:17:50 -04:00

docs

feat(api): rm 2fa & t2fa from myservers config type (#996 )

2025-01-08 14:15:15 -05:00

plugins

refactor(api): vendor node_modules instead of pnpm store (#1346 )

2025-04-09 15:17:50 -04:00

scripts

fix: OEM plugin issues (#1288 )

2025-03-28 16:39:15 -04:00

source/dynamix.unraid.net

refactor(api): vendor node_modules instead of pnpm store (#1346 )

2025-04-09 15:17:50 -04: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

feat: api plugin system & offline versioned dependency vendoring (#1252 )

2025-03-27 13:23:55 -04:00

.prettierrc.mjs

feat: begin building plugin with node instead of bash (#1120 )

2025-02-06 12:32:41 -05:00

docker-compose.yml

refactor(api): vendor node_modules instead of pnpm store (#1346 )

2025-04-09 15:17:50 -04:00

Dockerfile

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

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

package.json

chore(main): release 4.6.6 (#1328 )

2025-04-03 11:59:59 -04:00

pnpm-lock.yaml

feat: split plugin builds

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

README.md

chore: cleanup the cleanup scripts (#1266 )

2025-03-24 12:35:25 -04:00

vitest.config.ts

feat: split plugin builds

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

README.md

Unraid Plugin Builder

Tool for building and testing Unraid plugins locally as well as packaging them for deployment.

Development Workflow

1. Watch for Changes

The watch command will automatically sync changes from the API, UI components, and web app into the plugin source:

# Start watching all components
pnpm run watch:all

# Or run individual watchers:
pnpm run api:watch    # Watch API changes
pnpm run ui:watch     # Watch Unraid UI component changes
pnpm run wc:watch     # Watch web component changes

This will copy:

API files to ./source/dynamix.unraid.net/usr/local/unraid-api
UI components to ./source/dynamix.unraid.net/usr/local/emhttp/plugins/dynamix.my.servers/unraid-components
Web components to the same UI directory

2. Build the Plugin

Once your changes are ready, build the plugin package:

# Build using Docker - on non-Linux systems
pnpm run docker:build-and-run

# Or build with the build script
pnpm run build:validate

This will create the plugin files in ./deploy/release/

3. Serve and Install

Start a local HTTP server to serve the plugin files:

# Serve the plugin files
pnpm run http-server

Then 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

Run watchers in a separate terminal while developing
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
build:validate - Build with environment validation
docker:build - Build the Docker container
docker:run - Run the builder in Docker
docker:build-and-run - Build and run in Docker

Watch Commands

watch:all - Watch all component changes
api:watch - Watch API changes
ui:watch - Watch UI component changes
wc:watch - Watch web component changes

Server Commands

http-server - Serve the plugin files locally

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