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

docs: add logs section and fix typo in install line

Browse Source
This commit is contained in:
Alexis Tyler
2020-02-16 12:46:43 +10:30
parent 9590ebc7c5
commit 048558b9ed
1 changed files with 5 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@@ -7,7 +7,7 @@ Graphql-api wrapper around [@unraid/core](https://github.com/unraid/core).
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
/etc/rc.d/rc.unraid-api install
```
## Connecting
@@ -20,5 +20,9 @@ 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.