tnargav 1.2.3 → 1.3.3

data/website/docs/source/stylesheets/vagrantup.less

@@ -0,0 +1,16 @@
+/*
+/|\/|\/|\/|\/|\/|\
+v a g r a n t u p
+\|/\|/\|/\|/\|/\|/
+*/
+
+@import '_variables';
+@import '_type';
+@import '_mixins';
+@import '_base';
+@import '_nav';
+@import '_components';
+@import '_sidebar';
+@import '_pages';
+@import '_footer';
+@import '_media-queries';

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

@@ -0,0 +1,78 @@
+---
+page_title: "Boxes"
+sidebar_current: "boxes"
+---
+
+# Boxes
+
+Boxes are the skeleton from which Vagrant machines are constructed. They are
+portable files which can be used by others on any platform that runs Vagrant
+to bring up a working environment.
+
+The `vagrant box` utility provides all the functionality for managing
+boxes. Boxes must currently be created manually.
+
+Boxes are [provider-specific](/v2/providers/index.html), so you must obtain
+the proper box depending on what provider you're using.
+
+If you're interested in more details on the exact file format of
+boxes, there is a separate [page dedicated to that](/v2/boxes/format.html), since
+it is an advanced topic that general users don't need to know.
+
+## Adding Boxes
+
+Adding boxes is straightforward:
+
+```
+$ vagrant box add name url
+```
+
+`name` is a logical name by which the box is referenced from the
+Vagrantfile. You can put anything you want here, but know that Vagrant
+matches the `config.vm.box` directive with this name in order to look up
+the box to use.
+
+`url` is the location of the box. This can be a path to your local filesystem
+or an HTTP URL to the box remotely.
+
+Vagrant will automatically determine the provider the box was built
+for by reading the "metadata.json" file within the box archive. You
+may also tell Vagrant what provider the box is for by specifying the
+`--provider` flag.
+
+This is recommended as it adds an extra level of verification
+to the box you're downloading. Additionally, Vagrant can exit early with
+an error if a box with that name and provider already exists, whereas
+it must download the entire box before showing such an error in the other
+case.
+
+Multiple boxes with the same name can exist as long as they are all
+for different providers. The example of listing boxes below shows this,
+where there are multiple precise64 boxes, backed by different providers.
+This lets a single `config.vm.box` configuration within a Vagrantfile
+properly reference boxes across providers.
+
+## Listing Boxes
+
+To view what boxes Vagrant has locally installed, use `vagrant box list`:
+
+```
+$ vagrant box list
+precise64 (virtualbox)
+precise64 (vmware_fusion)
+```
+
+Vagrant lists all boxes along with the providers the box is for in parentheses.
+
+## Removing Boxes
+
+Boxes can be removed just as easily as they are added:
+
+```
+$ vagrant box remove precise64 virtualbox
+```
+
+The two arguments are the logical name of the box and the provider of the
+box. The second argument (the provider) is optional. If you have only a single
+provider backing that box, it doesn't need to be specified. If you have multiple
+providers backing a box and it isn't specified, Vagrant will show an error.

data/website/docs/source/v2/boxes/format.html.md

