← Back to issue list

The documentation for `how-to/publishing/authenticate.rst` should at least specify one system keyring as an example

View original Github issue

Metadata

Project
snapcraft
Number
#6049
Type
issue
State
open
Author
linghengqian
Labels
Status: Triaged Type: Documentation
Created
2026-02-19 15:03:07+00:00
Updated
2026-02-19 16:09:21+00:00
Closed

Current evaluation

No evaluation has been recorded for this issue yet.

Issue body

### Check existing issues - [x] I've verified that this request isn't described by any existing issues. ### Request <!-- Describe your request and the problem it solves. Include any relevant context, screenshots, or examples. --> - The documentation for `how-to/publishing/authenticate.rst` should at least specify one system keyring as an example. - Currently, https://documentation.ubuntu.com/snapcraft/latest/how-to/publishing/authenticate/#authenticate-with-a-keyring describes it as follows. > On systems where you wish to remain logged in, run `snapcraft login`. Snapcraft will attempt to use the system keyring. If no keyrings are installed or initialized, Snapcraft will fall back to file-based credential storage. The file-based storage is managed by Snapcraft. If you wish to import/export credentials, refer to the previous sections. - I find this a bit odd for WSL users, because most WSL users new to snapcraft don't know what to install as a system keyring. There's no proper Linux desktop environment, and therefore no way to provide the necessary files for `file-based storage`. ```bash sudo apt update && sudo apt upgrade --assume-yes sudo snap install snapcraft --classic sudo snap install multipass sudo snap set snapcraft provider=multipass snapcraft login ``` ```bash lingh@DESKTOP-58BHAE6:~$ snapcraft login No keyring found to store or retrieve credentials from. Recommended resolution: Ensure the keyring is working or SNAPCRAFT_STORE_CREDENTIALS is correctly exported into the environment For more information, check out: https://documentation.ubuntu.com/snapcraft/stable/how-to/publishing/authenticate Full execution log: '/home/lingh/.local/state/snapcraft/log/snapcraft-20260219-230047.517051.log' ``` - Most users will only know from internet searches that they need to additionally execute `sudo apt install --assume-yes gnome-keyring`, so why not write this command into the documentation? `gnome-keyring` can certainly be used under WSL2. - <img width="2450" height="1344" alt="Image" src="https://github.com/user-attachments/assets/f8f77fa2-fb6f-4ee9-842b-ff408d1612a4" /> - The early investigation is located at https://github.com/rancher-sandbox/rancher-desktop/issues/9847 . ### Document location https://documentation.ubuntu.com/snapcraft/latest/how-to/publishing/authenticate/#authenticate-with-a-keyring

Evaluation history

No evaluation history available.