source: trunk/gsdl3/extensions/vishnu/README@ 8301

Last change on this file since 8301 was 8301, checked in by kjdon, 20 years ago

more instructions

  • Property svn:keywords set to Author Date Id Revision
File size: 4.0 KB
Line 
1Vishnu package for ...
2
3LINUX INSTALL:
4
5If you are running this as part of Greenstone, just installing Greenstone will install Vishnu.
6
7If you want to run it standalone:
8
9The environment variable JAVA_HOME needs to be set.
10You 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.
11You need the lucene 1.4 or higher jar file in your CLASSPATH.
12Other jar files needed in CLASSPATH: xercesImpl.jar, servlet.jar.
13
14Edit the src/vishnu Makefile and uncomment the prefix for stand-alone vishnu.
15
16Then run the following:
17
18make
19make install
20
21WINDOWS INSTALL:
22
23Doesn't work on windows yet.
24
25COLLECTION BUILDING:
26
27Make 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.
28
29Then you can build the collection:
30
31Command line:
32java 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")
33
34Using a GUI tool:
35java vishnu.builder.IndexerGUI
36
37Fill in the fields as appropriate, and click "Start indexing".
38
39Once the collection is built, you need to rename the building directory to index. Collections are built into the building directory, but served from the index directory. This allows you to serve a built collection while rebuilding.
40
41For collections in the Greenstone 3 context, you will need to create the files etc/collectionConfig.xml and index/buildConfig.xml.
42These should look like the following:
43
44etc/collectionConfig.xml:
45<collectionConfig>
46 <metadataList>
47 <metadata name="creator">creator's email address</metadata>
48 </metadataList>
49 <displayItemList>
50 <displayItem name='name' lang='en'>Collection name</displayItem>
51 <displayItem name='description' lang='en'>Collection description
52 </displayItem>
53 </displayItemList>
54</collectionConfig>
55
56index/buildConfig.xml:
57<buildConfig>
58 <metadataList/>
59 <serviceRackList>
60 <serviceRack name="Visualizer">
61 <engineType name="MG"/> <!-- or LUCENE, depending on how you built the collection -->
62 </serviceRack>
63 </serviceRackList>
64</buildConfig>
65
66
67RUNNING THE SERVLET:
68
69
70If you are running this standalone, you need to run a servlet container for VisServlet.
71We have provided an example for use with Tomcat (version 4.1).
72
73Set the prefix in the src/vishnu Makefile to be ../.., then the servlet class and jar files will be installed in the correct places.
74The vishnu/web directory is setup to be the context directory for vishnu in Tomcat.
75You 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:
76
77<Context path="/vishnu" docBase="full-path-to-vishnu/web" debug="1" reloadable="true"><Resources allowLinking='true'/></Context>
78(replacing "full path-to-vishnu" with the path to the vishnu directory.)
79Edit the vishnu/web/WEB-INF/web.xml file and put in the correct path to your collections directory.
80
81The vishnu.jar file needs to be in your CLASSPATH, and make sure that Tomcat is using your CLASSPATH.
82
83RUNNING THE APPLET:
84
85The 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.
86
87If you are running Tomcat as described above, you can view this index file at http://localhost:8080/vishnu/index.html
Note: See TracBrowser for help on using the repository browser.