containers
/
automation-tests
mirror of https://github.com/containers/automation-tests.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #7584 from QiWang19/login-doc 

[CI:DOCS] Add auth.json(5) link to login/logout docs
This commit is contained in:
OpenShift Merge Robot 2020-09-11 05:29:27 -04:00 committed by GitHub
parent 10ba232b34 8467cd3d2e
commit 2bdb177b55
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/source/markdown/podman-login.1.md
View File

@ -12,9 +12,13 @@ and password. If the registry is not specified, the first registry under [regist
from registries.conf will be used. **podman login** reads in the username and password from STDIN. from registries.conf will be used. **podman login** reads in the username and password from STDIN.
The username and password can also be set using the **username** and **password** flags. The username and password can also be set using the **username** and **password** flags.
The path of the authentication file can be specified by the user by setting the **authfile** The path of the authentication file can be specified by the user by setting the **authfile**
flag. The default path used is **${XDG\_RUNTIME\_DIR}/containers/auth.json**. If there is a valid flag. The default path for reading and writing credentials is **${XDG\_RUNTIME\_DIR}/containers/auth.json**.
username and password in the **authfile** , Podman will use those existing credentials if the user does not pass in a username. Podman will use existing credentials if the user does not pass in a username.
If those credentials are not present, Podman will then use any existing credentials found in **$HOME/.docker/config.json**. Podman will first search for the username and password in the **${XDG\_RUNTIME\_DIR}/containers/auth.json**, if they are not valid,
Podman will then use any existing credentials found in **$HOME/.docker/config.json**.
If those credentials are not present, Podman will create **${XDG\_RUNTIME\_DIR}/containers/auth.json** (if the file does not exist) and
will then store the username and password from STDIN as a base64 encoded string in it.
For more details about format and configurations of the auth,json file, please refer to containers-auth.json(5)
**podman [GLOBAL OPTIONS]** **podman [GLOBAL OPTIONS]**
@ -104,7 +108,7 @@ Login Succeeded!
``` ```
## SEE ALSO ## SEE ALSO
podman(1), podman-logout(1) podman(1), podman-logout(1), containers-auth.json(5)
## HISTORY ## HISTORY
August 2017, Originally compiled by Urvashi Mohnani <umohnani@redhat.com> August 2017, Originally compiled by Urvashi Mohnani <umohnani@redhat.com>

4
docs/source/markdown/podman-logout.1.md
View File

@ -10,7 +10,7 @@ podman\-logout - Logout of a container registry
**podman logout** logs out of a specified registry server by deleting the cached credentials **podman logout** logs out of a specified registry server by deleting the cached credentials
stored in the **auth.json** file. If the registry is not specified, the first registry under [registries.search] stored in the **auth.json** file. If the registry is not specified, the first registry under [registries.search]
from registries.conf will be used. The path of the authentication file can be overridden by the user by setting the **authfile** flag. from registries.conf will be used. The path of the authentication file can be overridden by the user by setting the **authfile** flag.
The default path used is **${XDG\_RUNTIME\_DIR}/containers/auth.json**. The default path used is **${XDG\_RUNTIME\_DIR}/containers/auth.json**. For more details about format and configurations of the auth,json file, please refer to containers-auth.json(5)
All the cached credentials can be removed by setting the **all** flag. All the cached credentials can be removed by setting the **all** flag.
**podman [GLOBAL OPTIONS]** **podman [GLOBAL OPTIONS]**
@ -54,7 +54,7 @@ Remove login credentials for all registries
``` ```
## SEE ALSO ## SEE ALSO
podman(1), podman-login(1) podman(1), podman-login(1), containers-auth.json(5)
## HISTORY ## HISTORY
August 2017, Originally compiled by Urvashi Mohnani <umohnani@redhat.com> August 2017, Originally compiled by Urvashi Mohnani <umohnani@redhat.com>