bb9b539732
Raised by [MitchellThompkins](https://github.com/MitchellThompkins) in #1848 - Documents how to use Docker to build a local Connect plugin - Local Plugin flow will now build workspace packages before proceeding with plugin infra + build - Removes recommendation to run `pnpm build:watch` from root, as this race conditions and build cache issues. - Makes `pnpm dev` from root parallel, preventing servers from blocking each other. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Updated development workflow documentation to emphasize Docker-based plugin builds * Restructured development modes into three workflows: local Docker builds, direct deployment, and development servers * Updated build and deployment instructions * **Chores** * Modified dev script for parallel execution * Refactored build scripts with improved dependency handling <sub>✏️ Tip: You can customize this high-level summary in your review settings.</sub> <!-- end of auto-generated comment: release notes by coderabbit.ai -->
@unraid/api
Installation
Install the production plugin via the apps tab (search for "Unraid Connect")
Manual install can be done with the following routes: production staging
CLI
If you're on a unraid v6.9.2 or later machine this should be available by running unraid-api in any directory.
root@Devon:~# unraid-api
Unraid API
Thanks for using the official Unraid API
Usage:
$ unraid-api command <options>
Commands:
start/stop/restart/version/status/report/switch-env
Options:
-h, --help Prints this usage guide.
-d, --debug Enabled debug mode.
-p, --port string Set the graphql port.
--environment production/staging/development Set the working environment.
--log-level ALL/TRACE/DEBUG/INFO/WARN/ERROR/FATAL/MARK/OFF Set the log level.
Copyright © 2024 Lime Technology, Inc.
Key
To create and work with Unraid API keys, used for the local API, run the following command to view all available options. These options may change over time.
unraid-api key --help
Report
To view the current status of the unraid-api and its connection to mothership, run:
unraid-api report
To view verbose data (anonymized), run:
unraid-api report -v
To view non-anonymized verbose data, run:
unraid-api report -vv
Secrets
If you found this file you're likely a developer. If you'd like to know more about the API and when it's available please join our discord.
Internationalization
- Run
pnpm --filter @unraid/api i18n:extractto scan the Nest.js source for translation helper usages and updatesrc/i18n/en.jsonwith any new keys. The extractor keeps existing translations intact and appends new keys with their English source text.
Developer Documentation
For detailed information about specific features:
- API Plugins - Working with API plugins and workspace packages
- Docker Feature - Container management, GraphQL API, and WebGUI integration
- Feature Flags - Conditionally enabling functionality
- Repository Organization - Codebase structure
- Development Workflows - Development processes
License
Copyright Lime Technology Inc. All rights reserved.