tnargav 1.2.3 → 1.3.3

data/website/docs/source/v2/cli/ssh.html.md

@@ -0,0 +1,24 @@
+---
+page_title: "vagrant ssh - Command-Line Interface"
+sidebar_current: "cli-ssh"
+---
+
+# SSH
+
+**Command: `vagrant ssh`**
+
+This will SSH into a running Vagrant machine and give you access to a shell.
+
+If a `--` (two hyphens) are found on the command line, any arguments after
+this are passed directly into the `ssh` executable. This allows you to pass
+any abitrary commands to do things such as reverse tunneling down into the
+`ssh` program.
+
+## Options
+
+* `-c COMMAND` or `--command COMMAND` - This executes a single SSH command, prints
+  out the stdout and stderr, and exits. stdin will not be functional on this
+  executed command.
+
+* `-p` or `--plain` - This does an SSH without authentication, leaving
+  authentication up to the user.

data/website/docs/source/v2/cli/ssh_config.html.md

@@ -0,0 +1,16 @@
+---
+page_title: "vagrant ssh-config - Command-Line Interface"
+sidebar_current: "cli-ssh_config"
+---
+
+# SSH Config
+
+**Command: `vagrant ssh-config`**
+
+This will output valid configuration for an SSH config file to SSH
+into the running Vagrant machine from `ssh` directly (instead of
+using `vagrant ssh`).
+
+## Options
+
+* `--host NAME` - Name of the host for the outputted configuration.

data/website/docs/source/v2/cli/status.html.md

@@ -0,0 +1,14 @@
+---
+page_title: "vagrant status - Command-Line Interface"
+sidebar_current: "cli-status"
+---
+
+# Status
+
+**Command: `vagrant status`**
+
+This will tell you the state of the machines Vagrant is managing.
+
+It is quite easy, especially once you get comfortable with Vagrant, to
+forget whether your Vagrant machine is running, suspended, not created, etc.
+This command tells you the state of the underlying guest machine.

data/website/docs/source/v2/cli/suspend.html.md

@@ -0,0 +1,19 @@
+---
+page_title: "vagrant suspend - Command-Line Interface"
+sidebar_current: "cli-suspend"
+---
+
+# Suspend
+
+**Command: `vagrant suspend`**
+
+This suspends the guest machine Vagrant is managing, rather than fully
+[shutting it down](/v2/cli/halt.html) or [destroying it](/v2/cli/destroy.html).
+
+A suspend effectively saves the _exact point-in-time state_ of the machine,
+so that when you [resume](/v2/cli/resume.html) it later, it begins running
+immediately from that point, rather than doing a full boot.
+
+This generally requires extra disk space to store all the contents of the
+RAM within your guest machine, but the machine no longer consumes the
+RAM of your host machine or CPU cycles while it is suspended.

data/website/docs/source/v2/cli/up.html.md

@@ -0,0 +1,34 @@
+---
+page_title: "vagrant up - Command-Line Interface"
+sidebar_current: "cli-up"
+---
+
+# Up
+
+**Command: `vagrant up`**
+
+This command creates and configures guest machines according to your
+[Vagrantfile](/v2/vagrantfile/index.html).
+
+This is the single most important command in Vagrant, since it is how
+any Vagrant machine is created. Anyone using Vagrant must use this command
+on a day-to-day basis.
+
+# Options
+
+* `--[no-]destroy-on-error` - Destroy the newly created machine if a fatal,
+  unexpected error occurs. This will only happen on the first `vagrant up`.
+  By default this is set.
+
+* `--[no-]parallel` - Bring multiple machines up in parallel if the provider
+  supports it.
+
+* `--provider x` - Bring the machine up with the given
+  [provider](/v2/providers/index.html). By default this is "virtualbox".
+
+* `--provision` - Force the provisioners to run.
+
+* `--provision-with x,y,z` - This will only run the given provisioners. For
+  example, if you have a `:shell` and `:chef_solo` provisioner and run
+  `vagrant provision --provision-with shell`, only the shell provisioner will
+  be run.

data/website/docs/source/v2/debugging.html.md

