Go to file
Mitchell Hashimoto 2e3be3789e More documentation and fixed some YARD warnings 2010-09-23 09:53:18 -07:00
bin Since I18n isn't automatic for UI class, get rid of _ prefix on options 2010-09-21 18:14:18 -06:00
config Resource logger now logs to a "logs" directory in the home path 2010-09-20 09:58:19 -06:00
keys updated links on error messages and keys readme to reflect forthcoming windows documentation 2010-03-25 23:07:10 -07:00
lib More documentation and fixed some YARD warnings 2010-09-23 09:53:18 -07:00
templates Validation on `config.vm.boot_mode` 2010-09-21 12:00:45 -06:00
test Switch config to not implicitly use I18n. 2010-09-21 20:38:19 -06:00
.gitignore Mac files on .gitignore. Its on my global, but for any contributors 2010-09-20 08:45:19 -06:00
.yardopts YARD and some documentation 2010-09-22 09:43:30 -06:00
CHANGELOG.md Update CHANGELOG 2010-09-20 08:55:13 -06:00
Gemfile YARD and some documentation 2010-09-22 09:43:30 -06:00
Gemfile.lock YARD and some documentation 2010-09-22 09:43:30 -06:00
LICENSE MIT License 2010-03-07 16:58:24 -08:00
README.md Fix typo. How did this stick around so long?? 2010-09-08 22:28:30 -07:00
Rakefile Update Gemfile for Bundler RC5 2010-08-13 23:26:04 -07:00
vagrant.gemspec Remove Radar until next release. 2010-09-21 10:11:16 -06:00

README.md

Vagrant

Vagrant is a tool for building and distributing virtualized development environments.

By providing automated creation and provisioning of virtual machines using Oracles VirtualBox, Vagrant provides the tools to create and configure lightweight, reproducible, and portable virtual environments. For more information, see the part of the getting started guide on ”Why Vagrant?

Quick Start

First, make sure your development machine has VirtualBox installed. The setup from that point forward is very easy, since Vagrant is simply a rubygem.

gem install vagrant

To build your first virtual environment:

vagrant init lucid32 http://files.vagrantup.com/lucid32.box
vagrant up

Note: The above vagrant up command will also trigger Vagrant to download the lucid32 box via the specified URL. Vagrant only does this if it detects that the box doesn't already exist on your system.

Getting Started Guide and Video

To learn how to build a fully functional rails development environment, view the getting started guide.

There is also a fairly short (12 minute) getting started video which explains how to build a fully functional LAMP development environment, which covers a few parts of Vagrant in more detail than the website guide.

Installing the Gem from Git

If you want the bleeding edge version of Vagrant, we try to keep master pretty stable and you're welcome to give it a shot. The following is an example showing how to do this:

rake install

Contributing to Vagrant

To hack on vagrant, you'll need bundler which can be installed with a simple gem install bundler --pre. Afterwords, do the following:

bundle install
rake

This will run the test suite, which should come back all green! Then you're good to go!