包简介

Integrates Matomo Analytics with Winter CMS

README 文档

README

Matomo is a Google Analytics alternative that lets website owners own their analytical data and protect their customers' privacy. This is a WinterCMS plugin that integrates Matomo into WinterCMS providing reporting widgets, client-based tracking component, and (planned) a server-side tracking component.

Prerequisites

You must have access to Matomo, either through the cloud services provided by Matomo or a self hosted Matomo instance. If you are paranoid about privacy, you might want to go for a self-hosted instance.

Plugin Usage

You must have basic knowledge about Matomo in order to use this plugin. In particular, you must know how to create new tracking instances, users, and security tokens. Don't be worried. This is quite easy to learn by playing around with Matomo.

Setup site on Matomo

To get Matomo Analytics setup for your Winter CMS instance:

identify the analytics server you intend to use (e.g., matomo.org).
in the Matomo backend set your CMS server up for tracking and note down the site ID
again in the in the Matomo backend generate a security token (an Auth Token). Note that the Auth Token must be created under user who does not have super admin access
add the Matomo Server URL, the Site ID, and the Auth Token to this plugin's configuration

NOTE: You may want to disable any adblockers that you are currently using.

NOTE: The tracker is disabled when authenticated backend users are detected or the website is in maintenance mode

Configuration

Configuration for this plugin is handled through a configuration file. In order to modify the configuration values and get started you can either add the values to your .env environment file or copy the plugins/winter/matomo/config/config.php file to config/winter/matomo/config.php and make your changes there.

Environment File Supported Values:

MATOMO_SERVER="https://example.matomo.cloud/"
MATOMO_SITE_ID=1
MATOMO_TOKEN=""

Tracking

To start tracking your visitors simply add the Tracker component to the <head> section on all of the pages that you want to include the Matomo tracker on.

NOTE: The tracker component must be rendered before the closing </head> tag.

With that, Matomo should start tracking and you should see results shortly.

NOTE: Matomo provides near-realtime results with an emphasis on "near", so you might have to wait a few minutes to see the first results.

Reporting

This plugin provides two main Dashboard ReportWidgets out of the box.

The first widget is the "Analytics Dashboard" widget, which provides the entire Matomo dashboard embedded into the Winter dashboard through the use of an iframe. It is recommended that you set this widget to the maximum width in order to see all of the data present easily. This widget supports changing the period of time that is reported on.

The second widget is the "Analytics Report" widget, which provides the ability to pick from a pre-set list of common reports that can be embedded as individual widgets on the Winter Dashboard. Each of the widgets allows you to configure the period of time that is examined, how the data is displayed, and how many rows to include in the results. It is also possible to export the data of an individual report.

Credits

This plugin was originally written by Helmut Kaufmann, Küssnacht am Rigi, in Switzerland. Helmut can be reached by mail at software@mercator.li.

It has since been modified and re-released under the Winter namespace as a first party plugin for Winter CMS maintained by the Winter CMS team and Helmut Kaufmann.

If you would like to contribute to this plugin's development, please feel free to submit issues or pull requests to the plugin's repository here: https://github.com/wintercms/wn-matomo-plugin

If you would like to support Helmut Kaufmann please visit PayPal.

If you would like to support Winter CMS, please visit WinterCMS.com

winter/wn-matomo-plugin 适用场景与选型建议

winter/wn-matomo-plugin 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 2.73k 次下载、GitHub Stars 达 5，最近一次更新时间为 2022 年 03 月 01 日，在 PHP 生态内属于活跃度较高的组件。

它主要适用于以下技术方向：「cms」「analytics」「piwik」「matomo」「wintercms」等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。

我们在过去多个企业项目中使用过 winter/wn-matomo-plugin 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 winter/wn-matomo-plugin 我们能提供哪些服务？

定制开发 / 二次开发

基于 winter/wn-matomo-plugin 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发