📖 Description / Context
In the doc/cli-encryption/_index.md file, under the "File-based Keyring (Fallback)" section, the documentation explicitly states:
"By default, this file-based keyring is located at ~/.harbor/keyring."
However, the current language in the encryption markdown guide appears to be outdated and misleading for users attempting to configure or audit local credential backup structures.
🐛 Actual Behavior vs. Documentation
Testing the binary's actual configuration footprint demonstrates that Harbor CLI strictly adheres to XDG Base Directory Specification layout principles.
- The binary initializes configurations under
~/.config/harbor-cli/config.yaml.
- Runtime data stores are initialized within
~/.local/share/harbor-cli/.
- It never introduces a top-level
~/.harbor/ folder to the user's home directory, even when forcing an isolated fallback initialization.
🛠️ Proposed Change
Update the "File-based Keyring (Fallback)" section text in doc/cli-encryption/_index.md to accurately reflect the true configuration layout structures. References to the deprecated ~/.harbor/keyring path should be eliminated and replaced with the correct XDG-compliant tracking locations currently used by the application.
🙋♂️ Assignment
I have already investigated this locally and would like to submit a PR to resolve this discrepancy.
/assign
📖 Description / Context
In the
doc/cli-encryption/_index.mdfile, under the "File-based Keyring (Fallback)" section, the documentation explicitly states:However, the current language in the encryption markdown guide appears to be outdated and misleading for users attempting to configure or audit local credential backup structures.
🐛 Actual Behavior vs. Documentation
Testing the binary's actual configuration footprint demonstrates that Harbor CLI strictly adheres to XDG Base Directory Specification layout principles.
~/.config/harbor-cli/config.yaml.~/.local/share/harbor-cli/.~/.harbor/folder to the user's home directory, even when forcing an isolated fallback initialization.🛠️ Proposed Change
Update the "File-based Keyring (Fallback)" section text in
doc/cli-encryption/_index.mdto accurately reflect the true configuration layout structures. References to the deprecated~/.harbor/keyringpath should be eliminated and replaced with the correct XDG-compliant tracking locations currently used by the application.🙋♂️ Assignment
I have already investigated this locally and would like to submit a PR to resolve this discrepancy.
/assign