Skip to content

Latest commit

 

History

History
201 lines (142 loc) · 9.38 KB

README.md

File metadata and controls

201 lines (142 loc) · 9.38 KB
Raw

Slack MediaWiki

This is a extension for MediaWiki that sends notifications of actions in your Wiki like editing, adding or removing a page into Slack channel.

Looking for extension that can send notifications to HipChat or Discord?

Screenshot

Supported MediaWiki operations to send notifications

  • Article is added, removed, moved or edited.
  • Article protection settings are changed.
  • New user is added.
  • User is blocked.
  • User groups (rights) are changed.
  • File is uploaded.
  • ... and each notification can be individually enabled or disabled :)

Upgrading extension

Upgrading from older version to 1.15 of this extension has one change that you need to take into account:

  • All configuration parameters now use the format wgSlack. If you had configured any of the wgNotificationWikiUrlEnding parameters, you need to change these to format: wgSlackNotificationWikiUrlEnding.

Requirements

  • cURL. This extension also supports using file_get_contents for sending the data. See the configuration parameter $wgSlackSendMethod below to change this.
  • MediaWiki 1.8+ (tested with version 1.8, also tested and works with 1.25+)
  • Apache should have NE (NoEscape) flag on to prevent issues in URLs. By default you should have this enabled.

How to install

  1. Create a new Slack Incoming Webhook. When setting up the webhook, define channel where you want the notifications to go into. You can setup a new webhook on this page.

  2. After setting up the Webhook you will get a Webhook URL. Copy that URL as you will need it in step 4.

  3. Download latest release of this extension, uncompress the archive and move folder SlackNotifications into your mediawiki_installation/extensions folder.

  4. Add settings listed below in your localSettings.php. Note that it is mandatory to set these settings for this extension to work:

require_once("$IP/extensions/SlackNotifications/SlackNotifications.php");
// Required. Your Slack incoming webhook URL. Read more from here: https://api.slack.com/incoming-webhooks
$wgSlackIncomingWebhookUrl = "";
// Required. Name the message will appear to be sent from. Change this to whatever you wish it to be.
$wgSlackFromName = $wgSitename;
// URL into your MediaWiki installation with the trailing /.
$wgSlackNotificationWikiUrl		= "http://your_wiki_url/";
// Wiki script name. Leave this to default one if you do not have URL rewriting enabled.
$wgSlackNotificationWikiUrlEnding = "index.php?title=";
// What method will be used to send the data to Slack server. By default this is "curl" which only works if you have the curl extension enabled. This can be: "curl" or "file_get_contents". There have been cases where VisualEditor extension does not work with the curl method, so in that case the recommended solution is to use the file_get_contents method. Default: "curl".
$wgSlackSendMethod = "curl";
  1. Enjoy the notifications in your Slack room!

Additional options

These options can be set after including your plugin in your localSettings.php file.

Customize request call method (Fix extension not working with VisualEditor)

By default this extension uses curl to send the requests to slack's API. If you use VisualEditor and get unknown errors, do not have curl enabled on your server or notice other problems, the recommended solution is to change method to file_get_contents.

$wgSlackSendMethod = "file_get_contents";

Customize room where notifications gets sent to

By default when you create incoming webhook at Slack site you'll define which room notifications go into. You can also override this in MediaWiki by setting the parameter below. Remember to also include # before your room name.

$wgSlackRoomName = "";

Remove additional links from user and article pages

By default user and article links in the nofication message will get additional links for ex. to block user, view article history etc. You can disable either one of those by setting settings below to false.

// If this is true, pages will get additional links in the notification message (edit | delete | history).
$wgSlackIncludePageUrls = true;
// If this is true, users will get additional links in the notification message (block | groups | talk | contribs).
$wgSlackIncludeUserUrls = true;
// If this is true, all minor edits made to articles will not be submitted to Slack.
$wgSlackIgnoreMinorEdits = false;

Set emoji for notification

