leonjza/php-gitlab-jabberhook

A small library to parse Gitlab Webhooks and notify via XMPP

0.1 2014-10-16 12:06 UTC

Requires

• php: >=5.3.0, <6.0.0
• fahad19/xmpphp: dev-master

MIT

• Leon Jacobs

README

A simple project to parse Gitlab Webhooks and send notifications via XMPP.
The main idea is to have the messages sent to a broadcast service. This library has only really been testing using a Openfire jabber server, but will probably work fine on many others.

installation

Installation is relatively simple. Ensure that you have composer available and issue the command:

php composer.phar create-project leonjza/php-gitlab-jabberhook gitlab-notifier "dev-master"
Where gitlab-notifier is the name of the directory you wish to install to.

Next, create the entry point file (call it anything you want) where your webhook will POST to (from examples/test.php):

// File hook.php
<?php

require 'vendor/autoload.php';

$input = file_get_contents('php://input');

$message = new \GitlabXMPPHook\Read($input);
$message = $message->parse();

$jabber = new \GitlabXMPPHook\Client();
$jabber->setOptions('server.local', 5222, '[e-mail]', 'password');
$jabber->call('message')->send($message, '[e-mail]');

Ensure that this file is accessable by your webserver and setup the service hook in your Gitlab install. It is suggested that the directory containing all the project files is not world accessible and the hook.php file is the only one symlink in a web folder.

Lastly, ensure you have modified the setOptions() call with a valid Jabber server and JID.

##contact @leonjza