[master] 6ac0126 Document UDS backend addressing in vcl(7).
Geoff Simmons
geoff at uplex.de
Mon Mar 12 13:22:09 UTC 2018
commit 6ac01261e022636ca30e0f947d84e669d96e9388
Author: Geoff Simmons <geoff at uplex.de>
Date: Mon Mar 12 14:20:40 2018 +0100
Document UDS backend addressing in vcl(7).
diff --git a/doc/sphinx/reference/vcl.rst b/doc/sphinx/reference/vcl.rst
index 976a908..9275b57 100644
--- a/doc/sphinx/reference/vcl.rst
+++ b/doc/sphinx/reference/vcl.rst
@@ -212,16 +212,24 @@ backend. The actual declaration is in curly brackets, in a key/value fashion.::
.attribute = "value";
}
-The only mandatory attribute is ``.host``. The attributes will inherit
-their defaults from the global parameters. The following attributes
-are available:
+One of the attributes ``.host`` or ``.path`` is mandatory (but not
+both). The attributes will inherit their defaults from the global
+parameters. The following attributes are available:
- ``.host`` *(mandatory)*
+ ``.host``
The host to be used. IP address or a hostname that resolves to a
- single IP address.
+ single IP address. This attribute is mandatory, unless ``.path``
+ is declared.
+
+ ``.path``
+ The absolute path of a Unix domain socket at which a backend is
+ listening. The file at that path must exist and must be accessible
+ to Varnish at VCL load time, and it must be a socket. One of
+ ``.path`` or ``.host`` must be declared (but not both).
``.port``
- The port on the backend that Varnish should connect to.
+ The port on the backend that Varnish should connect to. Ignored if
+ a Unix domain socket is declared in ``.path``.
``.host_header``
A host header to add to probes and regular backend requests if they have no
More information about the varnish-commit
mailing list