diff --git a/website/source/docs/other/environmental-variables.html.md b/website/source/docs/other/environmental-variables.html.md index 6bca172bc..a49e2c889 100644 --- a/website/source/docs/other/environmental-variables.html.md +++ b/website/source/docs/other/environmental-variables.html.md @@ -14,45 +14,46 @@ Vagrant has a set of environmental variables that can be used to configure and control it in a global way. This page lists those environmental variables. +## CFLAGS + +If set the contents of this environment variable will be appended to the +value generated by the Vagrant launcher. + +## CPPFLAGS + +If set the contents of this environment variable will be appended to the +value generated by the Vagrant launcher. + +## CURL_CA_BUNDLE + +If set this environment variable will be passed through to the Vagrant +process. By default Vagrant will use the CA certificate included with +the Vagrant installation. + +## LDFLAGS + +If set the contents of this environment variable will be appended to the +value generated by the Vagrant launcher. + +## SSL_CERT_FILE + +If set this environment variable will be passed through to the Vagrant +process. By default Vagrant will use the CA certificate included with +the Vagrant installation. + ## `VAGRANT_ALIAS_FILE` `VAGRANT_ALIAS_FILE` can be set to change the file where Vagrant aliases are defined. By default, this is set to `~/.vagrant.d/aliases`. -## `VAGRANT_DEBUG_LAUNCHER` +## `VAGRANT_ALLOW_PLUGIN_SOURCE_ERRORS` -For performance reasons, especially for Windows users, Vagrant uses a static -binary to launch the actual Vagrant process. If you have _very_ early issues -when launching Vagrant from the official installer, you can specify the -`VAGRANT_DEBUG_LAUNCHER` environment variable to output debugging information -about the launch process. - -## `VAGRANT_DEFAULT_PROVIDER` - -This configures the default provider Vagrant will use. - -This normally does not need to be set since Vagrant is fairly intelligent -about how to detect the default provider. By setting this, you will force -Vagrant to use this provider for any _new_ Vagrant environments. Existing -Vagrant environments will continue to use the provider they came `up` with. -Once you `vagrant destroy` existing environments, this will take effect. - -## `VAGRANT_DEFAULT_TEMPLATE` - -This configures the template used by `vagrant init` when the `--template` option -is not provided. - -## `VAGRANT_PREFERRED_PROVIDERS` - -This configures providers that Vagrant should prefer. - -Much like the `VAGRANT_DEFAULT_PROVIDER` this environment variable normally -does not need to be set. By setting this you will instruct Vagrant to -_prefer_ providers defined in this environment variable for any _new_ -Vagrant environments. Existing Vagrant environments will continue to use -the provider they came `up` with. Once you `vagrant destroy` existing environments, -this will take effect. A single provider can be defined within this environment -variable or a comma delimited list of providers. +If this is set to any value, then Vagrant will not error when a configured +plugin source is unavailable. When installing a Vagrant plugin Vagrant +will error and halt if a plugin source is inaccessible. In some cases it +may be desirable to ignore inaccessible sources and continue with the +plugin installation. Enabling this value will cause Vagrant to simply log +the plugin source error and continue. ## `VAGRANT_BOX_UPDATE_CHECK_DISABLE` @@ -86,6 +87,58 @@ expanded relative to where the Vagrantfile is found. This environmental variable is most commonly set when running Vagrant from a scripting environment in order to set the directory that Vagrant sees. +## `VAGRANT_DEBUG_LAUNCHER` + +For performance reasons, especially for Windows users, Vagrant uses a static +binary to launch the actual Vagrant process. If you have _very_ early issues +when launching Vagrant from the official installer, you can specify the +`VAGRANT_DEBUG_LAUNCHER` environment variable to output debugging information +about the launch process. + +## `VAGRANT_DEFAULT_PROVIDER` + +This configures the default provider Vagrant will use. + +This normally does not need to be set since Vagrant is fairly intelligent +about how to detect the default provider. By setting this, you will force +Vagrant to use this provider for any _new_ Vagrant environments. Existing +Vagrant environments will continue to use the provider they came `up` with. +Once you `vagrant destroy` existing environments, this will take effect. + +## `VAGRANT_DEFAULT_TEMPLATE` + +This configures the template used by `vagrant init` when the `--template` option +is not provided. + +## `VAGRANT_DETECTED_ARCH` + +This environment variable may be set by the Vagrant launcher to help determine +the current runtime architecture in use. In general Vagrant will set this value +when running on a Windows host using a cygwin or msys based shell. The value +the Vagrant launcher may set in this environment variable will not always match +the actual architecture of the platform itself. Instead it signifies the detected +architecture of the environment it is running within. If this value is set, the +Vagrant launcher will not modify it. + +## `VAGRANT_DETECTED_OS` + +This environment variable may be set by the Vagrant launcher to help determine +the current runtime platform. In general Vagrant will set this value when running +on a Windows host using a cygwin or msys based shell. If this value is set, the +Vagrant launcher will not modify it. + +## `VAGRANT_DISABLE_RESOLV_REPLACE` + +Vagrant can optionally use the Ruby Resolv library in place of the libc resolver. +This can be disabled setting this environment variable. + +## `VAGRANT_DISABLE_VBOXSYMLINKCREATE` + +If set, this will disable the ability to create symlinks with all virtualbox +shared folders. Defaults to true if the option is not set. This can be overridden +on a per-folder basis within your Vagrantfile config by settings the +`SharedFoldersEnableSymlinksCreate` option to true. + ## `VAGRANT_DOTFILE_PATH` `VAGRANT_DOTFILE_PATH` can be set to change the directory where Vagrant stores @@ -97,6 +150,20 @@ host. To avoid this, you could set `VAGRANT_DOTFILE_PATH` to `.vagrant-laptop` and `.vagrant-desktop` on the respective machines. (Remember to update your `.gitignore`!) +## `VAGRANT_ENABLE_RESOLV_REPLACE` + +Use the Ruby Resolv library in place of the libc resolver. + +## `VAGRANT_FORCE_COLOR` + +If this is set to any value, then Vagrant will force colored output, even +if it detected that there is no TTY or the current environment does not +support it. + +The equivalent behavior can be achieved by using the `--color` flag on a +command-by-command basis. This environmental variable is useful for setting +this flag globally. + ## `VAGRANT_HOME` `VAGRANT_HOME` can be set to change the directory where Vagrant stores @@ -104,6 +171,30 @@ global state. By default, this is set to `~/.vagrant.d`. The Vagrant home directory is where things such as boxes are stored, so it can actually become quite large on disk. +## `VAGRANT_IGNORE_WINRM_PLUGIN` + +Vagrant will not display warning when `vagrant-winrm` plugin is installed. + +## `VAGRANT_INSTALL_LOCAL_PLUGINS` + +If this is set to any value, Vagrant will not prompt for confirmation +prior to installing local plugins which have been defined within the +local Vagrantfile. + +## `VAGRANT_IS_HYPERV_ADMIN` + +Disable Vagrant's check for Hyper-V admin privileges and allow Vagrant to assume +the current user has full access to Hyper-V. This is useful if the internal +privilege check incorrectly determines the current user does not have access +to Hyper-V. + +## `VAGRANT_LOCAL_PLUGINS_LOAD` + +If this is set Vagrant will not stub the Vagrantfile when running +`vagrant plugin` commands. When this environment variable is set the +`--local` flag will not be required by `vagrant plugin` commands to +enable local project plugins. + ## `VAGRANT_LOG` `VAGRANT_LOG` specifies the verbosity of log messages from Vagrant. @@ -136,15 +227,10 @@ The equivalent behavior can be achieved by using the `--no-color` flag on a command-by-command basis. This environmental variable is useful for setting this flag globally. -## `VAGRANT_FORCE_COLOR` +## `VAGRANT_NO_PARALLEL` -If this is set to any value, then Vagrant will force colored output, even -if it detected that there is no TTY or the current environment does not -support it. - -The equivalent behavior can be achieved by using the `--color` flag on a -command-by-command basis. This environmental variable is useful for setting -this flag globally. +If this is set, Vagrant will not perform any parallel operations (such as +parallel box provisioning). All operations will be performed in serial. ## `VAGRANT_NO_PLUGINS` @@ -157,54 +243,28 @@ Note that any `vagrant plugin` commands automatically do not load any plugins, so if you do install any unstable plugins, you can always use the `vagrant plugin` commands without having to worry. -## `VAGRANT_ALLOW_PLUGIN_SOURCE_ERRORS` +## `VAGRANT_POWERSHELL_VERSION_DETECTION_TIMEOUT` -If this is set to any value, then Vagrant will not error when a configured -plugin source is unavailable. When installing a Vagrant plugin Vagrant -will error and halt if a plugin source is inaccessible. In some cases it -may be desirable to ignore inaccessible sources and continue with the -plugin installation. Enabling this value will cause Vagrant to simply log -the plugin source error and continue. +Vagrant will use a default timeout when checking for the installed version +of PowerShell. Occasionally the default can be too low and Vagrant will report +being unable to detect the installed version of PowerShell. This environment +variable can be used to extend the timeout used during PowerShell version +detection. -## `VAGRANT_INSTALL_LOCAL_PLUGINS` +When setting this environment variable, its value will be in seconds. By default, +it will use 30 seconds as a timeout. -If this is set to any value, Vagrant will not prompt for confirmation -prior to installing local plugins which have been defined within the -local Vagrantfile. +## `VAGRANT_PREFERRED_PROVIDERS` -## `VAGRANT_LOCAL_PLUGINS_LOAD` +This configures providers that Vagrant should prefer. -If this is set Vagrant will not stub the Vagrantfile when running -`vagrant plugin` commands. When this environment variable is set the -`--local` flag will not be required by `vagrant plugin` commands to -enable local project plugins. - -## `VAGRANT_NO_PARALLEL` - -If this is set, Vagrant will not perform any parallel operations (such as -parallel box provisioning). All operations will be performed in serial. - -## `VAGRANT_DETECTED_OS` - -This environment variable may be set by the Vagrant launcher to help determine -the current runtime platform. In general Vagrant will set this value when running -on a Windows host using a cygwin or msys based shell. If this value is set, the -Vagrant launcher will not modify it. - -## `VAGRANT_DETECTED_ARCH` - -This environment variable may be set by the Vagrant launcher to help determine -the current runtime architecture in use. In general Vagrant will set this value -when running on a Windows host using a cygwin or msys based shell. The value -the Vagrant launcher may set in this environment variable will not always match -the actual architecture of the platform itself. Instead it signifies the detected -architecture of the environment it is running within. If this value is set, the -Vagrant launcher will not modify it. - -## `VAGRANT_WINPTY_DISABLE` - -If this is set, Vagrant will _not_ wrap interactive processes with winpty where -required. +Much like the `VAGRANT_DEFAULT_PROVIDER` this environment variable normally +does not need to be set. By setting this you will instruct Vagrant to +_prefer_ providers defined in this environment variable for any _new_ +Vagrant environments. Existing Vagrant environments will continue to use +the provider they came `up` with. Once you `vagrant destroy` existing environments, +this will take effect. A single provider can be defined within this environment +variable or a comma delimited list of providers. ## `VAGRANT_PREFER_SYSTEM_BIN` @@ -228,6 +288,15 @@ If Vagrant detects it is running outside of the officially installer, the original environment will always be restored. You can disable this automatic jailbreak by setting `VAGRANT_SKIP_SUBPROCESS_JAILBREAK`. +## `VAGRANT_USER_AGENT_PROVISIONAL_STRING` + +Vagrant will append the contents of this variable to the default user agent header. + +## `VAGRANT_USE_VAGRANT_TRIGGERS` + +Vagrant will not display the warning about disabling the core trigger feature if +the community plugin is installed. + ## `VAGRANT_VAGRANTFILE` This specifies the filename of the Vagrantfile that Vagrant searches for. @@ -238,49 +307,7 @@ This environmental variable is commonly used in scripting environments where a single folder may contain multiple Vagrantfiles representing different configurations. -## `VAGRANT_DISABLE_VBOXSYMLINKCREATE` +## `VAGRANT_WINPTY_DISABLE` -If set, this will disable the ability to create symlinks with all virtualbox -shared folders. Defaults to true if the option is not set. This can be overridden -on a per-folder basis within your Vagrantfile config by settings the -`SharedFoldersEnableSymlinksCreate` option to true. - -## `VAGRANT_ENABLE_RESOLV_REPLACE` - -Use the Ruby Resolv library in place of the libc resolver. - -## `VAGRANT_DISABLE_RESOLV_REPLACE` - -Vagrant can optionally use the Ruby Resolv library in place of the libc resolver. -This can be disabled setting this environment variable. - -## `VAGRANT_POWERSHELL_VERSION_DETECTION_TIMEOUT` - -Vagrant will use a default timeout when checking for the installed version -of PowerShell. Occasionally the default can be too low and Vagrant will report -being unable to detect the installed version of PowerShell. This environment -variable can be used to extend the timeout used during PowerShell version -detection. - -When setting this environment variable, its value will be in seconds. By default, -it will use 30 seconds as a timeout. - -## `VAGRANT_USE_VAGRANT_TRIGGERS` - -Vagrant will not display the warning about disabling the core trigger feature if -the community plugin is installed. - -## `VAGRANT_IGNORE_WINRM_PLUGIN` - -Vagrant will not display warning when `vagrant-winrm` plugin is installed. - -## `VAGRANT_USER_AGENT_PROVISIONAL_STRING` - -Vagrant will append the contents of this variable to the default user agent header. - -## `VAGRANT_IS_HYPERV_ADMIN` - -Disable Vagrant's check for Hyper-V admin privileges and allow Vagrant to assume -the current user has full access to Hyper-V. This is useful if the internal -privilege check incorrectly determines the current user does not have access -to Hyper-V. +If this is set, Vagrant will _not_ wrap interactive processes with winpty where +required.