mirror/api

mirror of https://github.com/unraid/api.git synced 2026-01-08 09:39:49 -06:00

Files

Eli Bosley a554bde5c2 feat: initial setup of permissions on keys (#1068 )

* feat: initial setup of permissions on keys

* fix: remove API keys

* test: update me resolver, findByIdWithSecret, findByKey and saveApiKey tests

* test: update and fix the rest of the failing api key tests

* fix: add reflect-metadata to test setup in vite config

* fix: revert myservers.cfg to original

* fix: update User type on me resolver

* fix: make permissions nullable and rerun codegen

* fix: update import syntax in me resolver

* refactor: move create-local-connect-api-key to api key service and handle in onModuleInit

* test: add tests for createLocalApiKeyForConnectIfNecessary

* refactor: add validation to me resolver

* refactor: address code rabbit suggestions

* refactor: update me resolver tests and fix hasOwnProperty error

* refactor: remove console log

* test: add additional coverage for me resolver tests

* test: fix failing test

* refactor: address review comments, add new api-key service test, and remove deprecated keys

* refactor: address review comments

---------

Co-authored-by: mdatelle <mike@datelle.net>

2025-01-23 15:37:15 -05:00

.vscode

chore: improve dx for scripting & setup (#969 )

2024-12-02 10:07:56 -05:00

dev

feat: initial setup of permissions on keys (#1068 )

2025-01-23 15:37:15 -05:00

docs

feat: code review changes

2024-11-05 16:11:21 -05:00

scripts

feat(api): graphql sandbox on unraid servers (#1047 )

2025-01-16 10:17:09 -05:00

src

feat: initial setup of permissions on keys (#1068 )

2025-01-23 15:37:15 -05:00

.dockerignore

…

.env.development

chore(web): mock user session cookie during development (#997 )

2025-01-08 14:15:46 -05:00

.env.test

…

.eslintrc.ts

fix: eslint config

2024-11-05 16:11:21 -05:00

.gitignore

…

.nvmrc

fix: delete boot script and update nvmrc

2024-11-05 16:11:21 -05:00

.prettierrc.cjs

chore: add import organizer to prettier config (#959 )

2024-11-12 09:46:29 -05:00

CHANGELOG.md

…

codegen.ts

fix: authorization type error (#987 )

2024-12-18 12:03:28 -05:00

docker-compose.yml

fix: authorization type error (#987 )

2024-12-18 12:03:28 -05:00

Dockerfile

feat: attempt to fix pm2

2024-11-05 16:11:21 -05:00

ecosystem.config.json

fix(api): pm2 start script & limit auto restarts (#1040 )

2025-01-14 14:27:00 -05:00

justfile

fix(api): update deploy-dev script to dist instead of src

2025-01-13 10:55:26 -05:00

package-lock.json

fix(deps): update graphql-tools monorepo

2025-01-15 12:49:23 -05:00

package.json

feat: initial setup of permissions on keys (#1068 )

2025-01-23 15:37:15 -05:00

README.md

feat: substantial docs updates

2024-11-05 16:11:21 -05:00

tsconfig.json

fix: no vite-node in non-dev mode

2024-11-05 16:11:21 -05:00

vite.config.ts

feat: initial setup of permissions on keys (#1068 )

2025-01-23 15:37:15 -05:00

README.md

@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.

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.

README.md

@unraid/api

Installation

CLI

Report

Secrets

License