website/docs: document environmental variables
This commit is contained in:
parent
f861fbcafb
commit
850d1484aa
|
@ -222,7 +222,14 @@
|
|||
</ul>
|
||||
<% end %>
|
||||
|
||||
<li<%= sidebar_current("debugging") %>><a href="/v2/debugging.html">Debugging</a></li>
|
||||
<li<%= sidebar_current("other") %>><a href="/v2/other/index.html">Other</a></li>
|
||||
|
||||
<% if sidebar_section == "other" %>
|
||||
<ul class="sub unstyled">
|
||||
<li<%= sidebar_current("other-debugging") %>><a href="/v2/other/debugging.html">Debugging</a></li>
|
||||
<li<%= sidebar_current("other-envvars") %>><a href="/v2/other/environmental-variables.html">Environmental Variables</a></li>
|
||||
</ul>
|
||||
<% end %>
|
||||
</ul>
|
||||
</aside> <!-- /.sidebar -->
|
||||
</div> <!-- /.sidebar -->
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
page_title: "Debugging and Troubleshooting"
|
||||
sidebar_current: "debugging"
|
||||
sidebar_current: "other-debugging"
|
||||
---
|
||||
|
||||
# Debugging
|
|
@ -0,0 +1,81 @@
|
|||
---
|
||||
page_title: "Environmental Variables"
|
||||
sidebar_current: "other-envvars"
|
||||
---
|
||||
|
||||
# Environmental Variables
|
||||
|
||||
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.
|
||||
|
||||
## VAGRANT\_CWWD
|
||||
|
||||
`VAGRANT_CWD` can be set to change the working directory of Vagrant. By
|
||||
default, Vagrant uses the current directory you're in. The working directory
|
||||
is important because it is where Vagrant looks for the Vagrantfile. It
|
||||
also defines how relative paths in the Vagrantfile are expanded, since they're
|
||||
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\_HOME
|
||||
|
||||
`VAGRANT_HOME` can be set to change the directory where Vagrant stores
|
||||
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\_LOG
|
||||
|
||||
`VAGRANT_LOG` specifies the verbosity of log messages from Vagrant.
|
||||
By default, Vagrant does not actively show any log messages.
|
||||
|
||||
Log messages are very useful when troubleshooting issues, reporting
|
||||
bugs, or getting support. At the most verbose level, Vagrant outputs
|
||||
basically everything it is doing.
|
||||
|
||||
Available log levels are "debug," "info," "warn," and "error." Both
|
||||
"warn" and "error" are practically useless since there are very few
|
||||
cases of these, and Vagrant generally reports them within the normal
|
||||
output.
|
||||
|
||||
"info" is a good level to start with if you're having problems, because
|
||||
while it is much louder than normal output, it is still very human-readable
|
||||
and can help identify certain issues.
|
||||
|
||||
"debug" output is _extremely_ verbose and can be difficult to read without
|
||||
some knowledge of Vagrant internals. It is the best output to attach to
|
||||
a support request or bug report, however.
|
||||
|
||||
## VAGRANT\_NO\_COLOR
|
||||
|
||||
If this is set to any value, then Vagrant will not use any colorized
|
||||
output. This is useful if you're logging the output to a file or
|
||||
on a system that doesn't support colors.
|
||||
|
||||
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\_NO\_PLUGINS
|
||||
|
||||
If this is set to any value, then Vagrant will not load any 3rd party
|
||||
plugins. This is useful if you install a plugin and it is introducing
|
||||
instability to Vagrant, or if you want a specific Vagrant environment to
|
||||
not load plugins.
|
||||
|
||||
Note that any `vagrant plugin` commands automatically don't load any
|
||||
plugins, so if you do install any unstable plugins, you can always use
|
||||
the `vagrant plugin` commands without having to worry.
|
||||
|
||||
## VAGRANT\_VAGRANTFILE
|
||||
|
||||
This specifies the filename of the Vagrantfile that Vagrant searches for.
|
||||
By default, this is "Vagrantfile." Note that this is _not_ a file path,
|
||||
but just a filename.
|
||||
|
||||
This environmental variable is commonly used in scripting environments
|
||||
where a single folder may contain multiple Vagrantfiles representing
|
||||
different configurations.
|
|
@ -0,0 +1,9 @@
|
|||
---
|
||||
page_title: "Other"
|
||||
sidebar_current: "other"
|
||||
---
|
||||
|
||||
# Other
|
||||
|
||||
This section covers other information that doesn't quite fit under the
|
||||
other categories. Please see the navigation to the left.
|
Loading…
Reference in New Issue