From a0e3ec87909320e1d8214ded8f8b42cea3f3a829 Mon Sep 17 00:00:00 2001 From: Thomas Riccardi Date: Wed, 3 Oct 2018 20:04:24 +0200 Subject: [PATCH] Fix login documentation layout ddadd3db494ce568a6b847932677f837802ea6b5 mass standardized the formatting, with some errors. This commit fixes errors on `login.md`: - revert wrong `Logging out` headline - restore correct level for some headlines (relative to parent headline level change) - re-add `Usage` headlines, with better name Also add `related commands` headline on `login` and `logout`. Signed-off-by: Thomas Riccardi --- docs/reference/commandline/login.md | 12 +++++++++--- docs/reference/commandline/logout.md | 4 ++++ 2 files changed, 13 insertions(+), 3 deletions(-) diff --git a/docs/reference/commandline/login.md b/docs/reference/commandline/login.md index 3ebeec3d41..95d14d2b55 100644 --- a/docs/reference/commandline/login.md +++ b/docs/reference/commandline/login.md @@ -85,6 +85,8 @@ you can download them from: - 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 +#### Configure the credentials store + You need to specify the credentials 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-`). @@ -99,7 +101,7 @@ For example, to use `docker-credential-osxkeychain`: If you are currently logged in, run `docker logout` to remove the credentials from the file and run `docker login` again. -### Default behavior +#### Default behavior By default, Docker looks for the native binary on each of the platforms, i.e. "osxkeychain" on macOS, "wincred" on windows, and "pass" on Linux. A special @@ -108,7 +110,7 @@ it cannot find the "pass" binary. If none of these binaries are present, it stores the credentials (i.e. password) in base64 encoding in the config files described above. -### Credential helper protocol +#### Credential helper protocol Credential helpers can be any program or script that follows a very simple protocol. This protocol is heavily inspired by Git, but it differs in the information shared. @@ -162,7 +164,7 @@ designated programs to handle credentials for *specific registries*. The default credential store (`credsStore` or the config file itself) will not be used for operations concerning credentials of the specified registries. -### Logging out +#### Configure credential helpers If you are currently logged in, run `docker logout` to remove the credentials from the default store. @@ -182,3 +184,7 @@ For example: } } ``` + +## Related commands + +* [logout](logout.md) diff --git a/docs/reference/commandline/logout.md b/docs/reference/commandline/logout.md index f930fe7b7c..19762b2a36 100644 --- a/docs/reference/commandline/logout.md +++ b/docs/reference/commandline/logout.md @@ -30,3 +30,7 @@ Options: ```bash $ docker logout localhost:8080 ``` + +## Related commands + +* [login](login.md)