haskal
/
vagrant
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update documentation to include more environment variable information

This commit is contained in:
Chris Roberts 2017-07-26 14:47:04 -07:00
parent e5500d0e14
commit d06fbb845b
2 changed files with 43 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
website/source/docs/other/environmental-variables.html.md
View File

@ -161,6 +161,34 @@ the plugin source error and continue.
If this is set, Vagrant will not perform any parallel operations (such as If this is set, Vagrant will not perform any parallel operations (such as
parallel box provisioning). All operations will be performed in serial. 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.
## `VAGRANT_PREFER_SYSTEM_BIN`
If this is set, Vagrant will prefer using utility executables (like `ssh` and `rsync`)
from the local system instead of those vendored within the Vagrant installation.
This currently only applies to Windows systems.
## `VAGRANT_SKIP_SUBPROCESS_JAILBREAK` ## `VAGRANT_SKIP_SUBPROCESS_JAILBREAK`
As of Vagrant 1.7.3, Vagrant tries to intelligently detect if it is running in As of Vagrant 1.7.3, Vagrant tries to intelligently detect if it is running in

15
website/source/docs/other/wsl.html.md
View File

@ -99,6 +99,21 @@ Other useful WSL related environment variables:
* `VAGRANT_WSL_DISABLE_VAGRANT_HOME` - Do not modify the `VAGRANT_HOME` variable * `VAGRANT_WSL_DISABLE_VAGRANT_HOME` - Do not modify the `VAGRANT_HOME` variable
* `VAGRANT_WSL_WINDOWS_ACCESS_USER_HOME_PATH` - Custom Windows system home path * `VAGRANT_WSL_WINDOWS_ACCESS_USER_HOME_PATH` - Custom Windows system home path
If a Vagrant project directory is not within the user's home directory on the
Windows system, certain actions that include permission checks may fail (like
`vagrant ssh`). When accessing Vagrant projects outside the WSL Vagrant will
skip these permission checks when the project path is within the path defined
in the `VAGRANT_WSL_WINDOWS_ACCESS_USER_HOME_PATH` environment variable. For
example, if a user wants to run a Vagrant project from the WSL that is located
at `C:\TestDir\vagrant-project`:
```
C:\Users\vagrant> cd C:\TestDir\vagrant-project
C:\TestDir\vagrant-project> bash
vagrant@vagrant-10:/mnt/c/TestDir/vagrant-project$ export VAGRANT_WSL_WINDOWS_ACCESS_USER_HOME_PATH="/mnt/c/TestDir"
vagrant@vagrant-10:/mnt/c/TestDir/vagrant-project$ vagrant ssh
```
## Using Docker ## Using Docker
The docker daemon cannot be run inside the Windows Subsystem for Linux. However, The docker daemon cannot be run inside the Windows Subsystem for Linux. However,