From 95bca99348c65b306f44c0e6b02759b89d89f875 Mon Sep 17 00:00:00 2001 From: Arun Isaac Date: Sun, 2 Aug 2026 04:46:02 +0100 Subject: nginx: Add record type. is an abstraction over that will allow us to pass on more information to the forge-nginx-service-type than an object will let us do. --- doc/forge.skb | 30 +++++++++++++++++++++++++++--- 1 file changed, 27 insertions(+), 3 deletions(-) (limited to 'doc') diff --git a/doc/forge.skb b/doc/forge.skb index f63b469..c628fde 100644 --- a/doc/forge.skb +++ b/doc/forge.skb @@ -394,10 +394,34 @@ be a ,(record-ref ""), ,(record-ref ""), or [/.well-known/acme-challenge/]) in response to ACME HTTP-01 challenges]) (record-field "server-blocks" - [List of ,(ref :url + [List of ,(ref :ident "" :text +"") or ,(ref :url "https://guix.gnu.org/manual/en/html_node/Web-Services.html#index-nginx_002dserver_002dconfiguration" -:text "") objects describing server blocks -to add to the nginx configuration])))) +:text "") objects describing server blocks to add to +the nginx configuration])) + (record-documentation "guix/forge/nginx.scm" ' + (record-field "server-name" + [List of server names this server represents. ,(code ['default]) +represents the default server for connections matching no other server.]) + (record-field "root" + [Root of the website nginx will serve]) + (record-field "locations" + [List of ,(ref :url +"https://guix.gnu.org/manual/devel/en/html_node/Web-Services.html#index-nginx_002dlocation_002dconfiguration" +:text (code [nginx-location-configuration])) or ,(ref :url +"https://guix.gnu.org/manual/devel/en/html_node/Web-Services.html#index-nginx_002dnamed_002dlocation_002dconfiguration" +:text (code [nginx-named-location-configuration])) records to use within this +server block.]) + (record-field "index" + [List of index files to look for when clients ask for a directory. If it +cannot be found, nginx will send the list of files in the directory.]) + (record-field "try-files" + [List of files whose existence is checked in the specified order. +nginx will use the first file it finds to process the request.]) + (record-field "raw-content" + [List of strings or file-like objects to be appended to the server +block. Each item is prefixed with indentation and suffixed with a new line. +Nested lists are flattened.])))) (section :title [ACME service] :ident "section-acme-service" (p [,(abbr :short "ACME" :long "Automatic Certificate Management -- cgit 1.4.1