Improve local development credential documentation #402
+26
−1
Conversation
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
Fixes authzed#350 Updated documentation to address confusion around INSECURE_PLAINTEXT_CREDENTIALS vs INSECURE_LOCALHOST_ALLOWED when using Orbstack, Docker, or other non-localhost setups for local SpiceDB development. Changes: - Added callout explaining when to use INSECURE_PLAINTEXT_CREDENTIALS - Clarified INSECURE_LOCALHOST_ALLOWED limitations with Docker/Orbstack hostnames - Added "Local Development Tips" section with quick reference for all languages - Production examples remain secure and production-ready
Address issue with INSECURE_PLAINTEXT_CREDENTIALS vs INSECURE_LOCALHOST_ALLOWED confusion for non-localhost scenarios. Improved formatting and conciseness to match existing documentation style. Fixes authzed#350
|
@ivanauth is attempting to deploy a commit to the authzed Team on Vercel. A member of the Team first needs to authorize it. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Addresses #350 by clarifying when to use
INSECURE_PLAINTEXT_CREDENTIALSvsINSECURE_LOCALHOST_ALLOWEDfor local development scenarios.Changes
Context
Teams using Orbstack or Docker with non-localhost hostnames (e.g.,
*.orb.local) were confused about which security setting to use. This makes it clear that insecure plaintext credentials work for all local development scenarios including localhost, Docker, Orbstack, and other non-TLS setups.Fixes #350