summaryrefslogtreecommitdiff
path: root/docs/source/markdown/podman-system-connection-add.1.md
diff options
context:
space:
mode:
authorJhon Honce <jhonce@redhat.com>2020-07-21 10:36:44 -0700
committerJhon Honce <jhonce@redhat.com>2020-07-22 15:25:44 -0700
commit964d3300c657047bb16c261e3ca5bdf4e0e1c3e5 (patch)
tree7c7e3c1a23ab3c9c5db61f5a45bedd4a300f9723 /docs/source/markdown/podman-system-connection-add.1.md
parent1aac197f79e91b06ec7e948bd73bb2464e8a508f (diff)
downloadpodman-964d3300c657047bb16c261e3ca5bdf4e0e1c3e5.tar.gz
podman-964d3300c657047bb16c261e3ca5bdf4e0e1c3e5.tar.bz2
podman-964d3300c657047bb16c261e3ca5bdf4e0e1c3e5.zip
[WIP] Refactor podman system connection
* Add support to manage multiple connections * Add connection * Remove connection * Rename connection * Set connection as default * Add markdown/man pages * Fix recursion in hack/xref-helpmsgs-manpages Signed-off-by: Jhon Honce <jhonce@redhat.com>
Diffstat (limited to 'docs/source/markdown/podman-system-connection-add.1.md')
-rw-r--r--docs/source/markdown/podman-system-connection-add.1.md46
1 files changed, 46 insertions, 0 deletions
diff --git a/docs/source/markdown/podman-system-connection-add.1.md b/docs/source/markdown/podman-system-connection-add.1.md
new file mode 100644
index 000000000..5059803a2
--- /dev/null
+++ b/docs/source/markdown/podman-system-connection-add.1.md
@@ -0,0 +1,46 @@
+% podman-system-connection-add(1)
+
+## NAME
+podman\-system\-connection\-add - Record destination for the Podman service
+
+## SYNOPSIS
+**podman system connection add** [*options*] *name* *destination*
+
+## DESCRIPTION
+Record ssh destination for remote podman service(s). The ssh destination is given as one of:
+ - [user@]hostname[:port]
+ - ssh://[user@]hostname[:port]
+
+The user will be prompted for the remote ssh login password or key file pass phrase as required. The `ssh-agent` is supported if it is running.
+
+## OPTIONS
+
+**-d**, **--default**=*false*
+
+Make the new destination the default for this user.
+
+**--identity**=*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.
+
+**-p**, **--port**=*port*
+
+Port for ssh destination. The default value is `22`.
+
+**--socket-path**=*path*
+
+Path to the Podman service unix domain socket on the ssh destination host
+
+## EXAMPLE
+```
+$ podman system connection add QA podman.example.com
+
+$ podman system connection add --identity ~/.ssh/dev_rsa production ssh://root@server.example.com:2222
+```
+## SEE ALSO
+podman-system(1) , podman-system-connection(1) , containers.conf(5)
+
+## HISTORY
+June 2020, Originally compiled by Jhon Honce (jhonce at redhat dot com)