Open Source RWSERVE plugin

Interscribe

Shoulders of giants

Motivation

This plugin reads a list of references generated via the snrfilter tool. Each time the plugin is invoked a reference is pulled from the snrfilter document list and inserted into the working document at a designated target point.

A cached copy of the interscribed merge is kept in the interscribe-cache for a specified period of time and used for subsequent HTTP requests.

This plugin may be used with BLUEPHRASE documents or HTML documents.

Customization

This plugin is open source and can be used as is, or enhanced to provide additional features.

The plugin may be used together with Etags, cache-control, and content-encoding (compression).

Download

The plugin module is available from NPM . Before proceeding, you should already have Node.js and RWSERVE configured and tested.

This module should be installed on your web server in a well-defined place, so that it can be discovered by RWSERVE. The standard place for public domain plugins is /srv/rwserve-plugins.

Configuration is Everything

Make the software available by declaring it in the plugins section of your configuration file. For detailed instructions on how to do this, refer to the plugins documentation on the Read Write Tools HTTP/2 Server website.

TL;DR

The sample router shown above will route any GET or HEAD request for BLUEPHRASE and HTML document to the /interscribe plugin for processing.

Cookbook

A full configuration file with typical settings for a server running on localhost port 7443, is included in this NPM module at etc/interscribe-config. To use this configuration file, adjust these variables if they don't match your server setup:

Review

License

The rwserve-interscribe plugin is licensed under the MIT License.

Availability