PHPackages                             sylvainallignol/service-worker - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. sylvainallignol/service-worker

ActiveKirby-plugin

sylvainallignol/service-worker
==============================

Kirby service worker caching plugin with configurable strategies, precache and offline fallback

v1.1.6(1mo ago)318↓100%MITPHPPHP >=8.2

Since Feb 26Pushed 1mo agoCompare

[ Source](https://github.com/SylvainAllignol/kirby-service-worker)[ Packagist](https://packagist.org/packages/sylvainallignol/service-worker)[ Docs](https://plugins.getkirby.com/sylvainallignol/kirby-service-worker)[ RSS](/packages/sylvainallignol-service-worker/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (10)Dependencies (2)Versions (11)Used By (0)

Kirby Service Worker
====================

[](#kirby-service-worker)

Service worker caching plugin for Kirby CMS focused on cache behavior and strategy tuning.

It is designed for site performance (faster repeat visits, reduced network usage, and better resilience offline).

Features
--------

[](#features)

- Registers a service worker at `/sw.js`
- Optional registration script at `/sw-register.js` or inline
- Runtime caching strategies:
    - `cacheFirst`
    - `networkFirst`
    - `staleWhileRevalidate`
    - `networkOnly`
- Rule-based caching by URL pattern
- Optional precache list
- Optional offline page fallback
- Cached pages retrieval via `postMessage` (`GET_CACHED_PAGES`)
- Built-in offline SVG fallback for images
- Optional debug logs in the browser console (`option('debug')`)

Requirements
------------

[](#requirements)

- PHP `>= 8.2`
- Kirby `^3.0 || ^4.0 || ^5.0`

Installation
------------

[](#installation)

### Composer

[](#composer)

```
composer require sylvainallignol/kirby-service-worker
```

### Manual (ZIP)

[](#manual-zip)

1. Download the latest release ZIP from GitHub
2. Unzip into `site/plugins/kirby-service-worker`

Quick start
-----------

[](#quick-start)

1. Install the plugin.
2. Register `/sw.js` in your frontend. You can either add the provided snippet in your layout (usually before ``):

```