Go to file
Mitchell Hashimoto f30ef2b8a9 Merge https://github.com/rcreasey/vagrant 2011-05-16 12:37:21 -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 Change default SSH host to 127.0.0.1 instead of localhost 2011-01-22 22:51:29 -08:00
contrib Emacs Vagrantfile config 2011-01-05 17:13:30 -08:00
keys Change comment on public key to be more descriptive of its role 2010-10-01 19:30:51 -07:00
lib Merge https://github.com/rcreasey/vagrant 2011-05-16 12:37:21 -07:00
templates Merge https://github.com/rcreasey/vagrant 2011-05-16 12:37:21 -07:00
test Merge https://github.com/rcreasey/vagrant 2011-05-16 12:37:21 -07:00
.gitignore Merge remote branch 'remotes/upstream/master' 2010-12-21 10:09:33 +00:00
.yardopts YARD and some documentation 2010-09-22 09:43:30 -06:00
CHANGELOG.md Update CHANGELOG 2011-05-16 12:33:04 -07:00
Gemfile Modify Gemfile to work on Windows 2011-01-29 20:17:40 -08:00
LICENSE MIT License 2010-03-07 16:58:24 -08:00
README.md Fix getting started link in README [closes GH-284] 2011-01-24 09:52:58 -08:00
Rakefile Update Gemfile for Bundler RC5 2010-08-13 23:26:04 -07:00
vagrant.gemspec Update json dep to ~> 1.5.1, which works with Ruby19 on Windows 2011-01-29 20:24:17 -08: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!

If you want to run Vagrant without having to install the gem, you may use bundle exec, like so:

bundle exec bin/vagrant help