summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorArun Isaac2023-07-25 19:22:52 +0100
committerArun Isaac2023-07-25 23:39:05 +0100
commit61731755a3b0d3086597483bb7f6ac0229a5433e (patch)
tree20210d3abd525f0c2002481bb6ad7034c03eaba4 /doc
parent02d72380017ae1f3744b4be6726dcab783b079bb (diff)
downloadguix-forge-61731755a3b0d3086597483bb7f6ac0229a5433e.tar.gz
guix-forge-61731755a3b0d3086597483bb7f6ac0229a5433e.tar.lz
guix-forge-61731755a3b0d3086597483bb7f6ac0229a5433e.zip
gunicorn: Add gunicorn service.
* guix/forge/gunicorn.scm: New file.
* doc/forge.skb (Reference): Document <gunicorn-configuration> and
<gunicorn-app>.
Diffstat (limited to 'doc')
-rw-r--r--doc/forge.skb26
1 files changed, 26 insertions, 0 deletions
diff --git a/doc/forge.skb b/doc/forge.skb
index 827003e..e11b255 100644
--- a/doc/forge.skb
+++ b/doc/forge.skb
@@ -257,6 +257,32 @@ respectively. The any address is ,(code ["0.0.0.0"]) and ,(code
      (record-documentation "guix/forge/socket.scm" '<forge-unix-socket>
        (record-field "path"
          [Path to socket file.]))
+     (record-documentation "guix/forge/gunicorn.scm" '<gunicorn-configuration>
+       (record-field "package"
+         [,(code [gunicorn]) package to use])
+       (record-field "apps"
+         [List of ,(ref :mark "<gunicorn-app>" :text (code
+[<gunicorn-app>])) objects describing gunicorn apps to run]))
+     (record-documentation "guix/forge/gunicorn.scm" '<gunicorn-app>
+       (record-field "name"
+         [Name of the app])
+       (record-field "package"
+         [Package of the app])
+       (record-field "wsgi-app-module"
+         [WSGI app module passed to gunicorn])
+       (record-field "sockets"
+         [List of ,(ref :mark "<forge-ip-socket>" :text (code
+[<forge-ip-socket>])) or ,(ref :mark "<forge-unix-socket>" :text (code
+[<forge-unix-socket>])) objects describing sockets to listen on])
+       (record-field "workers"
+         [Number of 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
+gunicorn is run in.]))
      (record-documentation "guix/forge/webhook.scm" '<webhook-configuration>
        (record-field "package"
          [,(code [webhook]) package to use])