summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorArun Isaac2022-06-04 02:28:48 +0530
committerArun Isaac2022-07-05 11:32:19 +0530
commit53c439e584eb81b62d49a83a2b29c8745f5656fd (patch)
tree444ceb05f94290b3cb46f32cd1dffda46afbf9b3 /doc
parent9c0c76e7d5e5e88d53843bf3620512d7fd9f6beb (diff)
downloadguix-forge-53c439e584eb81b62d49a83a2b29c8745f5656fd.tar.gz
guix-forge-53c439e584eb81b62d49a83a2b29c8745f5656fd.tar.lz
guix-forge-53c439e584eb81b62d49a83a2b29c8745f5656fd.zip
socket: Introduce <forge-*-socket> types.
<forge-*-socket> will be a universal type to specify IP addresses,
ports and Unix sockets across all guix-forge services.

* guix/forge/socket.scm: New file.
* doc/forge.skb (Reference): Document <forge-ip-socket> and
<forge-unix-socket>.
Diffstat (limited to 'doc')
-rw-r--r--doc/forge.skb11
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/forge.skb b/doc/forge.skb
index 7aa7939..5c46412 100644
--- a/doc/forge.skb
+++ b/doc/forge.skb
@@ -240,6 +240,17 @@ unused unused, and may be deprecated in the future.]))
        (record-field "trigger?"
          [If ,(code [#t]), this job is run on every commit. Else, it
 must be manually set up to run some other way.]))
+     (record-documentation "guix/forge/socket.scm" '<forge-ip-socket>
+       (record-field "ip"
+         [IP address, either IPv4 or IPv6, as a string. The loopback
+address is ,(code ["127.0.0.1"]) and ,(code ["::1"]) for IPv4 and IPv6
+respectively. The any address is ,(code ["0.0.0.0"]) and ,(code
+["::"]) for IPv4 and IPv6 respectively.])
+       (record-field "port"
+         [Port number to listen on.]))
+     (record-documentation "guix/forge/socket.scm" '<forge-unix-socket>
+       (record-field "path"
+         [Path to socket file.]))
      (record-documentation "guix/forge/webhook.scm" '<webhook-configuration>
        (record-field "package"
          [,(code [webhook]) package to use])