Advanced configuration

Advanced configuration

This page deals with advanced configuration options. Many of these require a considerable understanding of how OpenWayback operates under the hood. For the basics of getting OpenWayback up and running, see How to configure.

Configuring indexes

I.e. how OpenWayback goes from an URL being requested and to serving up either a list of matches or the actual content captured for that URL. The topics discussed in the basic configuration are mostly related to this.

Coping with very large indexes

When dealing with large collections, plain CDX files can become difficult to manage due to their size. One option is to use block or chunk compression to reduce the size of the files (as CDX data compresses easily). Options include:

• Configuring ZipNumCluster
• Using file-system block-level compression, e.g. Btrfs compression
• Using a database that supports data compression, e.g. HBase (see warcbase) or RocksDB (see OutbackCDX).

Using a database rather than CDX files is more complicated to set up, but has the advantage of allowing the index continually updated.

Additional topics

• Configuring a remote ResourceStore

Configuring access points

OpenWayback uses access points to handle incoming request. There can be multiple access points each with a different context (URL prefix) or even operating on different ports (Tomcat needs to be configured accordingly).

By default only the standard AccessPoint handler is enabled. It performs the basic OpenWayback functionality that you are probably already familiar with.

The behavior of the standard AccessPoint can however be modified by specifying renderers and parsers.

Alternative and additional access point configurations are provided in OpenWayback for things like Memento support, proxy mode and more. It is also possible to add your own request handler if you so choose. This is best done via a WAR overlay.

For more see:

• AccessPoint overview
• Configuring Memento access
• Configuring proxy replay mode
• Creating a WAR overlay

Other configuration

• Deploying WAR in non ROOT context
• Configuring access control
• WatchedCDXSource: Dynamically Adding CDX Indexes
• NLS configuration