@@ -0,0 +1,42 @@
+---
+page_title: "Debugging and Troubleshooting"
+sidebar_current: "debugging"
+---
+
+# Debugging
+
+As much as we try to keep Vagrant stable and bug free, it is inevitable
+that issues will arise and Vagrant will behave in unexpected ways. In
+these cases, Vagrant has amazing [support](http://www.vagrantup.com/support.html)
+channels available to assist you.
+
+When using these support channels, it is generally helpful to include
+debugging logs along with any error reports. These logs can often help you
+troubleshoot any problems you may be having.
+
+To enable detailed logging, set the `VAGRANT_LOG` environmental variable
+to the desired log level name, which is one of `debug` (loud), `info` (normal),
+`warn` (quiet), and `error` (very quiet). When asking for support, please
+set this to `debug`. When troubleshooting your own issues, you should start
+with `info`, which is much quieter, but contains important information
+about the behavior of Vagrant.
+
+On Linux and Mac systems, this can be done by prepending the `vagrant`
+command with an environmental variable declaration:
+
+```
+$ VAGRANT_LOG=info vagrant up
+...
+```
+
+On Windows, multiple steps are required:
+
+```
+$ set VAGRANT_LOG=info
+$ vagrant up
+...
+```
+
+If you plan on submitting a bug report, please submit debug-level logs
+along with the report using [gist](https://gist.github.com/) or
+some other paste service.

data/website/docs/source/v2/getting-started/boxes.html.md

@@ -0,0 +1,56 @@
+---
+page_title: "Boxes - Getting Started"
+sidebar_current: "gettingstarted-boxes"
+---
+
+# Boxes
+
+Instead of building a virtual machine from scratch, which would be a
+slow and tedious process, Vagrant uses a base image to quickly clone
+a virtual machine. These base images are known as _boxes_ in Vagrant,
+and specifying the box to use for your Vagrant environment is always
+the first step after creating a new Vagrantfile.
+
+## Installing a Box
+
+If you ran the commands on the [getting started overview page](/v2/getting-started/index.html),
+then you've already installed a box before, and you don't need to run
+the commands below again. However, it is still worth reading this section
+to learn more about how boxes are managed.
+
+Boxes are added to Vagrant with `vagrant box add`. This stores the box
+under a specific name so that multiple Vagrant environments can re-use it.
+If you haven't added a box yet, you can do so now:
+
+```
+$ vagrant box add precise32 \
+    http://files.vagrantup.com/precise32.box
+```
+
+This will download the box from an HTTP source and save it as "precise32"
+in a directory that Vagrant manages (away from your project). You can also
+add boxes from a local file path.
+
+Added boxes can be re-used by multiple projects. Each project uses a box
+as an initial image to clone from, and never modifies the actual base
+image. This means that if you have two projects both using the `precise32`
+box we just added, adding files in one guest machine will have no effect
+on the other machine.
+
+## Using a Box
+
+Now that the box has been added to Vagrant, we need to configure our
+project to use it as a base. Open the `Vagrantfile` and change the
+contents to the following:
+
+```ruby
+Vagrant.configure("2") do |config|
+  config.vm.box = "precise32"
+end
+```
+
+The "precise32" in this case must match the name you used to add
+the box above. This is how Vagrant knows what box to use.
+
+In the next section, we'll bring up the guest machine and interact
+with it a little bit.

data/website/docs/source/v2/getting-started/index.html.md

@@ -0,0 +1,43 @@
+---
+page_title: "Getting Started"
+sidebar_current: "gettingstarted"
+---
+
+# Getting Started
+
+The Vagrant getting started guide will walk you through your first
+Vagrant project, and show off the basics of the major features Vagrant
+has to offer.
+
+Before diving into your first project, please [install Vagrant](/v2/installation/index.html).
+And if you're curious what benefits Vagrant has to offer, you
+should also read the ["Why Vagrant?"](/v2/why-vagrant/index.html) page.
+
+The getting started guide will use Vagrant with [VirtualBox](http://www.virtualbox.org),
+since it is free, available on every major platform, and built-in to
+Vagrant. After reading the guide though, don't forget that Vagrant
+can work with [many other providers](/v2/getting-started/providers.html).
+
+## Up and Running
+
+```
+$ vagrant init precise32 http://files.vagrantup.com/precise32.box
+$ vagrant up
+```
+
+After running the above two commands, you'll have a fully running
+virtual machine in [VirtualBox](http://virtualbox.org) running
+Ubuntu 12.04 LTS 32-bit. You can SSH into this machine with
+`vagrant ssh`, and when you're done playing around, you can remove
+all traces of it with `vagrant destroy`.
+
+Now imagine every project you've ever worked on being this easy to
+set up.
+
+With Vagrant, `vagrant up` is all you need to work on any project,
+to install every dependency that project needs, and to setup any
+networking and synced folders so you can continue working from the
+comfort of your own machine.
+
+The rest of this guide will walk you through setting up a more
+complete project, covering more features of Vagrant.

data/website/docs/source/v2/getting-started/networking.html.md

@@ -0,0 +1,45 @@
+---
+page_title: "Networking - Getting Started"
+sidebar_current: "gettingstarted-networking"
+---
+
+# Networking
+
+At this point we have a web server up and running with the ability to
+modify files from our host and have them automatically synced to the guest.
+However, accessing the web pages simply from the terminal from inside
+the machine is not very satisfying. In this step, we'll use Vagrant's
+_networking_ features to give us additional options for accessing the
+machine from our host machine.
+
+## Port Forwarding
+
+One option is to use _port forwarding_. Port forwarding allows you to
+specify ports on the guest machine to share via a port on the host machine.
+This allows you to access a port on your own machine, but actually have
+all the network traffic forwarded to a specific port on the guest machine.
+
+Let's setup a forwarded port so we can access Apache in our guest. Doing so
+is a simple edit to the Vagrantfile, which now looks like this:
+
+```ruby
+Vagrant.configure("2") do |config|
+  config.vm.box = "precise32"
+  config.vm.provision :shell, :path => "bootstrap.sh"
+  config.vm.network :forwarded_port, host: 4567, guest: 80
+end
+```
+
+Run a `vagrant reload` or `vagrant up` (depending on if the machine
+is already running) so that these changes can take effect.
+
+Once the machine is running again, load `http://127.0.0.1:4567` in
+your browser. You should see a web page that is being served from
+the virtual machine that was automatically setup by Vagrant.
+
+## Other Networking
+
+Vagrant also has other forms of networking, allowing you to assign
+a static IP address to the guest machine, or to bridge the guest
+machine onto an existing network. If you're interested in other options,
+read the [networking](/v2/networking/index.html) page.

data/website/docs/source/v2/getting-started/project_setup.html.md

@@ -0,0 +1,38 @@
+---
+page_title: "Project Setup - Getting Started"
+sidebar_current: "gettingstarted-projectsetup"
+---
+
+# Project Setup
+
+The first step for any project to use Vagrant is to configure Vagrant
+using a [Vagrantfile](/v2/vagrantfile/index.html). The purpose of the
+Vagrantfile is twofold:
+
+1. Mark the root directory of your project. A lot of the configuration
+  of Vagrant is relative to this root directory.
+
+2. Describe the kind of machine and resources you need to run your project,
+  as well as what software to install and how you want to access it.
+
+Vagrant has a built-in command for initializing a directory for usage
+with Vagrant: `vagrant init`. For the purpose of this getting started guide,
+please follow along in your terminal:
+
+```
+$ mkdir vagrant_getting_started
+$ cd vagrant_getting_started
+$ vagrant init
+```
+
+This will place a `Vagrantfile` in your current directory. You can
+take a look at the Vagrantfile if you want, it is filled with comments
+and examples. Don't be afraid if it looks intimidating, we'll modify it
+soon enough.
+
+You can also run `vagrant init` in a pre-existing directory to
+setup Vagrant for an existing project.
+
+The Vagrantfile is meant to be committed to version control with
+your project, if you use version control. This way, every person working
+with that project can benefit from Vagrant without any upfront work.

data/website/docs/source/v2/getting-started/providers.html.md

@@ -0,0 +1,37 @@
+---
+page_title: "Providers - Getting Started"
+sidebar_current: "gettingstarted-providers"
+---
+
+# Providers
+
+In this getting started guide, your project was always backed with
+[VirtualBox](http://www.virtualbox.org). But Vagrant can work with
+a wide variety of backend providers, such as [VMware Fusion](/v2/vmware-fusion/index.html),
+[AWS](http://github.com/mitchellh/vagrant-aws), and more. Read the page
+of each provider for more information on how to set them up.
+
+Once you have a provider installed, you don't need to make any modifications
+to your Vagrantfile, just `vagrant up` with the proper provider and
+Vagrant will do the rest:
+
+```
+$ vagrant up --provider=vmware_fusion
+...
+```
+
+Ready to move that to the cloud? Take it to AWS:
+
+```
+$ vagrant up --provider=aws
+...
+```
+
+Once you run `vagrant up` with another provider, every other Vagrant
+command doesn't need to be told what provider to use. Vagrant can automatically
+figure it out. So when you're ready to SSH or destroy or anything else,
+just run the commands like normal, such as `vagrant destroy`. No extra
+flags necessary.
+
+For more information on providers, read the full documentation on
+[providers](/v2/providers/index.html).

data/website/docs/source/v2/getting-started/provisioning.html.md

@@ -0,0 +1,75 @@
+---
+page_title: "Provisioning - Getting Started"
+sidebar_current: "gettingstarted-provisioning"
+---
+
+# Provisioning
+
+Alright, so we have a virtual machine running a basic copy of Ubuntu and
+we can edit files from our machine and have them synced into the virtual machine.
+Let's now serve those files using a webserver.
+
+We could just SSH in and install a webserver and be on our way, but then
+every person who used Vagrant would have to do the same thing. Instead,
+Vagrant has built-in support for _automated provisioning_. Using this
+feature, Vagrant will automatically install software when you `vagrant up`
+so that the guest machine can be repeatably created and ready-to-use.
+
+## Installing Apache
+
+We'll just setup [Apache](http://httpd.apache.org/) for our basic project,
+and we'll do so using a shell script. Create the following shell script
+and save it as `bootstrap.sh` in the same directory as your Vagrantfile:
+
+```bash
+#!/usr/bin/env bash
+
+apt-get update
+apt-get install -y apache2
+rm -rf /var/www
+ln -fs /vagrant /var/www
+```
+
+Next, we configure Vagrant to run this shell script when setting up
+our machine. We do this by editing the Vagrantfile, which should now
+look like this:
+
+```ruby
+Vagrant.configure("2") do |config|
+  config.vm.box = "precise32"
+  config.vm.provision :shell, :path => "bootstrap.sh"
+end
+```
+
+The "provision" line is new, and tells Vagrant to use the `shell` provisioner
+to setup the machine, with the `bootstrap.sh` file. The file path is relative
+to the location of the project root (where the Vagrantfile is).
+
+## Provision!
+
+After everything is configured, just run `vagrant up` to create your
+machine and Vagrant will automatically provision it. You should see
+the output from the shell script appear in your terminal. If the guest
+machine is already running from a previous step, run `vagrant reload --provision`,
+which will quickly restart your virtual machine, skipping the initial
+import step. The provision flag on the reload command instructs Vagrant to
+run the provisioners, since usually Vagrant will only do this on the first
+`vagrant up`.
+
+After Vagrant completes running, the web server will be up and running.
+You can't see the website from your own browser (yet), but you can verify
+that the provisioning works by loading a file from SSH within the machine:
+
+```
+$ vagrant ssh
+...
+vagrant@precise32:~$ wget -qO- 127.0.0.1
+```
+
+This works because in the shell script above we installed Apache and
+setup the default `DocumentRoot` of Apache to point to our `/vagrant`
+directory, which is the default synced folder setup by Vagrant.
+
+You can play around some more by creating some more files and viewing
+them from the terminal, but in the next step we'll cover networking
+options so that you can use your own browser to access the guest machine.