Skip to content

Commit

Permalink
Merge pull request #4425 from thaJeztah/24.0_backport_credential-stor…
Browse files Browse the repository at this point in the history
…e-improvements

[24.0 backport] docs: rephrase section on credential stores for docker login
  • Loading branch information
thaJeztah authored Jul 17, 2023
2 parents 809975d + 1447974 commit dd08d44
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 12 deletions.
2 changes: 1 addition & 1 deletion docs/reference/commandline/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,7 @@ credential store. When this property is set, `docker login` will attempt to
store credentials in the binary specified by `docker-credential-<value>` which
is visible on `$PATH`. If this property is not set, credentials will be stored
in the `auths` property of the config. For more information, see the
[**Credentials store** section in the `docker login` documentation](login.md#credentials-store)
[**Credential stores** section in the `docker login` documentation](login.md#credential-stores)

The property `credHelpers` specifies a set of credential helpers to use
preferentially over `credsStore` or `auths` when storing and retrieving
Expand Down
23 changes: 12 additions & 11 deletions docs/reference/commandline/login.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,27 +56,28 @@ credentials. When you log in, the command stores credentials in
`$HOME/.docker/config.json` on Linux or `%USERPROFILE%/.docker/config.json` on
Windows, via the procedure described below.

### Credentials store
### Credential stores

The Docker Engine can keep user credentials in an external credentials store,
The Docker Engine can keep user credentials in an external credential store,
such as the native keychain of the operating system. Using an external store
is more secure than storing credentials in the Docker configuration file.

To use a credentials store, you need an external helper program to interact
To use a credential store, you need an external helper program to interact
with a specific keychain or external store. Docker requires the helper
program to be in the client's host `$PATH`.

This is the list of currently available credentials helpers and where
you can download them from:
You can download the helpers from the `docker-credential-helpers`
[releases page](https://github.com/docker/docker-credential-helpers/releases).
Helpers are available for the following credential stores:

- D-Bus Secret Service: https://github.com/docker/docker-credential-helpers/releases
- Apple macOS keychain: https://github.com/docker/docker-credential-helpers/releases
- Microsoft Windows Credential Manager: https://github.com/docker/docker-credential-helpers/releases
- [pass](https://www.passwordstore.org/): https://github.com/docker/docker-credential-helpers/releases
- D-Bus Secret Service
- Apple macOS keychain
- Microsoft Windows Credential Manager
- [pass](https://www.passwordstore.org/)

#### Configure the credentials store
#### Configure the credential store

You need to specify the credentials store in `$HOME/.docker/config.json`
You need to specify the credential store in `$HOME/.docker/config.json`
to tell the docker engine to use it. The value of the config property should be
the suffix of the program to use (i.e. everything after `docker-credential-`).
For example, to use `docker-credential-osxkeychain`:
Expand Down

0 comments on commit dd08d44

Please sign in to comment.