diff options
Diffstat (limited to 'doc/forge.skb')
| -rw-r--r-- | doc/forge.skb | 41 |
1 files changed, 40 insertions, 1 deletions
diff --git a/doc/forge.skb b/doc/forge.skb index f230d2c..91a608d 100644 --- a/doc/forge.skb +++ b/doc/forge.skb @@ -323,7 +323,46 @@ of 8 between 2048 and 8192.])) (record-documentation "guix/forge/acme.scm" '<acme-ecdsa-key> (record-field "length" [Length of the ECDSA key in number of bits. Must be either -256 or 384.]))))) +256 or 384.])))) + (section :title [Specialized application deployment services] + :ident "section-specialized-application-deployment-services" + (subsection :title [fcgiwrap service] + :ident "fcgiwrap-service" + (p [fcgiwrap is a specialized web server for ,(ref :url +"https://en.wikipedia.org/wiki/Common_Gateway_Interface" :text "CGI") +applications. It provides a ,(ref :url +"https://en.wikipedia.org/wiki/FastCGI" :text "FastCGI") interface +that web servers such as nginx can talk to. We run separate +containerized instances of fcgiwrap for each application.]) + (p [Note that this service is different from the fcgiwrap +service of the same name in Guix upstream.]) + (description + (record-documentation "guix/forge/fcgiwrap.scm" '<fcgiwrap-configuration> + (record-field "package" + [,(code [fcgiwrap]) package to use]) + (record-field "instances" + [List of ,(record-ref "<fcgiwrap-instance>") objects +describing fcgiwrap instances to run])) + (record-documentation "guix/forge/fcgiwrap.scm" '<fcgiwrap-instance> + (record-field "name" + [Name of the fcgiwrap instance]) + (record-field "socket" + [Socket the fcgiwrap instance listens on. Socket may be a +,(record-ref "<forge-host-socket>"), ,(record-ref "<forge-ip-socket>") +or ,(record-ref "<forge-unix-socket>") object.]) + (record-field "user" + [User the fcgiwrap instance should run as]) + (record-field "group" + [Group the fcgiwrap instance should run as]) + (record-field "processes" + [Number of fcgiwrap worker processes]) + (record-field "environment-variables" + [Association list mapping environment variables that +should be set in the execution environment to their values]) + (record-field "mappings" + [List of ,(code [<file-system-mapping>]) objects +describing additional directories that should be shared with the +container fcgiwrap is run in])))))) (chapter :title [Reference] :ident "chapter-reference" (description |