@@ -0,0 +1,32 @@
+---
+page_title: "Box File Format"
+sidebar_current: "boxes-format"
+---
+
+# Box File Format
+
+In the past, boxes were just [tar files](http://en.wikipedia.org/wiki/Tar_\(computing\))
+of VirtualBox exports. With Vagrant supporting multiple providers, box files
+are now tar files where the contents differ for each provider. They are
+still tar files, but they may now optionally be [gzipped](http://en.wikipedia.org/wiki/Gzip)
+as well.
+
+Box files made for Vagrant 1.0.x and VirtualBox continue to work with
+Vagrant 1.1+ and the VirtualBox provider.
+
+The only file required within a box is a "metadata.json" file. This is
+a [JSON](http://www.json.org/) file that has a top-level object that
+can contain any metadata about the box. Vagrant requires that a "provider"
+key exists in this metadata with the name of the provider the box is made
+for.
+
+The "metadata.json" file for a VirtualBox box:
+
+```json
+{
+  "provider": "virtualbox"
+}
+```
+
+If there is no metadata.json file or the file does not contain valid JSON
+with at least a "provider" key, then Vagrant will error when adding the box.

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

@@ -0,0 +1,62 @@
+---
+page_title: "vagrant box - Command-Line Interface"
+sidebar_current: "cli-box"
+---
+
+# Box
+
+**Command: `vagrant box`**
+
+This is the command used to manage (add, remove, etc.) [boxes](/v2/boxes.html).
+
+The main functionality of this command is exposed via even more subcommands:
+
+* `add`
+* `list`
+* `remove`
+* `repackage`
+
+# Box Add
+
+**Command: `vagrant box add NAME URL`**
+
+This adds a box at the given URL to Vagrant and stores it under the
+logical name `NAME`.
+
+The URL may be a file path or an HTTP URL. For HTTP, basic authentication
+is supported and `http_proxy` environmental variables are respected. HTTPS
+is also supported.
+
+The name argument of this command is a _logical name_, meaning you can
+effectively choose whatever you want. This is the name that Vagrant searches
+for to match with the `config.vm.box` setting in Vagrantfiles.
+
+## Options
+
+* `--provider PROVIDER` - If given, Vagrant will verify the box you're
+  adding is for the given provider. By default, Vagrant automatically
+  detects the proper provider to use.
+
+# Box List
+
+**Command: `vagrant box list`**
+
+This command lists all the boxes that are installed into Vagrant.
+
+# Box Remove
+
+**Command: `vagrant box remove NAME PROVIDER`**
+
+This command removes a box from Vagrant that matches the given name and
+provider.
+
+# Box Repackage
+
+**Command: `vagrant box repackage NAME PROVIDER`**
+
+This command repackages the given box and puts it in the current
+directory so you can redistribute it.
+
+When you add a box, Vagrant unpacks it and stores it internally. The
+original `*.box` file is not preserved. This command is useful for
+reclaiming a `*.box` file from an installed Vagrant box.

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

@@ -0,0 +1,20 @@
+---
+page_title: "vagrant destroy - Command-Line Interface"
+sidebar_current: "cli-destroy"
+---
+
+# Destroy
+
+**Command: `vagrant destroy`**
+
+This command stops the running machine Vagrant is managing and
+destroys all resources that were created during the machine creation process.
+After running this command, your computer should be left at a clean state,
+as if you never created the guest machine in the first place.
+
+This command usually asks for confirmation before destroying. This
+confirmation can be skipped by passing in the `-f` or `--force` flag.
+
+## Options
+
+* `-f` or `--force` - Don't ask for confirmation before destroying.

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

@@ -0,0 +1,19 @@
+---
+page_title: "vagrant halt - Command-Line Interface"
+sidebar_current: "cli-halt"
+---
+
+# Halt
+
+**Command: `vagrant halt`**
+
+This command shuts down the running machine Vagrant is managing.
+
+Vagrant will first attempt to gracefully shut down the machine by running
+the guest OS shutdown mechanism. If this fails, or if the `--force` flag is
+specified, Vagrant will effectively just shut off power to the machine.
+
+## Options
+
+* `-f` or `--force` - Don't attempt to gracefully shut down the machine.
+  This effectively pulls the power on the guest machine.

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

@@ -0,0 +1,24 @@
+---
+page_title: "Command-Line Interface"
+sidebar_current: "cli"
+---
+
+# Command-Line Interface
+
+Almost all interaction with Vagrant is done through the command-line
+interface.
+
+The interface is available using the `vagrant` command, and comes installed
+with Vagrant automatically. The `vagrant` command in turn has many subcommands,
+such as `vagrant up`, `vagrant destroy`, etc.
+
+If you run `vagrant` by itself, help will be displayed showing all available
+subcommands. In addition to this, you can run any Vagrant command with the
+`-h` flag to output help about that specific command. For example, try
+running `vagrant init -h`. The help will output a one sentence synopsis of
+what the command does as well as a list of all the flags the command
+accepts.
+
+In depth documentation and use cases of various Vagrant commands is
+available by reading the appropriate sub-section available in the left
+navigational area of this site.

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

@@ -0,0 +1,18 @@
+---
+page_title: "vagrant init - Command-Line Interface"
+sidebar_current: "cli-init"
+---
+
+# Init
+
+**Command: `vagrant init [box-name] [box-url]`**
+
+This initializes the current directory to be a Vagrant environment
+by creating an initial [Vagrantfile](/v2/vagrantfile/index.html) if
+one doesn't already exist.
+
+If a first argument is given, it will prepopulate the `config.vm.box`
+setting in the created Vagrantfile.
+
+If a second argument is given, it will prepopulate the `config.vm.box_url`
+setting in the created Vagrantfile.

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

@@ -0,0 +1,43 @@
+---
+page_title: "vagrant package - Command-Line Interface"
+sidebar_current: "cli-package"
+---
+
+# Package
+
+**Command: `vagrant package`**
+
+This packages a currently running _VirtualBox_ environment into a
+re-usable [box](/v2/boxes.html). This command cannot be used with
+any other [provider](/v2/providers/index.html). A future version of Vagrant
+will address packaging boxes for other providers. Until then, they must
+be made by hand.
+
+## Options
+
+* `--base NAME` - Instead of packaging a VirtualBox machine that Vagrant
+  manages, this will package a VirtualBox machine that VirtualBox manages.
+  `NAME` should be the name or UUID of the machine from the VirtualBox GUI.
+
+* `--output NAME` - The resulting package will be saved as `NAME`. By default,
+  it will be saved as `package.box`.
+
+* `--include x,y,z` - Additional files will be packaged with the box. These
+  can be used by a packaged Vagrantfile (documented below) to perform additional
+  tasks.
+
+* `--vagrantfile FILE` - Packages a Vagrantfile with the box, that is loaded
+  as part of the [Vagrantfile load order](/v2/vagrantfile/index.html#load-order)
+  when the resulting box is used.
+
+<div class="alert alert-info">
+	<p>
+		<strong>A common misconception</strong> is that the <code>--vagrantfile</code>
+		option will package a Vagrantfile that is used when <code>vagrant init</code>
+		is used with this box. This is not the case. Instead, a Vagrantfile
+		is loaded and read as part of the Vagrant load process when the box is
+		used. For more information, read about the
+		<a href="/v2/vagrantfile/index.html#load-order">Vagrantfile load order</a>.
+	</p>
+</div>
+

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

@@ -0,0 +1,56 @@
+---
+page_title: "vagrant plugin - Command-Line Interface"
+sidebar_current: "cli-plugin"
+---
+
+# Plugin
+
+**Command: `vagrant plugin`**
+
+This is the command used to manage [plugins](/v2/plugins/index.html).
+
+The main functionality of this command is exposed via another level
+of subcommands:
+
+* `install`
+* `license`
+* `list`
+* `uninstall`
+* `update`
+
+# Plugin Install
+
+**Command: `vagrant plugin install <name>`**
+
+This installs a plugin with the given name or file path. If the name
+is not a path to a file, then the plugin is installed from remote
+repositories, usually [RubyGems](http://rubygems.org). This command will
+also update a plugin if it is already installed, but you can also use
+`vagrant plugin update` for that.
+
+# Plugin License
+
+**Command: `vagrant plugin license <name> <license-file>`**
+
+This command installs a license for a proprietary Vagrant plugin,
+such as the [VMware Fusion provider](/v2/vmware/index.html).
+
+# Plugin List
+
+**Command: `vagrant plugin list`**
+
+This lists all installed plugins and their respective versions.
+
+# Plugin Uninstall
+
+**Command: `vagrant plugin uninstall <name>`**
+
+This uninstalls the plugin with the given name. Any dependencies of the
+plugin will also be uninstalled assuming no other plugin needs them.
+
+# Plugin Update
+
+**Command: `vagrant plugin update <name>`**
+
+This updates the plugin with the given name. If the plugin isn't already
+installed, this will not install it.

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

@@ -0,0 +1,24 @@
+---
+page_title: "vagrant provision - Command-Line Interface"
+sidebar_current: "cli-provision"
+---
+
+# Provision
+
+**Command: `vagrant provision`**
+
+Runs any configured [provisioners](/v2/provisioning/index.html)
+against the running Vagrant managed machine.
+
+This command is a great way to quickly test any provisioners, and is especially
+useful for incremental development of shell scripts, Chef cookbooks, or Puppet
+modules. You can just make simple modifications to the provisioning scripts
+on your machine, run a `vagrant provision`, and check for the desired results.
+Rinse and repeat.
+
+# Options
+
+* `--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/cli/reload.html.md

@@ -0,0 +1,27 @@
+---
+page_title: "vagrant reload - Command-Line Interface"
+sidebar_current: "cli-reload"
+---
+
+# Reload
+
+**Command: `vagrant reload`**
+
+The equivalent of running a [halt](/v2/cli/halt.html) followed by an
+[up](/v2/cli/up.html).
+
+This command is usually required for changes made in the Vagrantfile to
+take effect. After making any modifications to the Vagrantfile, a `reload`
+should be called.
+
+The configured provisioners will not run again, by default. You can force
+the provisioners to re-run by specifying the `--provision` flag.
+
+# Options
+
+* `--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/cli/resume.html.md

@@ -0,0 +1,11 @@
+---
+page_title: "vagrant resume - Command-Line Interface"
+sidebar_current: "cli-resume"
+---
+
+# Resume
+
+**Command: `vagrant resume`**
+
+This resumes a Vagrant managed machine that was previously suspended,
+perhaps with the [suspend command](/v2/cli/suspend.html).