mirror/api
1
0
Fork 0
mirror of https://github.com/unraid/api.git synced 2026-04-25 16:58:38 -05:00
Code Issues Packages Projects Releases Wiki Activity
Files
048558b9edf93f5211c82f83ba7ca89bf1880de8
api/README.md
T
Alexis Tyler 048558b9ed docs: add logs section and fix typo in install line
2020-02-16 12:46:43 +10:30

1.0 KiB
Raw Blame History

@unraid/graphql-api

Graphql-api wrapper around @unraid/core.

Installation

Ensure you have the latest version of the unraid.net plugin. This script should be run automatically on every boot.

/etc/rc.d/rc.unraid-api 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

Logs

If installed on a unraid machine logs can be accessed via /etc/rc.d/rc.unraid-api logs or directly at /var/run/graphql-api.log; otherwise please see stdout.

License

Copyright 2019 Lime Technology Inc. All rights reserved.

Reference in New Issue View Git Blame Copy Permalink