b74fca9f8b
This requires MediaWiki 1.34 and works up to (at least) MediaWiki 1.40. New features since v4.0.0: * Ignore wiki editors, to restrict analytics to anonymous users Maintenance since v4.0.0: * Replace global $wgUser deprecated in MediaWiki 1.35.2 * Replace User::isLoggedIn() deprecated in MediaWiki 1.34 * PSR-4 autoloading * Added CI and quality checks * Improved documentation Thanks to the following people since v4.0.0 🥳 Eduardo Elias (2): Ignore wiki editors Make README to be parsed Goldshop (1): Update extension.json Sam Wilson (2): Add CI and linting, and fix errors Move Matomo.hooks.php to src/Hooks.php and adjust loading Youri vd Bogert (1): Update README.md felipeforte (1): Updated hook mnival (2): Replace deprecated $wgUser by RequestContext::getMain()->getUser() Delete empty line previously contributed as ttenbergen (1): allow plugins Daniel Schuba (5): Merge pull request #32 from Goldshop/patch-1 Merge pull request #26 from YOUR1/patch-1 Merge pull request #35 from samwilson/phpcs Merge pull request #36 from samwilson/classname Merge pull request #37 from mnival/master Seb35 (10): Rebase IgnoreEditors feature on 4.0.0 Fix $wgMatomo* and $wgPiwik* parameters Merge pull request #40 from felipeforte/patch-1 Restrict plugins to composer/installers Merge branch 'fix-ci' Make explicit the parameter $wgMatomoIgnoreEditors Avoid to silently ignore non-existing parameters Fix documentation issues Update CI Version 5.0 |
||
---|---|---|
.github/workflows | ||
src | ||
.gitignore | ||
.phpcs.xml | ||
README.md | ||
Rakefile | ||
composer.json | ||
extension.json |
README.md
Mamoto extension for MediaWiki
Version 5.0.0
- Last update: 27 October 2023
This the Mamoto (ex-Piwik) integration extension for MediaWiki software. The extension is only useful if you've got a MediaWiki installation; it can only be installed by the administrator of the site.
Minimum requirements
-
MediaWiki 1.34+
-
A Matomo (0.4+) installation with the site configured
Installation instructions
Please, read them carefully. They're not very difficult to understand, but ALL steps are necessary:
-
Create a folder called "Matomo" in your extensions directory
-
Upload extension.json and Matomo.hooks.php in the "Matomo" folder you've just created
-
Edit your LocalSettings.php and, at the end of the file, add the following:
wfLoadExtension( 'Matomo' );
-
Configure the Matomo URL and site-id. To do so; edit the LocalSettings and set up the following variables:
$wgMatomoURL = "matomo-host.tld/dir/";
$wgMatomoIDSite = "matomo_idsite";
IMPORTANT Do not define the protocol of the $wgMatomoURL
Note: Change the value of $wgMatomoURL with the URL, without the protocol but including the domain name, where you installed Matomo. Remember to add the trailing slash!
- Enjoy our extension!
Note: to check if the extension has succesfully installed; go to your wiki and check if the Matomo extension is present on the bottom of the Wiki source code.
Custom variables
-
Disable cookies by setting the
$wgMatomoDisableCookies
variable tofalse
.For example: $wgMatomoDisableCookies = false;
-
Ignore regular editors: set
$wgMatomoIgnoreEditors
totrue
-
Do not ignore Bots: set
$wgMatomoIgnoreBots
tofalse
(by default bots are ignored) -
Do not ignore sysop users: set
$wgMatomoIgnoreSysops
tofalse
(by default sysops are ignored) -
To define custom javascript tags in the Matomo javascript code, its possible to define the $wgMatomoCustomJS variable. For example if you have a single setting to insert; use the following code:
$wgMatomoCustomJS = "_paq.push(['trackGoal', '1']);"
If you have multiple variables to define; use an array. For example:
$wgMatomoCustomJS = array( "_paq.push(['setCustomVariable', '1','environment','production']);", "_paq.push(['setCustomVariable', '1','is_user','yes']);" );
-
If you want to change the title of your pages inside the Matomo tracker, you can set
$wgMatomoActionName
inside your LocalSettings.php file. -
In case you want to include the title as, for example, "wiki/Title of the page", you can set
$wgMatomoUsePageTitle
totrue
and set$wgMatomoActionName
towiki/
. The extension will print matomo_action_name = 'wiki/Title of the page'; -
If you want to track the username of the visitor with the Matomo feature User ID (needs Matomo >= 2.7.0) set the
$wgMatomoTrackUsernames
to true in LocalSettings.php.
Troubleshooting
On MediaWiki 1.39.0–1.39.4 and 1.40.0, the tracking code is included twice: this can be fixed by upgrading MediaWiki to 1.39.5 and 1.40.1 (see this Phabricator task.