Changeset 8301


Ignore:
Timestamp:
2004-10-12T16:17:15+13:00 (19 years ago)
Author:
kjdon
Message:

more instructions

Location:
trunk
Files:
3 edited

Legend:

Unmodified
Added
Removed
  • trunk/greenstone3-extensions/vishnu/README

    r8194 r8301  
    22
    33LINUX INSTALL:
     4
    45If you are running this as part of Greenstone, just installing Greenstone will install Vishnu.
     6
    57If you want to run it standalone:
    68
    79The environment variable JAVA_HOME needs to be set.
    8 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.
    9 You need the lucene 1.4 or higher jar file in your classpath.
    10 Other jar files needed: xercesImpl.jar, servlet.jar.
     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.
    1113
    12 The Makefiles may need modifying with respect to where things get installed to.
     14Edit the src/vishnu Makefile and uncomment the prefix for stand-alone vishnu.
    1315
    14 ./configure [--prefix=...]
     16Then run the following:
     17
    1518make
    1619make install
     
    2225COLLECTION BUILDING:
    2326
    24 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.
     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.
    2528
    2629Then you can build the collection:
    2730
    2831Command line:
    29 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")
     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")
    3033
    3134Using a GUI tool:
     
    6467RUNNING THE SERVLET:
    6568
     69
    6670If 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).
    6772
    68 The servlet class is vishnu.server.VisServlet. The class file needs to be put in the appropriate directory for your servlet container.
    69 The servlet needs one initialisation parameter: collectionsHome, which is the directory where collections live.
    70 The vishnu.jar file needs to go into the CLASSPATH used by the servlet container.
     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.
    7182
    7283RUNNING THE APPLET:
    7384
    74 Edit the test.html file and add in the correct address of the Visualiser servlet in the library parameter.
    75 create a lib directory in the same directory as the test.html file, and copy the vishnu.jar file into it.
    76 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.
     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
  • trunk/gsdl3/extensions/vishnu/README

    r8194 r8301  
    22
    33LINUX INSTALL:
     4
    45If you are running this as part of Greenstone, just installing Greenstone will install Vishnu.
     6
    57If you want to run it standalone:
    68
    79The environment variable JAVA_HOME needs to be set.
    8 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.
    9 You need the lucene 1.4 or higher jar file in your classpath.
    10 Other jar files needed: xercesImpl.jar, servlet.jar.
     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.
    1113
    12 The Makefiles may need modifying with respect to where things get installed to.
     14Edit the src/vishnu Makefile and uncomment the prefix for stand-alone vishnu.
    1315
    14 ./configure [--prefix=...]
     16Then run the following:
     17
    1518make
    1619make install
     
    2225COLLECTION BUILDING:
    2326
    24 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.
     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.
    2528
    2629Then you can build the collection:
    2730
    2831Command line:
    29 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")
     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")
    3033
    3134Using a GUI tool:
     
    6467RUNNING THE SERVLET:
    6568
     69
    6670If 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).
    6772
    68 The servlet class is vishnu.server.VisServlet. The class file needs to be put in the appropriate directory for your servlet container.
    69 The servlet needs one initialisation parameter: collectionsHome, which is the directory where collections live.
    70 The vishnu.jar file needs to go into the CLASSPATH used by the servlet container.
     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.
    7182
    7283RUNNING THE APPLET:
    7384
    74 Edit the test.html file and add in the correct address of the Visualiser servlet in the library parameter.
    75 create a lib directory in the same directory as the test.html file, and copy the vishnu.jar file into it.
    76 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.
     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
  • trunk/gsdl3/packages/vishnu/README

    r8194 r8301  
    22
    33LINUX INSTALL:
     4
    45If you are running this as part of Greenstone, just installing Greenstone will install Vishnu.
     6
    57If you want to run it standalone:
    68
    79The environment variable JAVA_HOME needs to be set.
    8 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.
    9 You need the lucene 1.4 or higher jar file in your classpath.
    10 Other jar files needed: xercesImpl.jar, servlet.jar.
     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.
    1113
    12 The Makefiles may need modifying with respect to where things get installed to.
     14Edit the src/vishnu Makefile and uncomment the prefix for stand-alone vishnu.
    1315
    14 ./configure [--prefix=...]
     16Then run the following:
     17
    1518make
    1619make install
     
    2225COLLECTION BUILDING:
    2326
    24 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.
     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.
    2528
    2629Then you can build the collection:
    2730
    2831Command line:
    29 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")
     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")
    3033
    3134Using a GUI tool:
     
    6467RUNNING THE SERVLET:
    6568
     69
    6670If 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).
    6772
    68 The servlet class is vishnu.server.VisServlet. The class file needs to be put in the appropriate directory for your servlet container.
    69 The servlet needs one initialisation parameter: collectionsHome, which is the directory where collections live.
    70 The vishnu.jar file needs to go into the CLASSPATH used by the servlet container.
     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.
    7182
    7283RUNNING THE APPLET:
    7384
    74 Edit the test.html file and add in the correct address of the Visualiser servlet in the library parameter.
    75 create a lib directory in the same directory as the test.html file, and copy the vishnu.jar file into it.
    76 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.
     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 TracChangeset for help on using the changeset viewer.