Skip to content

Latest commit

 

History

History
97 lines (78 loc) · 3.41 KB

README.md

File metadata and controls

97 lines (78 loc) · 3.41 KB
Raw

Using the IRC bot

The IRC notification bot is a nice feature for remote teams that want to handle issues and want to have a quick and easy way to get simple notifications. The bot currently notifies of the following actions:

  • New Issues
  • Blocked emails
  • Issues with assignment list changes

With Eventum you can have an IRC bot if your development team has an IRC channel. The bot's features include, but are not limited to...

  • Authenticating users
  • Clocking in and out
  • Reporting when new issues are created
  • Reporting when issues are updated
  • Listing issues that are relevant to each user

The bot also provides a simple set of commands which can be invoked in a query to the bot user:

<user> help
<EventumBOT> This is the list of available commands:
<EventumBOT> auth: Format is "auth [email protected] password"
<EventumBOT> clock: Format is "clock [in|out]"
<EventumBOT> list-clocked-in: Format is "list-clocked-in"
<EventumBOT> list-quarantined: Format is "list-quarantined"

Setup

You will need to provide a config/config.php file with appropriate preferences, such as the IRC server and channel that the bot should join. An example setup file can be found in config/config.dist.php

Channels setting

  • channels : This array lists what channels belong to what projects, so the bot can be of use to several different projects, as long as they are on the same IRC network. You can also have more than one channel per project, like this:
    'channels' => [
        'Default Project' => [
            '#issues', '#myIssues ThisIsMyPassword'
        ],
        'My Second Project' => '#moreissues',
    ],

IRC server settings

  • 'hostname' : This variable holds the hostname or IP of the IRC server. Examples are irc.freenode.net or localhost if you use a private one hosted on the same server as Eventum.
  • 'port' : The port number for the IRC server. Default is 6667.
  • 'nickname' : The nickname you want the bot to use. This has to be unique.
  • 'realname' : What the bot will identify itself as if anyone executes a WHOIS command on it.
  • 'username' : You MUST fill in this variable, even if the server is not restricted. Anything goes here, unless you have been given a username/password by the server administrator.
  • 'password' : Same as for 'username'.

Eventum XMLRPC access

  • 'xmlrpc.url' : Address to Eventum XMLRPC. Example http://localhost:8012/rpc/xmlrpc.php
  • 'xmlrpc.login' : Eventum user with Admin privileges, Example [email protected]
  • 'xmlrpc.token' : Token or password for the admin user.

When done, it might look something like this...

return [
    /// connection parameters
    // IRC server address
    'hostname' => 'irc.tvt.mine.nu',
    'port' => 6667,
    'nickname' => 'EventumBOT',
    'realname' => 'Eventum Issue Tracking System',

    // do you need a username/password to connect to this server?
    // if so, fill in the next two variables
    'username' => 'identd',
    'password' => 'random',

    // configured IRC channels
    'channels' => array(
        'TvT2' => array(
            '#tvt-dev channel-key',
        ),
    ),

    // Eventum XMLRPC access
    'xmlrpc.url' => 'http://localhost/rpc/xmlrpc.php',
    'xmlrpc.login' => '[email protected]',
    'xmlrpc.token' => 'admin',
];

To invoke the notification bot and let it run on the server, run this command:

    bin/irc-bot.php &