Supporters

Documentation‎ > ‎

Installation Guide

Introduction

ReDBox and Mint releases are packaged up and made available for download via our deployment repository. Installing both systems is straight-forward and the following sections and links will guide you through the process. 

System Requirements

Both the ReDBox and Mint systems have the following prerequisites:

  • Operating system: any modern general-purpose operating system will work
    • We've tried a number: Ubuntu, RedHat, Solaris, Windows etc
    • Our user community let us know which systems they're using: see this thread for details.
  • Sun's Java JVM 1.6
  • Storage space: this really depends on how much data you're storing
    • 10Gb is probably a good start
    • Mint will need more storage space as it holds the Geonames data
  • RAM (memory): 1Gb each (at least) for ReDBox and Mint
You can run Mint and ReDBox on the same server - just make sure you have the memory capacity.

Server software

The installations for Mint and ReDBox include the Jetty server. This is a robust server that should suit most requirements. The documentation provided via this site is based on the default Jetty configuration provided with Mint and ReDBox. Currently, no work is being undertaken to test either ReDBox or Mint with other container servers (such as Apache Tomcat).

In some cases you may wish to use Apache's HTTP server as the public-facing web server for ReDBox and Mint. In this case we suggest using mod_proxy to provide a reverse proxy between the users and the Jetty servers running ReDBox and Mint. 

Installing

A key part of the installation process is considering what your curation options are, as this will decide which plugins need to be installed with your server(s). The demonstration install we first look at below puts this question aside for a moment and uses the Local Curation plugin to get things up and running quickly. This is ideal for a demonstration/test environment where you want to take a look at the system and how it works, but is not generally advised for production systems. Please do not put real data into the demonstration install with an expectation of smoothly migrating to something else... it is technically possible, but was not designed for this and will cause you more annoyance then convenience at a later date.

Production systems have been transitioned to a model of institutional builds in the v1.4 release. Documentation on such is also provided below, but if you are looking at the demonstration system for now, it is simply enough to know that the demonstration is a specific 'pre-canned' institutional build, and only one of the options available.

In general, we also suggest that installing Mint first is the best option. As mentioned in the System Overview, Mint provides ReDBox with a variety of look-up services.

Developer installation

For the developer install instructions, please refer to Developer Installation Guide.