status-im
/
consul
mirror of https://github.com/status-im/consul.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

updates based on feedback

This commit is contained in:
Brian Shumate 2016-12-06 14:46:26 -05:00
parent 291ea643d2
commit 418c76d8bb
No known key found for this signature in database
GPG Key ID: B2E211633F870928
2 changed files with 80 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

80
website/source/docs/commands/environment-variables.html.md Normal file
View File

@ -0,0 +1,80 @@
---
layout: "docs"
page_title: "Environment Variables"
sidebar_current: "docs-commands-environment-variables"
description: |-
Consul's behavior can be modified by certain environment variables.
---
# Environment variables
In addition to CLI flags, Consul reads environment variables for behavior
defaults. CLI flags always take precedence over environment variables, but it
is often helpful to use environment variables to configure the Consul agent,
particularly with configuration management and init systems.
The following table describes these variables:
## `CONSUL_HTTP_ADDR`
This is the HTTP API address to the *local* Consul agent
(not the remote server) specified as a URI:
```
CONSUL_HTTP_ADDR=127.0.0.1:8500
```
or as a Unix socket path:
```
CONSUL_HTTP_ADDR=unix://var/run/consul_http.sock
```
## `CONSUL_HTTP_TOKEN`
This is the API access token required when access control lists (ACLs)
are enabled, for example:
```
CONSUL_HTTP_TOKEN=aba7cbe5-879b-999a-07cc-2efd9ac0ffe
```
## `CONSUL_HTTP_AUTH`
This specifies HTTP Basic access credentials as a username:password pair:
```
CONSUL_HTTP_AUTH=operations:JPIMCmhDHzTukgO6
```
## `CONSUL_HTTP_SSL`
This is a boolean value (default is false) that enables the HTTPS URI
scheme and SSL connections to the HTTP API:
```
CONSUL_HTTP_SSL=true
```
## `CONSUL_HTTP_SSL_VERIFY`
This is a boolean value (default true) to specify SSL certificate verification; setting this value to `false` is not recommended for production use. Example
for development purposes:
```
CONSUL_HTTP_SSL_VERIFY=false
```
## `CONSUL_RPC_ADDR`
This is the RPC interface address for the local agent specified as a URI:
```
CONSUL_RPC_ADDR=127.0.0.1:8300
```
or as a Unix socket path:
```
CONSUL_RPC_ADDR=unix://var/run/consul_rpc.sock
```

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

@ -1,48 +0,0 @@
---
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 or path to Unix socket, for example <tt>127.0.0.1:8500</tt> or <tt>unix:///var/run/consul_http.sock</tt></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 or path to Unix socket, for example <tt>127.0.0.1:8300</tt> or <tt>unix:///var/run/consul_rpc.sock</tt></td>
</tr>
</table>