Extension:HipchatNotifications

From MediaWiki.org
Jump to navigation Jump to search

Other languages:
Deutsch • ‎English • ‎català • ‎español • ‎français • ‎italiano • ‎polski • ‎português • ‎português do Brasil • ‎sicilianu • ‎suomi • ‎日本語
MediaWiki extensions manual
Crystal Clear action run.svg
Hipchat Notifications
Release status: stable
Hipchat mediawiki.jpg
Implementation User interface, Notify
Description Sends notifications of actions in MediaWiki like adding, removing or deleting an article into HipChat channel
Author(s) Aleksi Postari (kulttuuritalk)
Latest version 1.06 (2016-06-05)
MediaWiki 1.8+
PHP 5.2+
Database changes No
License MIT License
Download
Parameters

  • $wgHipchatToken
  • $wgHipchatRoomID
  • $wgHipchatFromName
  • $wgWikiUrl
  • $wgWikiUrlEnding
Hooks used
ArticleSaveComplete
ArticleInsertComplete
ArticleDeleteComplete
AddNewAccount
BlockIpComplete
UploadComplete
TitleMoveComplete
Translate the HipchatNotifications extension if it is available at translatewiki.net
Check usage and version matrix.

The HipchatNotifications sends notifications of actions in MediaWiki like adding, removing or deleting an article into HipChat channel.

Installation[edit]

  • Download and place the file(s) in a directory called HipchatNotifications in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
    require_once "$IP/extensions/HipchatNotifications/HipchatNotifications.php";
    // HipChat API token. Manage API keys for Hipchat API v2 here: https://hipchat.com/account/api
    $wgHipchatToken = "";
    // HipChat room ID or name where you want all the notifications to go into.
    // You can directly use your room name or if that does not work, you can find your room ID from here: https://api.hipchat.com/v2/room?auth_token=YOUR_AUTH_TOKEN
    $wgHipchatRoomID = ;
    // Required. Name the message will appear be sent from.
    // Must be less than 15 characters long. May contain letters, numbers, -, _, and spaces.
    $wgHipchatFromName = "Wiki";
    // URL into your MediaWiki installation with the trailing /.
    $wgWikiUrl = "http://your_wiki_url/";
    // Wiki script name. Leave this to default one if you do not have URL rewriting enabled.
    $wgWikiUrlEnding = "index.php?title=";
    // What method will be used to send the data to HipChat server. This setting only works with Hipchat API v1, in V2 we always use curl.
    // By default this is "curl" which only works if you have the curl extension enabled. This can be: "curl" or "file_get_contents". Default: "curl".
    $wgHipchatSendMethod = "curl";
    
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configuration parameters[edit]

Please read the project README file for more configuration options.