summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorArun Isaac <arunisaac@systemreboot.net>2025-09-19 16:11:04 +0100
committerArun Isaac <arunisaac@systemreboot.net>2025-09-24 12:21:30 +0100
commit464d738655590cb3df4ac6843dc2fd08dd3771f6 (patch)
tree0e195e1ce6a2e1240f0080d80b26a67ff7def013 /doc
parent734da975a2038cf47ca45d8864c45b8626773edb (diff)
services: nginx: Add stream configuration.
* gnu/services/web.scm (<nginx-stream-configuration>): New record type. (<nginx-configuration>)[stream]: New field. (emit-nginx-server-config): Add context argument. (default-nginx-config): Serialize stream. * doc/guix.texi (Web Services): Document it.
Diffstat (limited to 'doc')
-rw-r--r--doc/guix.texi27
1 files changed, 27 insertions, 0 deletions
diff --git a/doc/guix.texi b/doc/guix.texi
index ef9922c423b..f531243c5c0 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -34622,6 +34622,10 @@ use the size of the processors cache line.
@item @code{server-names-hash-bucket-max-size} (default: @code{#f})
Maximum bucket size for the server names hash tables.
+@item @code{stream} (default: @code{#f})
+@code{<nginx-stream-configuration>} object describing stream server
+directives.
+
@item @code{modules} (default: @code{'()})
List of nginx dynamic modules to load. This should be a list of file
names of loadable modules, as in this example:
@@ -34834,6 +34838,29 @@ body of a named location block cannot contain location blocks.
@end table
@end deftp
+@deftp {Data Type} nginx-stream-configuration
+Data type representing the configuration file context in which stream
+directives are specified. This type has the following parameters:
+
+@table @asis
+@item @code{upstream-blocks} (default: @code{'()})
+A list of upstream blocks to create in the generated configuration file,
+the elements should be of type @code{<nginx-upstream-configuration>}.
+
+@item @code{server-blocks} (default: @code{'()})
+A list of server blocks to create in the generated configuration file,
+the elements should be of type @code{<nginx-server-configuration>}.
+
+@item @code{extra-content} (default: @code{'()})
+Additional content to be appended to the @code{stream} block. Can either
+be a value that can be lowered into a string or a list of such values.
+In the former case, it is inserted directly. In the latter, it is
+prefixed with indentation and suffixed with a newline. Nested lists are
+flattened into one line.
+
+@end table
+@end deftp
+
@subsubheading Varnish Cache
@cindex Varnish
Varnish is a fast cache server that sits in between web applications