Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ The full model, with the code that enforces each point:

## Quick start

1. In Perfloop Setup, under API keys, create a relay token. It is shown once.
1. In Perfloop Setup, under Telemetry, Relay tokens, create a relay token. It is shown once.
2. Write `relay.yaml`:

```yaml
Expand Down
2 changes: 1 addition & 1 deletion docs/security.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ never a short body that looks complete.
## The relay token

A relay token is a Perfloop API key with the `relay` scope. A tenant admin
creates it in Setup, under API keys, as a relay token, and revokes it there.
creates it in Setup, under Telemetry, Relay tokens, and revokes it there.
The plaintext is shown once; Perfloop stores only its hash. The token lets a
relay answer that tenant's validated reads and nothing else: the Perfloop API
refuses it as a bearer everywhere but the tunnel route, so a token held in
Expand Down
11 changes: 6 additions & 5 deletions docs/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,13 @@ To verify the signature and the binary, see [image.md](image.md).

## 2. Create the relay token

In the Perfloop app, open `https://app.perfloop.ai/t/<tenant>/setup`, find the
**API keys** group, enter a name for the token (for example
`relay <namespace>`), and press **Create relay token**. Copy the token now;
it is shown once. It starts with `plf_`.
In the Perfloop app, open `https://app.perfloop.ai/t/<tenant>/setup`, and in
**Model inputs**, at the end of the **Telemetry** section, find
**Relay tokens**. Enter a name for the token (for example `relay <namespace>`)
and press **Create relay token**. Copy the token now; it is shown once. It
starts with `plf_`.

Checkpoint: the token appears in the live keys table with scope `relay`.
Checkpoint: the token's name appears in the Relay tokens list.

Hold the token in an environment variable in your shell, never in a file
or on a command line that shell history records:
Expand Down
Loading