From: Bryan <btbonval@gmail.com>
Date: Tue, 7 Jan 2014 20:12:50 +0000 (-0500)
Subject: notes on fab from host machine.
X-Git-Tag: release-20150131~298
X-Git-Url: https://git.librecmc.org/?a=commitdiff_plain;h=e26bb1cb4c313d4d9dea5e9ca6052d98c8876870;p=oweals%2Fkarmaworld.git

notes on fab from host machine.
---

diff --git a/README.md b/README.md
index 8ef77dc..3228aa0 100644
--- 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}`.