feat: migrate configuration to spatie/laravel-settings

jeffersongoncalves · claude · jeffersongoncalves · commit fcc93609a98f · 2026-02-22T14:40:41.000-03:00
BREAKING CHANGE: Replace config/umami.php with database-backed settings via spatie/laravel-settings.

- Remove config/umami.php and all env() reads
- Add UmamiSettings class extending Spatie\LaravelSettings\Settings
- Add settings migration with default values
- Update UmamiServiceProvider to register settings class and migration paths
- Update Blade view to resolve settings from container
- Add spatie/laravel-settings ^3.3 as dependency
- Update README with new installation and usage instructions

Co-Authored-By: Claude Opus 4.6 &lt;noreply@anthropic.com&gt;
diff --git a/README.md b/README.md
@@ -12,28 +12,66 @@
 
 This Laravel 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.
 
+## Requirements
+
+- PHP 8.2+
+- Laravel 11+
+- [spatie/laravel-settings](https://github.com/spatie/laravel-settings) configured (the `settings` table must exist)
+
 ## Installation
 
-You can install the package via composer:
+Install the package via composer:
 
 ```bash
 composer require jeffersongoncalves/laravel-umami
 ```
 
-## Usage
+Run the migrations to create the Umami settings in your database:
 
-Publish config file.
+```bash
+php artisan migrate
+```
+
+Optionally, you can publish the settings migration to customize defaults:
 
 ```bash
-php artisan vendor:publish --tag=umami-config
+php artisan vendor:publish --tag=umami-settings-migrations
 ```
 
-Add head template.
+## Usage
+
+Add the Umami script to your Blade layout (typically in the `<head>` section):
 
-```php
+```blade
 @include('umami::script')
 ```
 
+### Configuring Settings
+
+Settings are stored in the database and can be managed via code:
+
+```php
+use JeffersonGoncalves\Umami\Settings\UmamiSettings;
+
+$settings = app(UmamiSettings::class);
+$settings->website_id = 'your-website-id';
+$settings->host_analytics = 'https://your-umami-instance.com';
+$settings->save();
+```
+
+### Available Settings
+
+| Property | Type | Default | Description |
+|----------|------|---------|-------------|
+| `website_id` | `?string` | `null` | Your Umami website ID (required for tracking) |
+| `host_analytics` | `string` | `https://cloud.umami.is` | URL of your Umami instance |
+| `host_url` | `?string` | `null` | Override data destination URL |
+| `auto_track` | `bool` | `true` | Automatically track pageviews and events |
+| `domains` | `?string` | `null` | Comma-delimited list of allowed domains |
+| `tag` | `?string` | `null` | Tag to group events in the dashboard |
+| `exclude_search` | `bool` | `false` | Exclude search parameters from URL |
+| `exclude_hash` | `bool` | `false` | Exclude hash value from URL |
+
 ## Testing
 
 ```bash
@@ -54,7 +92,7 @@ Please review [our security policy](../../security/policy) on how to report secu
 
 ## Credits
 
-- [Jèfferson Gonçalves](https://github.com/jeffersongoncalves)
+- [Jefferson Goncalves](https://github.com/jeffersongoncalves)
 - [All Contributors](../../contributors)
 
 ## License
diff --git a/composer.json b/composer.json
@@ -18,7 +18,8 @@
     "require": {
         "php": "^8.2|^8.3",
         "laravel/framework": "^11.0|^12.0",
-        "spatie/laravel-package-tools": "^1.14.0"
+        "spatie/laravel-package-tools": "^1.14.0",
+        "spatie/laravel-settings": "^3.3"
     },
     "require-dev": {
         "larastan/larastan": "^3.0",
diff --git a/config/umami.php b/config/umami.php
diff --git a/database/settings/2026_01_01_000000_create_umami_settings.php b/database/settings/2026_01_01_000000_create_umami_settings.php
@@ -0,0 +1,18 @@
+<?php
+
+use Spatie\LaravelSettings\Migrations\SettingsMigration;
+
+return new class extends SettingsMigration
+{
+    public function up(): void
+    {
+        $this->migrator->add('umami.website_id', null);
+        $this->migrator->add('umami.host_analytics', 'https://cloud.umami.is');
+        $this->migrator->add('umami.host_url', null);
+        $this->migrator->add('umami.auto_track', true);
+        $this->migrator->add('umami.domains', null);
+        $this->migrator->add('umami.tag', null);
+        $this->migrator->add('umami.exclude_search', false);
+        $this->migrator->add('umami.exclude_hash', false);
+    }
+};
diff --git a/resources/views/script.blade.php b/resources/views/script.blade.php
@@ -1,11 +1,13 @@
-@if(!empty(config('umami.website_id')))
-    <script async defer data-website-id="{{ config('umami.website_id') }}"
-            src="{{ config('umami.host_analytics') }}/script.js"
-            @if(config('umami.host_url')) data-host-url="{{ config('umami.host_url') }}" @endif
-            @if(config('umami.domains')) data-domains="{{ config('umami.domains') }}" @endif
-            @if(config('umami.tag')) data-tag="{{ config('umami.tag') }}" @endif
-            data-auto-track="{{ config('umami.auto_track') ? 'true' : 'false' }}"
-            data-exclude-search="{{ config('umami.exclude_search') ? 'true' : 'false' }}"
-            data-exclude-hash="{{ config('umami.exclude_hash') ? 'true' : 'false' }}">
+@php($settings = app(\JeffersonGoncalves\Umami\Settings\UmamiSettings::class))
+
+@if(!empty($settings->website_id))
+    <script async defer data-website-id="{{ $settings->website_id }}"
+            src="{{ $settings->host_analytics }}/script.js"
+            @if($settings->host_url) data-host-url="{{ $settings->host_url }}" @endif
+            @if($settings->domains) data-domains="{{ $settings->domains }}" @endif
+            @if($settings->tag) data-tag="{{ $settings->tag }}" @endif
+            data-auto-track="{{ $settings->auto_track ? 'true' : 'false' }}"
+            data-exclude-search="{{ $settings->exclude_search ? 'true' : 'false' }}"
+            data-exclude-hash="{{ $settings->exclude_hash ? 'true' : 'false' }}">
     </script>
 @endif
diff --git a/src/Settings/UmamiSettings.php b/src/Settings/UmamiSettings.php
@@ -0,0 +1,29 @@
+<?php
+
+namespace JeffersonGoncalves\Umami\Settings;
+
+use Spatie\LaravelSettings\Settings;
+
+class UmamiSettings extends Settings
+{
+    public ?string $website_id;
+
+    public string $host_analytics;
+
+    public ?string $host_url;
+
+    public bool $auto_track;
+
+    public ?string $domains;
+
+    public ?string $tag;
+
+    public bool $exclude_search;
+
+    public bool $exclude_hash;
+
+    public static function group(): string
+    {
+        return 'umami';
+    }
+}
diff --git a/src/UmamiServiceProvider.php b/src/UmamiServiceProvider.php
@@ -2,6 +2,8 @@
 
 namespace JeffersonGoncalves\Umami;
 
+use Illuminate\Support\Facades\Config;
+use JeffersonGoncalves\Umami\Settings\UmamiSettings;
 use Spatie\LaravelPackageTools\Package;
 use Spatie\LaravelPackageTools\PackageServiceProvider;
 
@@ -10,7 +12,30 @@ class UmamiServiceProvider extends PackageServiceProvider
     public function configurePackage(Package $package): void
     {
         $package->name('laravel-umami')
-            ->hasConfigFile('umami')
             ->hasViews();
     }
+
+    public function packageRegistered(): void
+    {
+        parent::packageRegistered();
+
+        Config::set('settings.settings', array_merge(
+            Config::get('settings.settings', []),
+            [UmamiSettings::class]
+        ));
+    }
+
+    public function packageBooted(): void
+    {
+        parent::packageBooted();
+
+        Config::set('settings.migrations_paths', array_merge(
+            Config::get('settings.migrations_paths', []),
+            [__DIR__.'/../database/settings']
+        ));
+
+        $this->publishes([
+            __DIR__.'/../database/settings' => database_path('settings'),
+        ], 'umami-settings-migrations');
+    }
 }
