docs: document CLI keyring-backed session storage#309
Open
mintlify[bot] wants to merge 1 commit into
Open
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
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.
Summary
Document that the Porter CLI now stores session tokens in the operating system's secure credential store instead of
porter.yaml.Changes
standard/cli/command-reference/porter-config.mdx: Added a "Credential Storage" section covering supported OS backends, automatic migration from older configs, and the headlessPORTER_KEYRING_PASSWORDfallback. Updated--show-tokento note it now also reveals values fetched from the keyring.cli/basic-usage.mdx: Added a short "Credential Storage" callout linking to the full reference, and listedPORTER_KEYRING_PASSWORDin the environment variables table.Context
Upstream PR introduces a keyring-backed session store. On login, access and refresh tokens are written to macOS Keychain, Windows Credential Manager, GNOME Secret Service, or KWallet (with an encrypted file fallback at
~/.porter/keyringfor headless environments). Existing plaintext tokens inporter.yamlare migrated to the keyring on first run after upgrading and removed from disk. The--show-tokenflag now hydrates the printed config with the keyring values so it still surfaces real credentials.cc @dgtown for review.