Files
podman/docs/source/markdown/podman-logout.1.md.in
Daniel J Walsh fe910ae96d Fix up example description of podman-logout.1.md.in
Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
2024-02-18 19:10:40 -05:00

60 lines
1.8 KiB
Markdown

% podman-logout 1
## NAME
podman\-logout - Log out of a container registry
## SYNOPSIS
**podman logout** [*options*] *registry*
## DESCRIPTION
**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]
from registries.conf is 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**. For more details about format and configurations of the auth,json file, see containers-auth.json(5)
All the cached credentials can be removed by setting the **all** flag.
**podman [GLOBAL OPTIONS]**
**podman logout [GLOBAL OPTIONS]**
**podman logout [OPTIONS] REGISTRY [GLOBAL OPTIONS]**
## OPTIONS
#### **--all**, **-a**
Remove the cached credentials for all registries in the auth file
@@option authfile
#### **--compat-auth-file**=*path*
Instead of updating the default credentials file, update the one at *path*, and use a Docker-compatible format.
#### **--help**, **-h**
Print usage statement
## EXAMPLES
Remove login credentials for the docker.io registry from the authentication file:
```
$ podman logout docker.io
```
Remove login credentials for the docker.io registry from the authdir/myauths.json file:
```
$ podman logout --authfile authdir/myauths.json docker.io
```
Remove login credentials for all registries:
```
$ podman logout --all
```
## SEE ALSO
**[podman(1)](podman.1.md)**, **[podman-login(1)](podman-login.1.md)**, **[containers-auth.json(5)](https://github.com/containers/image/blob/main/docs/containers-auth.json.5.md)**
## HISTORY
August 2017, Originally compiled by Urvashi Mohnani <umohnani@redhat.com>