doc: Move the NGinx service configuration documentation together.
* doc/guix.texi (Web Services): Add documentation for nginx-upstream-configuration and nginx-location-configuration. (VPN Services): Remove documentation for nginx-upstream-configuration and nginx-location-configuration. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
This commit is contained in:
parent
41db5a7563
commit
a88d41d11c
115
doc/guix.texi
115
doc/guix.texi
|
@ -13530,6 +13530,64 @@ Whether the server should add its configuration to response.
|
|||
@end table
|
||||
@end deftp
|
||||
|
||||
@deftp {Data Type} nginx-upstream-configuration
|
||||
Data type representing the configuration of an nginx @code{upstream}
|
||||
block. This type has the following parameters:
|
||||
|
||||
@table @asis
|
||||
@item @code{name}
|
||||
Name for this group of servers.
|
||||
|
||||
@item @code{servers}
|
||||
Specify the addresses of the servers in the group. The address can be
|
||||
specified as a IP address (e.g. @samp{127.0.0.1}), domain name
|
||||
(e.g. @samp{backend1.example.com}) or a path to a UNIX socket using the
|
||||
prefix @samp{unix:}. For addresses using an IP address or domain name,
|
||||
the default port is 80, and a different port can be specified
|
||||
explicitly.
|
||||
|
||||
@end table
|
||||
@end deftp
|
||||
|
||||
@deftp {Data Type} nginx-location-configuration
|
||||
Data type representing the configuration of an nginx @code{location}
|
||||
block. This type has the following parameters:
|
||||
|
||||
@table @asis
|
||||
@item @code{uri}
|
||||
URI which this location block matches.
|
||||
|
||||
@anchor{nginx-location-configuration body}
|
||||
@item @code{body}
|
||||
Body of the location block, specified as a string. This can contain many
|
||||
configuration directives. For example, to pass requests to a upstream
|
||||
server group defined using an @code{nginx-upstream-configuration} block,
|
||||
the following directive would be specified in the body @samp{proxy_pass
|
||||
http://upstream-name;}.
|
||||
|
||||
@end table
|
||||
@end deftp
|
||||
|
||||
@deftp {Data Type} nginx-named-location-configuration
|
||||
Data type representing the configuration of an nginx named location
|
||||
block. Named location blocks are used for request redirection, and not
|
||||
used for regular request processing. This type has the following
|
||||
parameters:
|
||||
|
||||
@table @asis
|
||||
@item @code{name}
|
||||
Name to identify this location block.
|
||||
|
||||
@item @code{body}
|
||||
@xref{nginx-location-configuration body}, as the body for named location
|
||||
blocks can be used in a similar way to the
|
||||
@code{nginx-location-configuration body}. One restriction is that the
|
||||
body of a named location block cannot contain location blocks.
|
||||
|
||||
@end table
|
||||
@end deftp
|
||||
|
||||
|
||||
@node DNS Services
|
||||
@subsubsection DNS Services
|
||||
@cindex DNS (domain name system)
|
||||
|
@ -14296,63 +14354,6 @@ Defaults to @samp{#f}.
|
|||
@c %end of automatic openvpn-server documentation
|
||||
|
||||
|
||||
@deftp {Data Type} nginx-upstream-configuration
|
||||
Data type representing the configuration of an nginx @code{upstream}
|
||||
block. This type has the following parameters:
|
||||
|
||||
@table @asis
|
||||
@item @code{name}
|
||||
Name for this group of servers.
|
||||
|
||||
@item @code{servers}
|
||||
Specify the addresses of the servers in the group. The address can be
|
||||
specified as a IP address (e.g. @samp{127.0.0.1}), domain name
|
||||
(e.g. @samp{backend1.example.com}) or a path to a UNIX socket using the
|
||||
prefix @samp{unix:}. For addresses using an IP address or domain name,
|
||||
the default port is 80, and a different port can be specified
|
||||
explicitly.
|
||||
|
||||
@end table
|
||||
@end deftp
|
||||
|
||||
@deftp {Data Type} nginx-location-configuration
|
||||
Data type representing the configuration of an nginx @code{location}
|
||||
block. This type has the following parameters:
|
||||
|
||||
@table @asis
|
||||
@item @code{uri}
|
||||
URI which this location block matches.
|
||||
|
||||
@anchor{nginx-location-configuration body}
|
||||
@item @code{body}
|
||||
Body of the location block, specified as a string. This can contain many
|
||||
configuration directives. For example, to pass requests to a upstream
|
||||
server group defined using an @code{nginx-upstream-configuration} block,
|
||||
the following directive would be specified in the body @samp{proxy_pass
|
||||
http://upstream-name;}.
|
||||
|
||||
@end table
|
||||
@end deftp
|
||||
|
||||
@deftp {Data Type} nginx-named-location-configuration
|
||||
Data type representing the configuration of an nginx named location
|
||||
block. Named location blocks are used for request redirection, and not
|
||||
used for regular request processing. This type has the following
|
||||
parameters:
|
||||
|
||||
@table @asis
|
||||
@item @code{name}
|
||||
Name to identify this location block.
|
||||
|
||||
@item @code{body}
|
||||
@xref{nginx-location-configuration body}, as the body for named location
|
||||
blocks can be used in a similar way to the
|
||||
@code{nginx-location-configuration body}. One restriction is that the
|
||||
body of a named location block cannot contain location blocks.
|
||||
|
||||
@end table
|
||||
@end deftp
|
||||
|
||||
@node Network File System
|
||||
@subsubsection Network File System
|
||||
@cindex NFS
|
||||
|
|
Loading…
Reference in New Issue