Skip to content

docs: correct outdated fallback keyring path documentation#935

Open
CygnusMaximillian wants to merge 1 commit into
goharbor:mainfrom
CygnusMaximillian:docs/fix-keyring-path
Open

docs: correct outdated fallback keyring path documentation#935
CygnusMaximillian wants to merge 1 commit into
goharbor:mainfrom
CygnusMaximillian:docs/fix-keyring-path

Conversation

@CygnusMaximillian
Copy link
Copy Markdown

📝 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.yaml and ~/.local/share/harbor-cli/), never generating a legacy ~/.harbor/ folder in the user's root home path.

🛠️ Changes Made

  • Modified: doc/cli-encryption/_index.md
  • Removed out-of-date documentation references targeting ~/.harbor/keyring.
  • Replaced outdated path with a generalized, clear note directing users toward the active XDG-compliant folder hierarchy (e.g., ~/.local/share/harbor-cli/keyring or ~/.config/harbor-cli/keyring).

🧪 Verification & Testing Completed

  1. Environment Stripping: Executed local configuration initializations using an isolated context wrapper to block default desktop session ring hooks (env -i HOME=$HOME PATH=$PATH ./harbor-cli login...).
  2. Footprint Check: Verified that directory generation successfully mapped variables to .config/harbor-cli/config.yaml and .local/share/harbor-cli/data.yaml without generating an extraneous ~/.harbor file path.
  3. Markdown Validation: Confirmed documentation links and styling render without any lint errors.

🔗 Related Issues

Fixes #934
Screenshot From 2026-05-16 14-44-36

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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: correct outdated fallback keyring path documentation in encryption guide

1 participant