From: <bi...@us...> - 2010-03-18 21:52:09
|
Revision: 2975 http://archive-access.svn.sourceforge.net/archive-access/?rev=2975&view=rev Author: binzino Date: 2010-03-18 21:51:55 +0000 (Thu, 18 Mar 2010) Log Message: ----------- Updated for NW 0.13. Modified Paths: -------------- trunk/archive-access/projects/nutchwax/archive/INSTALL.txt Modified: trunk/archive-access/projects/nutchwax/archive/INSTALL.txt =================================================================== --- trunk/archive-access/projects/nutchwax/archive/INSTALL.txt 2010-03-18 19:27:14 UTC (rev 2974) +++ trunk/archive-access/projects/nutchwax/archive/INSTALL.txt 2010-03-18 21:51:55 UTC (rev 2975) @@ -1,38 +1,39 @@ INSTALL.txt -2009-03-08 +2010-02-13 Aaron Binns Table of Contents o Introduction o Build from source - - SVN: Nutch 1.0-dev + - SVN: Nutch 1.0 - SVN: NutchWAX - Build and Install o Install binary package - o Install start-up scripts ====================================================================== Introduction ====================================================================== -This installation guide assumes the reader is already familiar with -building, packaging and deploying Nutch 1.0-dev. +This installation gues assumes the reader is not familiar with Nutch +and is looking for step-by-step instructions on building and +installing NutchWAX. -The NutchWAX 0.12 source and build system are designed to integrate -into the existing Nutch 1.0-dev source and build. -The long-term goal is for the NutchWAX components to be fully -integrated into mainline Nutch. As a stepping-stone toward that goal, -we have packaged the NutchWAX source to be dropped into the Nutch -"contrib" directory and built from there. +====================================================================== +Build from Source +====================================================================== -Like Nutch, NutchWAX 0.12 uses a simple 'ant' build script. The -NutchWAX build script calls out to the Nutch script to build Nutch -proper, then builds NutchWAX components and integrates them into the -Nutch build directory. +The NutchWAX source is packaged as a 'contrib' package for Nutch. +To build from source, you must checkout both the Nutch and +NutchWAX sources. +Like Nutch, NutchWAX uses a simple 'ant' build script. The NutchWAX +build script calls out to the Nutch script to build the Nutch +components, then builds the NutchWAX components and integrates them +into the Nutch build directory. + In order to build NutchWAX, execute all build commands from the NutchWAX directory. This way, NutchWAX will ensure that any and all dependencies in Nutch will be properly built and kept up-to-date. @@ -46,130 +47,64 @@ o tar o clean -Again, the idea is that if you're already used to building Nutch, you -can easily transition to building Nutch and NutchWAX together. All of -the build artifacts will still be placed in Nutch's 'build' -sub-directory as normal. +SVN: nutch-1.0 +-------------- +NutchWAX 0.13 is built against Nutch-1.0. -====================================================================== -Build from Source -====================================================================== - -To build from source, you must check-out the Nutch and NutchWAX sources -from their respective 'subversion' source control servers. - -SVN: nutch-1.0-dev ------------------- -As mentioned above, NutchWAX 0.12 is built against Nutch-1.0-dev. -Nutch doesn't have a 1.0 release package yet, so we have to use the -Nutch SVN trunk. The specific SVN revision that NutchWAX 0.12.4 is -built against is: - - 701524 - To checkout this revision of Nutch, use: - $ svn checkout -r 701524 http://svn.apache.org/repos/asf/lucene/nutch/trunk nutch + $ svn checkout http://svn.apache.org/repos/asf/lucene/nutch/tags/release-1.0 nutch $ cd nutch -Please be sure to check-out this specific version of the Nutch source. +Please be sure to check-out this specific release of the Nutch source. If you just grab the head of the trunk, there may be newer and -incompatible changed to Nutch. +incompatible changes to Nutch. SVN: NutchWAX ------------- -Once you have Nutch-1.0-dev checked-out, check-out NutchWAX 0.12.4 +Once you have Nutch-1.0 checked-out, check-out the NutchWAX 0.13 source into Nutch's "contrib" directory. $ cd contrib - $ svn checkout http://archive-access.svn.sourceforge.net/svnroot/archive-access/tags/nutchwax-0_12_4/archive + $ svn checkout http://archive-access.svn.sourceforge.net/svnroot/archive-access/tags/nutchwax-0_13/archive This will create a sub-directory named "archive" containing the -NutchWAX 0.12.4 sources. +NutchWAX 0.13 sources. Build and install ----------------- -Assuming you already have the required tool-set for building Nutch, -building NutchWAX is a snap. +Simply execute the same 'ant' build command in the NutchWAX +source tree -Simply execute the same 'ant' build command in - - nutch/contrib/archive - -as you normally would and everything will build as normal. - -For example - $ cd nutch/contrib/archive $ ant tar This command will build all of Nutch, then the NutchWAX add-ons and -finally will package everything up into the "nutch-1.0-dev.tar.gz" -release package. +finally will package everything up into the "nutch-1.0.tar.gz" release +package, which is placed in the Nutch 'build' subdir: -Then, install the "nutch-1.0-dev.tar.gz" tarball as normal. For + # Assuming we are still in nutch/contrib/archive + $ ls ../../build/nutch-1.0.tar.gz + ../../build/nutch-1.0.tar.gz + +Then, install the "nutch-1.0.tar.gz" tarball as normal. For example: $ cd /opt - $ tar xvfz nutch-1.0-dev.tar.gz - $ mv nutch-1.0-dev nutchwax-0.12.4 + $ tar xvfz nutch-1.0.tar.gz + $ mv nutch-1.0 nutchwax-0.13 ====================================================================== Install binary package ====================================================================== -Alternatively, grab a "binary" release package from the Internet -Archive's NutchWAX home page. +Alternatively, grab a pre-compiled (binary) release package from the +Internet Archive's NutchWAX home page. Install it simply by untarring it, for example: $ cd /opt - $ tar xvfz nutchwax-0.12.4.tar.gz + $ tar xvfz nutchwax-0.13.tar.gz - -====================================================================== -Install start-up scripts -====================================================================== - -NutchWAX 0.12.4 comes with a Unix init.d script which can be used to -automatically start the searcher slaves for a multi-node search -configuration. - -Assuming you installed NutchWAX as - - /opt/nutchwax-0.12.4 - -the script is found at - - /opt/nutchwax-0.12.4/contrib/archive/etc/init.d/searcher-slave - -This script can be placed in /etc/init.d then added to the list of -startup scripts to run at bootup by using commands appropriate to your -Linux distribution. - -You must edit a few of the environment variables defined in the -'searcher-slave' specifying where NutchWAX is installed and where the -index(s) are deployed. In 'searcher-slave' you will find the: - - export NUTCH_HOME=TODO - export DEPLOYMENT_DIR=TODO - -edit those appropriately for your system. - - -The "master" in the multi-node search deployment is the NutchWAX -webapp running in a webapp server, such as Tomcat or Jetty. - -Jetty comes with a start/stop script appropriate for use as an init.d -script, similar to the 'searcher-slave' script described above. If you -use Jetty, create a symlink - - /etc/init.d/jetty.sh -> /opt/jetty/bin/jetty.sh - -Then add this script to the list of startup scripts to run at bootup -by using commands appropriate to your Linux distribution. - -Follow the instructions from Jetty on the deployment of the NutchWAX -webapp (nutch-1.0-dev.war) in the Jetty web application server. This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |