1KGB-CLIENT.CONF(5p) User Contributed Perl Documentation KGB-CLIENT.CONF(5p)
2
6 kgb-client.conf -- KGB client configuration file
7
9 kgb-client(1) can be configured via command line options and/or via a
10 configuration file (via the --conf option). Most of the settings can
11 use either way, with command line options overriding settings from the
12 configuration file.
13 The file format is YAML. Elaborate example configuration is at the end
15 of this document.
16
18 repo-id
19 Unique project identifier on the server. Mandatory.
20 password
22 Pass phrase string. Used together with repo-id to authenticate the
23 request to the servers. Per-server configuration overrides this
24 setting.
25 timeout
27 Request timeout in seconds. Defaults to 15.
28 servers
30 A list of maps, describing the servers to try to send ntifications to.
31 Each server map can have the following members:
32 uri The URI of the server. Something like
34 "http://kgb.server.org:port/".
35 proxy
37 SOAP proxy to use. Mandatory if using SOAP protocol. Defaults to to
38 the value of the uri setting, with "?session=KGB" appended.
39 password
41 Per-server pass phrase. Defaults to the global password setting.
42 timeout
44 Timeout of the request. Defaults to the global timeout setting.
45 status_dir
47 Directory to store information about the last successfully contacted
48 server. If the request is soon after the last contact, the last server
49 is tried first. This way related notifications tend to come out of the
50 same server.
51
53 branch-and-module-re
54 A list of regular expressions. These are matched against the path of
55 the modified files and should have two captures in them -- the first
56 capture is for the branch and the second capture is for the module.
57 This is useful with Subversion repositories where there is a single
59 repository for the project, with all the modules and branches.
60 module-and-branch-re
62 Same as branch-and-module-re, but captures are in reverse order --
63 module first and branch second.
64 ignore-branch
66 A name of a branch to ignore. All changes in that branch are sent
67 without branch info. Useful if most of the branches are made in one
68 branch (e.g. trunk, master).
69 web-link
71 URL containing information about the commit (e.g. cgit, gitweb,
72 viewvcs). "${commit}", "${branch}", "${module}" and "${project}" in
73 that string are substituted with the commit ID, the branch name, the
74 module name and the project ID respectively.
75 See App::KGB::Client for examples.
77 short-url-service
79 The name of the URL shortening service to use. If given, the service is
80 used to shorten the result of web-link substitution.
81 See WWW::Shorten for the list of available services. Note that kgb-
83 client comes with an additional service called "Debli", which is
84 primarily useful for clients running on Debian's collaboration server,
85 alioth.
86 single-line-commits
88 Send only a single line of the commit message to the channel. Possible
89 values: auto|force|off.
90 auto
92 (default) Uses single line notification if the commit log's second
93 line is an empty string. Otherwise uses the whole commit log (as if
94 set to off).
95 force
97 Uses only the first line of the commit log, ignoring the rest.
98 off Uses the whole commit log, ignoring any empty lines.
100 use-irc-notices
102 If set to a true value will make the IRC bot use IRC "notice" messages
103 instead of the ordinary "privmsg" messages.
104 use-color
106 If set to a false value will make the IRC bot use no color in the
107 notifications.
108 Repository-specific configuration options
110 Some of the backends may support additional configuration options. See
111 App::KGB::Client::Git, App::KGB::Client::Subversion and
112 App::KGB::Client::CVS.
113
115 # vim: filetype=yaml
116 ---
117 repo-id: 'kgb'
118 password: 'notknown'
119 timeout: 7
120 status-dir: '/home/proj/kgb-client/status'
121 module-and-branch-re:
122 - '^/([^/]+)/(trunk|tags/(?:[^/]+))/'
123 - '^/([^/]+)/branches/([^/]+)/'
124 - '^/(website)/()'
125 web-link: 'http://svn.debian.org/viewvc/${project}?view=revision&revision=${commit}'
126 # web-link: 'http://anonscm.debian.org/gitweb/?p=${project}/${module}.git;a=commitdiff;h=${commit}'
127 #short-url-service: 'TinyURL'
128 short-url-service: 'Debli'
129 ignore-branch: 'trunk'
130 use-irc-notices: 0
131 use-color: 1
132 servers:
133 - uri: 'http://kgb.server.org:9418/'
134 - uri: 'http://another.kgb.server.org:9418/'
135 timeout: 3
136 password: 'notknowneither'
137
139 kgb-client(1), App::KGB::Client, WWW::Shorten, WWW::Shorten::Debli,
140 kgb-bot(1)
141
143 Damyan Ivanov dmn@debian.org
144
146 Copyright (C) 2012, 2013 Damyan Ivanov
147 This program is free software; you can redistribute it and/or modify it
149 under the terms of the GNU General Public License as published by the
150 Free Software Foundation; either version 2 of the License, or (at your
151 option) any later version.
152 This program is distributed in the hope that it will be useful, but
154 WITHOUT ANY WARRANTY; without even the implied warranty of
155 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
156 General Public License for more details.
157 You should have received a copy of the GNU General Public License along
159 with this program; if not, write to the Free Software Foundation, Inc.,
160 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
161perl v5.28.2 2018-06-04 KGB-CLIENT.CONF(5p)