diff --git a/_layouts/getting_started.html b/_layouts/getting_started.html index 80d8c6bca..e641dceaf 100644 --- a/_layouts/getting_started.html +++ b/_layouts/getting_started.html @@ -13,6 +13,7 @@
  • Packaging
  • Teardown
  • Rebuild Instantly
    • +
  • Windows
    • @@ -21,4 +22,4 @@
    {{ content }}
    -{% include footer.html %} \ No newline at end of file +{% include footer.html %} diff --git a/docs/getting-started/windows.md b/docs/getting-started/windows.md new file mode 100644 index 000000000..c228fd96d --- /dev/null +++ b/docs/getting-started/windows.md @@ -0,0 +1,96 @@ +--- +layout: getting_started +title: Windows +--- +# Windows + +
    +

    Windows Support

    +

    + Windows support is a recent addition to vagrant so if you do experience trouble + or find this section hard to follow, please see the support page + and let us know so we can help you. Our goal is to make Vagrant the best tool + for the job on all platforms. +

    +

    + All Windows testing has been performed from the vanilla Windows XP command prompt. Cygwin support + is planned but Vista, and Windows 7 testing will have to be a community effort. +

    +

    + If you are interested in testing the latest updates please do the following (requires a github account): + +{% highlight bash %} +$ git clone git@github.com:mitchellh/vagrant.git +$ cd vagrant +$ rake install +{% endhighlight %} +

    +
    + +## Assumptions + +The following assumes you have installed Ruby 1.8.6 or greater (see [here](http://www.ruby-lang.org/en/downloads/), in the Ruby on Windows section) with RubyGems and issued the following from a command prompt: + +{% highlight bash %} +C:\> gem install vagrant +C:\> gem install win32console +{% endhighlight %} + +Also, as with other platforms, you will need to have downloaded, installed, and opened [Oracle's Virtualbox](http://www.virtualbox.org/) at least once to generate the necessary configuration files for it, and vagrant, to run properly. + +## Post Installation + +After you have completed the above there are a few more important Windows specific configuration items to handle. + +### Adding VBoxManage to Your Path + +Vagrant, and the virtualbox gem on which it relies, require that the VBoxManage utility is present in your Windows path. When VirtualBox is installed on Windows it doesn't add the utility to the Windows path automatically so you'll need to do that yourself. By default the utility is installed into 'C:\Program Files\Sun\Virtual Box'. If you've installed VirtualBox to a different location you'll need to use that directory when adding it to the path. + +![Copying MAC Address](/images/windows/vbox_manage_default_location.jpg) + +You can add additional folders to Windows XP path by taking the following steps. First click Start, right click My Computer and select Properties. Select the Advanced tab in the window that pops up and find the Environment Variables button + +![Environment Variables Button](/images/windows/environment_variables_button.jpg) + +In the next window locate the System Variables list and find the Path variable. Click edit. + +![Edit Path](/images/windows/edit_path.jpg) + +Select the Variable value field and make your way to the end of the dialog to append the path that contains your VirtualBox install and the VBoxManage executable. Make sure to separate each path you add with a semi-colon. + +![Alter Path](/images/windows/alter_path.jpg) + +You can verify that VBoxManage has been made available by opening a command prompt and testing with `VBoxManage`. You should see the help listing for the tool. You can now continue with the installation of a base box and creation of your first Vagrant virtual machine. + +{% highlight bash %} +C:\ > vagrant box add base http://files.vagrantup.com/base.box +C:\ > cd MyProjectDir +C:\ MyProjectDir> vagrant init +C:\ MyProjectDir> vagrant up +{% endhighlight %} + +After this completes you'll need to move onto the following section to connect to your VM. + +### Putty + +Since SSH is not easy to use/install on the command line under Windows we have included a [Putty](http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html) formatted private key generated from the keypair included with the Vagrant gem. This allows quick and easy SSH access to all Base Boxes that leverage those keys. + +To configure Putty we need 3 things: a user to log on with, the port that Vagrant forwarded for ssh, and the location of the ppk file. By default the first two will be `vagrant` and 2222, but there are many reasons those may be different, especially the port (other vm's services etc). If you've come here after following the quick start you'll have seen the following: + +![No Vagrant SSH On Windows](/images/windows/port_and_ppk_path.jpg) + +It's important to take note of both the port and the .ppk file location. If you've used the Ruby 1.8.6 installer, the above path will be the same for you. Moving on, once you've got Putty installed, opening putty.exe will present you with the connection configuration window. First enter the SSH information and a name for the connection, then open the SSH configuration sub-tree. + +![Vagrant SSH Info Putty](/images/windows/putty_first_screen.jpg) + +Here in the `Auth` configuration section we'll take the path information provided to us above and locate the .ppk file via the browse dialog. + +![PPK Selection](/images/windows/ppk_selection.jpg) + +Once you've done that head to the top of the configuration tree and click the `Session` tree item and save the putty configuration so it will be available for use again later. + +![Save Result](/images/windows/save_result.jpg) + +Last but not least, click the Open button to be presented with a bash prompt inside your new and shiny Vagrant virtual development environtment! + + diff --git a/images/windows/alter_path.jpg b/images/windows/alter_path.jpg new file mode 100644 index 000000000..8af723c91 Binary files /dev/null and b/images/windows/alter_path.jpg differ diff --git a/images/windows/edit_path.jpg b/images/windows/edit_path.jpg new file mode 100644 index 000000000..c0c8a000e Binary files /dev/null and b/images/windows/edit_path.jpg differ diff --git a/images/windows/environment_variables_button.jpg b/images/windows/environment_variables_button.jpg new file mode 100644 index 000000000..9bab1ba9f Binary files /dev/null and b/images/windows/environment_variables_button.jpg differ diff --git a/images/windows/port_and_ppk_path.jpg b/images/windows/port_and_ppk_path.jpg new file mode 100755 index 000000000..50065c0aa Binary files /dev/null and b/images/windows/port_and_ppk_path.jpg differ diff --git a/images/windows/ppk_selection.jpg b/images/windows/ppk_selection.jpg new file mode 100755 index 000000000..64b081e25 Binary files /dev/null and b/images/windows/ppk_selection.jpg differ diff --git a/images/windows/putty_first_screen.jpg b/images/windows/putty_first_screen.jpg new file mode 100755 index 000000000..c7cd49642 Binary files /dev/null and b/images/windows/putty_first_screen.jpg differ diff --git a/images/windows/save_result.jpg b/images/windows/save_result.jpg new file mode 100755 index 000000000..54873fee4 Binary files /dev/null and b/images/windows/save_result.jpg differ diff --git a/images/windows/vbox_manage_default_location.jpg b/images/windows/vbox_manage_default_location.jpg new file mode 100644 index 000000000..4c8b192c6 Binary files /dev/null and b/images/windows/vbox_manage_default_location.jpg differ diff --git a/index.md b/index.md index f0b62c59e..4ae181b54 100644 --- a/index.md +++ b/index.md @@ -11,8 +11,9 @@ virtual environments. For more information, see the part of the getting started guide on "[Why Vagrant?](/docs/getting-started/why.html)" Are you ready to revolutionize the way you work? Check out -the [getting started guide](/docs/getting-started/index.html) and the -[getting started video](http://vimeo.com/9976342). +the [getting started guide](/docs/getting-started/index.html), the +[getting started video](http://vimeo.com/9976342), or if you're using +Windows see [here](/docs/getting-started/windows.html). ## Your First Vagrant Virtual Environment