notes on fab from host machine.
authorBryan <btbonval@gmail.com>
Tue, 7 Jan 2014 20:12:50 +0000 (15:12 -0500)
committerBryan <btbonval@gmail.com>
Tue, 7 Jan 2014 20:12:50 +0000 (15:12 -0500)
README.md

index 8ef77dc104ae577950907a2353c9aaf5ecb60644..3228aa0d0898eef254d754ac4f25d4dc442c47b8 100644 (file)
--- a/README.md
+++ b/README.md
@@ -305,6 +305,27 @@ not generally be needed.
 
 # Accessing the Vagrant Virtual Machine
 
+## Accessing the VM via Fabric
+If you have Fabric on the host machine, you can configure your host machine
+to run Fabric against the virtual machine.
+
+You will need to setup the host machine with the proper SSH credentials to
+access the virtual machine. This is done by running `vagrant ssh-config` from
+`{project_root}`.
+
+The VM will, by default, route its SSH connection through localhost port 2222
+on the host machine and the base user with be vagrant. Point Fabric there when
+running fab commands from `{project_root}`. So the command will look like this:
+
+        fab -H 127.0.0.1 --port=2222 -u vagrant <commands>
+
+In unix, it might be convenient to create and use an alias like so:
+
+        alias vmfab='fab -H 127.0.0.1 --port=2222 -u vagrant'
+        vmfab <commands>
+
+Removing a unix alias is done with `unalias`.
+
 ## Connecting to the VM via SSH
 If you have installed a virtual machine using `vagrant up`, you can connect
 to it by running `vagrant ssh` from `{project_root}`.