README

Filament Umami

This Filament package seamlessly integrates Umami analytics into your Blade templates. Easily track website visits and user engagement directly within your Laravel application, providing valuable insights into your website's performance. This package simplifies the integration process, saving you time and effort. With minimal configuration, you can leverage Umami's powerful analytics features to gain a clearer understanding of your audience and website usage.

Installation

You can install the package via composer:

composer require jeffersongoncalves/filament-umami

This package depends on jeffersongoncalves/laravel-umami which provides the core Umami analytics integration for Laravel applications.

Requirements

PHP 8.2 or higher
Laravel 11.0 or higher
Filament 5.0

Usage

1. Register the Plugin

Add the plugin to your PanelProvider:

use JeffersonGoncalves\Filament\Umami\UmamiPlugin;

public function panel(Panel $panel): Panel
{
    return $panel
        ->plugins([
            UmamiPlugin::make(),
        ]);
}

This will automatically:

Inject the Umami tracking script into your panel
Add a Settings Page to manage your Umami configuration

2. Run Settings Migration

If you haven't already, publish the spatie/laravel-settings migration to create the settings table:

php artisan vendor:publish --provider="Spatie\LaravelSettings\LaravelSettingsServiceProvider" --tag="migrations"

Then publish and run the Umami settings migration:

php artisan vendor:publish --tag=umami-settings-migrations
php artisan migrate

3. Manage Settings

Navigate to Settings > Umami Analytics in your Filament panel to configure:

Tracking Configuration - Website ID, Analytics Host, Host URL
Tracking Behavior - Auto Track, Exclude Search Parameters, Exclude Hash
Advanced Options - Domains filter, Custom Tag

Disabling the Settings Page

If you only want the tracking script injection without the settings page:

UmamiPlugin::make()
    ->settingsPage(false),

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

jeffersongoncalves / filament-umami

Maintainers

Details