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

Tweaks the address and advertise docs.

This commit is contained in:
James Phillips 2016-03-01 13:01:13 -08:00
parent 4c8725ef63
commit b92243d8d0
1 changed files with 12 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
website/source/docs/agent/options.html.markdown
View File

@ -288,10 +288,10 @@ definitions support being updated during a reload.
```javascript ```javascript
{ {
"datacenter": "us-cenrtal1", "datacenter": "east-aws",
"data_dir": "/opt/consul", "data_dir": "/opt/consul",
"log_level": "INFO", "log_level": "INFO",
"node_name": "barfoo", "node_name": "foobar",
"server": true, "server": true,
"addresses": { "addresses": {
"https": "0.0.0.0" "https": "0.0.0.0"
@ -366,30 +366,31 @@ Consul will not enable TLS for the HTTP API unless the `https` port has been ass
Both `rpc` and `http` support binding to Unix domain sockets. A socket can be Both `rpc` and `http` support binding to Unix domain sockets. A socket can be
specified in the form `unix:///path/to/socket`. A new domain socket will be specified in the form `unix:///path/to/socket`. A new domain socket will be
created at the given path. If the specified file path already exists, Consul created at the given path. If the specified file path already exists, Consul
will attempt to clear the file and create the domain socket in its place. will attempt to clear the file and create the domain socket in its place. The
<br><br> permissions of the socket file are tunable via the [`unix_sockets` config construct](#unix_sockets).
The permissions of the socket file are tunable via the [`unix_sockets` config
construct](#unix_sockets).
<br><br> <br><br>
When running Consul agent commands against Unix socket interfaces, use the 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 `-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` can also place the desired values in `CONSUL_RPC_ADDR` and `CONSUL_HTTP_ADDR`
environment variables. For TCP addresses, these should simply be an IP address environment variables.
without the port. For example: `10.0.0.1`, not `10.0.0.1:8500`. <br><br>
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`. Ports are set separately in the
<a href="#ports">`ports`</a> structure.
<br><br> <br><br>
The following keys are valid: The following keys are valid:
* `dns` - The DNS server. Defaults to `client_addr` * `dns` - The DNS server. Defaults to `client_addr`
* `http` - The HTTP API. Defaults to `client_addr` * `http` - The HTTP API. Defaults to `client_addr`
* `https` - The HTTPS API. Defaults to `client_addr` * `https` - The HTTPS API. Defaults to `client_addr`
* `rpc` - The RPC endpoint. Defaults to `client_addr` * `rpc` - The RPC endpoint. Defaults to `client_addr`
* <a name="advertise_addr"></a><a href="#advertise_addr">`advertise_addr`</a> Equivalent to * <a name="advertise_addr"></a><a href="#advertise_addr">`advertise_addr`</a> Equivalent to
the [`-advertise` command-line flag](#_advertise). the [`-advertise` command-line flag](#_advertise).
* <a name="advertise_addrs"></a><a href="#advertise_addrs">`advertise_addrs`</a> Allows to set * <a name="advertise_addrs"></a><a href="#advertise_addrs">`advertise_addrs`</a> Allows to set
the advertised addresses for SerfLan, SerfWan and RPC together with the port. This gives the advertised addresses for SerfLan, SerfWan and RPC together with the port. This gives
you more control than (#_advertise) or (#_advertise-wan) while it serves the same purpose. you more control than <a href="#_advertise">`-advertise`</a> or <a href="#_advertise-wan">`-advertise-wan`</a>
These settings might override (#_advertise) and (#_advertise-wan). while it serves the same purpose. These settings might override <a href="#_advertise">`-advertise`</a> or
<a href="#_advertise-wan">`-advertise-wan`</a>
<br><br> <br><br>
This is a nested setting that allows the following keys: This is a nested setting that allows the following keys:
* `serf_lan` - The SerfLan address. Accepts values in the form of "host:port" like "10.23.31.101:8301". * `serf_lan` - The SerfLan address. Accepts values in the form of "host:port" like "10.23.31.101:8301".