mirror/api
1
0
Fork 0
mirror of https://github.com/unraid/api.git synced 2026-01-02 22:50:02 -06:00
Code Issues Packages Projects Releases Wiki Activity

chore: add details on using a custom api version

Browse Source
This commit is contained in:
Alexis
2021-09-14 07:50:33 +09:30
parent f12a88ea67
commit 38dc7d25b3
1 changed files with 9 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@@ -10,7 +10,7 @@ This script should be run automatically on every boot.
## CLI
If you're on a unraid v6.9.0 or later machine this should be avaliable by running `unraid-api` in any directory.
If you're on a unraid v6.9.0 or later machine this should be available by running `unraid-api` in any directory.
```bash
root@Devon:~# unraid-api
@@ -84,7 +84,7 @@ You should get something like this back.
{
"data": {
"welcome": {
"message": "Welcome root to this Unraid 6.9.0 server"
"message": "Welcome root to this Unraid 6.10.0 server"
}
}
}
@@ -113,5 +113,12 @@ NCHAN=disable \ # Disable nchan polling
To create a new version run `npm run release`.
To create a new prerelease run `npm run release -- --prerelease alpha`.
## Using a custom version (e.g. testing a new release)
1. Download the tgz you want from [the releases page](https://github.com/unraid/api/releases) and copy to `/boot/config/plugins/dynamix.my.servers/unraid-api.tgz`.
2. Download the plugin `https://s3.amazonaws.com/dnld.lime-technology.com/unraid-api/dynamix.unraid.net.staging.plg` to a new area on the flash drive. I put it in `/boot/config/custom/`.
3. Edit that plg and remove the MD5/SHA256 entries from `unraid-api.tgz`. Now when it installs it will use the `unraid-api.tgz` that exists on the flash instead of downloading the latest one.
4. Go to Plugins -> Install Plugin -> navigate to /boot/config/custom and select the staging plugin.
## License
Copyright 2019-2021 Lime Technology Inc. All rights reserved.