diff options
| author | baude <bbaude@redhat.com> | 2019-05-28 09:21:22 -0500 |
|---|---|---|
| committer | baude <bbaude@redhat.com> | 2019-05-30 09:41:17 -0500 |
| commit | dc7ae3117146aa4e91d454b4b1afa03058638b13 (patch) | |
| tree | 4ece06385c0b91373234050ec05ba995d3906a0d /docs | |
| parent | 8a8db34131c213c3880940284c2fa278ae48cd7d (diff) | |
| download | podman-dc7ae3117146aa4e91d454b4b1afa03058638b13.tar.gz podman-dc7ae3117146aa4e91d454b4b1afa03058638b13.tar.bz2 podman-dc7ae3117146aa4e91d454b4b1afa03058638b13.zip | |
podman-remote.conf enablement
add the ability for the podman remote client to use a configuration file
which describes its connections. users can now define a connection the
configuration and then call it by name like:
podman-remote -c connection1
and the destination and user will be derived from the configuration
file. if no -c is provided, we look for a connection in the
configuration file designated as 'default'. If the configuration file
has only one connection, it will be deemed the 'default'.
Signed-off-by: baude <bbaude@redhat.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/podman-remote.conf.5.md | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/docs/podman-remote.conf.5.md b/docs/podman-remote.conf.5.md new file mode 100644 index 000000000..3e1cffb02 --- /dev/null +++ b/docs/podman-remote.conf.5.md @@ -0,0 +1,47 @@ +% podman-remote.conf(5) + +## NAME +podman-remote.conf - configuration file for the podman remote client + +## DESCRIPTION +The libpod.conf file is the default configuration file for all tools using +libpod to manage containers. + +The podman-remote.conf file is the default configuration file for the podman +remote client. It is in the TOML format. It is primarily used to keep track +of the user's remote connections. + +## CONNECTION OPTIONS +**destination** = "" + The hostname or IP address of the remote system + +**username** = "" + The username to use when connecting to the remote system + +**default** = bool + Denotes whether the connection is the default connection for the user. The default connection + is used when the user does not specify a destination or connection name to `podman`. + + +## EXAMPLE + +The following example depicts a configuration file with two connections. One of the connections +is designated as the default connection. +``` +[connections] + [connections.host1] + destination = "host1" + username = "homer" + default = true + + [connections.host2] + destination = "192.168.122.133" + username = "fedora" +``` + +## FILES + `/$HOME/.config/containers/podman-remote.conf`, default location for the podman remote +configuration file + +## HISTORY +May 2019, Originally compiled by Brent Baude<bbaude@redhat.com> |