haskal
/
vagrant
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Include SSH client usage note in documentation

This commit is contained in:
Chris Roberts 2018-01-26 07:25:57 -08:00
parent a9fc91b73f
commit 81a3386af0
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
website/source/docs/cli/ssh.html.md
View File

@ -26,6 +26,19 @@ any arbitrary commands to do things such as reverse tunneling down into the
* `-p` or `--plain` - This does an SSH without authentication, leaving * `-p` or `--plain` - This does an SSH without authentication, leaving
authentication up to the user. authentication up to the user.
## SSH client usage
Vagrant will attempt to use the local SSH client installed on the host machine. On
POSIX machines, an SSH client must be installed and available on the PATH.
For Windows installations, an SSH client is provided within the installer
image. If no SSH client is found on the current PATH, Vagrant will use the
SSH client it provided. Depending on the local environment used for running
Vagrant, the installer provided SSH client may not work correctly. For example,
when using a cygwin or msys2 shell the SSH client will fail to work as expected
when run interactively. Installing the SSH package built for the current working
environment will resolve this issue.
## Background Execution ## Background Execution
If the command you specify runs in the background (such as appending a `&` to If the command you specify runs in the background (such as appending a `&` to