feat: document expiring API key from ory tunnel#2631
Open
alnr wants to merge 1 commit into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds documentation explaining that ory tunnel creates a temporary project API key during runtime (with optional expiry) and cross-links that behavior from the local development guide.
Changes:
- Document temporary API key creation/cleanup behavior for
ory tunnel, including--api-key-expirysemantics. - Add a cross-reference from the local development getting-started page to the new “Temporary API key” section.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/guides/cli/20_proxy-and-tunnel.mdx | Adds a new “Temporary API key” section describing creation, best-effort cleanup, and expiry control. |
| docs/getting-started/local-development.mdx | Links local development guidance to the “Temporary API key” section and mentions --api-key-expiry. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+106
to
+108
| To configure your project so that flows such as Social Sign-In work, the Tunnel creates a short-lived API key for your project | ||
| while it runs and deletes it again on shutdown. See [Temporary API key](../guides/cli/20_proxy-and-tunnel.mdx#temporary-api-key) | ||
| for details, including how to control its expiry with `--api-key-expiry`. |
| ory tunnel --project <project-id> --api-key-expiry 0 http://localhost:3000 | ||
| ``` | ||
|
|
||
| The same `--api-key-expiry` flag is available on `ory proxy`. |
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
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.
No description provided.