How do I add a lib jar file

Configuration

Opensolr indexes can run custom JAR libraries: a Solr plugin, a custom filter, anything your schema needs that is not in the standard distribution. You send us the jar, we install it.

01 · How to have a jar installed

Email the jar to support

Send the file, or a link to the official plugin page where the compiled binaries are published, to support@opensolr.com.

Tell us where it goes

Include your Opensolr registration email address and the name of the index the plugin belongs on.

Expect it the same day

Most installations are done within a couple of hours. We quote up to 24 hours to cover the rare awkward case.

02 · What makes it fast

DoWhy
Send the compiled .jar, not the sourceWe install binaries. Source has to be built somewhere, and that somewhere is not your search server.
Prefer official or well-known sourcesEvery jar is reviewed before it goes on a server. A link to an official release page shortens that review.
Match the jar to your Solr versionA plugin built for another major version will fail to load, and the core will not come back up cleanly.

03 · After the installation

Reference it from your config

Add the filter, handler or component to schema.xml or solrconfig.xml. Ask us if you want a hand with the snippet.

Reload the index

The new library is picked up on reload, from the Tools menu of your index control panel.

Test with real data

Custom analysis chains behave differently on your content than on an example. Index a sample and look at the results.

A worked example of this process, for one specific plugin: the AutoPhrase TokenFilter.