diff options
author | Morten Linderud <morten@linderud.pw> | 2019-11-02 13:48:47 +0100 |
---|---|---|
committer | Morten Linderud <morten@linderud.pw> | 2019-11-02 13:48:47 +0100 |
commit | 079164c39193ee35641e2f4b680d8e69fe553625 (patch) | |
tree | bef00e36cb26f9e636684012fe30836b15081ce3 /docs/source/markdown/podman-remote.conf.5.md | |
parent | 9558797fb7bb019810d18f7acdde93adc35d02cc (diff) | |
download | podman-079164c39193ee35641e2f4b680d8e69fe553625.tar.gz podman-079164c39193ee35641e2f4b680d8e69fe553625.tar.bz2 podman-079164c39193ee35641e2f4b680d8e69fe553625.zip |
[docs] Ensure we include section 5 documentation
Section 5 documentation is missing from the documentation restructure.
Signed-off-by: Morten Linderud <morten@linderud.pw>
Diffstat (limited to 'docs/source/markdown/podman-remote.conf.5.md')
-rw-r--r-- | docs/source/markdown/podman-remote.conf.5.md | 57 |
1 files changed, 57 insertions, 0 deletions
diff --git a/docs/source/markdown/podman-remote.conf.5.md b/docs/source/markdown/podman-remote.conf.5.md new file mode 100644 index 000000000..e9cc05989 --- /dev/null +++ b/docs/source/markdown/podman-remote.conf.5.md @@ -0,0 +1,57 @@ +% 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`. + +**port** = int + Use an alternative port for the ssh connections. The default port is 22. + +**identity_file** = "" + Use an alternative location for the ssh private key + +**ignore_hosts** = bool + Don't match the remote ssh host key with known hosts + + +## 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" + port = 2222 +``` + +## 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> |