Matomo Analytics

[Discourse]

	Summary	Matomo Analytics is a script to enable Matomo analytics on Discourse.
	Repository Link	https://github.com/discourse/discourse-matomo-analytics
	New to Discourse Themes?	Beginner’s guide to using Discourse Themes

Install this theme component

As this is an official theme component maintained by the Discourse team, Support, Bug, UX, and Feature requests can be made in the respective categories here on Meta, and tagged with the appropriate theme component tag. Click on a link below to get one started.

 Support  Bug  UX  Feature

Features

Matomo is an open source analytics platform. Users can choose between self-hosting or paying for professional hosting in the cloud.

Matomo was formerly named Piwik. See Piwik is now Matomo - Announcement - Analytics Platform - Matomo for details about the name change.

To enable Matomo analytics on your Discourse forum, all you have to do is install the official theme component.

Valid for Matomo API v1.5 and newer

1. Follow the theme installation guide to import from the following URL:

   https://github.com/discourse/discourse-matomo-analytics.git
   

   And you will see

   

2. Enter the Host URL and Website ID

   

3. Add the theme component “Matomo Analytics” to your active theme(s).

   

That’s it!

Settings

Name	Description
host url	Host URL without http:// or https://
website id
exclude groups	Comma separated list of groups to exclude from tracking such as admins, staff
user id tracking	An indentifying field name on the current user object such as id, username or external_id.
subdomain tracking	Track visitors across main domain & subdomains, assuming discourse is on a subdomain.
do not track	So tracking requests will not be sent if visitors do not wish to be tracked.
disable cookies	Disables all first party cookies. Existing Matomo cookies for this website will be deleted on the next pageview.

Credits

Thanks to @mattab & @brahn @tagtomat and @simon

Hosted by us? Theme components are available to use on our Standard, Business, and Enterprise plans.

Last edited by @david 2025-01-09T09:44:19Z

Check document

Perform check on document:

[chrisblech (Christoph Blechschmitt)]

Thanks for this howto, works fine for me.

In order to comply with the European laws, users must have the possibility to reject piwik’s cookie. Piwik offers a really simple solution for this, by including an IFrame.

Unfortunately, Discourse doesn’t allow iframe tags in posts…
Does anyone see a way to include this piwik iframe in Discourse TOS ?
Thanks.

[xrav3nz]

I just created a new “Matomo Analytics” theme component, and updated the instructions on how to set it up.

Could you give it a try? Please also remember to remove the original custom scripts.

[some-user]

Looks good on first sight. No error in javascript console. Requests to piwik.php being in the webserver log again.

Statistics in Matomo are available as well.

[sam (Sam Saffron)]

Is this iframe thing still a concern?

[chrisblech (Christoph Blechschmitt)]

Hey @xrav3nz your component works great - thanks!

@sam

Is this iframe thing still a concern?

Yes it is. Opt-out should be possible, and Matomo provides this via including an iFrame: see Matomo documentation

[Patrick_David (Pat David)]

This doesn’t appear to be working for me at the moment? I can add the component, and add the correct URL and siteid, but it doesn’t render anything:

I added the comments around the code to find it quicker in the page:

[darix]

We are on beta 6+git1 on our instance

[xrav3nz]

Inline JavaScripts in themes and components are automatically extracted to an external “theme JavaScript” file.

Could you try checking the one immediately after your comments?

[Patrick_David (Pat David)]

This is at the main page on https://discuss.pixls.us:

Edit
Hold on, I’ve got a new hash on the file on recent refresh, it looks like the code is there. Thank you @xrav3nz!

Looks like it’s working now - not sure what I was doing wrong yesterday - user error.

[downey (Michael Downey)]

So I have the JS loaded into the theme customizations, and the external “theme JavaScript file”* is linked in my test browser, just under where I inserted it like in the screenshot in a few posts earlier … BUT the requests aren’t coming through to the Matomo tracking web server.

(Tracking works fine for other non-Discourse sites, FWIW.)

Has anyone else seen that happen?

---

* e.g. https://discourse-cdn.example.com/standard11/theme-javascripts/{numeric_string}.js?__ws=my-discourse-forum.example.org

[surety (Ryan)]

感谢提供这个组件！

我不太明白为什么追踪代码会发送一个名为“Anonymous”的自定义变量。这难道不是针对您特定的 Matomo 设置的吗？看起来它不应该对所有人都存在。

_paq.push(['setCustomVariable', 1, 'Anonymous', !currentUser, 'visit']);

我添加了几行代码，以便在子域名的 Discourse 和主站点之间追踪访客。如果您需要，我很乐意提交拉取请求。

[goaround]

您需要在内容安全策略（Content-Security-Policy）标头中将您的 Matomo URL 列入白名单。搜索管理设置 content_security_policy_script_src，并在其中添加您的域名（包含 https://）。

[danb35 (Dan)]

我在我的安装环境中遇到无法正常工作的问题。我已经安装了该组件，并将其添加到我的主题中，但 Matomo 提示该站点没有数据。我认为我的设置是正确的：

但在我的浏览器控制台中看到了这个错误：

…当我在 Matomo 中查看该站点时，看到的是这个：

我遗漏了什么？

编辑：进一步调查后发现，JavaScript 控制台中的错误仅在 Firefox 中出现，而在 Chrome 中则没有（在 Mac 上使用的是两者的最新版本）。现在我在 Matomo 中看到了一些结果，但 Firefox 明显缺失——所有访客中只有一人未使用 Chrome；该例外访客使用的是 Safari。

[danb35 (Dan)]

对此有什么看法吗？这篇帖子：

Tracking not working in Firefox

指出这可能是 Firefox 的“不追踪”设置所致，但即使我为我的网站禁用了该设置，在 Firefox 的网页控制台中仍然出现相同的错误。而且无论如何，Firefox 似乎并没有将其视为追踪器：

[goaround]

请尝试移除“https://www.familybrown.org/analytics/”末尾的斜杠 /，将其改为“https://www.familybrown.org/analytics”

[danb35 (Dan)]

谢谢。不幸的是，我仍然收到相同的错误：

[goaround]

能告诉我您论坛的网址吗？

[danb35 (Dan)]

SpareOom

[eextra (Sylwia)]

这两个字段需要填写吗？我不是很理解它们。