solr-proxy

solr-proxy

Reverse proxy to make a Solr instance read-only, rejecting requests that have the potential to modify the Solr index.

This is a rewrite of solr-security-proxy with some bug fixes and additional features.

Installation

For use from the command line:

npm install -g solr-proxy

For use in another application:

npm install solr-proxy

Usage

From the command-line:

solr-proxy

Options are:

  --port           Listen on this port                     [default: 8008]
  --backendPort    Solr backend port                       [default: 8080]
  --backendHost    Solr backend host                       [default: "localhost"]
  --validPaths     Allowed paths (comma separated)         [default: "/solr/select"]
  --invalidParams  Blocked parameters (comma separated)    [default: "qt,stream"]
  --validMethods   Allowed HTTP methods (comma separated)  [default: "GET,HEAD"]
  --quiet, -q      Do not write messages to STDOUT
  --version, -v    Show version
  --help, -h       Show this message

To start the server from your application:

var SolrProxy = require('solr-proxy');
SolrProxy.start();

You can pass an options object as the first parameter to start().

var defaultOptions = {
  validHttpMethods: ['GET','HEAD'], // all other HTTP methods will be disallowed
  validPaths: ['/solr/select'],     // all other paths will be denied
  invalidParams: ['qt', 'stream'],  // blocks requests with params qt or stream.* (all other params are allowed)
  backend: {                        // proxy to solr at this location
    host: 'localhost',
    port: 8080
  }
};

To enable verbose logging, set environment variable DEBUG to include solr-proxy.

Default Rules

solr-proxy has the following default rules:

• Reject any requests other than GET and HEAD
• Only allow the /solr/select path
• Block requests with qt and stream.* query parameters.

License

MIT

Related Reading

• Why use a Solr proxy?
• Solr Security Resources