Go to file
Russell Jackson a3c94ab910 Fix Linux NFS exports pruning due to bad `sed` expression
The mount id is a file path which will contain forward slashes. A
previous attempt (although notably missing in the Linux host plugin) at
fixing this used `String.gsub` to escape the forward slashes; however,
the solution that eventually made its way into the 1.5 release uses
`Regexp.escape` which doesn't escape forward slashes.

The Ruby `Regexp.escape` method does not escape forward slashes because
they are not RE meta-characters; their special meaning is specific to
sed expressions as delimiters. To avoid the issue entirely, we can use
an alternative delimiter by prefixing the address expression with a
backslash with the desired delimiter character following.

Use control character (ASCII code point `0x01`) as expression delimiter
so it is very unlikely an identifier will have a conflicting character
within it.
2014-03-12 12:25:53 -07:00
bin More wording changes on version conflicts 2014-03-09 22:47:56 -07:00
contrib Update contrib/README & bash shebang line 2014-03-10 11:18:20 -04:00
keys Remove reference to PPK in keys readme 2013-07-18 10:52:38 -04:00
lib core: Windows paths work for box add [GH-3132] 2014-03-11 11:27:35 -07:00
plugins Fix Linux NFS exports pruning due to bad `sed` expression 2014-03-12 12:25:53 -07:00
scripts scripts: calculate shasum 2013-12-09 00:17:14 -08:00
tasks update rake tasks for acceptance testing 2013-12-05 14:24:10 -08:00
templates core: output when upgrading home path 2014-03-11 11:06:38 -07:00
test Fix failing tests on Windows 2014-03-11 11:09:37 -07:00
website Nit-picky grammer making it easier to read. 2014-03-10 17:26:48 -05:00
.gitignore website/docs: document Vagrantfile updates 2014-02-05 21:20:26 -08:00
.travis.yml Install Bundler 1.5.2 for tests 2014-01-16 09:36:26 -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 2014-03-11 11:29:03 -07:00
CONTRIBUTING.md Add notes about debugging logs to contributing guidelines 2013-06-09 20:42:31 -03:00
Gemfile Update dep of ChildProcess to 0.4.0 2014-01-17 20:34:58 -08:00
LICENSE 🎆 New year! 🎆 2014-01-02 00:48:22 -02:00
README.md Update README 2014-03-09 21:46:01 -07:00
Rakefile stdout.sync = true for rake tasks. 2011-11-13 19:41:38 -08: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 Depend on ChildProcess 0.5.0, fix bugs 2014-02-18 11:15:19 -08:00
version.txt Up version for dev 2014-03-09 22:51:31 -07:00

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