5093f3120e
This is a big commit, and I apologize in advance for the future
git-blames all pointing to me. This commit does a few things:
1. Merges the website/docs and website/www repo into a single website repo
to be in line with other HashiCorp projects
2. Updates to use middleman-hashicorp
3. Converts less to scss to be in line with other projects
4. Updates page styles to be in line with other projects
5. Optimizes images
6. Prepare for S3 + Fastly deployment with scripts, etc.
7. Removes blog posts (they have been transferred to hashicorp.com with
redirects in place
8. Updated sitemap generation script for better SEO
9. Fixed many broken links
10. Add description to all fields
178 lines
6.1 KiB
Markdown
178 lines
6.1 KiB
Markdown
---
|
|
layout: "docs"
|
|
page_title: "config.vm - Vagrantfile"
|
|
sidebar_current: "vagrantfile-machine"
|
|
description: |-
|
|
The settings within "config.vm" modify the configuration of the
|
|
machine that Vagrant manages.
|
|
---
|
|
|
|
# Machine Settings
|
|
|
|
**Config namespace: `config.vm`**
|
|
|
|
The settings within `config.vm` modify the configuration of the
|
|
machine that Vagrant manages.
|
|
|
|
## Available Settings
|
|
|
|
`config.vm.boot_timeout` - The time in seconds that Vagrant will wait
|
|
for the machine to boot and be accessible. By default this is 300 seconds.
|
|
|
|
<hr>
|
|
|
|
`config.vm.box` - This configures what [box](/docs/boxes.html) the
|
|
machine will be brought up against. The value here should be the name
|
|
of an installed box or a shorthand name of a box in
|
|
[HashiCorp's Atlas](https://atlas.hashicorp.com).
|
|
|
|
This option requires Vagrant 1.5 or higher. You can download the latest version
|
|
of Vagrant from the [Vagrant installers page](/downloads.html).
|
|
|
|
<hr>
|
|
|
|
`config.vm.box_check_update` - If true, Vagrant will check for updates to
|
|
the configured box on every `vagrant up`. If an update is found, Vagrant
|
|
will tell the user. By default this is true. Updates will only be checked
|
|
for boxes that properly support updates (boxes from
|
|
[HashiCorp's Atlas](https://atlas.hashicorp.com)
|
|
or some other versioned box).
|
|
|
|
<hr>
|
|
|
|
`config.vm.box_download_checksum` - The checksum of the box specified by
|
|
`config.vm.box_url`. If not specified, no checksum comparison will be done.
|
|
If specified, Vagrant will compare the checksum of the downloaded box to
|
|
this value and error if they do not match. Checksum checking is only done
|
|
when Vagrant must download the box.
|
|
|
|
If this is specified, then `config.vm.box_download_checksum_type` must
|
|
also be specified.
|
|
|
|
<hr>
|
|
|
|
`config.vm.box_download_checksum_type` - The type of checksum specified
|
|
by `config.vm.box_download_checksum` (if any). Supported values are
|
|
currently "md5", "sha1", and "sha256".
|
|
|
|
<hr>
|
|
|
|
`config.vm.box_download_client_cert` - Path to a client certificate to
|
|
use when downloading the box, if it is necessary. By default, no client
|
|
certificate is used to download the box.
|
|
|
|
<hr>
|
|
|
|
`config.vm.box_download_ca_cert` - Path to a CA cert bundle to use when
|
|
downloading a box directly. By default, Vagrant will use the Mozilla CA cert
|
|
bundle.
|
|
|
|
<hr>
|
|
|
|
`config.vm.box_download_ca_path` - Path to a directory containing
|
|
CA certificates for downloading a box directly. By default, Vagrant will
|
|
use the Mozilla CA cert bundle.
|
|
|
|
<hr>
|
|
`config.vm.box_download_insecure` - If true, then SSL certificates
|
|
from the server will not be verified. By default, if the URL is an HTTPS
|
|
URL, then SSL certs will be verified.
|
|
|
|
<hr>
|
|
|
|
`config.vm.box_download_location_trusted` - If true, then all HTTP redirects will be
|
|
treated as trusted. That means credentials used for initial URL will be used for
|
|
all subsequent redirects. By default, redirect locations are untrusted so credentials
|
|
(if specified) used only for initial HTTP request.
|
|
|
|
<hr>
|
|
|
|
`config.vm.box_url` - The URL that the configured box can be found at.
|
|
If `config.vm.box` is a shorthand to a box in [HashiCorp's Atlas](https://atlas.hashicorp.com)
|
|
then this value does not need to be specified. Otherwise, it should
|
|
point to the proper place where the box can be found if it is not
|
|
installed.
|
|
|
|
This can also be an array of multiple URLs. The URLs will be tried in
|
|
order. Note that any client certificates, insecure download settings, and
|
|
so on will apply to all URLs in this list.
|
|
|
|
The URLs can also be local files by using the `file://` scheme. For
|
|
example: "file:///tmp/test.box".
|
|
|
|
<hr>
|
|
|
|
`config.vm.box_version` - The version of the box to use. This defaults to
|
|
">= 0" (the latest version available). This can contain an arbitrary list
|
|
of constraints, separated by commas, such as: `>= 1.0, < 1.5`. When constraints
|
|
are given, Vagrant will use the latest available box satisfying these
|
|
constraints.
|
|
|
|
<hr>
|
|
|
|
`config.vm.communicator` - The communicator type to use to connect to the
|
|
guest box. By default this is `"ssh"`, but should be changed to `"winrm"` for
|
|
Windows guests.
|
|
|
|
<hr>
|
|
|
|
`config.vm.graceful_halt_timeout` - The time in seconds that Vagrant will
|
|
wait for the machine to gracefully halt when `vagrant halt` is called.
|
|
Defaults to 60 seconds.
|
|
|
|
<hr>
|
|
|
|
`config.vm.guest` - The guest OS that will be running within this
|
|
machine. This defaults to `:linux`, and Vagrant will auto-detect the
|
|
proper distro. Vagrant needs to know this information to perform some
|
|
guest OS-specific things such as mounting folders and configuring
|
|
networks.
|
|
|
|
<hr>
|
|
|
|
`config.vm.hostname` - The hostname the machine should have. Defaults
|
|
to nil. If nil, Vagrant will not manage the hostname. If set to a string,
|
|
the hostname will be set on boot.
|
|
|
|
<hr>
|
|
|
|
`config.vm.network` - Configures [networks](/docs/networking/) on
|
|
the machine. Please see the networking page for more information.
|
|
|
|
<hr>
|
|
|
|
`config.vm.post_up_message` - A message to show after `vagrant up`. This
|
|
will be shown to the user and is useful for containing instructions
|
|
such as how to access various components of the development environment.
|
|
|
|
<hr>
|
|
|
|
`config.vm.provider` - Configures [provider-specific configuration](/docs/providers/configuration.html),
|
|
which is used to modify settings which are specific to a certain
|
|
[provider](/docs/providers/). If the provider you are configuring
|
|
does not exist or is not setup on the system of the person who runs
|
|
`vagrant up`, Vagrant will ignore this configuration block. This allows
|
|
a Vagrantfile that is configured for many providers to be shared among
|
|
a group of people who may not have all the same providers installed.
|
|
|
|
<hr>
|
|
|
|
`config.vm.provision` - Configures [provisioners](/docs/provisioning/)
|
|
on the machine, so that software can be automatically installed and configured
|
|
when the machine is created. Please see the page on provisioners for more
|
|
information on how this setting works.
|
|
|
|
<hr>
|
|
|
|
`config.vm.synced_folder` - Configures [synced folders](/docs/synced-folders/)
|
|
on the machine, so that folders on your host machine can be synced to
|
|
and from the guest machine. Please see the page on synced folders for
|
|
more information on how this setting works.
|
|
|
|
<hr>
|
|
|
|
`config.vm.usable_port_range` - A range of ports Vagrant can use for
|
|
handling port collisions and such. Defaults to `2200..2250`.
|
|
|
|
<hr>
|