mirror/api

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

Files

Eli Bosley 5517e7506b feat: add rclone (#1362 )

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

- **New Features**
- Introduced full RClone remote management with creation, deletion,
listing, and detailed remote info via a multi-step, schema-driven UI.
- Added guided configuration forms supporting advanced and
provider-specific options for RClone remotes.
  - Enabled flash backup initiation through API mutations.
- Added new Vue components for RClone configuration, overview, remote
item cards, and flash backup page.
- Integrated new combobox, stepped layout, control wrapper, label
renderer, and improved form renderers with enhanced validation and error
display.
- Added JSON Forms visibility composable and Unraid settings layout for
consistent UI rendering.

- **Bug Fixes**
- Standardized JSON scalar usage in Docker-related types, replacing
`JSONObject` with `JSON`.

- **Chores**
- Added utility scripts and helpers to manage rclone binary installation
and versioning.
- Updated build scripts and Storybook configuration for CSS handling and
improved developer workflow.
- Refactored ESLint config for modularity and enhanced code quality
enforcement.
- Improved component registration with runtime type checks and error
handling.

- **Documentation**
- Added extensive test coverage for RClone API service, JSON Forms
schema merging, and provider config slice generation.

- **Style**
- Improved UI consistency with new layouts, tooltips on select options,
password visibility toggles, and error handling components.
- Removed deprecated components and consolidated renderer registrations
for JSON Forms.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

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

2025-05-27 07:52:25 -04:00

.vscode

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

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

builder

feat: add rclone (#1362 )

2025-05-27 07:52:25 -04:00

plugins

fix: node_modules dir removed on plugin update (#1406 )

2025-05-23 09:22:59 -04:00

scripts

feat: slightly better watch mode (#1398 )

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

source/dynamix.unraid.net

fix: rc.unraid-api now cleans up older dependencies (#1404 )

2025-05-23 10:23:58 -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

.nvmrc

feat: slightly better watch mode (#1398 )

2025-05-22 13:42:08 -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: slightly better watch mode (#1398 )

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

Dockerfile

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

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

package.json

feat: slightly better watch mode (#1398 )

2025-05-22 13:42:08 -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