b970fd9e6c
<!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **Chores** - Updated deployment and build commands to use a more efficient package manager. - **Refactor** - Improved the internal file modification structure for enhanced flexibility and maintainability. - **New Features** - Enhanced log management by adding functionality for proper permission handling and cleanup after operations. - Introduced a new log rotation configuration for managing log files effectively. - Updated timestamps for various components to reflect the latest download times. <!-- 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.