このプロジェクトについて
Laravel Umamiは、LaravelアプリケーションにUmamiアナリティクスを簡単に追加する方法を提供します。このパッケージはspatie/laravel-settingsに依存してすべてのUmami設定値をデータベースに保持するため、コードを変更することなく設定を簡単に変更できます。
主な機能:
- シンプルなBladeへの組み込み:レイアウトに @include('umami::script') を追加するだけでトラッキングスクリプトをロードできます。
- データベース駆動の設定:website ID、ホストURL、ドメインホワイトリスト、自動追跡フラグなどのオプションが設定テーブルに保存され、コードまたは管理UI経由で編集可能です。
- ページビューとイベントの自動追跡を標準で提供し、クエリ文字列やハッシュフラグメントを除外するオプションもあります。
- より精密な分析のために、カスタムタグとドメイン制限をサポートしています。
インストール手順:
1. Composerでパッケージを要求します。
2. spatie/laravel-settingsがインストールされ、そのマイグレーションが実行されていることを確認します。
3. パッケージが提供するUmami設定のマイグレーションをパブリッシュして実行します。
4. Bladeレイアウトにスクリプトのincludeを追加します。
設定例 (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();
```
利用可能な設定:
- website_id (必須)
- host_analytics (デフォルト: https://cloud.umami.is)
- host_url (オプションの上書き)
- auto_track (boolean, デフォルト: true)
- domains (カンマ区切りのリスト)
- tag (オプションのグループ化タグ)
- exclude_search および exclude_hash (URLの一部を削除するためのboolean)
本パッケージはPHP 8.2+ および Laravel 11+ と互換性があります。テストは `composer test` で実行可能です。MITライセンスの下でリリースされています。
詳細については、リポジトリのREADME、変更履歴、および貢献ガイドラインを参照してください。
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.