Document relay authentication#59
Merged
Merged
Conversation
Relays from Iroh Services now require authentication by default: only a project's own endpoints can connect, using a short-lived token the iroh_services::preset() builder mints from the project's API key. - concepts/relays: add an Authentication section explaining how it works (allow-set, per-endpoint token, live revocation, on/off toggle) - managed: authenticated-by-default framing + "Turn authentication off" section with dashboard screenshot - access: API keys now also authorize dedicated relay connections - add new authenticated preset config snippet; use it in add-a-relay and managed - reword public/private as authentication on/off (a relay with auth off is not discoverable) Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
The preset config flow uses the iroh-services crate, so show installing it before the example. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
okdistribute
commented
Jun 4, 2026
| <RelayEndpointConfig /> | ||
| <RelayPresetConfig /> | ||
|
|
||
| Relays you self-host outside of Iroh Services are configured directly with `RelayMode::Custom`; see [Dedicated Infrastructure](/deployment/dedicated-infrastructure). |
Contributor
Author
There was a problem hiding this comment.
probably should link to the rust doc instead
b5
approved these changes
Jun 4, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Relays from Iroh Services now require authentication by default: only a project's own endpoints can connect, using a short-lived token the iroh_services::preset() builder mints from the project's API key.