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 this 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.

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

You'll need Apache Maven 2 or higher to build OpenWayback from source, which 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

Apache Tomcat is required to run OpenWayback. Please refer to the README file in your Tomcat distribution For instructions. The instructions below assume that Tomcat is installed under the directory $CATALINA_HOME.

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 configuration file wayback.xml and possibly other XML configuration files. See How to configure for details.
5. Restart Tomcat.

OpenWayback can also be deployed in a non-ROOT context. Please see Deploying OpenWayback in non-ROOT for details.