paulmorel/fathom-analytics
Composer 安装命令：
composer require paulmorel/fathom-analytics
包简介
A Kirby 3 plugin for integrating the Fathom Analytics service to your site.
README 文档
README
A Kirby 3 plugin for integrating the privacy focused Fathom Analytics service to your site.
Main Feautres
This plugin does two things:
- It provides a panel view to display the Fathom Analytics dashboard directily in the panel
- It provides a snippet to embed the Fathom Analytics tracking code
Requirements
- Kirby CMS v3.4.0+
Installation
Download
Download and copy this repository to the plugins folder of your Kirby 3 installation. You should end up with a folder structure like this:
/site/plugins/fathom-analytics
Git submodule
If you prefer to use Git submodules, you can install the plugin like this:
git submodule add https://github.com/PaulMorel/kirby3-fathom-analytics.git site/plugins/fathom-analytics
Composer
If you are using Composer, you can install the plugin like this:
composer require paulmorel/fathom-analytics
Usage
Setup
After installing the plugin, there a couple of important steps to do in your Fathom Analytics settings.
- If not already done, add your site in Fathom Analytics
- Go to your site settings and get the SiteID.
- Still in the site settings, setup Site Sharing, either Public or Private.
Afterwards, in your site config, add your SiteID and the share password (if needed).
Example:
return [ /* ... */ 'paulmorel.fathom-analytics' => [ 'siteId' => 'ABCDEFGH', 'sharePassword' => 'hunter2' ] /* ... */ ];
Embedding the tracking code
The tracking code is provided as a snippet, so it can be simply embedded in the <head> tag with the snippet() helper function.
If no siteId is provided, the snippet does nothing.
<head>
<!-- ... -->
<php snippet('fathom-analytics-embed'); ?>
<!-- ... -->
</head>
Viewing your stats
The plugin provides a panel view that loads your site's analytics dashboard in an iframe. Simply open the menu in the panel's top bar and click on Analytics.
Options
siteId (Required)
This is the SiteID provided by Fathom Analytics at the top of your site's setting page.
sharePassword
This is the share password for your site's dashboard. This is only required if you set Site Sharing to Private.
customDomain
If you use the custom domain feature with Fathom Analytics, you can set it with this option.
Example:
'customDomain' => 'https://armadillo.example.com'
disableForRole
Allows you to disable the tracking code for logged in users with the specified roles. Expects an Array. Defaults to ['admin'].
Examples:
'disableForRole' => [ 'admin' ],
'disableForRole' => [ 'admin', 'editor', 'translator' ],
Disclaimer
This plugin is provided "as is" with no guarantee. Use it at your own risk and always test it yourself before using it in a production environment. If you find any issues, please create a new issue.
License
MIT
Support
This plugin is completely free to use, but if you'd like to support me or this project, consider signing-up to Fathom Analytics with my affiliate link.
paulmorel/fathom-analytics 适用场景与选型建议
paulmorel/fathom-analytics 是一款 基于 PHP 开发的 Composer 扩展包，目前已累计 7.36k 次下载、GitHub Stars 达 9， 最近一次更新时间为 2021 年 09 月 29 日， 在 PHP 生态内属于活跃度较高的组件。
我们在过去多个企业项目中使用过 paulmorel/fathom-analytics 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。
基于 paulmorel/fathom-analytics 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。
线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。
承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。
统计信息
- 总下载量： 7.36k
- 月度下载量： 0
- 日度下载量： 0
- 收藏数： 9
- 点击次数： 9
- 依赖项目数： 0
- 推荐数： 0
其他信息
- 授权协议： MIT
- 更新时间： 2021-09-29