mirror of https://github.com/hashicorp/consul
TLS example and correcting error
The example configuration file omits TLS support in the HTTP API. This is fine, but a second example demonstrating how to enable TLS over the HTTP API is harmless and, in fact, should be default practice. Using the format `ip:port` in the "addresses" block will cause Consul to crash on reload/start. See issue (#1727)[https://github.com/hashicorp/consul/issues/1727#issuecomment-184980751]pull/1728/head
parent
052140f8a7
commit
4c8725ef63
|
@ -284,6 +284,37 @@ definitions support being updated during a reload.
|
|||
}
|
||||
```
|
||||
|
||||
#### Example Configuration File, with TLS
|
||||
|
||||
```javascript
|
||||
{
|
||||
"datacenter": "us-cenrtal1",
|
||||
"data_dir": "/opt/consul",
|
||||
"log_level": "INFO",
|
||||
"node_name": "barfoo",
|
||||
"server": true,
|
||||
"addresses": {
|
||||
"https": "0.0.0.0"
|
||||
},
|
||||
"ports": {
|
||||
"https": 8080
|
||||
},
|
||||
"key_file": "/etc/pki/tls/private/my.key",
|
||||
"cert_file": "/etc/pki/tls/certs/my.crt",
|
||||
"ca_file": "/etc/pki/tls/certs/ca-bundle.crt"
|
||||
}
|
||||
```
|
||||
|
||||
Note that the use of `port`:
|
||||
|
||||
```javascript
|
||||
"ports": {
|
||||
"https": 8080
|
||||
}
|
||||
```
|
||||
|
||||
Consul will not enable TLS for the HTTP API unless the `https` port has been assigned a port number `> 0`.
|
||||
|
||||
#### Configuration Key Reference
|
||||
|
||||
* <a name="acl_datacenter"></a><a href="#acl_datacenter">`acl_datacenter`</a> - Only
|
||||
|
@ -343,7 +374,8 @@ definitions support being updated during a reload.
|
|||
When running Consul agent commands against Unix socket interfaces, use the
|
||||
`-rpc-addr` or `-http-addr` arguments to specify the path to the socket. You
|
||||
can also place the desired values in `CONSUL_RPC_ADDR` and `CONSUL_HTTP_ADDR`
|
||||
environment variables. For TCP addresses, these should be in the form ip:port.
|
||||
environment variables. For TCP addresses, these should simply be an IP address
|
||||
without the port. For example: `10.0.0.1`, not `10.0.0.1:8500`.
|
||||
<br><br>
|
||||
The following keys are valid:
|
||||
* `dns` - The DNS server. Defaults to `client_addr`
|
||||
|
|
Loading…
Reference in New Issue