Changeset 8301 for trunk/greenstone3-extensions/vishnu/README

Timestamp:

2004-10-12T16:17:15+13:00 (19 years ago)

Author:

kjdon

Message:

more instructions

File:

• trunk/greenstone3-extensions/vishnu/README (modified) (3 diffs)

trunk/greenstone3-extensions/vishnu/README

@@ -2 +2 @@
 
 LINUX INSTALL:
+
 If you are running this as part of Greenstone, just installing Greenstone will install Vishnu.
+
 If you want to run it standalone:
 
 The environment variable JAVA_HOME needs to be set.
-You need to have MG installed - this should be the version from Greenstone, and you need the mg.jar file in your classpath and the libmgjni.so in your ld_library_path.
-You need the lucene 1.4 or higher jar file in your classpath.
-Other jar files needed: xercesImpl.jar, servlet.jar.
+You need to have MG installed - this should be the version from Greenstone, and you need the mg.jar file in your CLASSPATH and the libmgjni.so in your LD_LIBRARY_PATH.
+You need the lucene 1.4 or higher jar file in your CLASSPATH.
+Other jar files needed in CLASSPATH: xercesImpl.jar, servlet.jar.
 
-The Makefiles may need modifying with respect to where things get installed to.
+Edit the src/vishnu Makefile and uncomment the prefix for stand-alone vishnu.
 
-./configure [--prefix=...]
+Then run the following:
+
 make
 make install
@@ -22 +25 @@
 COLLECTION BUILDING:
 
-The directory where collection live is called collsHome. Inside this, create a new directory for your collection. The name of this directory is the collection identifier. Inside the collection directory create a new direcotry called import. Inside here put all the documents that you want in your collection. Documents must be plain text, xml or html.
+Make a directory called collections inside the main vishnu directory. Inside this, create a new directory for your collection. The name of this directory is the collection identifier. Inside the collection directory create a new direcotry called import. Inside here put all the documents that you want in your collection. Documents must be plain text, xml or html.
 
 Then you can build the collection:
 
 Command line: 
-java vishnu.builder.CollectionBuilder -collsHome (directory where collections live) -collection (directory name of collection) -name (descriptive name for collection) -description (collection description) -index ("mg" or "luc")
+java vishnu.builder.CollectionBuilder -collsHome (directory where collections live: path-to-vishnu/collections) -collection (directory name of collection) -name (descriptive name for collection) -description (collection description) -index ("mg" or "luc")
 
 Using a GUI tool:
@@ -64 +67 @@
 RUNNING THE SERVLET:
 
+
 If you are running this standalone, you need to run a servlet container for VisServlet.
+We have provided an example for use with Tomcat (version 4.1).
 
-The servlet class is vishnu.server.VisServlet. The class file needs to be put in the appropriate directory for your servlet container. 
-The servlet needs one initialisation parameter: collectionsHome, which is the directory where collections live.
-The vishnu.jar file needs to go into the CLASSPATH used by the servlet container.
+Set the prefix in the src/vishnu Makefile to be ../.., then the servlet class and jar files will be installed in the correct places.
+The vishnu/web directory is setup to be the context directory for vishnu in Tomcat. 
+You need to edit Tomcat's conf/server.xml file, and add in the context for vishnu. Add the following element after the tomcat root context element:
+
+<Context path="/vishnu" docBase="full-path-to-vishnu/web" debug="1" reloadable="true"><Resources allowLinking='true'/></Context>
+(replacing "full path-to-vishnu" with the path to the vishnu directory.)
+Edit the vishnu/web/WEB-INF/web.xml file and put in the correct path to your collections directory.
+
+The vishnu.jar file needs to be in your CLASSPATH, and make sure that Tomcat is using your CLASSPATH.
 
 RUNNING THE APPLET:
 
-Edit the test.html file and add in the correct address of the Visualiser servlet in the library parameter.
-create a lib directory in the same directory as the test.html file, and copy the vishnu.jar file into it.
-Open up the test.html file in a browser. Assuming you have collections available in the collectionsHome directory given to the servlet, you should be able to view them in the applet.
+The file vishnu/web/index.html is an introductory page about vishnu, and contains the applet. Make sure that the library parameter has the correct address for your visualiser servlet. The default is http://localhost:8080/vishnu/server. This will be correct if you haveinstalled Tomcat to use port 8080, and have set the vishnu servlet up as described above. But note, if you are using Mozilla, it may not like localhost here, so if you have problems, try putting the full name of the server running Tomcat in place of localhost.
+
+If you are running Tomcat as described above, you can view this index file at http://localhost:8080/vishnu/index.html