feat: add cli command for api keys

.github/workflows/main.yml

@@ -238,8 +238,7 @@ jobs:
 
   release-pull-request:
     if: |
-      github.event_name == 'pull_request' &&
-      github.event.pull_request.base.ref == 'main'
+      github.event_name == 'pull_request'
     runs-on: ubuntu-latest
     needs: [build-plugin]
     steps:

api/README.md

@@ -17,46 +17,60 @@ root@Devon:~# unraid-api
 
 Unraid API
 
-  Thanks for using the official Unraid API 
+  Thanks for using the official Unraid API
 
 Usage:
 
-  $ unraid-api command <options> 
+  $ 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.           
+  -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.
+
+```sh
+unraid-api key --help
+```
+
 ## Report
+
 To view the current status of the unraid-api and its connection to mothership, run:
-```
+
+```sh
 unraid-api report
 ```
 
 To view verbose data (anonymized), run:
-```
+
+```sh
 unraid-api report -v
 ```
 
 To view non-anonymized verbose data, run:
-```
+
+```sh
 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](https://discord.unraid.net/).
 
 ## License
+
 Copyright Lime Technology Inc. All rights reserved.

api/dev/Unraid.net/myservers.cfg

@@ -2,8 +2,6 @@
 version="3.11.0"
 extraOrigins="https://google.com,https://test.com"
 [local]
-[notifier]
-apikey="unnotify_30994bfaccf839c65bae75f7fa12dd5ee16e69389f754c3b98ed7d5"
 [remote]
 wanaccess="yes"
 wanport="8443"
@@ -14,9 +12,8 @@ email="test@example.com"
 username="zspearmint"
 avatar="https://via.placeholder.com/200"
 regWizTime="1611175408732_0951-1653-3509-FBA155FA23C0"
-idtoken=""
 accesstoken=""
+idtoken=""
 refreshtoken=""
 dynamicRemoteAccessType="DISABLED"
-[upc]
-apikey="unupc_fab6ff6ffe51040595c6d9ffb63a353ba16cc2ad7d93f813a2e80a5810"
+ssoSubIds=""

api/dev/keys/b5b4aa3d-8e40-4c92-bc40-d50182071886.json

@@ -0,0 +1,11 @@
+{
+  "createdAt": "2025-01-27T16:22:56.501Z",
+  "description": "API key for Connect user",
+  "id": "b5b4aa3d-8e40-4c92-bc40-d50182071886",
+  "key": "_______________________LOCAL_API_KEY_HERE_________________________",
+  "name": "Connect",
+  "permissions": [],
+  "roles": [
+    "connect"
+  ]
+}

api/dev/states/myservers.cfg

@@ -2,8 +2,6 @@
 version="3.11.0"
 extraOrigins="https://google.com,https://test.com"
 [local]
-[notifier]
-apikey="unnotify_30994bfaccf839c65bae75f7fa12dd5ee16e69389f754c3b98ed7d5"
 [remote]
 wanaccess="yes"
 wanport="8443"
@@ -14,12 +12,12 @@ email="test@example.com"
 username="zspearmint"
 avatar="https://via.placeholder.com/200"
 regWizTime="1611175408732_0951-1653-3509-FBA155FA23C0"
-idtoken=""
 accesstoken=""
+idtoken=""
 refreshtoken=""
-allowedOrigins="/var/run/unraid-notifications.sock, /var/run/unraid-php.sock, /var/run/unraid-cli.sock, http://localhost:8080, https://localhost:4443, https://tower.local:4443, https://192.168.1.150:4443, https://tower:4443, https://192-168-1-150.thisisfourtyrandomcharacters012345678900.myunraid.net:4443, https://85-121-123-122.thisisfourtyrandomcharacters012345678900.myunraid.net:8443, https://10-252-0-1.hash.myunraid.net:4443, https://10-252-1-1.hash.myunraid.net:4443, https://10-253-3-1.hash.myunraid.net:4443, https://10-253-4-1.hash.myunraid.net:4443, https://10-253-5-1.hash.myunraid.net:4443, https://10-100-0-1.hash.myunraid.net:4443, https://10-100-0-2.hash.myunraid.net:4443, https://10-123-1-2.hash.myunraid.net:4443, https://221-123-121-112.hash.myunraid.net:4443, https://google.com, https://test.com, https://connect.myunraid.net, https://connect-staging.myunraid.net, https://dev-my.myunraid.net:4000, https://studio.apollographql.com"
 dynamicRemoteAccessType="DISABLED"
-[upc]
-apikey="unupc_fab6ff6ffe51040595c6d9ffb63a353ba16cc2ad7d93f813a2e80a5810"
+ssoSubIds=""
+allowedOrigins="/var/run/unraid-notifications.sock, /var/run/unraid-php.sock, /var/run/unraid-cli.sock, http://localhost:8080, https://localhost:4443, https://tower.local:4443, https://192.168.1.150:4443, https://tower:4443, https://192-168-1-150.thisisfourtyrandomcharacters012345678900.myunraid.net:4443, https://85-121-123-122.thisisfourtyrandomcharacters012345678900.myunraid.net:8443, https://10-252-0-1.hash.myunraid.net:4443, https://10-252-1-1.hash.myunraid.net:4443, https://10-253-3-1.hash.myunraid.net:4443, https://10-253-4-1.hash.myunraid.net:4443, https://10-253-5-1.hash.myunraid.net:4443, https://10-100-0-1.hash.myunraid.net:4443, https://10-100-0-2.hash.myunraid.net:4443, https://10-123-1-2.hash.myunraid.net:4443, https://221-123-121-112.hash.myunraid.net:4443, https://google.com, https://test.com, https://connect.myunraid.net, https://connect-staging.myunraid.net, https://dev-my.myunraid.net:4000, https://studio.apollographql.com"
 [connectionStatus]
 minigraph="PRE_INIT"
+upnpStatus=""

api/docker-compose.yml

@@ -1,5 +1,3 @@
-version: '3.8'
-
 x-volumes: &volumes
   volumes:
   - ./dev:/app/dev