diff options
| author | Nalin Dahyabhai <nalin@redhat.com> | 2022-02-02 17:53:42 -0500 |
|---|---|---|
| committer | Matthew Heon <matthew.heon@pm.me> | 2022-02-03 15:02:53 -0500 |
| commit | 99968002fb7aa5fe7af681932606876d8c6a99da (patch) | |
| tree | c0f8eee75e65bcba162ef3879f25e224facefd36 /docs/source/markdown/podman-remote.1.md | |
| parent | 6d747dca22c8a232273be468304d59c6fe802d5d (diff) | |
| download | podman-99968002fb7aa5fe7af681932606876d8c6a99da.tar.gz podman-99968002fb7aa5fe7af681932606876d8c6a99da.tar.bz2 podman-99968002fb7aa5fe7af681932606876d8c6a99da.zip | |
Document `schema` values in the `--url` flag
Document the recognized `schema` types that can be used in a value
passed to the `--url` command line flag.
[CI:DOCS]
Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
Diffstat (limited to 'docs/source/markdown/podman-remote.1.md')
| -rw-r--r-- | docs/source/markdown/podman-remote.1.md | 26 |
1 files changed, 20 insertions, 6 deletions
diff --git a/docs/source/markdown/podman-remote.1.md b/docs/source/markdown/podman-remote.1.md index 72c8d7226..e87129e38 100644 --- a/docs/source/markdown/podman-remote.1.md +++ b/docs/source/markdown/podman-remote.1.md @@ -57,18 +57,32 @@ URL to access Podman service (default from `containers.conf`, rootless "unix://r - `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. + - `schema` is one of: + * `ssh` (default): a local unix(7) socket on the named `host` and `port`, reachable via SSH + * `tcp`: an unencrypted, unauthenticated TCP connection to the named `host` and `port` + * `unix`: a local unix(7) socket at the specified `path`, or the default for the user + - `user` will default to either `root` or the current running user (`ssh` only) + - `password` has no default (`ssh` only) + - `host` must be provided and is either the IP or name of the machine hosting the Podman service (`ssh` and `tcp`) + - `port` defaults to 22 (`ssh` and `tcp`) + - `path` defaults to either `/run/podman/podman.sock`, or `/run/user/$UID/podman/podman.sock` if running rootless (`unix`), or must be explicitly specified (`ssh`) URL value resolution precedence: - command line value - environment variable `CONTAINER_HOST` - - `containers.conf` + - `containers.conf` `service_destinations` table - `unix://run/podman/podman.sock` +Remote connections use local containers.conf for default. + +Some example URL values in valid formats: + - unix://run/podman/podman.sock + - unix://run/user/$UID/podman/podman.sock + - ssh://notroot@localhost:22/run/user/$UID/podman/podman.sock + - ssh://root@localhost:22/run/podman/podman.sock + - tcp://localhost:34451 + - tcp://127.0.0.1:34451 + #### **--version** Print the version |