Go to file
Chris Roberts d790c138ac Update gem dependency constraints 2017-04-06 13:01:21 -07:00
.github Update ISSUE_TEMPLATE.md 2016-06-06 09:58:25 -04:00
bin Prevent loading local Vagrantfile when disabling plugins for global actions 2016-11-30 19:41:59 -08:00
contrib Fix vagrant bash completion when path have spaces 2017-03-06 22:47:26 +00:00
keys Use SSL and HTTPS links where appropriate 2016-01-25 13:14:54 -05:00
lib Validate plugin sources and report errors if detected. 2017-04-04 17:53:04 -07:00
plugins Merge pull request #7425 from tjuerge/6220-mount_shared_folder-via-ssh 2017-04-05 15:11:32 -07:00
scripts Update RELEASE 2016-06-14 20:33:19 +02:00
tasks Use color 2015-07-09 17:24:29 -06:00
templates Add note on forwarded_port and include host_ip configuration 2017-04-05 15:13:24 -07:00
test Merge pull request #7425 from tjuerge/6220-mount_shared_folder-via-ssh 2017-04-05 15:11:32 -07:00
website Include documentation entry for plugin source errors environment variable 2017-04-05 13:17:48 -07:00
.gitignore Add entry point for running vagrant-spec 2017-03-09 16:05:34 -08:00
.travis.yml Update travis configuration 2016-11-22 07:56:52 -08:00
.vimrc .vimrc with vagrant tabstop settings 2013-10-22 08:24:58 +02:00
.yardopts YARD and some documentation 2010-09-22 09:43:30 -06:00
CHANGELOG.md Update CHANGELOG 2017-04-05 15:17:54 -07:00
Gemfile change Gemfile source to HTTPS 2014-10-23 15:25:40 -04:00
LICENSE update license to 2017 2017-01-02 19:43:46 -08:00
README.md Fix README URL 2017-04-05 19:55:25 -05:00
RELEASE.md Update RELEASE docs 2016-07-18 22:42:20 -04:00
Rakefile Change symbols inside hashes to 1.9 JSON-like syntax 2014-05-22 12:35:12 -04:00
Vagrantfile Updated Vagrantfile to install more recent versions of software. 2016-07-26 20:00:02 -04:00
vagrant-spec.config.example.rb core: Within a Bundler env, don't manage Bundler 2014-01-17 09:39:20 -08:00
vagrant.gemspec Update gem dependency constraints 2017-04-06 13:01:21 -07:00
version.txt Bump version for new development 2017-03-21 17:36:10 -07:00

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. Please review the installation page here.

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

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"
...