vagrant/README.md

54 lines
2.0 KiB
Markdown
Raw Normal View History

2010-02-10 07:10:16 +00:00
# Vagrant
* Website: [http://vagrantup.com](http://vagrantup.com)
2010-07-09 00:38:38 +00:00
* Source: [http://github.com/mitchellh/vagrant](http://github.com/mitchellh/vagrant)
* IRC: `#vagrant` on Freenode
* Mailng list: [Google Groups](http://groups.google.com/group/vagrant-up)
2010-03-07 20:05:53 +00:00
Vagrant is a tool for building and distributing virtualized development environments.
2010-05-20 09:32:04 +00:00
By providing automated creation and provisioning of virtual machines using [Oracles VirtualBox](http://www.virtualbox.org),
2010-03-07 20:05:53 +00:00
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?](http://vagrantup.com/docs/getting-started/index.html)”
## Quick Start
First, make sure your development machine has [VirtualBox](http://www.virtualbox.org)
installed. The setup from that point forward is very easy, since Vagrant is simply
a rubygem.
sudo gem install vagrant
To build your first virtual environment:
vagrant init
vagrant box add base http://files.vagrantup.com/base.box
vagrant up
## Getting Started Guide and Video
To learn how to build a fully functional rails development environment, view the
[getting started guide](http://vagrantup.com/getting-started/index.html).
There is also a fairly short (12 minute) [getting started video](http://vimeo.com/9976342) 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:
sudo rake install
2010-02-10 07:10:16 +00:00
## Contributing to Vagrant
2010-02-10 07:13:16 +00:00
To hack on vagrant, you'll need [bundler](http://github.com/carlhuda/bundler) which can
be installed with a simple `sudo gem install bundler`. Afterwords, do the following:
2010-02-10 07:10:16 +00:00
bundle install
2010-05-20 09:32:04 +00:00
bundle exec rake
This will run the test suite, which should come back all green! Then you're good to go!