Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix APT keyring location in Linux installation instructions #8697

Closed
wants to merge 1 commit into from

Conversation

borfast
Copy link

@borfast borfast commented Feb 14, 2024

The current installation instructions mention /usr/share/keyrings as the location to copy the apt key files to, but according to the sources.list and apt-key manpages, the correct location for manually installed keys would be /etc/apt/keyrings.

This PR changes the instructions to point to that location instead.

From the sources.list manpage:

The recommended locations for keyrings are /usr/share/keyrings for keyrings managed by packages, and /etc/apt/keyrings for keyrings managed by the system operator.

From the apt-key manpage:

FILES
/etc/apt/trusted.gpg
Keyring of local trusted keys, new keys will be added here. Configuration Item: Dir::Etc::Trusted.

/etc/apt/trusted.gpg.d/
File fragments for the trusted keys, additional keyrings can be stored here (by other packages or the administrator). Configuration Item Dir::Etc::TrustedParts.

/etc/apt/keyrings/
Place to store additional keyrings to be used with Signed-By.

The current installation instructions mention `/usr/share/keyrings` as the location to copy the apt key files to, but according to the sources.list and apt-key manpages, the correct location for manually installed keys would be `/etc/apt/keyrings`.

This PR changes the instructions to point to that location instead.

From the sources.list manpage:
> The recommended locations for keyrings are /usr/share/keyrings for keyrings managed by packages, and /etc/apt/keyrings for keyrings managed by the system operator.

From the apt-key manpage:
> FILES
>    /etc/apt/trusted.gpg
>            Keyring of local trusted keys, new keys will be added here. Configuration Item: Dir::Etc::Trusted.
> 
>    /etc/apt/trusted.gpg.d/
>            File fragments for the trusted keys, additional keyrings can be stored here (by other packages or the administrator). Configuration Item Dir::Etc::TrustedParts.
> 
>    /etc/apt/keyrings/
>            Place to store additional keyrings to be used with Signed-By.
@borfast borfast requested a review from a team as a code owner February 14, 2024 11:58
@borfast borfast requested review from andyfeller and removed request for a team February 14, 2024 11:58
@cliAutomation cliAutomation added the external pull request originating outside of the CLI core team label Feb 14, 2024
@cliAutomation
Copy link
Collaborator

Hi! Thanks for the pull request. Please ensure that this change is linked to an issue by mentioning an issue number in the description of the pull request. If this pull request would close the issue, please put the word 'Fixes' before the issue number somewhere in the pull request body. If this is a tiny change like fixing a typo, feel free to ignore this message.

@cliAutomation cliAutomation added this to Needs review 🤔 in The GitHub CLI Feb 14, 2024
@williammartin
Copy link
Member

@borfast do you know @hongquan from #8693 or did these docs just change recently? Pretty coincidental that these were opened within a day of each other!

@borfast
Copy link
Author

borfast commented Feb 14, 2024

@williammartin, no, I don't know them, it was just a coincidence 😅
The standard for the keyrings location has changed quite some time ago. For example, I opened a similar PR for another OSS project almost a year ago, and at that time it was already "old news".

Also, apologies for the duplicate PR. I did search to see if there was something already but I didn't see #8693. Feel free to close this one, if you prefer to do it all in one go with the other one.

Crankscase

This comment was marked as spam.

@williammartin
Copy link
Member

That's so funny. Alright I think I'll close this one then, thank you for basically doing a review of this part of the other PR on my behalf 😅

@borfast
Copy link
Author

borfast commented Feb 15, 2024

Glad I could help 😂

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
external pull request originating outside of the CLI core team
Projects
No open projects
The GitHub CLI
  
Needs review 🤔
Development

Successfully merging this pull request may close these issues.

None yet

4 participants