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

docs(install/connect): add simple docs

Browse Source
This commit is contained in:
Alexis Tyler
2020-02-14 17:01:31 +10:30
parent 2b38842dda
commit dfc1381182
1 changed files with 18 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@@ -2,5 +2,23 @@
Graphql-api wrapper around [@unraid/core](https://github.com/unraid/core).
## Installation
Ensure you have the latest version of the unraid.net plugin.
This script should be run automatically on every boot.
```bash
/etc/rc.d/rc.unraid.net install
```
## Connecting
### HTTP
This can be accessed by default via `http://tower.local/graph`. If the server is connected to my servers then it's likely to have a DNS hash address, something like `https://www.__HASH_HERE__.unraid.net/graph`.
See https://graphql.org/learn/serving-over-http/#http-methods-headers-and-body
### WS
If you're using the ApolloClient please see https://github.com/apollographql/subscriptions-transport-ws#full-websocket-transport otherwise see https://github.com/apollographql/subscriptions-transport-ws/blob/master/PROTOCOL.md
## License
Copyright 2019 Lime Technology Inc. All rights reserved.