opensource/podman
1
0
Fork 0
mirror of https://github.com/containers/podman.git synced 2025-07-15 03:02:52 +08:00
Code Issues Packages Projects Releases Wiki Activity

Document schema values in the --url flag

Browse Source 
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>
This commit is contained in:
Nalin Dahyabhai
2022-02-02 17:53:42 -05:00
parent 21a8ee9044
commit fee76f6abc
2 changed files with 40 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
docs/source/markdown/podman-remote.1.md
View File

@ -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>]` - `CONTAINER_HOST` is of the format `<schema>://[<user[:<password>]@]<host>[:<port>][<path>]`
Details: Details:
- `user` will default to either `root` or current running user - `schema` is one of:
- `password` has no default * `ssh` (default): a local unix(7) socket on the named `host` and `port`, reachable via SSH
- `host` must be provided and is either the IP or name of the machine hosting the Podman service * `tcp`: an unencrypted, unauthenticated TCP connection to the named `host` and `port`
- `port` defaults to 22 * `unix`: a local unix(7) socket at the specified `path`, or the default for the user
- `path` defaults to either `/run/podman/podman.sock`, or `/run/user/<uid>/podman/podman.sock` if running rootless. - `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: URL value resolution precedence:
- command line value - command line value
- environment variable `CONTAINER_HOST` - environment variable `CONTAINER_HOST`
- `containers.conf` - `containers.conf` `service_destinations` table
- `unix://run/podman/podman.sock` - `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** #### **--version**
Print the version Print the version

28
docs/source/markdown/podman.1.md
View File

@ -101,11 +101,10 @@ Path to the command binary to use for setting up a network. It is currently onl
Redirect stdout to /dev/null. This command will prevent all stdout from the Podman command. The **--noout** option will not block stderr or stdout from containers. Redirect stdout to /dev/null. This command will prevent all stdout from the Podman command. The **--noout** option will not block stderr or stdout from containers.
#### **--remote**, **-r** #### **--remote**, **-r**
When true, access to the Podman service will be remote. Defaults to false. When true, access to the Podman service will be remote. Defaults to false.
Settings can be modified in the containers.conf file. If the CONTAINER_HOST Settings can be modified in the containers.conf file. If the CONTAINER_HOST
environment variable is set, the remote option defaults to true. environment variable is set, the **--remote** option defaults to true.
#### **--url**=*value* #### **--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`).
@ -113,19 +112,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>]` - `CONTAINER_HOST` is of the format `<schema>://[<user[:<password>]@]<host>[:<port>][<path>]`
Details: Details:
- `user` will default to either `root` or current running user - `schema` is one of:
- `password` has no default * `ssh` (default): a local unix(7) socket on the named `host` and `port`, reachable via SSH
- `host` must be provided and is either the IP or name of the machine hosting the Podman service * `tcp`: an unencrypted, unauthenticated TCP connection to the named `host` and `port`
- `port` defaults to 22 * `unix`: a local unix(7) socket at the specified `path`, or the default for the user
- `path` defaults to either `/run/podman/podman.sock`, or `/run/user/<uid>/podman/podman.sock` if running rootless. - `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: URL value resolution precedence:
- command line value - command line value
- environment variable `CONTAINER_HOST` - environment variable `CONTAINER_HOST`
- `containers.conf` - `containers.conf` `service_destinations` table
- `unix://run/podman/podman.sock` - `unix://run/podman/podman.sock`
Remote connections use local containers.conf for default. 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
#### **--root**=*value* #### **--root**=*value*
Storage root dir in which data, including images, is stored (default: "/var/lib/containers/storage" for UID 0, "$HOME/.local/share/containers/storage" for other users). Storage root dir in which data, including images, is stored (default: "/var/lib/containers/storage" for UID 0, "$HOME/.local/share/containers/storage" for other users).