summaryrefslogtreecommitdiff
path: root/docs/source/man/podman-login.1.md
diff options
context:
space:
mode:
authorbaude <bbaude@redhat.com>2019-10-24 14:54:57 -0500
committerbaude <bbaude@redhat.com>2019-10-31 12:31:39 -0500
commit52b92023edeba3a5e2c466d92d742e54b14a85cb (patch)
tree44e6193d49afd1277b7d07b0df41fc80d31b3adb /docs/source/man/podman-login.1.md
parent5af166ff513265b17aee92a9ce3a1522090d7dec (diff)
downloadpodman-52b92023edeba3a5e2c466d92d742e54b14a85cb.tar.gz
podman-52b92023edeba3a5e2c466d92d742e54b14a85cb.tar.bz2
podman-52b92023edeba3a5e2c466d92d742e54b14a85cb.zip
Restructure documentation dir
Restructuring the docs dir to make integration with sphinx easier. man pages now exist in docs/source/man and the sphinx make files exists in docs. Signed-off-by: baude <bbaude@redhat.com>
Diffstat (limited to 'docs/source/man/podman-login.1.md')
-rw-r--r--docs/source/man/podman-login.1.md107
1 files changed, 107 insertions, 0 deletions
diff --git a/docs/source/man/podman-login.1.md b/docs/source/man/podman-login.1.md
new file mode 100644
index 000000000..9d368e9f2
--- /dev/null
+++ b/docs/source/man/podman-login.1.md
@@ -0,0 +1,107 @@
+% podman-login(1)
+
+## NAME
+podman\-login - Login to a container registry
+
+## SYNOPSIS
+**podman login** [*options*] *registry*
+
+## DESCRIPTION
+**podman login** logs into a specified registry server with the correct username
+and password. **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 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**.
+
+**podman [GLOBAL OPTIONS]**
+
+**podman login [GLOBAL OPTIONS]**
+
+**podman login [OPTIONS] REGISTRY [GLOBAL OPTIONS]**
+
+## OPTIONS
+
+**--password**, **-p**=*password*
+
+Password for registry
+
+**--password-stdin**
+
+Take the password from stdin
+
+**--username**, **-u=***username*
+
+Username for registry
+
+**--authfile**=*path*
+
+Path of the authentication file. Default is ${XDG\_RUNTIME\_DIR}/containers/auth.json (Not available for remote commands)
+
+Note: You can also override the default path of the authentication file by setting the REGISTRY\_AUTH\_FILE
+environment variable. `export REGISTRY_AUTH_FILE=path`
+
+**--get-login**
+
+Return the logged-in user for the registry. Return error if no login is found.
+
+**--cert-dir**=*path*
+
+Use certificates at *path* (\*.crt, \*.cert, \*.key) to connect to the registry.
+Default certificates directory is _/etc/containers/certs.d_. (Not available for remote commands)
+
+**--tls-verify**=*true|false*
+
+Require HTTPS and verify certificates when contacting registries (default: true). If explicitly set to true,
+then TLS verification will be used. If set to false, then TLS verification will not be used. If not specified,
+TLS verification will be used unless the target registry is listed as an insecure registry in registries.conf. (Not available for remote commands)
+
+**--help**, **-h**
+
+Print usage statement
+
+## EXAMPLES
+
+```
+$ podman login docker.io
+Username: umohnani
+Password:
+Login Succeeded!
+```
+
+```
+$ podman login -u testuser -p testpassword localhost:5000
+Login Succeeded!
+```
+
+```
+$ podman login --authfile authdir/myauths.json docker.io
+Username: umohnani
+Password:
+Login Succeeded!
+```
+
+```
+$ podman login --tls-verify=false -u test -p test localhost:5000
+Login Succeeded!
+```
+
+```
+$ podman login --cert-dir /etc/containers/certs.d/ -u foo -p bar localhost:5000
+Login Succeeded!
+```
+
+```
+$ podman login -u testuser --password-stdin < testpassword.txt docker.io
+Login Succeeded!
+```
+
+```
+$ echo $testpassword | podman login -u testuser --password-stdin docker.io
+Login Succeeded!
+```
+
+## SEE ALSO
+podman(1), podman-logout(1)
+
+## HISTORY
+August 2017, Originally compiled by Urvashi Mohnani <umohnani@redhat.com>