Skip to content

Updates to README.md to clarify confusion. #434

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
csjewell wants to merge 2 commits into
base: main
Choose a base branch
from
+2 −2
Open

Updates to README.md to clarify confusion. #434

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1f11b47
Link to pass web site
csjewell May 9, 2026
946968d
Specify file name in installation directions
csjewell May 9, 2026
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
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ docker-credential-helpers is a suite of programs to use native stores to keep Do

## Installation

Go to the [Releases](https://github.com/docker/docker-credential-helpers/releases) page and download the binary that works better for you. Put that binary in your `$PATH`, so Docker can find it.
Go to the [Releases](https://github.com/docker/docker-credential-helpers/releases) page and download the binary that works better for you. Put that binary - removing the portion of the name that specifies the version, OS, and architecture, leaving it named "docker-credential-_X_" (where _X_ is pass, secretservice, osxkeychain, or wincred) - in your `$PATH`, so Docker can find it.

## Building

Expand Down Expand Up @@ -87,7 +87,7 @@ You can see examples of each function in the [client](https://godoc.org/github.c

#### Note

`pass` needs to be configured for `docker-credential-pass` to work properly.
[`pass`](https://www.passwordstore.org/) needs to be installed and configured for `docker-credential-pass` to work properly.
It must be initialized with a `gpg2` key ID. Make sure your GPG key exists is in `gpg2` keyring as `pass` uses `gpg2` instead of the regular `gpg`.

## Development
Expand Down