From 7a585d7a9bc4a69b28f4e65763fa4be8905c9fbb Mon Sep 17 00:00:00 2001 From: Ryan Uber Date: Fri, 16 Jan 2015 13:06:49 -0800 Subject: [PATCH] website: update docs for agent socket options --- .../source/docs/agent/options.html.markdown | 22 ++++++++++--------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/website/source/docs/agent/options.html.markdown b/website/source/docs/agent/options.html.markdown index b7423dabe9..2ecc5e2db7 100644 --- a/website/source/docs/agent/options.html.markdown +++ b/website/source/docs/agent/options.html.markdown @@ -239,21 +239,23 @@ definitions support being updated during a reload. However, because the caches are not actively invalidated, ACL policy may be stale up to the TTL value. -* `addresses` - This is a nested object that allows setting bind addresses. For `rpc` - and `http`, a Unix socket can be specified in the following form - `unix:///path/to/socket`. A new domain socket will be created at the given - path. Any existing socket file (or any other kind of file) at the specified - path will be **overwritten**, so use caution when configuring this argument. - +* `addresses` - This is a nested object that allows setting bind addresses. +

+ 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 + 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. +

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. - +

The following keys are valid: - * `dns` - The DNS server. Defaults to `client_addr` - * `http` - The HTTP API. Defaults to `client_addr` - * `rpc` - The RPC endpoint. Defaults to `client_addr` + * `dns` - The DNS server. Defaults to `client_addr` + * `http` - The HTTP API. Defaults to `client_addr` + * `rpc` - The RPC endpoint. Defaults to `client_addr` * `advertise_addr` - Equivalent to the `-advertise` command-line flag.