Changeset 10780

Timestamp:

2005-10-27T13:14:41+13:00 (19 years ago)

Author:

kjdon

Message:

changed gsdl3 to greenstone3 in dir name and url

File:

• trunk/gsdl3/README.txt (modified) (18 diffs)

trunk/gsdl3/README.txt

@@ -1 +1 @@
 Greenstone 3 (GSDL3)
 Copyright (C) 2003 New Zealand Digital Libraries, University Of Waikato
-GSDL3 comes with ABSOLUTELY NO WARRANTY; for details see LICENSE.txt
+Greenstone3 comes with ABSOLUTELY NO WARRANTY; for details see LICENSE.txt
 This is free software, and you are welcome to redistribute it
 
@@ -10 +10 @@
 Ant (Apache's Java based build tool) can be downloaded from http://ant.apache.org/bindownload.cgi. Set the environment variable ANT_HOME to be the root of your Ant installation, and make sure the Ant executables are on your PATH. You may have problems with earlier versions. This has been tested with version 1.6.2
 
-In the gsdl3 directory, you can run 'ant' which will give you a help message.
+In the greenstone3 directory, you can run 'ant' which will give you a help message.
 Running 'ant -projecthelp' gives a list of the targets that you can run - these
 do various things like compile the source code, start up the server etc.
@@ -19 +19 @@
 ---------------------------------------------------------
 
-Download the appropriate zip/tar file (gsdl3-x.xx-linux.tar.gz/gsdl3-x.xx-win32.zip/gsdl3-x.xx-macOSX.tar.gz), and unzip/untar it. In the gsdl3 directory, edit the build.properties file if appropriate (see 'Configuring your installation' below), and run 'ant install'.
+Download the appropriate zip/tar file (greenstone-3.xx-linux.tar.gz/greenstone-3.xx-win32.zip/greenstone-3.xx-macOSX.tar.gz), and unzip/untar it. In the greenstone3 directory, edit the build.properties file if appropriate (see 'Configuring your installation' below), and run 'ant install'.
 
 Installing Greenstone from a CVS checkout (Linux/Windows/MacOS X):
@@ -28 +28 @@
 Checkout the code:
 
-cvs -d :pserver:[email protected]:2402/usr/local/global-cvs/gsdl-src co gsdl3
+cvs -d :pserver:[email protected]:2402/usr/local/global-cvs/gsdl-src co greenstone3
 
 Build and install:
 
-In the gsdl3 directory, edit the build.properties file if appropriate (see 'Configuring your installation' below), and run 'ant prepare install'. The two targets can be run separately if you like.
+In the greenstone3 directory, edit the build.properties file if appropriate (see 'Configuring your installation' below), and run 'ant prepare install'. The two targets can be run separately if you like.
 
 The 'prepare' target will download additional code (using CVS and http), so you need to be online to run it. The 'install' target can be run offline.
@@ -63 +63 @@
 -------------------------------
 1. Install for the first time from CVS:
-cvs co gsdl3
-cd gsdl3
+cvs co greenstone3
+cd greenstone3
 ant prepare install
 
 2. Install for the first time from CVS, mostly offline:
 [online]
-cvs co gsdl3
-cd gsdl3
+cvs co greenstone3
+cd greenstone3
 ant prepare
 [offline]
@@ -76 +76 @@
 
 3. Install for the first time, with CVS done outside of Ant (if you have problems running CVS commands from Ant):
-cvs co -P gsdl3
-cd gsdl3/packages
+cvs co -P greenstone3
+cd greenstone3/packages
 cvs co mgpp
 cd ..
@@ -90 +90 @@
 
 4. Updating your Greenstone installation from CVS (and reconfigure/recompile):
-cd gsdl3
+cd greenstone3
 ant update
 
 5. Updating your Greenstone installation from CVS, offline:
-cd gsdl3
+cd greenstone3
 [online]
 ant cvsupdate
@@ -101 +101 @@
 
 6. Updating your Greenstone installation, with CVS done outside of Ant:
-cd gsdl3
+cd greenstone3
 cvs update -l
 cvs update -dP bin comms docs lib resources src winutil packages 
-cd web (or the path-to-tomcat/webapps/gsdl3 if have installed greenstone as a webapp in Tomcat, see Using External Tomcat section)
+cd web (or the path-to-tomcat/webapps/greenstone3 if have installed greenstone as a webapp in Tomcat, see Using External Tomcat section)
 cvs update -dP 
-cd gsdl3
+cd greenstone3
 [ if you have greenstone 2 building:
 cvs update -dP gli
@@ -118 +118 @@
 Any sub targets can be run by themselves. Run 'ant -projecthelp' for a list of public targets, otherwise you can look at the build.xml file to see which targets depend on other ones.
 
-If you run your install using an external Tomcat, the SOAP web service for localsite (used by the gateway servlet) will not be loaded. You need to start up Tomcat, then run 'ant soap-deploy-site' and accept the defaults for sitename and siteuri (both localsite). If you want to use the gateway servlet without restarting Tomcat, you will need to reload the site information. Visit the URL localhost:8080/gsdl3/gateway?a=s&sa=c  (substituting your server name and port number if necessary). See the user guide for more information about run time reconfiguration.
+If you run your install using an external Tomcat, the SOAP web service for localsite (used by the gateway servlet) will not be loaded. You need to start up Tomcat, then run 'ant soap-deploy-site' and accept the defaults for sitename and siteuri (both localsite). If you want to use the gateway servlet without restarting Tomcat, you will need to reload the site information. Visit the URL localhost:8080/greenstone3/gateway?a=s&sa=c  (substituting your server name and port number if necessary). See the user guide for more information about run time reconfiguration.
 
 Running Greenstone:
@@ -126 +126 @@
 These will only start/stop local servers (ones installed by Greenstone). You will need to manually start/stop external Tomcat/mysql.
 
-Greenstone will be available in a browser at "http://localhost:8080/gsdl3".
+Greenstone will be available in a browser at "http://localhost:8080/greenstone3".
 
 You can change the port number by changing the 'tomcat.port' property in build.properties, then running 'ant configure'.
@@ -143 +143 @@
 ant -Daxis.sitename=xxx -Daxis.siteuri=yyy soap-deploy-site
 
-The service is accessible at http://localhost:8080/gsdl3/services/<siteuri>
-(or http://<computer-web-address>:<port>/gsdl3/services/<siteuri>)
+The service is accessible at http://localhost:8080/greenstone3/services/<siteuri>
+(or http://<computer-web-address>:<port>/greenstone3/services/<siteuri>)
 
 Building Collections:
@@ -154 +154 @@
 
 You need to have Perl installed and on your PATH. Perl is included as part of the Windows binary distribution.
-run  'ant gli", or cd to gsdl3/gli and run gli4gs3.sh/bat. This is a graphical tool for building collections. Once you have created and built a collection, you can see it by clicking 'Preview collection' on the Build panel.
+run  'ant gli", or cd to greenstone3/gli and run gli4gs3.sh/bat. This is a graphical tool for building collections. Once you have created and built a collection, you can see it by clicking 'Preview collection' on the Build panel.
 
 Note that GLI doesn't start up the Greenstone server (Tomcat/mysql) so you should run 'ant start' before previewing your collection.
 Greenstone 3:
 
-In the gsdl3 directory, run: 'source gs3-setup.sh' (Linux/Mac OS X) or 'gs3-setup' (windows).
+In the greenstone3 directory, run: 'source gs3-setup.sh' (Linux/Mac OS X) or 'gs3-setup' (windows).
 To create a new collection, run 'gs3-mkcol.sh/bat <sitename> <collname>'
-Put documents in the import directory (gsdl3/web/sites/<sitename>/collect/<collname>/import), edit the collection configuration file (gsdl3/web/sites/<sitename>/collect/<collname>/etc/collectionConfig.xml), and run 'gs3-build.sh <sitename> <collname>'
-Rename the building directory to index (in gsdl3/web/sites/<sitename>/collect/<collname>) and reload the collection in Tomcat (?a=s&sa=a&st=collection&sn=<collname>), or restart Tomcat.
+Put documents in the import directory (greenstone3/web/sites/<sitename>/collect/<collname>/import), edit the collection configuration file (greenstone3/web/sites/<sitename>/collect/<collname>/etc/collectionConfig.xml), and run 'gs3-build.sh <sitename> <collname>'
+Rename the building directory to index (in greenstone3/web/sites/<sitename>/collect/<collname>) and reload the collection in Tomcat (?a=s&sa=a&st=collection&sn=<collname>), or restart Tomcat.
 
 See the manual for more details about both styles of collection building.
@@ -169 +169 @@
 ---------------
 
-See gsdl3/docs/manual/manual.pdf for more details about the software and installation etc.
-
-Under Linux, Tomcat logs output in gsdl3/comms/jakarta/tomcat/logs/catalina.out.
-
-To prevent Tomcat showing directory listings, edit the gsdl3/comms/jakarta/tomcat/conf/web.xml file and set the value of the "listings" servlet parameter to false.
+See greenstone3/docs/manual/manual.pdf for more details about the software and installation etc.
+
+Under Linux, Tomcat logs output in greenstone3/comms/jakarta/tomcat/logs/catalina.out.
+
+To prevent Tomcat showing directory listings, edit the greenstone3/comms/jakarta/tomcat/conf/web.xml file and set the value of the "listings" servlet parameter to false.
 
 ant can't seem to do cvs using authenticated cvs on windows:
@@ -192 +192 @@
 A. Add in the Greenstone context to Tomcat's server.xml (In the Host name="localhost".. element)
 
-<Context path="/gsdl3" docBase="path-to-gsdl3/web" debug="1" 
+<Context path="/greenstone3" docBase="path-to-greenstone3/web" debug="1" 
 reloadable="true"><Resources allowLinking='true'/></Context>
 
-B. Alternatively, you can move (and rename) the gsdl3/web directory to tomcat/webapps/gsdl3 (i.e. the resulting directories will be like
-tomcat/webapps/gsdl3/WEB-INF, no web directory). This should be done after running the initial 'ant [prepare] install'.
+B. Alternatively, you can move (and rename) the greenstone3/web directory to tomcat/webapps/greenstone3 (i.e. the resulting directories will be like
+tomcat/webapps/greenstone3/WEB-INF, no web directory). This should be done after running the initial 'ant [prepare] install'.
 You will need to set the web.home property in the build.properties file
 i.e.
-web.home=${tomcat.installed.path}/webapps/gsdl3
+web.home=${tomcat.installed.path}/webapps/greenstone3
 And then run 'ant configure-web' to reset gsdl3home.
 
@@ -208 +208 @@
 
 These JNI bits are located by default in the lib/jni directory. There are two ways to get them into Tomcat:
-A: Keep all the Greenstone stuff inside the gsdl3 directory, and just modify the environment that Tomcat runs in
-
-Set LD_LIBRARY_PATH (linux) or PATH (windows) to include the  gsdl3/lib/jni directory.
-Add all the jar files in gsdl3/lib/jni directory to the CLASSPATH, then edit tomcats setclasspath.sh/bat to use the system CLASSPATH.
+A: Keep all the Greenstone stuff inside the greenstone3 directory, and just modify the environment that Tomcat runs in
+
+Set LD_LIBRARY_PATH (linux) or PATH (windows) to include the  greenstone3/lib/jni directory.
+Add all the jar files in greenstone3/lib/jni directory to the CLASSPATH, then edit tomcats setclasspath.sh/bat to use the system CLASSPATH.
 (in setclasspath.bat, change 
 set CLASSPATH=%JAVA_HOME%\lib\tools.jar
@@ -231 +231 @@
 
 B: Copy the files into Tomcat installation:
-Move the gsdl3/lib/jni jar files into tomcat's shared/lib directory.
-Move the gsdl3/lib/jni library files (.so for linux, .dll for windows) into shared/classes, and set LD_LIBARARY_PATH (linux) or PATH (windows) to include this directory. 
+Move the greenstone3/lib/jni jar files into tomcat's shared/lib directory.
+Move the greenstone3/lib/jni library files (.so for linux, .dll for windows) into shared/classes, and set LD_LIBARARY_PATH (linux) or PATH (windows) to include this directory. 
 This has the advantage that you can use this for other webapps without modifying the Tomcat environment.
 
@@ -250 +250 @@
 GRANT SELECT ON *.* TO gsdl3reader@localhost identified by 'reader-password';
 
-You will need to edit the gsdl3/web/WEB-INF/classes/global.properties file and set the two passwords that you used in here:
+You will need to edit the greenstone3/web/WEB-INF/classes/global.properties file and set the two passwords that you used in here:
 mysql.admin.password and mysql.reader.password
 The mysql.tcp.port property specified here should be set to the port that your mysql is running on. (default 3306).
@@ -258 +258 @@
 
 Close mysql, then run
-mysql localsite_gs3mgdemo < <path-to-gsdl3>/web/sites/localsite/collect/gs3mgdemo/mysqldatadump.sql
+mysql localsite_gs3mgdemo < <path-to-greenstone3>/web/sites/localsite/collect/gs3mgdemo/mysqldatadump.sql
 
 (Note that if you have installed the Greenstone web directory into Tomcats webapps dir, then this command will be
-mysql localsite_gs3mgdemo < <path-to-tomcat>/webapps/gsdl3/sites/localsite/collect/gs3mgdemo/mysqldatadump.sql )
+mysql localsite_gs3mgdemo < <path-to-tomcat>/webapps/greenstone3/sites/localsite/collect/gs3mgdemo/mysqldatadump.sql )
 
 You may need to run this using '--user=root -p'