[master] f878f3044 Document the relaxed restrictions on backend UDS declarations.
Geoff Simmons
geoff at uplex.de
Mon Jan 28 12:27:08 UTC 2019
commit f878f30444ca6cc19175e54c87c84fca69f9f697
Author: Geoff Simmons <geoff at uplex.de>
Date: Fri Jan 25 16:53:59 2019 +0100
Document the relaxed restrictions on backend UDS declarations.
diff --git a/doc/sphinx/reference/vcl.rst b/doc/sphinx/reference/vcl.rst
index 2f31f4d3f..c1de845e7 100644
--- a/doc/sphinx/reference/vcl.rst
+++ b/doc/sphinx/reference/vcl.rst
@@ -233,9 +233,17 @@ parameters. The following attributes are available:
is declared.
``.path`` (``VCL >= 4.1``)
+
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
+ listening. If the file at that path does not exist or is not
+ accessible to Varnish at VCL load time, then the VCL compiler
+ issues a warning, but does not fail. This makes it possible to
+ start the UDS-listening peer, or set the socket file's
+ permissions, after starting Varnish or loading VCL with a UDS
+ backend. But the socket file must exist and have necessary
+ permissions before the first connection is attempted, otherwise
+ fetches will fail. If the file does exist and is accessible, then
+ it must be a socket; otherwise the VCL load fails. One of
``.path`` or ``.host`` must be declared (but not both). ``.path``
may only be used in VCL since version 4.1.
More information about the varnish-commit
mailing list