939383e4ef
* feat(api): rm api-key validation from connect sign in This will now happen at the mothership layer. * chore(api): rm redundant validate-api-key helper * chore(api): rm obsolete api-key-check-job tests * chore(api): suppress noisy notification loading logs * feat(api): rm client-side mothership api key validation refactor(api): encapsulate mothership jobs lifecycle * fix(api): mothership gql client lifecycle & error handling the api would crash when an invalid mothership api key was detected/invalidated *after* the inital server start/connection. * refactor(api): rm mothership API_KEY_STATUS enum
Unraid Connect
Monorepo for Unraid Connect and the Unraid API.
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
Table of Contents
About The Project
Built With
Getting Started
This section will guide you through the steps necessary to get the monorepo projects running and communicating with each other.
Prerequisites
Make sure the following software is installed before proceeding.
- Bash
- Docker (for macOS folks, Orbstack works too)
- Node.js (v20)
- Just
- An Unraid server for development
Next, create an SSH key if you haven't already. Once you have your key pair, add your public SSH key to your Unraid server:
- Log in to your Unraid development server.
- Use the navigation menu to go to 'Users'.
- Click on the user you logged in with (e.g.
root) - Paste your SSH public key into 'SSH authorized keys' and click 'Save'.
Installation
- Clone and enter the repo
# Optionally, give the cloned folder a more specific name gh repo clone unraid/api api-monorepo cd api-monorepo - Run the monorepo setup command.
This will run installation scripts, container builds, and some git scripts to reduce noise (i.e. personal editor customizations, etc).
just setup - Run the API container
cd api npm run container:start - This should bring you inside the API container. There, run the following command to start the server:
npm run dev - In another terminal, open the project and navigate to the web directory. Then, run the dev server:
cd web npm install # just in case npm run dev
Usage
Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.
For more examples, please refer to the Documentation
Contact
@UnraidOfficial - support@unraid.net.com
Project Link: https://github.com/unraid/api