By default notification in Slack has the default emoji for notification. You can customize this with the setting below. You can find all available emojis from here.

$wgSlackEmoji = "";

Show edit size

By default we show size of the edit. You can hide this information with the setting below.

$wgSlackIncludeDiffSize = false;

Disable new user extra information

By default we show full name, email and IP address of newly created user in the notification. You can individually disable each of these using the settings below. This is helpful for example in situation where you do not want to expose this information for users in your Slack channel.

// If this is true, newly created user email address is added to notification.
$wgSlackShowNewUserEmail = true;
// If this is true, newly created user full name is added to notification.
$wgSlackShowNewUserFullName = true;
// If this is true, newly created user IP address is added to notification.
$wgSlackShowNewUserIP = true;

Disable notifications from certain user roles

By default notifications from all users will be sent to your Slack room. If you wish to exclude users in certain group to not send notification of any actions, you can set the group with the setting below.

// If this is set, actions by users with this permission won't cause alerts
$wgSlackExcludedPermission = "";

Disable notifications from certain pages / namespaces

You can exclude notifications from certain namespaces / articles by adding them into this array. Note: This targets all pages starting with the name.

// Actions (add, edit, modify) won't be notified to Slack room from articles starting with these names
$wgSlackExcludeNotificationsFrom = ["User:", "Weirdgroup"];

Enable notifications from certain pages / namespaces

You can whitelist notifications from certain namespaces / articles by adding them into this array. Note: This targets all pages starting with the name. ALL Other notifications will be discarded, When active, the previously listed exclusion array will further limit this whitelist.

// Actions (add, edit, modify) will be notified to Slack room from articles starting with these names
$wgSlackIncludeNotificationsFrom = ["IT:", "Specialgroup"];

Actions to notify of

MediaWiki actions that will be sent notifications of into Slack. Set desired options to false to disable notifications of those actions.

// New user added into MediaWiki
$wgSlackNotificationNewUser = true;
// User or IP blocked in MediaWiki
$wgSlackNotificationBlockedUser = true;
// User groups changed in MediaWiki
$wgSlackNotificationUserGroupsChanged = true;
// Article added to MediaWiki
$wgSlackNotificationAddedArticle = true;
// Article removed from MediaWiki
$wgSlackNotificationRemovedArticle = true;
// Article moved under new title in MediaWiki
$wgSlackNotificationMovedArticle = true;
// Article edited in MediaWiki
$wgSlackNotificationEditedArticle = true;
// File uploaded
$wgSlackNotificationFileUpload = true;
// Article protection settings changed
$wgSlackNotificationProtectedArticle = true;

Additional MediaWiki URL Settings

Should any of these default MediaWiki system page URLs differ in your installation, change them here.

$wgSlackNotificationWikiUrlEndingUserRights          = "Special%3AUserRights&user=";
$wgSlackNotificationWikiUrlEndingBlockUser           = "Special:Block/";
$wgSlackNotificationWikiUrlEndingUserPage            = "User:";
$wgSlackNotificationWikiUrlEndingUserTalkPage        = "User_talk:";
$wgSlackNotificationWikiUrlEndingUserContributions   = "Special:Contributions/";
$wgSlackNotificationWikiUrlEndingBlockList           = "Special:BlockList";
$wgSlackNotificationWikiUrlEndingEditArticle         = "action=edit";
$wgSlackNotificationWikiUrlEndingDeleteArticle       = "action=delete";
$wgSlackNotificationWikiUrlEndingHistory             = "action=history";
$wgSlackNotificationWikiUrlEndingDiff                = "diff=prev&oldid=";

Setting proxy

To add proxy for requests, you can use the normal MediaWiki way of setting proxy, as described here. Basically this means that you just need to set $wgHTTPProxy parameter in your localSettings.php file to point to your proxy.

Contributors

@jacksga @Meneth @mdmallardi

License

MIT License

Issues / Ideas / Comments

Feel free to use the Issues section on Github for this project to submit any issues / ideas / comments! :)