753f1588b8
<!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit • New Features - Enhanced the login experience with improved session management and two-factor authentication. - Introduced a comprehensive README for the Unraid Plugin Builder, detailing development workflows and commands. • Chores - Streamlined build, packaging, and deployment processes with updated dependency and environment configurations. - Updated Docker configurations to support pnpm as the package manager. - Added new environment variables for better configuration management. - Introduced new scripts for improved build and packaging processes. • Tests - Removed outdated test cases and simplified test setups. • Refactor - Modernized internal code structure and asynchronous handling for improved overall performance. - Transitioned imports from lodash to lodash-es for better module handling. - Updated environment variable management and configuration settings. - Enhanced the build script for improved deployment processes. - Updated the notification handling structure to improve efficiency. <!-- 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.
License
Copyright Lime Technology Inc. All rights reserved.