Manual:$wgRCFeeds
| Recent changes, new pages, watchlist and history: $wgRCFeeds | |
|---|---|
| Configuration for sending RC updates |
|
| Introduced in version: | 1.22.0 (Gerrit change 52922; git #2961884b) |
| Removed in version: | Still in use |
| Allowed values: | Unspecified |
| Default value: | [] |
| Other settings: Alphabetical | By function | |
Details
[edit]This variable is for configuring where MediaWiki will send network updates for recent changes. This is called after recent changes info have been inserted into the recentchanges table.
Usage
[edit]MediaWiki supports sending recent changes updates to any number of destinations. Therefore this variable is an array, with each entry being a descriptor of where and how to send the data.
Each descriptor is an associative array with the following keys:
- formatter
- Fully qualified class name for the class that will format the data for sending over the network. It must inherit the RCFeedFormatter interface.
- uri
- URI to send the data to (the protocol indicates what engine is used to send the data)
- omit_bots
- True or false whether to skip bot edits
- omit_anon
- True or false whether to skip anon edits
- omit_user
- True or false whether to skip registered users
- omit_minor
- True or false whether to skip minor edits
- omit_patrolled
- True or false whether to skip patrolled edits
As mentioned, the formatter key specifies what class will be used to format the data, and the protocol of the URI specifies how to actually send the data.
Formatters
[edit]A formatter needs to be specified in order for the data to be translated properly before going over the network. MediaWiki has the following built-in formatter classes:
- JSONRCFeedFormatter
- Outputs the RC information in a JSON dictionary
- XMLRCFeedFormatter
- Outputs the RC information in XML format
- IRCColourfulRCFeedFormatter
- Outputs an IRC line with color codes for broadcast to an IRC server
- Custom parameters:
- add_interwiki_prefix
- True or false whether to add the interwiki prefix to the data (
$wgLocalInterwikis). Only works for the IRCColourfulRCFeedFormatter formatter.
Engines
[edit]Engines are the method by which the recentchange notifications are sent. MediaWiki has the following built-in engines:
- UDPRCFeedEngine
- Sends via a UDP packet
- RedisPubSubFeedEngine
- Sends via Redis Pub/Sub
See $wgRCEngines for how to configure the mapping of protocols to engines.
Example
[edit]Here are some example configurations:
$wgRCFeeds['example'] = [
'class' => UDPRCFeedEngine::class,
'uri' => 'udp://localhost:1336',
'formatter' => JSONRCFeedFormatter::class,
'omit_bots' => true,
];
$wgRCFeeds['example'] = [
'class' => ExampleRCFeed::class,
];