Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/funliday/pppr
pppr is a prerender service
https://github.com/funliday/pppr
expressjs funliday prerender puppeteer
Last synced: 7 days ago
JSON representation
pppr is a prerender service
- Host: GitHub
- URL: https://github.com/funliday/pppr
- Owner: funliday
- License: mit
- Created: 2020-05-19T10:06:05.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-15T04:34:00.000Z (2 months ago)
- Last Synced: 2024-10-18T10:54:34.329Z (2 months ago)
- Topics: expressjs, funliday, prerender, puppeteer
- Language: JavaScript
- Homepage:
- Size: 1010 KB
- Stars: 24
- Watchers: 3
- Forks: 2
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# pppr
pppr is a zero-configuration prerender service. If you develop a web via client-side rendering (such as Vue, Angular, React...), you can integrate Nginx (or other reverse proxy) and pppr for search engine crawler (such as googlebot, bingbot...) and social network (such as Facebook, Twitter...) to render complete HTML.
## Usage
```js
const pppr = require('pppr');
app.use(pppr());
```
## Installation
```sh
npm i pppr
```
## Configuration
### Nginx
[Configuration](https://gist.github.com/thoop/8165802)
### Cache (default is turn on)
```js
app.use(pppr());
// equals to
app.use(pppr({
cache: true
}));
```
If you want to turn off cache, you can do below configuration.
```js
app.use(pppr({
cache: false
}));
```
If you want to modify cache parameter, you can do below configuration.
```js
app.use(pppr({
cache: {
max: 50, // LRU cache entry max count (default is 50)
ttl: 300000 // LRU cache entry ttl (milliseconds, default is 300000)
}
}));
```
### Retry times (default is 5)
If it renders occur timeout, you can retry render again.
```js
app.use(pppr({
retryTimes: 5
}));
```
### Endpoint (default is /render)
If endpoint conflicts, you can change it.
```js
app.use(pppr({
endpoint: '/render'
}));
```
### Callback
If you want to do something before/after render, you can do below configuration.
```js
app.use(pppr({
beforeRender: (userAgent, url) => {
// do something
},
afterRender: (userAgent, url, content) => {
// do something
}
}))
```
## How-to
When Nginx received a request, it will check it is crawler or not. If it is crawler, it will forward to prerender service (such as pppr). Otherwise it will forward to web server.
## Lyrics
I have a page, I want to prerender it.
Ah, pppr.
## Inspired from
[prerender/prerender](https://github.com/prerender/prerender)