about summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorArun Isaac2025-11-09 12:05:57 +0000
committerArun Isaac2025-11-09 12:28:36 +0000
commit9741fba05c24f8cf81d0e03bbfc0d5817b8e69ba (patch)
treec0eb79ef919ec3edb532329a231885a3ad705bd1 /doc
parent4fb5ad671312091e10eff831600dab1b5cd4a6dd (diff)
downloadguix-forge-9741fba05c24f8cf81d0e03bbfc0d5817b8e69ba.tar.gz
guix-forge-9741fba05c24f8cf81d0e03bbfc0d5817b8e69ba.tar.lz
guix-forge-9741fba05c24f8cf81d0e03bbfc0d5817b8e69ba.zip
klaus: Implement klaus as a first class service.
Implement klaus as a first class service, deprecating the
klaus-gunicorn-app function.
Diffstat (limited to 'doc')
-rw-r--r--doc/forge.skb20
1 files changed, 17 insertions, 3 deletions
diff --git a/doc/forge.skb b/doc/forge.skb
index 9f04fc2..3ea04d3 100644
--- a/doc/forge.skb
+++ b/doc/forge.skb
@@ -291,7 +291,22 @@ first).])
 shown. Else, they won't.])
            (record-field "extra-options"
              [Association list of additional key-value option pairs to
-include in the generated ,(file [cgitrc]) configuration file])))))
+include in the generated ,(file [cgitrc]) configuration file]))))
+      (subsection :title [klaus service]
+                  :ident "subsection-klaus-service"
+        (p [klaus is a web viewer to serve git repositories on the web.])
+        (description
+         (record-documentation "guix/forge/klaus.scm" '<klaus-configuration>
+           (record-field "python-klaus"
+             [,(code [python-klaus]) package to use])
+           (record-field "server-name"
+             [Domain name to serve klaus on])
+           (record-field "socket"
+             [Socket that the internal klaus gunicorn app listens on])
+           (record-field "repository-directory"
+             [Directory containing git repositories to serve])
+           (record-field "site-name"
+             [Title on klaus web pages])))))
     (section :title [tissue service]
              :ident "section-tissue-service"
       (p [tissue is an issue tracker built on plain text files and
@@ -680,5 +695,4 @@ hooks to configure]))
          [Identifier of the webhook. This hook is triggered at ,(ref
 :url [http://host:port/hooks/<id>]).])
        (record-field "run"
-         [G-expression to run when the webhook is triggered]))
-     (docstring-function-documentation "guix/forge/klaus.scm" 'klaus-gunicorn-app))))
+         [G-expression to run when the webhook is triggered])))))