9 Commits
6 changed files with 24 additions and 36 deletions

No files matched your search

+1 -1
View File
@@ -17,7 +17,7 @@ jobs:
fail-fast: true
matrix:
os: [ubuntu-latest, windows-latest]
php: [8.4]
php: [8.4, 8.3]
laravel: [11.*]
stability: [prefer-lowest, prefer-stable]
include:
+16
View File
@@ -2,6 +2,22 @@
All notable changes to `laravel-plausible-proxy` will be documented in this file.
## v1.2 - 2025-01-31
**Full Changelog**: https://github.com/MattitjaAB/laravel-plausible-proxy/compare/v1.1...v1.2
## v1.1 - 2025-01-31
### What's Changed
* Refactor event forwarding and improve test coverage by @mathiaspalmqvist in https://github.com/MattitjaAB/laravel-plausible-proxy/pull/1
### New Contributors
* @mathiaspalmqvist made their first contribution in https://github.com/MattitjaAB/laravel-plausible-proxy/pull/1
**Full Changelog**: https://github.com/MattitjaAB/laravel-plausible-proxy/compare/v1.0...v1.1
## First release - 2025-01-30
**Full Changelog**: https://github.com/MattitjaAB/laravel-plausible-proxy/commits/v1.0
+6 -26
View File
@@ -5,11 +5,11 @@
[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/mattitjaab/laravel-plausible-proxy/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/mattitjaab/laravel-plausible-proxy/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
[![Total Downloads](https://img.shields.io/packagist/dt/mattitjaab/laravel-plausible-proxy.svg?style=flat-square)](https://packagist.org/packages/mattitjaab/laravel-plausible-proxy)
A Laravel package for proxying Plausible Analytics, improving performance and privacy.
A Laravel package for proxying Plausible Analytics, improving performance.
## Requirements
- Laravel 11
- PHP 8.4+
- PHP 8.3+
## 🚀 Installation
@@ -26,27 +26,15 @@ A Laravel package for proxying Plausible Analytics, improving performance and pr
3. Add the following environment variables to your `.env` file:
```env
PLAUSIBLE_DOMAIN=https://plausible.io
PLAUSIBLE_SITE=example.com
```
4. **(Optional)** If you want to use Laravel Queues to send events in the background, ensure your queue driver is set up correctly:
```env
QUEUE_CONNECTION=database
```
Then run migrations to create the necessary queue tables:
```sh
php artisan queue:table
php artisan migrate
```
## ⚙️ Configuration
The `config/plausible-proxy.php` file allows you to customize the package settings:
The `config/plausible-proxy.php` file allows you to customize the plausible domain:
```php
return [
'domain' => env('PLAUSIBLE_DOMAIN', 'https://plausible.io'),
'site' => env('PLAUSIBLE_SITE', 'example.com'),
];
```
@@ -63,21 +51,13 @@ After installation, you can include the script like this:
The route `/js/script.js` is automatically handled and caches the script for **6 hours**.
### **2. Sending Events to Plausible**
Instead of sending events directly to `plausible.io`, you can now send them to `/api/event`, and they will be queued and processed asynchronously.
Example request:
```sh
curl -X POST "https://example.com/api/event" \
-H "Content-Type: application/json" \
-d '{"n":"pageview","u":"https://example.com/page","d":"example.com"}'
```
Instead of sending events directly to plausible.io, the script is loaded from /js/script.js and proxies the request to Plausible via /api/event, helping to prevent blocking by ad blockers.
## ✅ Features
- 🚀 **Fast & Optimized**: Caches the Plausible script to reduce external calls.
- 🔒 **Privacy-Friendly**: Prevents direct calls to `plausible.io`.
- 📊 **Improved Performance**: Events are processed via Laravel Queues to avoid blocking user interactions.
- 🛠 **Fully Configurable**: Easily set your own Plausible instance and domain via `.env`.
- ✅ No issues with ad blockers: Proxies the request via a local API endpoint.
- 🛠 **Fully Configurable**: Easily set your own Plausible instance via `.env`.
## 🛠 Testing
+1 -1
View File
@@ -18,7 +18,7 @@
}
],
"require": {
"php": "^8.4",
"php": "^8.3",
"spatie/laravel-package-tools": "^1.16",
"illuminate/contracts": "^10.0||^11.0"
},
-1
View File
@@ -4,5 +4,4 @@
return [
'domain' => env('PLAUSIBLE_DOMAIN', 'https://plausible.io'),
'site' => env('PLAUSIBLE_SITE', 'example.com'),
];
-7
View File
@@ -54,9 +54,6 @@ it('accepts valid event data and forwards headers', function () {
Http::fake([
'https://plausible.io/api/event' => function ($request) {
dump($request->headers());
dump($request->data());
return Http::response(['status' => 'queued'], 200);
},
]);
@@ -78,10 +75,6 @@ it('accepts valid event data and forwards headers', function () {
Http::assertSentCount(1);
Http::assertSent(function ($request) {
dump($request->url());
dump($request->headers());
dump($request->data());
return $request->url() === 'https://plausible.io/api/event'
&& isset($request['n']) && $request['n'] === 'pageview'
&& isset($request['u']) && $request['u'] === 'https://example.com/page'