Move wiki information to source

This commit is contained in:
Seth Vargo 2016-06-20 08:20:53 -04:00
parent 5650896732
commit cf1b18d6b2
No known key found for this signature in database
GPG Key ID: 905A90C2949E8787
5 changed files with 140 additions and 30 deletions

View File

@ -1,6 +1,6 @@
GIT
remote: git://github.com/hashicorp/middleman-hashicorp.git
revision: e30d05d2d3b03ed95d8a09d20c33ec32a0732b62
revision: adc9159aeb1be03513925527326d5f25266f9732
specs:
middleman-hashicorp (0.2.0)
bootstrap-sass (~> 3.3)
@ -21,15 +21,14 @@ GIT
GEM
remote: https://rubygems.org/
specs:
activesupport (4.2.5)
activesupport (4.2.6)
i18n (~> 0.7)
json (~> 1.7, >= 1.7.7)
minitest (~> 5.1)
thread_safe (~> 0.3, >= 0.3.4)
tzinfo (~> 1.1)
autoprefixer-rails (6.3.1)
autoprefixer-rails (6.3.6.2)
execjs
json
bootstrap-sass (3.3.6)
autoprefixer-rails (>= 5.2.1)
sass (>= 3.3.4)
@ -40,7 +39,7 @@ GEM
rack (>= 1.0.0)
rack-test (>= 0.5.4)
xpath (~> 2.0)
chunky_png (1.3.5)
chunky_png (1.3.6)
coffee-script (2.4.1)
coffee-script-source
execjs
@ -63,8 +62,8 @@ GEM
eventmachine (>= 0.12.9)
http_parser.rb (~> 0.6.0)
erubis (2.7.0)
eventmachine (1.0.9.1)
execjs (2.6.0)
eventmachine (1.2.0.1)
execjs (2.7.0)
ffi (1.9.10)
git-version-bump (0.15.1)
haml (4.0.7)
@ -76,13 +75,13 @@ GEM
http_parser.rb (0.6.0)
i18n (0.7.0)
json (1.8.3)
kramdown (1.9.0)
kramdown (1.11.1)
less (2.6.0)
commonjs (~> 0.2.7)
libv8 (3.16.14.13)
listen (3.0.5)
rb-fsevent (>= 0.9.3)
rb-inotify (>= 0.9)
libv8 (3.16.14.15)
listen (3.0.8)
rb-fsevent (~> 0.9, >= 0.9.4)
rb-inotify (~> 0.9, >= 0.9.7)
middleman (3.4.1)
coffee-script (~> 2.2)
compass (>= 1.0.0, < 2.0.0)
@ -121,20 +120,22 @@ GEM
middleman-syntax (2.1.0)
middleman-core (>= 3.2)
rouge (~> 1.0)
mime-types (3.0)
mime-types (3.1)
mime-types-data (~> 3.2015)
mime-types-data (3.2015.1120)
mini_portile2 (2.0.0)
minitest (5.8.3)
multi_json (1.11.2)
nokogiri (1.6.7.1)
mini_portile2 (~> 2.0.0.rc2)
padrino-helpers (0.12.5)
mime-types-data (3.2016.0521)
mini_portile2 (2.1.0)
minitest (5.9.0)
multi_json (1.12.1)
nokogiri (1.6.8)
mini_portile2 (~> 2.1.0)
pkg-config (~> 1.1.7)
padrino-helpers (0.12.8)
i18n (~> 0.6, >= 0.6.7)
padrino-support (= 0.12.5)
padrino-support (= 0.12.8)
tilt (~> 1.4.1)
padrino-support (0.12.5)
padrino-support (0.12.8)
activesupport (>= 3.1)
pkg-config (1.1.7)
rack (1.6.4)
rack-contrib (1.4.0)
git-version-bump (~> 0.15)
@ -148,12 +149,12 @@ GEM
rack-test (0.6.3)
rack (>= 1.0)
rb-fsevent (0.9.7)
rb-inotify (0.9.5)
rb-inotify (0.9.7)
ffi (>= 0.5.0)
redcarpet (3.3.4)
ref (2.0.0)
rouge (1.10.1)
sass (3.4.21)
rouge (1.11.1)
sass (3.4.22)
sprockets (2.12.4)
hike (~> 1.2)
multi_json (~> 1.0)
@ -167,10 +168,10 @@ GEM
therubyracer (0.12.2)
libv8 (~> 3.16.14.0)
ref
thin (1.6.4)
thin (1.7.0)
daemons (~> 1.0, >= 1.0.9)
eventmachine (~> 1.0, >= 1.0.4)
rack (~> 1.0)
rack (>= 1, < 3)
thor (0.19.1)
thread_safe (0.3.5)
tilt (1.4.1)
@ -190,4 +191,4 @@ DEPENDENCIES
middleman-hashicorp!
BUNDLED WITH
1.10.6
1.12.5

View File

