diff options
| author | Ed Santiago <santiago@redhat.com> | 2020-08-27 12:57:51 -0600 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-08-27 12:57:51 -0600 |
| commit | 72c5b35ea5db44ca1c81a688d90f5c3aa8f8262e (patch) | |
| tree | a6124a25a79973cdb5a76b565db903ed1bdc733f /docs/source | |
| parent | b13af4537fea0647c029067c664f1e79e0a6c3e6 (diff) | |
| parent | 7dce7a64ca7fa4b2fec418509bf8a57c232e5102 (diff) | |
| download | podman-72c5b35ea5db44ca1c81a688d90f5c3aa8f8262e.tar.gz podman-72c5b35ea5db44ca1c81a688d90f5c3aa8f8262e.tar.bz2 podman-72c5b35ea5db44ca1c81a688d90f5c3aa8f8262e.zip | |
Merge pull request #7458 from Luap99/fix-remote-docs
[CI:DOCS] Update podman-remote docs
Diffstat (limited to 'docs/source')
| -rw-r--r-- | docs/source/markdown/podman-remote.1.md | 30 |
1 files changed, 11 insertions, 19 deletions
diff --git a/docs/source/markdown/podman-remote.1.md b/docs/source/markdown/podman-remote.1.md index 23ccaf0e6..3dcfae606 100644 --- a/docs/source/markdown/podman-remote.1.md +++ b/docs/source/markdown/podman-remote.1.md @@ -17,7 +17,9 @@ Podman uses Buildah(1) internally to create container images. Both tools share i (not container) storage, hence each can use or manipulate images (but not containers) created by the other. -Podman-remote provides a local client interacting with a Podman backend node through a RESTful API tunneled through a ssh connection. In this context, a Podman node is a Linux system with Podman installed on it and the API service activated. Credentials for this session can be passed in using flags, environment variables, or in `podman-remote.conf` +Podman-remote provides a local client interacting with a Podman backend node through a RESTful API tunneled through a ssh connection. In this context, a Podman node is a Linux system with Podman installed on it and the API service activated. Credentials for this session can be passed in using flags, environment variables, or in `containers.conf`. + +The `containers.conf` file should be placed under `$HOME/.config/containers/containers.conf` on Linux and Mac and `%APPDATA%\containers\containers.conf` on Windows. **podman [GLOBAL OPTIONS]** @@ -31,29 +33,19 @@ Remote connection name Print usage statement -**--log-level**=*level* - -Log messages above specified level: debug, info, warn, error (default), fatal or panic - -**--port**=*integer* - -Use an alternative port for the ssh connections. The default port is 22 +**--identity**=*path* -**--remote-config-path**=*path* +Path to ssh identity file. If the identity file has been encrypted, Podman prompts the user for the passphrase. +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. -Alternate path for configuration file - -**--remote-host**=*ip* - -Remote host IP - -**--syslog** +**--log-level**=*level* -Output logging information to syslog as well as the console +Log messages above specified level: debug, info, warn, error (default), fatal or panic -**--username**=*string* +**--url**=*value* -Username on the remote host (defaults to current username) +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). **--version** |