A middleware written in TypeScript to connect different CMS with your delivery layer and to notify it of content changes.
To leverage the flexibility of a content management system while having the performance of a static site one needs to decouple the delivery layer from the CMS. Paperboy acts as a broker between these two layers by informing the delivery layer of content changes. To support the use-case of multiple frontend servers Paperboy multiplexes events via a Queue. Using the Magnolia CMS, the complete setup looks like the following:
- This setup works by add a Magnolia module to both instances, which listens for content changes and publishes details of those changes to a Webhook which publishes a message to a NATS server
- A client-side library then subscribes to this queue
- Finally it will execute an arbitrary command to trigger the actual rebuild of the frontend
In case we don't want to operate the delivery tier ourselves and instead use a CDN like Netlify you can use the Magnolia Module to publish directly to a webhook by the CDN provider:
For the content management tier we provide two submodules which together with a queue handle the propagation of content change events:
- Paperboy push service: A small HTTP service that can be used as a webhook.
The subscriber part of this system is currently comprised of two submodules in this repository:
- Paperboy Core: The core library which handles all generic configuration and knows how to execute the commands to trigger rebuilds.
- Paperboy CLI: A simple CLI to ease usage and setup
Run the following command to start a queue, push service and a simple 'frontend':
$ docker-compose upWhen all services are up an running execute the follow command to send a message via the push service:
$ curl -X POST \
http://localhost:8080/ \
-H 'Authorization: Bearer supersecret' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-d 'payload=%7B%22foo%22%3A%22bar%22%7D&source=foo'To use Paperboy in your Frontend you can simply install the CLI globally via:
$ npm i -g @neoskop/paperboy-cliIn case that you are writing the frontend with JavaScript you can also install the CLI locally in your project:
$ npm i --save-dev @neoskop/paperboy-cli
Start the push service and a NATS server by running the following command in the root folder of this repository:
$ docker-compose upTo configure the frontend, create a file called paperboy.config.json with the following contents:
{
"queue": {
"uri": "nats://queue:4222"
},
"command": "npm start"
}Finally change to the frontend directory and run:
$ paperboy startThis project is under the terms of the Apache License, Version 2.0. A copy of this license is included with the sources.
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
![renovate[bot] avatar](https://avatars.githubusercontent.com/in/2740?v=4 "renovate[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent