How to install

System Requirements

• Java: Oracle Java version 1.6 or higher.
• Tomcat: Apache Tomcat version 6.0 or higher.

Please note that the recommended operating environment for OpenWayback is UNIX/Linux and is assumed in this documentation.

Download OpenWayback

OpenWayback is packaged as a web application file (.war file). You can choose to download the binary distribution or build from source. Maven 3 is recommended for this.

Downloading the Binary Distribution

All OpenWayback releases are hosted on Maven Central. You can find the latest binary release here, currently openwayback-2.0.0.BETA.2

Extract the .tar.gz file containing the webapp (.war) file: tar -xzvf <filename>.tar.gz

This will produce a folder named 'openwayback' containing two (2) folders (bin and lib) and the web application file: 'openwayback-(version).war'.

Building From Source

Note! To build OpenWayback from source, you'll need Apache Maven 2 or higher. This involves the following steps:

1. Download the source code from the OpenWayback GitHub repository using git: git clone https://github.com/iipc/openwayback.git
2. Git will create an openwayback directory containing the OpenWayback source code. Change directory (cd) to this directory. Now cd to the directory called "wayback-webapp" in which you'll find a Maven POM file.
3. Now build the distribution with Maven: mvn clean package

Maven will build the web application, e.g. openwayback-2.0.0.BETA.2-SNAPSHOT.war. It will be located in the wayback-webapp/target directory.

Installation

To install OpenWayback, you'll first need a running Apache Tomcat Installation. For instructions, please refer to the README file included with your Tomcat distribution. In the instructions below, $CATALINA_HOME is the directory where you install Tomcat.

Important! You must rename the .war web application file to ROOT.war before deploying it to Tomcat.

Please follow these steps:

1. Locate the .war file you built or downloaded. Rename it to ROOT.war.
2. Place the ROOT.war file in the webapps folder of Tomcat, usually $CATALINA_HOME/webapps/.
3. Wait for Tomcat to unpack the .war file.
4. Customise base configuration file wayback.xml and possibly other XML configuration files. See "Basic Usage" below.
5. Restart Tomcat.

Basic Usage

Wayback is configured through a series of Spring configuration files, the main one being wayback.xml which is located in: $CATALINA_HOME/webapps/ROOT/WEB-INF/.

The main parts of a configuration include the wayback collection, the index (BDB or CDX) source and the archive (WARC, ARC) files.

The access URL for the collection

By default, OpenWayback assumes deployment as ROOT context (ROOT.war) with an AccessPoint called wayback. The default URL for accessing OpenWayback is: http://localhost:8080/wayback/. TODO: How to change the context to something other than ROOT.

Collection Index

By default, OpenWayback will create a BDBCollection that uses automatic indexing (BDB indexing). You can point to a folder of WARCs and it will perform the indexing for you, storing it the results in a local Berkley Database instance (hence BDB).

Many archiving institutions generate so-called CDX files from the WARCs and point Wayback at those two sets of resources. This is known as a CDX Collection, and the CDX provides a way to look up a URL and find which WARCs contain copies of it.

You choose between the two options by modifying the relevant Spring configuration files. Please see the the configuration instructions for information.