Skip to content

docs: add gnome-keyring example for WSL users (fixes #6049) #6073

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.

Sign up for GitHub

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

Open
Dotunbey wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add gnome-keyring example for WSL users (fixes #6049) #6073

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions docs/how-to/publishing/authenticate.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,3 +118,19 @@ Note that ``snapcraft login`` sometimes fails to unlock GNOME keyring when acces
Linux system with a desktop environment from a virtual console or SSH. GNOME keyring
will not present a CLI password prompt to unlock the keyring, causing Snapcraft to stall
and timeout.

Example (WSL users):

Comment on lines +122 to +123
Copy link
Member

@bepri bepri Mar 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can drop this header

Copy link
Author

@Dotunbey Dotunbey Mar 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure

On WSL systems, you may need to install a system keyring such as
``gnome-keyring`` manually:
Comment on lines +124 to +125
Copy link
Member

@bepri bepri Mar 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
On WSL systems, you may need to install a system keyring such as
``gnome-keyring`` manually:
On WSL systems, you may need to install a system keyring such as
the GNOME keyring manually:


.. code-block:: bash

sudo apt update
sudo apt install --assume-yes gnome-keyring

After installation, restart your shell and run:

.. code-block:: bash

snapcraft login