Irker IRC Gateway
GitLab provides a way to push update messages to an Irker server. When configured, pushes to a project will trigger the service to send data directly to the Irker server.
See the project homepage for further info: https://gitlab.com/esr/irker
Needed setup
You will first need an Irker daemon. You can download the Irker code from its repository on https://gitlab.com/esr/irker:
git clone https://gitlab.com/esr/irker.git
Once you have downloaded the code, you can run the Python script named irkerd
.
This script is the gateway script, it acts both as an IRC client, for sending
messages to an IRC server obviously, and as a TCP server, for receiving messages
from the GitLab service.
If the Irker server runs on the same machine, you are done. If not, you will need to follow the firsts steps of the next section.
Complete these steps in GitLab
- Navigate to the project you want to configure for notifications.
- Navigate to the Integrations page
- Click “Irker”.
- Select the “Active” checkbox.
- Enter the server host address where
irkerd
runs (defaults tolocalhost
) in theServer host
field on the Web page - Enter the server port of
irkerd
(e.g. defaults to 6659) in theServer port
field on the Web page. - Optional: if
Default IRC URI
is set, it has to be in the formatirc[s]://domain.name
and will be prepend to each and every channel provided by the user which is not a full URI. - Specify the recipients (e.g. #channel1, user1, etc.)
- Save or optionally click “Test Settings”.
Note on Irker recipients
Irker accepts channel names of the form chan
and #chan
, both for the
#chan
channel. If you want to send messages in query, you will need to add
,isnick
after the channel name, in this form: Aorimn,isnick
. In this latter
case, Aorimn
is treated as a nick and no more as a channel name.
Irker can also join password-protected channels. Users need to append
?key=thesecretpassword
to the chan name. When using this feature remember to
not put the #
sign in front of the channel name; failing to do so will
result on irker joining a channel literally named #chan?key=password
henceforth
leaking the channel key through the /whois
IRC command (depending on IRC server
configuration). This is due to a long standing irker bug.
Help and feedback
If there's something you don't like about this feature
To propose functionality that GitLab does not yet offer
To further help GitLab in shaping new features
If you didn't find what you were looking for
If you want help with something very specific to your use case, and can use some community support
POST ON GITLAB FORUM
If you have problems setting up or using this feature (depending on your GitLab subscription)
REQUEST SUPPORT
To view all GitLab tiers and features or to upgrade
If you want to try all features available in GitLab.com
If you want to try all features available in GitLab self-managed
If you spot an error or a need for improvement and would like to fix it yourself in a merge request
EDIT THIS PAGE
If you would like to suggest an improvement to this doc
If you want to give quick and simple feedback on this doc