johannschopplich / kirby-plausible
Plausible Analytics for Kirby CMS
Package info
github.com/johannschopplich/kirby-plausible
Type:kirby-plugin
pkg:composer/johannschopplich/kirby-plausible
Requires
- php: >=8.2
- getkirby/composer-installer: ^1
Requires (Dev)
- getkirby/cms: ^5
- phpunit/phpunit: ^12
Suggests
None
Provides
None
Conflicts
None
Replaces
None
README
Kirby Plausible
Kirby Plausible is a plugin for Kirby CMS that shows your Plausible dashboard in the Panel and adds the tracking script to your site.
Features • Options • Troubleshooting
When to Use
| I want to… | Use |
|---|---|
| See my site's stats in the Panel | sharedLink option |
| Track the visitors of my site | scriptUrl option and snippet('plausible') |
| Send visits to a self-hosted Plausible instance | scriptUrl option |
| Hide the dashboard from a role | access.plausible permission |
Features
📊 Panel Dashboard
The plugin adds an Analytics entry to the Panel menu that embeds your dashboard through a Plausible shared link. The dashboard follows the Panel's light or dark theme, lets the Panel's background show through, and grows with its content instead of a fixed height. A shared link from a self-hosted Plausible instance works the same way.
// config.php return [ 'johannschopplich.plausible' => [ 'sharedLink' => 'https://plausible.io/share/example.com?auth=…' ] ];
Note
Plausible cannot embed a password-protected shared link. Leave its password empty and control who sees the dashboard through Panel roles.
🏷️ Tracking Snippet
Add the snippet to the <head> of your templates. It prints nothing in debug mode or for a logged-in user, so your own visits stay out of the stats.
<?php snippet('plausible') ?>
Plausible gives every site its own script, listed in the site settings under General → Site installation. Set its URL as scriptUrl, and the snippet prints Plausible's current snippet. Without scriptUrl, it prints nothing.
To pass options to plausible.init(), copy src/snippets/plausible.php to site/snippets/plausible.php and edit the copy: Kirby prefers a site snippet over the plugin's.
🔐 Role Access
Kirby gives every Panel area an access permission of its own. Hide the dashboard from a role in its blueprint:
# site/blueprints/users/editor.yml title: Editor permissions: access: plausible: false
Requirements
- Kirby 6
Installation
Composer (Recommended)
composer require johannschopplich/kirby-plausible
Manual Installation
Download a release and extract it to /site/plugins/kirby-plausible.
Options
All options are namespaced under johannschopplich.plausible:
| Option | Default | Description |
|---|---|---|
sharedLink |
'' |
Plausible shared link the Panel dashboard embeds. Without it, the area shows a setup notice. |
scriptUrl |
null |
Your site's script URL from Plausible. Without it, the snippet prints nothing. |
Example config.php:
return [ 'johannschopplich.plausible' => [ 'sharedLink' => 'https://plausible.io/share/example.com?auth=…', 'scriptUrl' => 'https://plausible.io/js/pa-….js' ] ];
Troubleshooting
The Analytics entry is missing from the Panel menu. Kirby's panel.menu option is an allow-list: once you set it, it has to list the plugin's plausible area.
// config.php return [ 'panel' => [ 'menu' => ['site', 'users', 'system', 'plausible'] ] ];
Credits
Based on kirby-plausible by Florian Karsten.
License
MIT License © 2022-PRESENT Johann Schopplich
MIT License © 2021 Florian Karsten