Skip to content

Commit 7c4363f

Browse files
committed
docs(readme): explain env
1 parent 13e08d3 commit 7c4363f

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,20 @@ You can build it from source using:
1717
go install github.com/unshade/unraidctl@latest
1818
```
1919

20+
You will then need to set the following environment variables to connect to your unraid server:
21+
22+
- `API_KEY`: Your unraid API key.
23+
- `API_BASE_URL`: The base URL of your unraid server's GraphQL endpoint.
24+
- `API_SKIP_TLS_VERIFY`: (optional) Set to `true` to skip TLS verification (useful for self-signed certificates).
25+
26+
`unraidctl` also supports a `.env` file for setting these environment variables. You can create a `.env` file in the same directory where you run `unraidctl` with the following format:
27+
28+
```env
29+
API_KEY=your_api_key
30+
API_BASE_URL=https://your-unraid-server:port/graphql
31+
API_SKIP_TLS_VERIFY=true
32+
```
33+
2034
Once installed, you can run commands like:
2135

2236
```bash

0 commit comments

Comments
 (0)