Skip to content

Commit 16f8152

Browse files
Merge pull request #1078 from guardrails-ai/auth-docs
Auth docs
2 parents 7e157bd + d13dadc commit 16f8152

File tree

3 files changed

+25
-0
lines changed

3 files changed

+25
-0
lines changed

docs/faq.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,21 @@
11
# Frequently Asked Questions
22

3+
## I get an "Unauthorized" error when installing validators from the Guardrails Hub. What should I do?
4+
5+
If you see an "Unauthorized" error when installing validators from the Guardrails hub, it means that the API key you are using is not authorized to access the Guardrails hub. It may be unset or expired.
6+
7+
To fix this, first generate a new API key from the [Guardrails Hub](https://hub.guardrailsai.com/keys). Then, configure the Guardrails CLI with the new API key.
8+
9+
```bash
10+
guardrails configure
11+
```
12+
13+
There is also a headless option to configure the CLI with the token.
14+
15+
```bash
16+
guardrails configure --token <your_token>
17+
```
18+
319
## I'm seeing a PromptCallableException when invoking my Guard. What should I do?
420

521
If you see an exception that looks like this

docs/getting_started/guardrails_server.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,13 @@ This document will overview a few of the key features of the Guardrails Server,
1313

1414
# Walkthrough
1515

16+
## 0. Configure Guardrails
17+
First, get a free auth key from [Guardrails Hub](https://hub.guardrailsai.com/keys). Then, configure the Guardrails CLI with the auth key.
18+
19+
```bash
20+
guardrails configure
21+
```
22+
1623
## 1. Install the Guardrails Server
1724
This is done by simply installing the `guardrails-ai` package. See the [installation guide](./quickstart.md) for more information.
1825

docs/getting_started/quickstart.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ pip install guardrails-ai
1717
```
1818

1919
### Configure the Guardrails CLI (required)
20+
21+
First, get a free auth key from [Guardrails Hub](https://hub.guardrailsai.com/keys). Then, configure the Guardrails CLI with the auth key.
2022

2123
```bash
2224
guardrails configure

0 commit comments

Comments
 (0)