website: update docs for agent socket options

pull/612/head
Ryan Uber 10 years ago
parent f01bb5cf3b
commit 7a585d7a9b

@ -239,21 +239,23 @@ definitions support being updated during a reload.
However, because the caches are not actively invalidated, ACL policy may be stale However, because the caches are not actively invalidated, ACL policy may be stale
up to the TTL value. up to the TTL value.
* `addresses` - This is a nested object that allows setting bind addresses. For `rpc` * `addresses` - This is a nested object that allows setting bind addresses.
and `http`, a Unix socket can be specified in the following form <br><br>
`unix:///path/to/socket`. A new domain socket will be created at the given Both `rpc` and `http` support binding to Unix domain sockets. A socket can be
path. Any existing socket file (or any other kind of file) at the specified specified in the form `unix:///path/to/socket`. A new domain socket will be
path will be **overwritten**, so use caution when configuring this argument. created at the given path. If the specified file path already exists, Consul
will refuse to start and return an error. For information on how to secure
socket file permissions, refer to the manual page for your operating system.
<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 be in the form ip:port. environment variables. For TCP addresses, these should be in the form ip:port.
<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`
* `rpc` - The RPC endpoint. Defaults to `client_addr` * `rpc` - The RPC endpoint. Defaults to `client_addr`
* `advertise_addr` - Equivalent to the `-advertise` command-line flag. * `advertise_addr` - Equivalent to the `-advertise` command-line flag.

Loading…
Cancel
Save