github
/
consul
mirror of https://github.com/hashicorp/consul
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add a table of CLI environment variables

pull/2587/head
Brian Shumate 2016-12-05 12:35:44 -05:00
parent 4efa1a72fa
commit fbd074b7e7
No known key found for this signature in database
GPG Key ID: B2E211633F870928
1 changed files with 48 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -0,0 +1,48 @@
---
layout: "docs"
page_title: "Environment"
sidebar_current: "docs-commands-environment"
description: |-
Consul's behavior can be modified by certain environment variables.
---
# Environment variables
The Consul CLI will read the following environment variables to set
behavioral defaults. These can be overridden in all cases using
command-line arguments; see the
[Consul Commands documentation](https://www.consul.io/docs/commands/index.html)
for details.
The following table describes these variables:
<table>
<tr>
<th>Variable name</th>
<th>Value</th>
</tr>
<tr>
<td><tt>CONSUL_HTTP_ADDR</tt></td>
<td>The HTTP API address as a host:port pair</td>
</tr>
<tr>
<td><tt>CONSUL_HTTP_TOKEN</tt></td>
<td>The API access token required when access control lists (ACLs) are enabled</td>
</tr>
<tr>
<td><tt>CONSUL_HTTP_AUTH</tt></td>
<td>The HTTP Basic access credentials as a username:password pair</td>
</tr>
<tr>
<td><tt>CONSUL_HTTP_SSL</tt></td>
<td>Boolean (default False) to specify HTTPS connections</td>
</tr>
<tr>
<td><tt>CONSUL_HTTP_SSL_VERIFY</tt></td>
<td>Boolean (default True) to specify SSL certificate verification</td>
</tr>
<tr>
<td><tt>CONSUL_RPC_ADDR</tt></td>
<td>The RPC interface address as a host:port pair</td>
</tr>
</table>