2013-09-04 22:51:56 +00:00
|
|
|
---
|
2016-01-19 18:08:53 +00:00
|
|
|
layout: "docs"
|
2013-09-06 16:50:43 +00:00
|
|
|
page_title: "config.vagrant - Vagrantfile"
|
2013-09-04 22:51:56 +00:00
|
|
|
sidebar_current: "vagrantfile-vagrant"
|
2016-01-19 18:08:53 +00:00
|
|
|
description: |-
|
|
|
|
The settings within "config.vagrant" modify the behavior of Vagrant
|
|
|
|
itself.
|
2013-09-04 22:51:56 +00:00
|
|
|
---
|
|
|
|
|
|
|
|
# Vagrant Settings
|
|
|
|
|
|
|
|
**Config namespace: `config.vagrant`**
|
|
|
|
|
|
|
|
The settings within `config.vagrant` modify the behavior of Vagrant
|
|
|
|
itself.
|
|
|
|
|
|
|
|
## Available Settings
|
|
|
|
|
2018-10-26 22:32:51 +00:00
|
|
|
* `config.vagrant.host` (string, symbol) - This sets the type of host machine
|
|
|
|
that is running Vagrant. By default this is `:detect`, which causes Vagrant to
|
|
|
|
auto-detect the host. Vagrant needs to know this information in order to perform
|
|
|
|
some host-specific things, such as preparing NFS folders if they're enabled.
|
2013-09-04 22:51:56 +00:00
|
|
|
You should only manually set this if auto-detection fails.
|
2018-01-15 15:23:47 +00:00
|
|
|
|
2018-10-26 22:32:51 +00:00
|
|
|
* `config.vagrant.plugins` - (string, array, hash) - Define plugin, list of
|
2018-07-18 22:48:55 +00:00
|
|
|
plugins, or definition of plugins to install for the local project. Vagrant
|
|
|
|
will require these plugins be installed and available for the project. If
|
|
|
|
the plugins are not available, it will attempt to automatically install
|
|
|
|
them into the local project. When requiring a single plugin, a string can
|
|
|
|
be provided:
|
|
|
|
|
2018-10-26 22:32:51 +00:00
|
|
|
```ruby
|
|
|
|
config.vagrant.plugins = "vagrant-plugin"
|
|
|
|
```
|
2018-07-18 22:48:55 +00:00
|
|
|
|
2018-10-26 22:32:51 +00:00
|
|
|
If multiple plugins are required, they can be provided as an array:
|
2018-07-18 22:48:55 +00:00
|
|
|
|
2018-10-26 22:32:51 +00:00
|
|
|
```ruby
|
|
|
|
config.vagrant.plugins = ["vagrant-plugin", "vagrant-other-plugin"]
|
|
|
|
```
|
2018-07-18 22:48:55 +00:00
|
|
|
|
2018-10-26 22:32:51 +00:00
|
|
|
Plugins can also be defined as a Hash, which supports setting extra options
|
|
|
|
for the plugins. When a Hash is used, the key is the name of the plugin, and
|
|
|
|
the value is a Hash of options for the plugin. For example, to set an explicit
|
|
|
|
version of a plugin to install:
|
2018-07-18 22:48:55 +00:00
|
|
|
|
2018-10-26 22:32:51 +00:00
|
|
|
```ruby
|
|
|
|
config.vagrant.plugins = {"vagrant-scp" => {"version" => "1.0.0"}}
|
|
|
|
```
|
2018-07-18 22:48:55 +00:00
|
|
|
|
2018-10-26 22:32:51 +00:00
|
|
|
Supported options are:
|
2018-07-18 22:48:55 +00:00
|
|
|
|
2018-10-26 22:32:51 +00:00
|
|
|
* `entry_point` - Path for Vagrant to load plugin
|
|
|
|
* `sources` - Custom sources for downloading plugin
|
|
|
|
* `version` - Version constraint for plugin
|
2018-07-18 22:48:55 +00:00
|
|
|
|
2018-10-26 22:32:51 +00:00
|
|
|
* `config.vagrant.sensitive` - (string, array) - Value or list of values that
|
2018-01-15 15:23:47 +00:00
|
|
|
should not be displayed in Vagrant's output. Value(s) will be removed from
|
|
|
|
Vagrant's normal UI output as well as logger output.
|
2018-01-17 00:04:32 +00:00
|
|
|
|
2018-10-26 22:32:51 +00:00
|
|
|
```ruby
|
|
|
|
config.vagrant.sensitive = ["MySecretPassword", ENV["MY_TOKEN"]]
|
|
|
|
```
|