Document mosquitto service

Evgeny PisemskySat Mar 15 15:50:50+0300 2025

5bc24ae

Document mosquitto service

manuals/cogd.skb

99
          :info-dir-category "System administration"
1010
  (chapter :title [Modules]
1111
    (section :title [Packages])
12-
    (section :title [Services])))
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 (p [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 (p [Data Type: ,(code [mosquitto-configuration])])
19+
               (p [This is the configuration for Mosquitto, with the following fields:])
20+
               (description
21+
                (item :key (p [,(code [package]) (default: ,(code [mosquitto]))])
22+
                      (p [The Mosquitto package to use.]))
23+
                (item :key (p [,(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 (p [,(code [user]) (default: ,(code ["mosquitto"]))])
26+
                      (p [Owner of the broker process.]))
27+
                (item :key (p [,(code [group]) (default: ,(code ["mosquitto"]))])
28+
                      (p [Owner's group of the broker process.])))))))))