Changeset 19839
- Timestamp:
- 2009-06-15T14:36:18+12:00 (15 years ago)
- Location:
- greenstone3/trunk
- Files:
-
- 2 edited
-
README-SVN.txt (modified) (3 diffs)
-
README.txt (modified) (9 diffs)
Legend:
- Unmodified
- Added
- Removed
-
greenstone3/trunk/README-SVN.txt
r15188 r19839 4 4 This is free software, and you are welcome to redistribute it 5 5 6 These are some extra notes for installing Greenstone from SVN. Please also read the README.txt file for general information as almost all of that applies here too. 6 These are some extra notes for installing Greenstone from SVN. Please also 7 read the README.txt file for general information as almost all of that applies 8 here too. 9 10 You will need Java and Ant to run Greenstone 3. 11 12 Your Java version should be 1.4 or higher. We recommend Sun Java. You need the 13 SDK (development environment). Set the environment variable JAVA_HOME to be 14 the root of your Java installation. 15 16 Ant (Apache's Java based build tool) can be downloaded from 17 http://ant.apache.org/bindownload.cgi. Set the environment variable 18 ANT_HOME to be the root of your Ant installation, and make sure the Ant 19 executables are on your PATH. You may have problems with earlier versions. 20 This has been tested with version 1.6.2 7 21 8 22 Installing Greenstone from an SVN checkout: … … 17 31 Build and install: 18 32 19 In the greenstone3 directory, edit the build.properties file (see 'Configuring your installation' in README.txt), and run 'ant prepare install'. The two targets can be run separately if you like.20 33 21 The 'prepare' target will download additional code (using SVN and http), so you need to be online to run it. The 'install' target can be run offline. 34 In the greenstone3 directory, check and/or edit the build.properties file. In 35 particular, set the Tomcat port number. See 'Configuring your installation' in 36 README.txt for more information. 22 37 23 The prepare/install targets will ask you if you accept the properties before starting. 38 Note, initial checkouts from SVN have a build.properties.in file. Running 39 'ant' will result in the build.properties file being generated from the .in 40 file (a straight copy). 41 42 Then, run 'ant prepare install'. The two targets can be run separately if you 43 like. 44 45 The 'prepare' target will download additional code (using SVN and http), so 46 you need to be online to run it. The 'install' target can be run offline. 47 48 The prepare/install targets will ask you if you accept the properties before 49 starting. 24 50 To suppress this prompt, use the -Dproperties.accepted=yes flag. E.g. 25 ant -Dproperties.accepted=yes prepare install (from CVS), or 51 ant -Dproperties.accepted=yes prepare install 52 26 53 To log the output, run 27 ant -Dproperties.accepted=yes -logfile build.log prepare install (from CVS), or 54 ant -Dproperties.accepted=yes -logfile build.log prepare install 55 56 On Windows, Visual Studio is used for compiling. The VCVARS32.bat script needs 57 to be run in the command prompt before compiling with "ant install". 58 59 In the greenstone3 directory, you can run 'ant' which will give you a help 60 message. 61 Running 'ant -projecthelp' gives a list of the targets that you can run - these 62 do various things like compile the source code, start up the server etc. 28 63 29 64 Extra Configuration notes: … … 33 68 including external packages and the Librarian Interface. These will be 34 69 installed during the Greenstone 3 installation process. If you do not want 35 collection building capability, please set the disable.collection.building property to true in build.properties. 70 collection building capability, please set the disable.collection.building 71 property to true in build.properties. 36 72 37 73 -
greenstone3/trunk/README.txt
r15385 r19839 4 4 This is free software, and you are welcome to redistribute it 5 5 6 You will need Java and Ant to run Greenstone 3.7 8 Your Java version should be 1.4 or higher. We recommend Sun Java. You need the SDK (development environment). Set the environment variable JAVA_HOME to be the root of your Java installation.9 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.211 12 In the greenstone3 directory, you can run 'ant' which will give you a help message.13 Running 'ant -projecthelp' gives a list of the targets that you can run - these14 do various things like compile the source code, start up the server etc.15 16 6 Installing Greenstone 17 7 --------------------------------------------------------- … … 23 13 See the README-SVN.txt file for extra notes about installing directly from SVN. 24 14 15 Greenstone 3 requires Java and Ant to run. These may be installed during 16 Greenstone installation. 17 25 18 Running Greenstone: 26 19 --------------------------------------------------------- 27 20 28 To start up Greenstone, select Greenstone3 Digital Library from the Start menu (Windows), or run gs3-server.sh/bat. This launches a small server program, which starts up Tomcat and launches a browser. A small window pops up which allows you to chnage some settings for your library and restart the Tomcat server. Closing this program will stop Tomcat running. 29 30 Alternatively, you can start Tomcat directly through using Ant. 'ant start', 'ant restart' and 'ant stop' starts, restarts and shuts down Tomcat, respectively. This will only start/stop a local server (one installed by Greenstone). You will need to manually start/stop an external Tomcat (see below for notes about using a version of Tomcat external to Greenstone). 31 32 Once the Tomcat server is running, Greenstone will be available in a browser at "http://localhost:8080/greenstone3" (or whatever port you specified during the 33 installation process). 34 You can change the port number using File->Settings in the server program, or by changing the 'tomcat.port' property in build.properties, then running 'ant configure'. 21 To start up Greenstone, select Greenstone3 Digital Library from the Start menu 22 (Windows), or run gs3-server.sh/bat. This launches a small server program 23 which starts up Tomcat and launches a browser. A small window pops up which 24 allows you to change some settings for your library and restart the Tomcat 25 server. Closing this program will stop Tomcat running. 26 27 Alternatively, you can start Tomcat directly through using Ant. 'ant start', 28 'ant restart' and 'ant stop' starts, restarts and shuts down Tomcat, 29 respectively. This will only start/stop a local server (one installed by 30 Greenstone). You will need to manually start/stop an external Tomcat 31 (see below for notes about using a version of Tomcat external to Greenstone). 32 33 Once the Tomcat server is running, Greenstone will be available in a browser 34 at "http://localhost:8080/greenstone3" (or whatever port you specified 35 during the installation process). 36 You can change the port number using File->Settings in the server program, or 37 by changing the 'tomcat.port' property in build.properties, then running 38 'ant configure'. 35 39 36 40 Building Collections: … … 39 43 You need to have Perl installed and on your PATH. Perl is included as part of 40 44 the Windows binary distribution. 41 You can build collections using the Greenstone Librarian Interface (GLI). To start GLI, run 'ant gli", or cd to greenstone3/gli and run gli4gs3.sh/bat. 45 46 You can build collections using the Greenstone Librarian Interface (GLI). 47 To start GLI, select it from the Start Menu (Windows), run 'ant gli" from the 48 greenstone3 directory, or cd to greenstone3/gli and run gli.sh/bat. 49 42 50 Once you have created and built a collection, you can see it by clicking 'Preview collection' on the Build panel. 43 44 Note that GLI doesn't start up the Greenstone Tomcat server so you should45 run 'ant start' before previewing your collection.46 47 51 48 52 Greenstone Admin … … 54 58 ------------------------------------------------------- 55 59 56 Greenstone comes with Apache Axis installed as part of the Greenstone web application. However, no SOAP services are deployed by default. 57 58 To deploy a SOAP server for localsite, run 'ant deploy-localsite'. You should now be able to see all localsite's collections through the gateway servlet. (http://localhost:8080/greenstone3/gateway) 60 Greenstone comes with Apache Axis installed as part of the Greenstone web 61 application. However, no SOAP services are deployed by default. 62 63 To deploy a SOAP server for localsite, run 'ant deploy-localsite'. You should 64 now be able to see all localsite's collections through the gateway servlet. 65 (http://localhost:8080/greenstone3/gateway) 59 66 60 67 To set up a SOAP server on a new site, run 61 68 ant soap-deploy-site 62 This will prompt you for the sitename (the directory name), and the site uri - this should be a unique identifier for the site's web service. 69 This will prompt you for the sitename (the directory name), and the site uri 70 - this should be a unique identifier for the site's web service. 63 71 64 72 For a non-interactive version, run 65 73 ant -Daxis.sitename=xxx -Daxis.siteuri=yyy soap-deploy-site 66 74 67 The service is accessible at http://localhost:8080/greenstone3/services/<siteuri> 75 The service is accessible at 76 http://localhost:8080/greenstone3/services/<siteuri> 77 68 78 (or http://<computer-web-address>:<port>/greenstone3/services/<siteuri>) 69 79 70 Note: Deploying a SOAP service for any site other than localsite requires the Greenstone source code to be installed. This is not installed by default for a binary distribution. To get the source code, re-run the installer, select custom install and deselect everything except the source code. 80 Note: Deploying a SOAP service for any site other than localsite requires 81 the Greenstone source code to be installed. This is not installed by default 82 for a binary distribution. To get the source code, re-run the installer, 83 select custom install and deselect everything except the source code. 71 84 72 85 Using External Tomcat: … … 74 87 75 88 If you want to use an existing Tomcat, set the path to its base directory 76 in build.properties (tomcat.installed.path). Also set the tomcat.port property to be the port you are running Tomcat on, and change tomcat.server if the web address is not localhost. Then run 'ant configure'. 89 in build.properties (tomcat.installed.path). Also set the tomcat.port 90 property to be the port you are running Tomcat on, and change tomcat.server 91 if the web address is not localhost. Then run 'ant configure'. 77 92 78 93 You will need to modify the Tomcat setup slightly. … … 80 95 1. Tell Tomcat about the Greenstone web app. There are two ways to do this. 81 96 82 A. Copy the file greenstone3/resources/tomcat/greenstone3.xml into Tomcat's conf/Catalina/localhost directory. You'll need to edit the file and replace @gsdl3webhome@ with the full path to the web directory of your greenstone 3 installation. Any path separator is fine here ('/', '\\', '\'). 83 84 B. Alternatively, you can move (and rename) the greenstone3/web directory to tomcat/webapps/greenstone3 (i.e. the resulting directories will be like 85 tomcat/webapps/greenstone3/WEB-INF, no web directory). This should be done after running the initial 'ant install'. 97 A. Copy the file greenstone3/resources/tomcat/greenstone3.xml into Tomcat's 98 conf/Catalina/localhost directory. You'll need to edit the file and 99 replace @gsdl3webhome@ with the full path to the web directory of your 100 greenstone 3 installation. Any path separator is fine here ('/', '\\', '\'). 101 102 B. Alternatively, you can move (and rename) the greenstone3/web directory to 103 tomcat/webapps/greenstone3 (i.e. the resulting directories will be like 104 tomcat/webapps/greenstone3/WEB-INF, no web directory). This should be done 105 after running the initial 'ant install'. 86 106 87 107 You will need to set the web.home property in the build.properties file … … 91 111 92 112 2. Set up the JNI libraries and Java wrappers. 93 JNI libraries and their Java wrappers cannot go into the web app. The libraries need to be loaded by the same class loader as their wrappers. The libraries need to be in java.library.path, and I think get loaded by the system class loader. 113 JNI libraries and their Java wrappers cannot go into the web app. The 114 libraries need to be loaded by the same class loader as their wrappers. The 115 libraries need to be in java.library.path, and I think get loaded by the 116 system class loader. 94 117 The wrappers need to be loaded by this too. 95 118 96 These JNI bits are located by default in the lib/jni directory. There are two ways to get them into Tomcat: 97 A: Keep all the Greenstone stuff inside the greenstone3 directory, and just modify the environment that Tomcat runs in 98 99 Set LD_LIBRARY_PATH (GNU/Linux), DYLD_LIBRARY_PATH (Mac OS X) or PATH/Path (windows) to include the greenstone3/lib/jni directory. 100 Add all the jar files in greenstone3/lib/jni directory to the CLASSPATH, then edit tomcats setclasspath.sh/bat to use the system CLASSPATH. 119 These JNI bits are located by default in the lib/jni directory. There are 120 two ways to get them into Tomcat: 121 A: Keep all the Greenstone stuff inside the greenstone3 directory, and just 122 modify the environment that Tomcat runs in 123 124 Set LD_LIBRARY_PATH (GNU/Linux), DYLD_LIBRARY_PATH (Mac OS X) or PATH/Path 125 (windows) to include the greenstone3/lib/jni directory. 126 Add all the jar files in greenstone3/lib/jni directory to the CLASSPATH, 127 then edit tomcats setclasspath.sh/bat to use the system CLASSPATH. 101 128 (in setclasspath.bat, change 102 129 set CLASSPATH=%JAVA_HOME%\lib\tools.jar … … 119 146 B: Copy the files into Tomcat installation: 120 147 Move the greenstone3/lib/jni jar files into tomcat's shared/lib directory. 121 Move the greenstone3/lib/jni library files (.so for GNU/Linux, .jnilib for Mac OS X .dll for Windows) into shared/classes, and set LD_LIBARARY_PATH (GNU/Linux), DYLD_LIBRARY_PATH (Mac OS X) or PATH/Path (Windows) to include this directory. 122 This has the advantage that you can use this for other webapps without modifying the Tomcat environment. 123 124 Once all these changes have been made, you will need to restart the Tomcat server for them to take effect. 148 Move the greenstone3/lib/jni library files (.so for GNU/Linux, .jnilib for 149 Mac OS X .dll for Windows) into shared/classes, and set LD_LIBARARY_PATH 150 (GNU/Linux), DYLD_LIBRARY_PATH (Mac OS X) or PATH/Path (Windows) to include 151 this directory. 152 This has the advantage that you can use this for other webapps without 153 modifying the Tomcat environment. 154 155 Once all these changes have been made, you will need to restart the Tomcat 156 server for them to take effect. 125 157 126 158 … … 133 165 ----------------------------------------------- 134 166 135 You can set environment variables by going to Control Panel->System->Advanced->Environment Variables. 167 You can set environment variables by going to 168 Control Panel->System->Advanced->Environment Variables. 136 169 137 170 Installing from a Source Distribution 138 171 ---------------------------------------------- 139 172 140 Download the greenstone-3.xx-src.tar.gz package from sourceforge.net/projects/greenstone3, and unpack it. 173 Download the greenstone-3.xx-src.tar.gz package from 174 sourceforge.net/projects/greenstone3, and unpack it. 175 141 176 In the greenstone3 directory, edit the build.properties file and run 142 177 ant install 143 178 144 Tomcat will be installed as part of the prepare process. To stop this set the tomcat.installed.path to be the root of an existing Tomcat installation. 179 Tomcat will be installed as part of the prepare process. To stop this set the 180 tomcat.installed.path to be the root of an existing Tomcat installation. 145 181 146 182 * Solaris notes:
Note:
See TracChangeset
for help on using the changeset viewer.
