cogd/manuals/cogd.skb

cogd.skb

1
;;; SPDX-FileCopyrightText: 2025 Evgeny Pisemsky <mail@pisemsky.site>
2
;;;
3
;;; SPDX-License-Identifier: GPL-3.0-or-later
4
5
(document :title "Channel of guix definitions"
6
          :author (list (author :name "Evgeny Pisemsky"
7
                                :email (mailto "mail@pisemsky.site")))
8
          :info-dir-entry "Channel of guix definitions"
9
          :info-dir-category "System administration"
10
  (chapter :title [Modules]
11
    (section :title [Packages])
12
    (section :title [Services]
13
      (subsection :title [Mosquitto]
14
        (p [Mosquitto is a lightweight message broker that implements the MQTT protocol versions 5.0, 3.1.1 and 3.1.  It is suitable for use on all devices from low power single board computers to full servers.])
15
        (description
16
         (item :key (list [Variable: ,(code [mosquitto-service-type])])
17
               (p [This is the service type for the Mosquitto MQTT broker.  Its value is a ,(code [mosquitto-configuration]) (see below).]))
18
         (item :key (list [Data Type: ,(code [mosquitto-configuration])])
19
               (p [This is the configuration for Mosquitto, with the following fields:])
20
               (description
21
                (item :key (list [,(code [package]) (default: ,(code [mosquitto]))])
22
                      (p [The Mosquitto package to use.]))
23
                (item :key (list [,(code [config-file]) (default: ,(code [#f]))])
24
                      (p [The Mosquitto configuration file as a file-like object or the value ,(code [#f]) to use the default configuration.]))
25
                (item :key (list [,(code [user]) (default: ,(code ["mosquitto"]))])
26
                      (p [Owner of the broker process.]))
27
                (item :key (list [,(code [group]) (default: ,(code ["mosquitto"]))])
28
                      (p [Owner's group of the broker process.]))))))
29
      (subsection :title [USB relay daemon]
30
        (p [USB relay daemon allows controlling locally connected USB HID relays remotely via MQTT protocol.])
31
        (description
32
         (item :key (list [Variable: ,(code [usbrelayd-service-type])])
33
               (p [This is the service type for the USB relay daemon.  Its value is a ,(code [usbrelayd-configuration]) (see below).]))
34
         (item :key (list [Data Type: ,(code [usbrelayd-configuration])])
35
               (p [This is the configuration for the USB relay daemon, with the following fields:])
36
               (description
37
                (item :key (list [,(code [package]) (default: ,(code [python-usbrelay]))])
38
                      (p [The package containing the USB relay daemon.]))
39
                (item :key (list [,(code [mqtt-broker]) (default: ,(code ["localhost"]))])
40
                      (p [The hostname or IP address of the MQTT broker.]))
41
                (item :key (list [,(code [mqtt-client]) (default: ,(code ["usbrelayd"]))])
42
                      (p [The client name used when connecting to the broker.])))))))))
43