Support custom Plausible script path #19

Merged

mathiaspalmqvist merged 2 commits from issue-14-custom-script-path into main 2026-11-12 07:29:23 +00:00

Conversation 0 Commits 2 Files Changed 4

+94 -27

mathiaspalmqvist commented 2026-11-12 07:27:54 +00:00

Owner

Copy link

Copy source

Closes #14

Summary

Adds a PLAUSIBLE_SCRIPT config option so the package can proxy Plausible's site-specific scripts (js/pa-XXXXX.js) and legacy script extensions (e.g. js/script.outbound-links.js).

• New config key script (env PLAUSIBLE_SCRIPT), default js/script.js, so existing installs are unaffected
• The script is still served locally from /js/script.js
• Leading/trailing slashes in domain and script are normalised
• Cache key is derived from the script URL, so changing the script takes effect immediately instead of serving the old cached script for up to 6 hours
• README documents the site-specific script setup, including plausible.init({ endpoint: '/api/event' }) so events go through the proxy

Testing

• composer test: 10 passed (new tests for custom path, slash normalisation, cache invalidation on script change and caching)
• composer analyse: no errors
• vendor/bin/pint --test: passed

To verify before merge

• That the endpoint option in plausible.init() is the correct way to route events from the new pa- script through the proxy (not tested against a real pa- script).

Closes #14 ## Summary Adds a `PLAUSIBLE_SCRIPT` config option so the package can proxy Plausible's site-specific scripts (`js/pa-XXXXX.js`) and legacy script extensions (e.g. `js/script.outbound-links.js`). - New config key `script` (env `PLAUSIBLE_SCRIPT`), default `js/script.js`, so existing installs are unaffected - The script is still served locally from `/js/script.js` - Leading/trailing slashes in `domain` and `script` are normalised - Cache key is derived from the script URL, so changing the script takes effect immediately instead of serving the old cached script for up to 6 hours - README documents the site-specific script setup, including `plausible.init({ endpoint: '/api/event' })` so events go through the proxy ## Testing - `composer test`: 10 passed (new tests for custom path, slash normalisation, cache invalidation on script change and caching) - `composer analyse`: no errors - `vendor/bin/pint --test`: passed ## To verify before merge - That the `endpoint` option in `plausible.init()` is the correct way to route events from the new `pa-` script through the proxy (not tested against a real `pa-` script).

mathiaspalmqvist added 1 commit 2026-11-12 07:27:54 +00:00

Support custom Plausible script path ... 513ceb61a0

Add a PLAUSIBLE_SCRIPT config option so site-specific scripts
(js/pa-XXXXX.js) and legacy script extensions can be proxied. The
script is still served locally from /js/script.js and the cache key
is derived from the script URL so changing the script takes effect
immediately.

Closes #14

mathiaspalmqvist added 1 commit 2026-11-12 07:29:12 +00:00

Merge branch 'main' into issue-14-custom-script-path 91429ccd22

mathiaspalmqvist merged commit 77c0e38f84 into main 2026-11-12 07:29:23 +00:00

mathiaspalmqvist deleted branch issue-14-custom-script-path 2026-11-12 07:29:23 +00:00

Sign in to join this conversation.

Reviewers

No Reviewers

Labels

Clear labels

bug

Something isn't working

documentation

Improvements or additions to documentation

duplicate

This issue or pull request already exists

enhancement

New feature or request

good first issue

Good for newcomers

help wanted

Extra attention is needed

invalid

This doesn't seem right

question

Further information is requested

wontfix

This will not be worked on

No labels

Milestone

No items

No Milestone

Assignees

Clear assignees

mathiaspalmqvist (Mathias Palmqvist)

No Assignees

1 Participants

Notifications

Subscribe

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: 559342-9607/laravel-plausible-proxy#19