summaryrefslogtreecommitdiff
path: root/docs/source/markdown/podman.1.md
diff options
context:
space:
mode:
authorDaniel J Walsh <dwalsh@redhat.com>2020-09-12 06:35:44 -0400
committerDaniel J Walsh <dwalsh@redhat.com>2020-09-14 17:06:24 -0400
commit48927f186d776a4679f7851d64747a7bc5f437bd (patch)
treef49f7a266c35b089050abd3d5a92f6e053c71dcc /docs/source/markdown/podman.1.md
parentfd7cdb25027bb33c33eacb99f1a02838eca5d684 (diff)
downloadpodman-48927f186d776a4679f7851d64747a7bc5f437bd.tar.gz
podman-48927f186d776a4679f7851d64747a7bc5f437bd.tar.bz2
podman-48927f186d776a4679f7851d64747a7bc5f437bd.zip
Document the connection path for podman --remote
Issue: GH-7010 Signed-off-by: Jhon Honce <jhonce@redhat.com> Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
Diffstat (limited to 'docs/source/markdown/podman.1.md')
-rw-r--r--docs/source/markdown/podman.1.md22
1 files changed, 21 insertions, 1 deletions
diff --git a/docs/source/markdown/podman.1.md b/docs/source/markdown/podman.1.md
index 2dc6b13bf..555486562 100644
--- a/docs/source/markdown/podman.1.md
+++ b/docs/source/markdown/podman.1.md
@@ -67,6 +67,11 @@ Path to ssh identity file. If the identity file has been encrypted, podman promp
If no identity file is provided and no user is given, podman defaults to the user running the podman command.
Podman prompts for the login password on the remote server.
+Identity value resolution precedence:
+ - command line value
+ - environment variable `CONTAINER_SSHKEY`, if `CONTAINER_HOST` is found
+ - `containers.conf`
+
**--log-level**=*level*
Log messages above specified level: debug, info, warn, error (default), fatal or panic (default: "error")
@@ -83,7 +88,22 @@ Path to the command binary to use for setting up a network. It is currently onl
Access Podman service will be remote
**--url**=*value*
-URL to access Podman service (default from `containers.conf`, rootless "unix://run/user/$UID/podman/podman.sock" or as root "unix://run/podman/podman.sock).
+URL to access Podman service (default from `containers.conf`, rootless `unix://run/user/$UID/podman/podman.sock` or as root `unix://run/podman/podman.sock`).
+
+ - `CONTAINER_HOST` is of the format `<schema>://[<user[:<password>]@]<host>[:<port>][<path>]`
+
+Details:
+ - `user` will default to either `root` or current running user
+ - `password` has no default
+ - `host` must be provided and is either the IP or name of the machine hosting the Podman service
+ - `port` defaults to 22
+ - `path` defaults to either `/run/podman/podman.sock`, or `/run/user/<uid>/podman/podman.sock` if running rootless.
+
+URL value resolution precedence:
+ - command line value
+ - environment variable `CONTAINER_HOST`
+ - `containers.conf`
+ - `unix://run/podman/podman.sock`
**--root**=*value*