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.

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

Add admonition for credential helper on macOS #728

Merged
merged 1 commit into from
Jul 18, 2024
Merged

Add admonition for credential helper on macOS #728

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
14 changes: 14 additions & 0 deletions source/user-guide/containers-and-docker/configure-docker-helper.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,20 @@
.. note::
The :ref:`credentials<ref-api-access>` will need the “containers:read” scope to work with Docker.

.. important::
On macOS, you may encounter authentication issues.
This is due to Git on OSX using the Keychain Access Utility.

Check warning on line 14 in source/user-guide/containers-and-docker/configure-docker-helper.rst

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Fio-docs.expand-acronyms] 'OSX' has no definition, definition is missing capitalization, or is a variable name and should be written as a literal.

Raw Output:
{"message": "[Fio-docs.expand-acronyms] 'OSX' has no definition, definition is missing capitalization, or is a variable name and should be written as a literal.", "location": {"path": "source/user-guide/containers-and-docker/configure-docker-helper.rst", "range": {"start": {"line": 14, "column": 26}}}, "severity": "WARNING"}
Git attempts to use this for authentication before ``git-credential-fio``.

The solution is to remove Keychain Access entries from your git config file.
Locate the git config by running::

git config -l --show-origin | grep credential

Edit the gitconfig file with ``credential.helper=osxkeychain``, commenting out the line.

Fioctl should now be able to authenticate.

To do this, run:

.. code:: bash
Expand Down
Loading