README

Simple plugin providing Plausible tracking and iframe panel view to Kirby panel.

Installation

composer require floriankarsten/kirby-plausible or download from releases

How to use

Create a shared link https://plausible.io/docs/shared-links

Set floriankarsten.plausible.sharedLink in config.php

// config/config.php
'floriankarsten.plausible' => [
    // Required
    'scriptUrl' => 'https://plausible.io/js/XYZ.js', // replace with the URL of the Plausible site you want to use

    // Required
    'sharedLink' => 'https://plausible.io/share/yourwebsiteurl.com?auth=Jz0mCWTPu5opXi0sAgRrq',

    // Optional: To proxy Plausible through your own server (helps avoid ad blockers)
    // 'proxy' => [
        // 'enabled' => true,
        // 'cache' => 60 * 24, // 24 hours, optional
        // 'plausibleEndpoint' => 'https://plausible.io', // customize the Plausible instance when self-hosting, optional
    // ]
];

Add the following snippet inside your site's <head> tag. Note that this will not generate any output for logged in users or when Kirby is in debug mode.
```
<?php snippet('plausible'); ?>
```

Proxy setup

To avoid ad blockers you can proxy the Plausible script and events through your own server.

Set floriankarsten.plausible.proxy.enabled to true in your config.php
When self-hosting Plausible, set floriankarsten.plausible.proxy.plausibleEndpoint to your Plausible instance URL.

More information about the Plausible proxy setup can be found in the Plausible documentation.

Optional measurements / additional Plausible options

There are a number of additional options you can set when initialising Plausible (more here: https://plausible.io/docs/script-extensions). The easiest way to set these is by copying snippets/plausible.php from the plugin into your own snippets folder and modifying it to your needs.

Troubleshooting

The panel menu item doesn't show up or is not working

Make sure you have set a valid sharedLink in your config.php.
If you have overwritten your panel menu items using the panel.menu option, include plausible in the array of menu items.

Credits

This plugin wouldn't happen without @garethworld who kindly hired me to make it and then wanted to have it released to Kirby community. Yaaaaay

floriankarsten / kirby-plausible

Maintainers

Details