Extension:MatomoAnalytics
MatomoAnalytics Release status: stable |
|
---|---|
Description | Integration with Matomo for analytics. Adds a special page to view that stats on-wiki. |
Author(s) | John Lewis, Southparkfan, Universal Omega |
Maintainer(s) | Miraheze system administrators |
Latest version | continuous updates |
MediaWiki | 1.35.3+ |
PHP | 7.2+ |
Database changes | No, Yes if $wgMatomoAnalyticsUseDB is enabled |
Composer | miraheze/matomo-analytics |
License | GNU General Public License 3.0 |
Download | GitHub: |
|
|
|
|
The MatomoAnalytics extension inserts tracking code for the Matomo analytics platform. It also creates a Special Page (Special:Analytics) where you can view the stats on-wiki.
For reporting an issue or a bug, please use Miraheze Phabricator. See here for the workboard.
Installation
edit- Download and place the file(s) in a directory called
MatomoAnalytics
in yourextensions/
folder. - Add the following code at the bottom of your LocalSettings.php file:
wfLoadExtension( 'MatomoAnalytics' );
- Configure as required.
- Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.
- It is important that the whole URL is used with protocol and trailing slash:
http://example.org/
Configuration
editparameter | default | comment | required? |
---|---|---|---|
$wgMatomoAnalyticsServerURL
|
false
|
URL of your Matomo installation | Required |
$wgMatomoAnalyticsTokenAuth
|
false
|
The auth token for the API of your Matomo install | Required |
$wgMatomoAnalyticsSiteID
|
1
|
Matomo site ID | Optional |
$wgMatomoAnalyticsGlobalID
|
false
|
Shared Matomo site ID. For use on wikifarms. | Optional |
$wgMatomoAnalyticsUseDB
|
false
|
Whether to use a database or not. For use on wikifarms. | Optional |
$wgMatomoAnalyticsDatabase
|
false
|
Name of the main database to use. For use on wikifarms. | Optional |
$wgMatomoAnalyticsDisableCookie
|
false
|
Allow disabling cookies set by Matomo. | Optional |
$wgMatomoAnalyticsDisableJS
|
false
|
Allow disabling of JS tracking code globally | Optional |
Matomo API token
editTo obtain a Matomo API token from your Matomo installation, you can follow the official documentation:
See also
editThis 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. |
This extension is maintained by Miraheze. Some Miraheze extensions are very Miraheze-specific and you may encounter issues you don't see on Miraheze. To report a bug or request a configuration change, please do so on the Miraheze Issue Tracker and not on Wikimedia Phabricator. |