 Release status: stable | |
|---|---|
 | |
| Implementation | Notify |
| Description | Provides an in-wiki notification system that can be used by other extensions. |
| Author(s) | |
| Latest version | continuous updates |
| Compatibility policy | Snapshots releases along with MediaWiki. Master is not backward compatible. |
| Database changes | Yes |
| Tables | echo_email_batch echo_event echo_notification echo_subscription echo_target_page echo_push_provider echo_push_subscription echo_push_topic echo_unread_wikis |
| License | MIT License |
| Download | |
| Help | Help:Extension:Echo |
| |
| |
| |
| Translate the Echo extension if it is available at translatewiki.net | |
| Issues | Open tasks ·Report a bug |
TheNotifications extension, historically calledEcho in code and documentation for sysadmins and developers, provides an in-wiki notification system that provides the user with alerts and notices about activity on the wiki, such as another user mentioning them on a talk page, or an edit of theirs being reverted.Other MediaWiki extensions can make use of Notifications to send their own notifications;Thanks andDiscussionTools are two such extensions.
$wgDBuser inLocalSettings.php).Echo folder to yourextensions/ directory.cdextensions/gitclonehttps://gerrit.wikimedia.org/r/mediawiki/extensions/EchowfLoadExtension('Echo');
Done – Navigate toSpecial:Version on your wiki to verify that the extension is successfully installed.To allow daily or weekly summary notifications to be delivered by mail (for users that choose that in preferences), the followingmaintenance script inside the Echo extension directory needs to be run on a daily basis, which can be scheduled in a cron job:
$php./maintenance/run.phpEcho:processEchoEmailBatch
|
It is possible to useconditional user options to set different notification preferences for new users, without affecting existing users.
SeeSpecial:DisplayNotificationsConfiguration for local details.
| Parameter | Default | Comment |
|---|---|---|
$wgEchoEnableEmailBatch | true | Whether to turn on email batch function |
$wgEchoUseJobQueue | false |
|
$wgEchoEmailFooterAddress | '' | The organization address (or whatever text you want to appear in the footer of the email notifications). Should be defined in LocalSettings.php |
$wgNotificationSender | $wgPasswordSender | The email address for both "from" and "reply to" on email notifications. Should be defined in LocalSettings.php |
$wgNotificationSenderName | "emailsender" message (MediaWiki) | Name for "from" on email notifications. Should be defined in LocalSettings.php |
$wgNotificationReplyName | No Reply | Name for "reply to" on email notifications. Should be defined in LocalSettings.php |
$wgEchoCluster | false | Use the main db if this is set to false, to use a specific external db, just use any key defined in$wgExternalServers |
$wgEchoSharedTrackingDB | false | Shared database to use for keeping track of cross-wiki unread notifications; false to not keep track of it at all |
$wgEchoSharedTrackingCluster | false | Cluster the shared tracking database is located on; false if it is on the main one. Must be a key defined in$wgExternalServers |
$wgEchoMaxUpdateCount | 2000 | The max number of notifications allowed for a user to do a live update, this is also the number of max notifications allowed for a user to have. |
$wgEchoMaxMentionsCount | 50 | The max number of mention notifications allowed for a user to send at once |
$wgEchoMentionStatusNotifications | false | Enable mention success/failure notifications |
$wgEchoMentionsOnMultipleSectionEdits | true | Trigger mentions for multiple-section edits |
$wgEchoMentionOnChanges | true | Trigger mentions for edits to existing comments, as long as a signature is added in the same section |
$wgEchoMaxMentionsInEditSummary | 0 | Maximum number of users that will be notified that they were linked from an edit summary or 0 for no notifications |
$EchoMentionsInEditSummaryBots | false | Whether to allow mentions by bot accounts in edit summaries to trigger notifications (subject to EchoMaxMentionsInEditSummary limit) |
$wgEchoBundleEmailInterval | 0 | The time interval between each bundle email in seconds; set a small number for test wikis. This should be set to 0 to disable email bundling if there is no delay queue support |
$wgEchoNewMsgAlert | true | Whether or not to enable a new talk page message alert for logged in users. |
$wgNotifyTypeAvailabilityByCategory | [// Otherwise, a user->user email could trigger an additional redundant notification email.'emailuser'=>['web'=>true,'email'=>false,],'mention-failure'=>['web'=>true,'email'=>false,],'mention-success'=>['web'=>true,'email'=>false,],] | Define which notify types are available for each notification category. If any notify types are omitted, it defaults to $wgDefaultNotifyTypeAvailability. |
$wgEchoNotifiers | ['web'=>['EchoNotifier','notifyWithNotification'],'email'=>['EchoNotifier','notifyWithEmail'],] | Definitions of the different types of notification delivery that are possible. Each definition consists of a class name and a function name. See also EchoNotificationController class. |
$wgEchoAgentBlacklist | [] | List of usernames which will not trigger notifications |
$wgEchoOnWikiBlacklist | Echo-blacklist | Page location of community maintained blacklist within NS_MEDIAWIKI containing one username per line, which will not trigger notifications. Set to null to disable. |
$wgEchoPerUserWhitelistFormat | %s/Echo-whitelist | An sprintf format of the location of the per-user notification agent whitelist within the NS_USER namespace. %s will be replaced with the users name. The whitelists must contain one username per line, which will always trigger notifications regardless of their existence in the blacklists. Set tonull to disable. |
$wgEchoCrossWikiNotifications | false | Whether to enable the cross-wiki notifications feature. To enable this feature you need to:
|
$wgEchoUseCrossWikiBetaFeature | false | Feature flag for the cross-wiki notifications beta feature If this is This does not control whether cross-wiki notifications are enabled by default.For that, use |
$wgEchoNotificationCategories | Seeextension.json | Define the categories that notifications can belong to. Categories can be assigned the following parameters. All parameters are optional:
If a notifications type doesn't have a category parameter, it is automatically assigned to the |
$wgEchoNotificationIcons | Seeextension.json | Defines icons, which are 30x30 images. This is passed to BeforeCreateEchoEvent so extensions can define their own icons with the same structure. It is recommended that extensions prefix their icon key. An example is myextension-name. This will help avoid namespace conflicts. You can use either a path or a url, but not both. The value of 'path' is relative to The value of 'url' should be a URL. You should customize the site icon URL, which is: |
$wgEchoNotifications | Seeextension.json | Define the event types for echo. Event definitions are in the form of 'event-name' => [ ... ].
|
$wgEchoConfig | Seeextension.json | Configuration for EventLogging. Individual schemas can be disabled. |
$wgEchoPerUserBlacklist | null | Boolean that enabled Per User Blacklist. |
| Preference | Default | Comment |
|---|---|---|
$wgDefaultUserOptions['echo-email-frequency'] | 0 | How often to send emails, by default:
|
$wgDefaultUserOptions['echo-email-format'] | Depends on$wgAllowHTMLEmail | Default user preference for whether to use HTML or text email. Eitherhtml orplain-text. |
$wgDefaultUserOptions["echo-subscriptions-email-{$category}"] | false for most categories; depends | Default user preference for whether to notify via email for a particular category |
$wgDefaultUserOptions["echo-subscriptions-web-{$category}"] | true for most categories; depends | Default user preference for whether to notify via web for a particular category |
Seethe architecture section of the feature page.
There are occasionally specific users, typically bots, which perform maintenance tasks that should not generate notifications.To handle these cases, users can be globally blacklisted from the LocalSettings.php file (or InitialiseSettings.php in the case of WMF wikis):
$wgEchoAgentBlacklist=['SampleBot','SampleUser'];
There is also an on-wiki blacklist that can be maintained by the wiki's community.The location of the global on-wiki blacklist defaults toMediaWiki:Echo-blacklist.Individual users can override the blacklist by creating a whitelist.The whitelist location defaults toSpecial:MyPage/Echo-whitelist.All on-wiki lists expect to receive one case-specific username per line with no special markup or prefixes.For example:
SampleBotSampleUser
One of the notification types that this extension allows is: "Notify me when someone links to my user page." It might not be obvious to some users, but this particular notification only works when the person linking to another user's page also signs (~~~~) the post.
After installation of the extension, a new tab "Notifications" is created in a user'sSpecial:Preferences page.Under the section "Notify me about these events", in front of the "Mention" option, the hoverbox states: "Notify me when someone links to my user page."If an administrator feels, that the requirement for signing the post isn't obvious in this help text, it can be modified by changing the text in the Wiki'sMediaWiki:Echo-pref-tooltip-mention page.
 | This extension is being used on one or moreWikimedia projects. This probably means that the extension is stable and works well enough to be used by such high-traffic websites. Look for this extension's name in Wikimedia'sCommonSettings.php andInitialiseSettings.php configuration files to see where it's installed. A full list of the extensions installed on a particular wiki can be seen on the wiki'sSpecial:Version page. |
 | This extension is included in the following wiki farms/hosts and/or packages:This is not an authoritative list. Some wiki farms/hosts and/or packages may contain this extension even if they are not listed here. Always check with your wiki farms/hosts or bundle to confirm. |
-logo.svg){kind=logo}