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 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.
NetarchiveSuite uses Java Messaging Service (JMS) for communication between the different components.
Download the openmq installation script:
Install the openmq broker:
sh mq.sh install
This will download openmq, install and start it.
Note: OpenMQ will as be installed to ~/MessageQueue5.1.
Binary releases are available from https://sbforge.org/downloads/netarchivesuite/releases/.
Create a working directory and navigate to it
mkdir netarchive; cd netarchive
Download the latest release
wget -N -O NetarchiveSuite.zip https://sbforge.org/downloads/netarchivesuite/releases/stable/5.0/NetarchiveSuite-5.0.zip
together with the latest bundled harvester
wget -N -O NetarchiveSuite.zip https://sbforge.org/downloads/netarchivesuite/releases/stable/5.0/NetarchiveSuite-bundler-5.0.zip
wget -N https://raw.githubusercontent.com/netarchivesuite/netarchivesuite/master/deploy/distribution/src/main/resources/examples/deploy_standalone_example.xml wget -N https://raw.githubusercontent.com/netarchivesuite/netarchivesuite/master/deploy/deploy-core/scripts/RunNetarchiveSuite.sh chmod +x RunNetarchiveSuite.sh
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 as the current user and then - as the user "test" - install NetarchiveSuite into the /home/test/QUICKSTART directory (using ssh).
Remember that Sun/Oracle Java 8 is required for the Quickstart procedure.
If you already have a Quickstart installation, the existing bitarchive, database and admin.data files will be untouched. You must explicitly remove any previous installation, if you want a clean empty installation.
Now do the deployment:
./RunNetarchiveSuite.sh NetarchiveSuite.zip deploy_standalone_example.xml deploy NetarchiveSuite-bundler-5.0.zip
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.
Now configure your browser:
Choose in the Firefox toolbar: Edit->Preferences->Advanced->Network->Settings Checkmark: Manual Proxy Configuration and add: Http proxy: name-of-host Port: 8070 No Proxy for: localhost, name-of-host
ssh test@localhost cd QUICKSTART ./conf/killall.sh ./conf/startall.sh