Skip to content

Latest commit

 

History

History
55 lines (36 loc) · 2.17 KB

README.md

File metadata and controls

55 lines (36 loc) · 2.17 KB

prerender-filesystem-cache Build Status

This is a plugin for prerender(.io) providing caching in the file system. It is a fork of https://github.com/suhanovv/prerender-file-cache, focussing on improved URI parsing, platform-independency and providing test coverage.

Version 2.0.0 has been tested to work with prerender version 5.4.x.

Requires node >= 4.0

Status

Build Status Coverage Status

The version 1.0.0 of this plugin and all its hotfixes target the prerender phantomjs branch (version 4.4.x).

How it works

This plugin will store all prerendered pages into a filesystem hierarchy. For example:

How to use

The package is available on npm. Thus, in your local prerender project simply run:

$ npm install prerender-filesystem-cache --save

Then in the server.js that initializes prerender:

server.use(require('prerender-filesystem-cache'));

Configuration

Optionally, define some env variables:

export CACHE_ROOT_DIR=/your/directory/for/cache  
export CACHE_LIVE_TIME=10000 (in seconds)
  • CACHE_ROOT_DIR defaults to os.tmpdir()/prerender-cache
  • CACHE_LIVE_TIME defaults to 3600 (1 hour)