Vagrant is a tool for building and distributing development environments.
Ruby HTML CSS PowerShell Shell JavaScript
Latest commit 9c299a2 Aug 19, 2016 @chrisroberts chrisroberts committed on GitHub Merge pull request #7724 from dragon788/patch-2
Updated comments to match example
Failed to load latest commit information.
.github Update ISSUE_TEMPLATE.md Jun 6, 2016
bin Allow users to force color May 30, 2016
contrib Merge pull request #7270 from lpenz/nfspager Jun 6, 2016
keys Use SSL and HTTPS links where appropriate Jan 25, 2016
lib Merge pull request #7623 from carlosefr/relative-dotfile-path Aug 12, 2016
plugins Merge pull request #7740 from chrisroberts/nfs/v4 Aug 19, 2016
scripts Update RELEASE Jun 14, 2016
tasks Use color Jul 9, 2015
templates Add NFSv4 warning and information Aug 19, 2016
test Merge pull request #7726 from chrisroberts/fix/rsync-exclude Aug 19, 2016
website Merge pull request #7724 from dragon788/patch-2 Aug 19, 2016
.gitignore redux of pr 7398 for ssh-agent key fix Aug 11, 2016
.travis.yml Bump listen gem Jun 15, 2016
.vimrc .vimrc with vagrant tabstop settings Oct 22, 2013
.yardopts YARD and some documentation Sep 22, 2010
CHANGELOG.md Update CHANGELOG.md Aug 19, 2016
Gemfile Use Winrm 1.2.0 and fix tests Dec 11, 2014
LICENSE Updated copyright to 2016 Jan 1, 2016
README.md Use SSL and HTTPS links where appropriate Jan 25, 2016
RELEASE.md Update RELEASE docs Jul 19, 2016
Rakefile Change symbols inside hashes to 1.9 JSON-like syntax May 22, 2014
Vagrantfile Updated Vagrantfile to install more recent versions of software. Jul 27, 2016
vagrant-spec.config.example.rb core: Within a Bundler env, don't manage Bundler Jan 17, 2014
vagrant.gemspec Constrain ruby_dep gem versions to prevent constraints on ruby versions Aug 4, 2016
version.txt Bump for dev Jul 19, 2016

README.md

Vagrant

Vagrant is a tool for building and distributing development environments.

Development environments managed by Vagrant can run on local virtualized platforms such as VirtualBox or VMware, in the cloud via AWS or OpenStack, or in containers such as with Docker or raw LXC.

Vagrant provides the framework and configuration format to create and manage complete portable development environments. These development environments can live on your computer or in the cloud, and are portable between Windows, Mac OS X, and Linux.

Quick Start

For the quick-start, we'll bring up a development machine on VirtualBox because it is free and works on all major platforms. Vagrant can, however, work with almost any system such as OpenStack, VMware, Docker, etc.

First, make sure your development machine has VirtualBox installed. After this, download and install the appropriate Vagrant package for your OS.

To build your first virtual environment:

vagrant init hashicorp/precise32
vagrant up

Note: The above vagrant up command will also trigger Vagrant to download the precise32 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

To learn how to build a fully functional development environment, follow the getting started 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

Ruby 2.0 is needed.

Contributing to Vagrant

To install Vagrant from source, please follow the guide in the Wiki.

You can run the test suite with:

bundle exec rake

This will run the unit 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 vagrant help

NOTE: By default running Vagrant via bundle will disable plugins. This is necessary because Vagrant creates its own private Bundler context (it does not respect your Gemfile), because it uses Bundler to manage plugin dependencies.

Acceptance Tests

Vagrant also comes with an acceptance test suite that does black-box tests of various Vagrant components. Note that these tests are extremely slow because actual VMs are spun up and down. The full test suite can take hours. Instead, try to run focused component tests.

To run the acceptance test suite, first copy vagrant-spec.config.example.rb to vagrant-spec.config.rb and modify it to valid values. The places you should fill in are clearly marked.

Next, see the components that can be tested:

$ rake acceptance:components
cli
provider/virtualbox/basic
...

Then, run one of those components:

$ rake acceptance:run COMPONENTS="cli"
...