/WikiNotif

Simple MediaWiki extension to send notifications upon the creation of new user accounts and when new revisions are added (based on https://www.mediawiki.org/wiki/Extension:New_User_Email_Notification)

Primary LanguagePHP

WIKI EMAIL NOTIFICATION EXTENSION

	Version 0.1

	© 2022 Igor Absorto
	(Based on work by Rob Church - https://www.mediawiki.org/wiki/Extension:New_User_Email_Notification)

This is free software licenced under the GNU General Public Licence. Please
see http://www.gnu.org/copyleft/gpl.html for further details, including the
full text and terms of the license.

== Overview ==

	1. Introduction
	2. Installation requirements
	3. Installing the extension
	4. Editing the notification email
	5. Further configuration
	6. Feedback

== 1. Introduction ==

The Wiki Email Notification extension provides a clean mean to send email messages to one or more registered 
users upon the creation of a user account or when a new page is created or an existing page is edited . Some
options can be configured in the LocalSettings.php file for MediaWiki.

== 2. Installation requirements ==

This extension requires MediaWiki 1.35.0 or later.

== 3. Installing the extension ==

To install the extension, place all extension files into a WikiNotif/ directory within your MediaWiki extensions/ 
directory, then edit LocalSettings.php and add the following line

	wfLoadExtension( 'WikiNotif' );

== 4. Further configuration ==

The behaviour of the extension can be tweaked using three configuration
variables. To override the defaults for these, set them in LocalSettings.php
underneath the call to the extension file.

$wgWikiNotifSender
	Email address of the sender of the email

	Defaults to the value of $wgPasswordSender

$wgWikiNotifTargets
	Array containing the usernames or user IDs of those who should receive
	a notification email. Email will not be sent unless the recipient's
	email address has been validated, where this is required in the site
	configuration.

	Defaults to the first user in the wiki as this is usually the wiki's primary administrator

$wgWikiNotifEmailTargets
	Array containing email addresses to which a notification should also be sent

	Defaults to no additional addresses

== 5. Feedback ==

All feedback, bug reports, etc. welcome via https://github.com/absort0/WikiNotif