Skip to content
This repository

Vagrant is a tool for building and distributing working environments.

Octocat-spinner-32 bin core: vagrant help no longer loads Vagrantfile
Octocat-spinner-32 contrib Update contrib/README & bash shebang line
Octocat-spinner-32 keys Remove reference to PPK in keys readme
Octocat-spinner-32 lib core: use process.alive? to avoid exceptions
Octocat-spinner-32 plugins guests/linux: rsync chown if either user or group incorrect [GH-3485]
Octocat-spinner-32 scripts scripts: calculate shasum
Octocat-spinner-32 tasks update rake tasks for acceptance testing
Octocat-spinner-32 templates added missing newline in `box remove version listing`
Octocat-spinner-32 test core: allow overriding default SSH port [GH-3474]
Octocat-spinner-32 website website/www: 1.6 feature preview: global status and control
Octocat-spinner-32 .gitignore website/docs: document Vagrantfile updates
Octocat-spinner-32 .travis.yml Install Bundler 1.5.2 for tests
Octocat-spinner-32 .vimrc .vimrc with vagrant tabstop settings
Octocat-spinner-32 .yardopts YARD and some documentation
Octocat-spinner-32 CHANGELOG.md Update CHANGELOG
Octocat-spinner-32 CONTRIBUTING.md Add notes about debugging logs to contributing guidelines
Octocat-spinner-32 Gemfile Update dep of ChildProcess to 0.4.0
Octocat-spinner-32 LICENSE :fireworks: New year! :fireworks:
Octocat-spinner-32 README.md A simple typo
Octocat-spinner-32 Rakefile stdout.sync = true for rake tasks.
Octocat-spinner-32 vagrant-spec.config.example.rb core: Within a Bundler env, don't manage Bundler
Octocat-spinner-32 vagrant.gemspec No, we really need listen 2.7.1
Octocat-spinner-32 version.txt Up version for dev
README.md

Vagrant

Vagrant is a tool for building and distributing development environments.

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

First, make sure your development machine has VirtualBox installed. After this, download and install the appropriate Vagrant package for your OS. If you're not on Mac OS X or Windows, you'll need to add /opt/vagrant/bin to your PATH. After this, you're ready to go!

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

Dependencies and Unit Tests

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

bundle install
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 in 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"
...
Something went wrong with that request. Please try again.