mirror/api

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

Files

Eli Bosley fcd6fbcdd4 feat: move to iframe for changelog (#1388 )

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- **New Features**
- Changelog modal now displays changelog documentation within an
embedded iframe if a URL is available, allowing navigation within the
iframe and providing a "Back to Changelog" button to return to the
original view.
- "View on Docs" button dynamically updates to reflect the current page
within the iframe.
- Added support for displaying a formatted changelog string and testing
modal behavior with or without this content.
- Introduced a new component to fetch, parse, and render changelogs from
URLs with enhanced markdown handling.
- Update OS store extended to manage changelog display and release
stability, consolidating changelog state and actions.

- **Bug Fixes**
  - Close button in modal dialogs is now visible on all screen sizes.

- **Chores**
- Updated the default server state, which may affect registration device
counts and types.
- Added new localization string for changelog titles with version
placeholders.
- Removed deprecated changelog store and related tests, simplifying
state management.
- Refined backup and restoration scripts for unraid-components directory
to use move operations with improved logging.
- Improved modal visibility state handling by consolidating changelog
modal controls into the main update OS store.
- Added URL origin and pattern checks for changelog iframe navigation
security.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

2025-05-19 15:34:44 -04:00

.vscode

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

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

builder

feat: native slackware package (#1381 )

2025-05-08 22:54:10 -04:00

plugins

feat: move to iframe for changelog (#1388 )

2025-05-19 15:34:44 -04:00

scripts

feat: native slackware package (#1381 )

2025-05-08 22:54:10 -04:00

source/dynamix.unraid.net

feat: move to iframe for changelog (#1388 )

2025-05-19 15:34:44 -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: native slackware package (#1381 )

2025-05-08 22:54:10 -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

feat: native slackware package (#1381 )

2025-05-08 22:54:10 -04:00

Dockerfile

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

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

package.json

fix(deps): update dependency commander to v14 (#1394 )

2025-05-19 12:17: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