From eb494455ed82aaa57f9c1640c0de94ba474fd24a Mon Sep 17 00:00:00 2001 From: "Michael S. Fischer" Date: Fri, 7 Aug 2015 16:10:17 -0700 Subject: [PATCH] docs: Document environment variables --- .../source/docs/commands/environment.html.md | 50 +++++++++++++++++++ website/source/layouts/docs.erb | 3 ++ 2 files changed, 53 insertions(+) create mode 100644 website/source/docs/commands/environment.html.md diff --git a/website/source/docs/commands/environment.html.md b/website/source/docs/commands/environment.html.md new file mode 100644 index 0000000000..f93c671603 --- /dev/null +++ b/website/source/docs/commands/environment.html.md @@ -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: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Variable nameValue
VAULT_TOKENThe Vault authentication token. If not specified, the token located in $HOME/.vault-token will be used if it exists.
VAULT_ADDRThe address of the Vault server.
VAULT_CACERTPath to a PEM-encoded CA cert file to use to verify the Vault server SSL certificate.
VAULT_CAPATHPath to a directory of PEM-encoded CA cert files to verify the Vault server SSL certificate. If VAULT_CACERT is specified, its value will take precedence.
VAULT_CLIENT_CERTPath to a PEM-encoded client certificate for TLS authentication to the Vault server.
VAULT_CLIENT_KEYPath to an unencrypted PEM-encoded private key matching the client certificate.
VAULT_SKIP_VERIFYIf set, do not verify Vault's presented certificate before communicating with it. Setting this variable is not recommended except during testing.
diff --git a/website/source/layouts/docs.erb b/website/source/layouts/docs.erb index d7b95e8018..3b62a76008 100644 --- a/website/source/layouts/docs.erb +++ b/website/source/layouts/docs.erb @@ -86,6 +86,9 @@ > Reading and Writing Data + > + Environment Variables +