From 7b508e3100f4096eadcd8e579b395e4133944d61 Mon Sep 17 00:00:00 2001 From: TomSweeneyRedHat Date: Tue, 18 Feb 2020 14:03:49 -0500 Subject: [PATCH] Intial authfile man page The initial man page for the authfile used by the container tools. Fixes: https://github.com/containers/libpod/issues/4359 Signed-off-by: TomSweeneyRedHat --- docs/containers-auth.json.5.md | 43 ++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 docs/containers-auth.json.5.md diff --git a/docs/containers-auth.json.5.md b/docs/containers-auth.json.5.md new file mode 100644 index 000000000..16e4d7bc3 --- /dev/null +++ b/docs/containers-auth.json.5.md @@ -0,0 +1,43 @@ +% containers-auth.json(5) + +# NAME +containers-auth.json - syntax for the registry authentication file + +# DESCRIPTION + +A credentials file stored at `${XDG_RUNTIME_DIR}/containers/auth.json` in +json format used to authenticate against container image registries. + +## FORMAT + +The auth.json file stores encrypted authentication information for the +user to container image registries. The file can have zero to many entries and +is created by a `login` command from a container tool such as `podman login` or +`buildah login`. Each entry includes the name of the registry and then an auth +token in the form of a base64 encoded string from the concatenation of the +username, a colon, and the password. + +The following example shows the values found in auth.json after the user logged in to +their accounts on quay.io and docker.io: + +``` +{ + "auths": { + "docker.io": { + "auth": "erfi7sYi89234xJUqaqxgmzcnQ2rRFWM5aJX0EC=" + }, + "quay.io": { + "auth": "juQAqGmz5eR1ipzx8Evn6KGdw8fEa1w5MWczmgY=" + } + } +} +``` + +An entry can be removed by using a `logout` command from a container +tool such as `podman logout` or `buildah logout`. + +# SEE ALSO + buildah-login(1), buildah-logout(1), podman-login(1), podman-logout(1) + +# HISTORY +Feb 2020, Originally compiled by Tom Sweeney