Download the PHP package paulmorel/fathom-analytics without Composer
On this page you can find all versions of the php package paulmorel/fathom-analytics. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download paulmorel/fathom-analytics
More information about paulmorel/fathom-analytics
Files in paulmorel/fathom-analytics
Package fathom-analytics
Short Description A Kirby 3 plugin for integrating the Fathom Analytics service to your site.
License MIT
Informations about the package fathom-analytics
Kirby Fathom Analytics
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:
Git submodule
If you prefer to use Git submodules, you can install the plugin like this:
Composer
If you are using Composer, you can install the plugin like this:
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:
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.
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:
disableForRole
Allows you to disable the tracking code for logged in users with the specified roles. Expects an Array
. Defaults to ['admin']
.
Examples:
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.