1KGB-BOT(1)            User Contributed Perl Documentation           KGB-BOT(1)
2
3
4

NAME

6       kgb-bot - an IRC bot helping collaborative work
7

SYNOPSIS

9       kgb-bot [--config file] [--foreground] [--simulate file]
10

OPTIONS

12       --config file
13           Specify configuration file to load. Default is
14           /etc/kgb-bot/kgb.conf.
15
16       --config-dir directory
17           Specify directory with configuration files to load. All files like
18           *.conf are loaded, in alphabetical order. Default is
19           /etc/kgb-bot/kgb.conf.d.
20
21       --foreground
22           Do not detach from console, print log messages to STDERR and do not
23           become a daemon, useful for debugging.
24
25       --simulate file
26           Do not connect to IRC. Instead, output each notification line to
27           the given file, like:
28
29               #chan repo user branch revision module changed-paths
30               #chan repo commit message line 1
31               #chan repo commit message line 2
32
33           There are no colour codes in the output, unless --simulate-color is
34           also given.
35
36       --simulate-color
37           Include color codes in the file used by --simulate.
38
39       --debug
40           Log additional debugging information
41
42   webhook_request request response dirmatch
43       Handler for webhook HTTP request.
44
45       This handler only processes the HTTP part, parsing URI parameters and
46       POST contents.
47
48       The actual processing and IRC notification is done via an appropriate
49       "gitlab_webhook_*" event, asynchronously.
50
51   gitlab_webhook_push
52       Handle a gitlab webhook call for the "push" event (branch update).
53
54       Expects the body of the POST request (decoded, as a hash reference) in
55       ARG0 and all the request parameters in ARG1.
56
57       The request is expected to conform to the GitLab webhook documentation
58       at
59       <https://salsa.debian.org/help/user/project/integrations/webhooks.md#push-events>.
60
61       The request parameters should look like the result of the CGI's param()
62       method.
63
64       Supported parameters (?param=value&param=value2...)
65
66       channel
67           The name of the channel to post notifications to. Leading hash sign
68           is optional and should be URL-encoded if present (%23).
69
70       network
71           The name of the IRC network, servicing the channel. Supported
72           networks are configured by the bot's admin.
73
74       private
75           A boolean flag, indicating that the notifications shouldn't also be
76           posted to the "#commits" channel on Freenode.
77
78       use_color
79           A boolean flag enabling colors. Defaults to true.
80
81       rev_prefix
82           Optional text to prepend to the commit ID.
83
84       use_irc_notices
85           If true, IRC notification uses "notice" messages, instead of
86           "privmsg".  Defaults to 1.
87
88           "notice" messages are usually less intrusive.
89
90       squash_threshold number
91           For push events, limit the commit notifications to the given
92           number. If a branch update contains more commits, the usual
93           notifications are replaced by a single notification about the
94           number of the pushed commits.
95
96           Default: 20
97
98
99
100perl v5.36.0                      2023-01-19                        KGB-BOT(1)
Impressum