Page tree

Note that this documentation is for the coming release
NetarchiveSuite 5.5.1
and is still work-in-progress.

For documentation on the released versions, please view the previous versions of the NetarchiveSuite documentation and select the relevant version.

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 36 Next »

We have prepared a bash shell script that starts all the necessary components on one machine. We will use this script throughout this quickstart manual to allow you to get a feel for what the system can do and how it works without having to deal with issues of distributing to other servers.

Base system required

For the quick startup, NetarchiveSuite requires:

  • A Linux system with a minimum of 2GB free diskspace.
  • Sun/Oracle Java 6 SE. Other Java versions such as OpenJDK and Oracle Java 7 are not tested or recommended.
  • A additional user is named "test". The commands to install NetarchiveSuite are run from your own login. The commands install and run the NetarchiveSuite software under user "test". This simulates the more realistic productions situation where the software runs under various logins on one or more machines in a distributed network. For convenience, it is a good idea to configure the test-user to have password-free ssh access - i.e. you should be able to execute "ssh test@localhost" in a shell without entering the test-user's password.

Setup JMS

NetarchiveSuite uses Java Messaging Service (JMS) for communication between the different components.

Download the openmq installation script:



Install the openmq broker:

sh install

This will download openmq, install and start it. 


Note: OpenMQ will as defaut be installed to ~/openmq4.5. A alternative installdir can be defined the installdir variable prior to using the mq script, eg. 

export installdir="netarchive/openmq" 
sh start 

Download NetarchiveSuite

Download of the newest release is described here

  • Create a directory for the download e.g. directory

     $ mkdir netarchive 
  • Download the latest stable version of and put it in the netarchive directory you just created. The latest nightly build can be found here.


Download the following files to the netarchive directory:

The first script is a simple script for doing all the steps during deployment. It takes a NetarchiveSuite package ('.zip'), a configuration file (the second file), and a temporary installation directory as arguments (in the given order). The different ports used by the application for communication are included in the deploy_standalone_example.xml file.

In the configuration file all the applications are placed on one machine, the current machine (localhost).

When the installation script is run it will unpack the installation files into the netarchive/deploy directory and install NetarchiveSuite into the /home/test/QUICKSTART directory (using ssh).  Remember to check, that a Sun JVM is in the path for the test. If you already have a Quickstart installation, the existing bitarchive, database and files will be untouched. You must explicitly remove any previous installation, if you want a clean empty installation.

$ chmod +x
$ ./ deploy_standalone_example.xml deploy/

Note that if you have not setup your automatic ssh test user login (using key based login), you need to login some times before the installation finishes successfully. You must also have permission to ssh and scp to test@localhost (try e.g ssh test@localhost)

The script creates a deployment folder named "QUICKSTART" in e.g. /home/test/QUICKSTART, which contains methods for starting and stopping NetarchiveSuite, and starts the whole NetarchiveSuite. The files to run the installation will be placed in the ~/netarchive/deploy directory.

  • Start a web browser. Note that it is important that the browser is started on the same machine as the simple harvest script is run on
  • Setup the browser to proxy on port 8070 and exclude localhost and the hostname (used by the Heritrix GUI) e.g. in firefox:
Choose in the firefox toolbar:
Manual Proxy Configuration
and add:
Proxy: localhost
Port: 8070
No Proxy for: localhost
  • Write following url in the started browser http://localhost:8074/HarvestDefinition
  • You can now see the webinterface in the browser. You can now create, run and browse according to the following or the User Manual
  • You can stop and start the entire NAS system with:
ssh test@localhost
  • If you want to try other deploy examples, then go to "Examples of deploy configuration files" in the Installation Manual.


  • No labels