upstream/vault
1
0
Fork 0
mirror of https://github.com/hashicorp/vault.git synced 2026-06-11 09:51:16 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 9

Merge pull request #508 from mfischer-zd/webdoc_environment

Browse source 
docs: Document environment variables
This commit is contained in:
Jeff Mitchell 2015-09-09 11:29:10 -04:00
commit 12521eb87f
2 changed files with 53 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

50
website/source/docs/commands/environment.html.md Normal file
View file

@ -0,0 +1,50 @@
---
layout: "docs"
page_title: "Environment"
sidebar_current: "docs-commands-environment"
description: |-
Vault's behavior can be modified by certain environment variables.
---
# Environment variables
The Vault CLI will read the following environment variables to set
behavioral defaults. These can be overridden in all cases using
command-line arguments; see the command-line help for details.
The following table describes them:
<table>
<tr>
<th>Variable name</th>
<th>Value</th>
</tr>
<tr>
<td><tt>VAULT_TOKEN</tt></td>
<td>The Vault authentication token. If not specified, the token located in <tt>$HOME/.vault-token<tt> will be used if it exists.</td>
</tr>
<tr>
<td><tt>VAULT_ADDR</tt></td>
<td>The address of the Vault server.</td>
</tr>
<tr>
<td><tt>VAULT_CACERT</tt></td>
<td>Path to a PEM-encoded CA cert file to use to verify the Vault server SSL certificate.</td>
</tr>
<tr>
<td><tt>VAULT_CAPATH</tt></td>
<td>Path to a directory of PEM-encoded CA cert files to verify the Vault server SSL certificate. If <tt>VAULT_CACERT</tt> is specified, its value will take precedence.</td>
</tr>
<tr>
<td><tt>VAULT_CLIENT_CERT</tt></td>
<td>Path to a PEM-encoded client certificate for TLS authentication to the Vault server.</td>
</tr>
<tr>
<td><tt>VAULT_CLIENT_KEY</tt></td>
<td>Path to an unencrypted PEM-encoded private key matching the client certificate.</td>
</tr>
<tr>
<td><tt>VAULT_SKIP_VERIFY</tt></td>
<td>If set, do not verify Vault's presented certificate before communicating with it. Setting this variable is not recommended except during testing.</td>
</tr>
</table>

3
website/source/layouts/docs.erb
View file

@ -86,6 +86,9 @@
<li<%= sidebar_current("docs-commands-readwrite") %>>
<a href="/docs/commands/read-write.html">Reading and Writing Data</a>
</li>
<li<%= sidebar_current("docs-commands-environment") %>>
<a href="/docs/commands/environment.html">Environment Variables</a>
</li>
</ul>
</li>