docs: correct outdated fallback keyring path documentation#935
Merged
qcserestipy merged 1 commit intoMay 26, 2026
Merged
Conversation
Updates the file-based keyring fallback documentation to accurately reflect the standard XDG-compliant path layout structures used by the application instead of referencing a separate ~/.harbor/ directory. Fixes goharbor#934 Signed-off-by: CygnusMaximillian <dprajjwal11@gmail.com>
qcserestipy
approved these changes
May 25, 2026
qcserestipy
left a comment
Collaborator
There was a problem hiding this comment.
Thank you for your contribution, LGTM
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #935 +/- ##
=========================================
- Coverage 10.99% 8.51% -2.48%
=========================================
Files 173 288 +115
Lines 8671 14443 +5772
=========================================
+ Hits 953 1230 +277
- Misses 7612 13096 +5484
- Partials 106 117 +11 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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.
📝 Description
This PR updates the File-based Keyring (Fallback) documentation in the Harbor CLI Encryption Guide to reflect standard XDG Base Directory Specification alignment.
Previously, the documentation erroneously stated that the default fallback keyring file path defaults to a top-level home dotfile directory (
~/.harbor/keyring). Local isolation testing on modern distributions verifies that the CLI binary strictly respects system-wide XDG variables (~/.config/harbor-cli/config.yamland~/.local/share/harbor-cli/), never generating a legacy~/.harbor/folder in the user's root home path.🛠️ Changes Made
doc/cli-encryption/_index.md~/.harbor/keyring.~/.local/share/harbor-cli/keyringor~/.config/harbor-cli/keyring).🧪 Verification & Testing Completed
env -i HOME=$HOME PATH=$PATH ./harbor-cli login...)..config/harbor-cli/config.yamland.local/share/harbor-cli/data.yamlwithout generating an extraneous~/.harborfile path.🔗 Related Issues
Fixes #934
