Skip to content

Latest commit

 

History

History
76 lines (54 loc) · 2.34 KB

README.md

File metadata and controls

76 lines (54 loc) · 2.34 KB
Raw

Reverse proxy for Plausible Analytics

Written in PHP for shared hosting on Apache.

Installation

  1. Manually download the latest release from here.

Running in the root of a domain or subdomain

  1. Move .htaccess, index.php and options.php into the root of your domain or subdomain (e.g. stats.example.com).
  2. Optional Customize the options.php.
  3. Add the script like in the following example and customize the attributes.
<script defer data-domain="example.com" src="//stats.example.com/js/script.js"></script>

Running in a sub folder of a website

  1. Move .htaccess, index.php and options.php into the sub folder of your website (e.g. example.com/stats).
  2. Optional Customize the options.php.
  3. Add the script like in the following example and customize the attributes.
<script defer data-domain="example.com" data-api="/stats/api/event" src="/stats/js/script.js"></script>

Options

// Set the relative URI when the reverse proxy is running in a folder.
// If your proxy runs under https://example.com/stats, then set /stats as relative URI and otherwise just leave the string blank.
$relativeUri = '/stats';

// Set all allowed URI which should be accessible through the proxy
$whitelist = [
    '/js/script.js',
    '/js/plausible.outbound-links.js',
    '/api/event'
];

// Optional, map allowed URI to another for sanitizing any proofs of Plausible Analytics in the URI.
// If not needed then leave the array empty.
$mapping = [
    '/foo/bar.js' => '/js/plausible.outbound-links.js'
];

// Set visitor IP addresses as exclusion (e.g. for yourself or developers)
// If not needed then leave the array empty.
$excluded = [
    '127.0.0.1',
    '::1',
];

// Set URL of Plausible Analytics
$backendUrl = "https://plausible.io";

Contributors

  • Jonathan Nessier
  • David Mondok
  • Julien Tessier, Utile

If you would like to see this reverse proxy for Plausible Analytics develop further, or if you want to support me or show me your appreciation, please donate any amount through PayPal. Thank you! 🍻

Donate

License

Licensed under MIT.

Made in Switzerland with 🧀 and ❤️