@ -57,3 +57,25 @@ This is untrue. Namespaces on Atlas behave very similarly to namespaces on
GitHub, for example. Just as GitHub's support team is unable to assist with
issues in someone's repository, HashiCorp's support team is unable to assist
with third-party published boxes.
## Official Boxes
HashiCorp (the makers of Vagrant) publish a basic Ubuntu 12.04 (32 and 64-bit) box that is available for minimal use cases. It is highly optimized, small in size, and includes support for Virtualbox and VMware. You can use it like this:
```shell
$ vagrant init hashicorp/precise64
```
or you can update your `Vagrantfile` as follows:
```ruby
Vagrant.configure("2") do
config.box = "hashicorp/precise64"
end
```
For other users, we recommend the [Bento boxes](https://atlas.hashicorp.com/bento). The Bento boxes are [open source](https://github.com/chef/bento) and built for a number of providers including VMware, Virtualbox, and Parallels. There are a variety of operating systems and versions available.
These are the only two officially-recommended box sets.
~> **It is often a point of confusion**, but Canonical (the company that makes the Ubuntu operating system) publishes boxes under the "ubuntu" namespace on Atlas. These boxes only support Virtualbox and do not provide an ideal experience for most users. If you encounter issues with these boxes, please try the Bento boxes instead.

View File

@ -0,0 +1,86 @@
---
layout: "docs"
page_title: "Installing Vagrant from Source"
sidebar_current: "installation-source"
description: |-
Installing Vagrant from source is an advanced topic and is only recommended
when using the official installer is not an option. This page details the
steps and prerequisites for installing Vagrant from source.
---
# Installing Vagrant from Source
Installing Vagrant from source is an advanced topic and is only recommended
when using the official installer is not an option. This page details the
steps and prerequisites for installing Vagrant from source.
## Install Ruby
You must have a modern Ruby (>= 2.0) in order to develop and build Vagrant. The
specific Ruby version is documented in the Vagrant's `gemspec`. Please refer to
the `vagrant.gemspec` in the repository on GitHub, as it will contain the most
up-to-date requirement. This guide will not discuss how to install and manage Ruby. However, beware of the following pitfalls:
- Do **NOT** use the system Ruby - use a Ruby version manager like rvm or chruby
- Ensure you have the latest version of Rubygems
- Ensure you have installed a version of [Bundler](https://bundler.io) that is
compatible with Vagrant.
The bundler constraint is a floating requirement in Vagrant. You will need to inspect the `vagrant.gemspec` to determine the version when you are compiling from source. For example, if the gemspec specifies version 1.2.3, you will need to install a version of Bundler that satisfies that constraint.
You can install a specific version of bundler with the following command:
```shell
gem install bundler -v '1.2.3'
```
## Clone Vagrant
Clone Vagrant's repository from GitHub into the directory where you keep code on your machine:
```shell
$ git clone https://github.com/mitchellh/vagrant.git
```
Next, `cd` into that path. All commands will be run from this path:
```shell
$ cd /path/to/your/vagrant/clone
```
Run the `bundle` command with a required version* to install the requirements:
```shell
$ bundle _1.10.6_ install
```
You can now run Vagrant by running `bundle exec vagrant` from inside that
directory.
## Use Locally
In order to use your locally-installed version of Vagrant in other projects, you will need to create a binstub and add it to your path.
First, run the following command from the Vagrant repo:
```shell
$ bundle --binstubs exec
```
This will generate files in `exec/`, including `vagrant`. You can now specify
the full path to the `exec/vagrant` anywhere on your operating system:
```shell
$ /path/to/vagrant/exec/vagrant init -m hashicorp/precise64
```
Note that you _will_ receive warnings that running Vagrant like this is not
supported. It's true. It's not. You should listen to those warnings.
If you do not want to specify the full path to Vagrant (i.e. you just want to
run `vagrant`), you can create a symbolic link to your exec:
```shell
$ ln -sf /path/to/vagrant/exec/vagrant /usr/local/bin/vagrant
```
When you want to switch back to the official Vagrant version, simply
remove the symlink.

View File

@ -18,8 +18,8 @@
<link rel="shortcut icon" href="<%= image_path("favicon.png") %>">
<script type="text/javascript" src="//use.typekit.net/xfs6zus.js"></script>
<script type="text/javascript">try{Typekit.load();}catch(e){}</script>
<!-- <script type="text/javascript" src="//use.typekit.net/xfs6zus.js"></script>
<script type="text/javascript">try{Typekit.load();}catch(e){}</script> -->
<%= yield_content :head %>
</head>

View File

@ -16,6 +16,7 @@
<li<%= sidebar_current("installation-backwards-compatibility") %>><a href="/docs/installation/backwards-compatibility.html">Backwards Compatibility</a></li>
<li<%= sidebar_current("installation-upgrading") %>><a href="/docs/installation/upgrading.html">Upgrading</a></li>
<li<%= sidebar_current("installation-1-0-upgrading") %>><a href="/docs/installation/upgrading-from-1-0.html">Upgrading from 1.0.x</a></li>
<li<%= sidebar_current("installation-source") %>><a href="/docs/installation/source.html">From Source</a></li>
<li<%= sidebar_current("installation-uninstallation") %>><a href="/docs/installation/uninstallation.html">Uninstallation</a></li>
</ul>
</li>