website: note SSH forwarding

11 years ago · c0bc74990b
parent 3cc90768a2
commit c0bc74990b
1 changed files with 4 additions and 0 deletions
--- a/website/source/docs/templates/communicator.html.md
+++ b/website/source/docs/templates/communicator.html.md
@ -48,6 +48,10 @@ configuration parameters for that communicator. These are documented below.

 ## SSH Communicator

+The SSH communicator connects to the host via SSH. If you have an SSH
+agent enabled on the machine running Packer, it will automatically forward
+the SSH agent to the remote host.
+
 The SSH communicator has the following options:

  * `ssh_host` (string) - The address to SSH to. This usually is automatically