Changeset 10674
- Timestamp:
- 2005-10-03T15:13:53+13:00 (19 years ago)
- File:
-
- 1 edited
-
trunk/gsdl3/README.txt (modified) (9 diffs)
Legend:
- Unmodified
- Added
- Removed
-
trunk/gsdl3/README.txt
r10671 r10674 4 4 This is free software, and you are welcome to redistribute it 5 5 6 Installing Greenstone from a binary distribution (Linux): 7 --------------------------------------------------------- 8 9 Download the gsdl3-x.xx-linux executable file, and run it. Follow the instructions given. 10 11 Installing Greenstone from a binary distribution (Windows): 12 ----------------------------------------------------------- 13 14 Download the gsdl3-x.xx-win32.exe executable file, and double click on it. 15 Follow the instructions given. 16 17 18 Installing Greenstone from a CVS checkout (Linux and Windows): 19 -------------------------------------------------------------- 20 21 Checkout the code: 22 23 cvs -d :pserver:[email protected]:2402/usr/local/global-cvs/gsdl-src co gsdl3 24 25 Build and install: 26 27 Greenstone is built and installed using Ant (Apache's Java based build tool, 28 http://ant.apache.org). You will need a Java Development 29 Environment (1.4 or higher, we recommend Sun Java), and Ant installed to use Greenstone. You can download Ant from http://ant.apache.org/bindownload.cgi. 30 31 Set the environment variable JAVA_HOME to be the root of your Java installation. 32 Set the environment variable ANT_HOME to be the root of you Ant installation. 33 Make sure the cvs and ant executables are on your Path. 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. If you are installing from a binary distribution, you will only need the JRE (Runtime environment). If you are installing from CVS, you will need the SDK (Development environment). 9 Set the environment variable JAVA_HOME to be the root of your Java installation. 10 11 Ant (Apache's Java based build tool, http://ant.apache.org) 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. 34 12 35 13 In the gsdl3 directory, you can run 'ant' which will give you a help message. 36 14 Running 'ant -projecthelp' gives a list of the targets that you can run - these 37 do various things like compile the source code, startup the server etc. 38 39 For a first time install, run 'ant prepare install'. 15 do various things like compile the source code, start up the server etc. 16 17 Installing Greenstone from a binary distribution: 18 --------------------------------------------------------- 19 20 Download the appropriate zip file (gsdl3-x.xx-linux.zip/gsdl3-x.xx-win32.zip/gsdl3-x.xx-macOSX.zip), and unzip it. In the gsdl3 directory, edit the build.properties file if appropriate (see 'Configuring your installation' below), and run 'ant install'. 21 22 Installing Greenstone from a CVS checkout (Linux/Windows/MacOS X): 23 --------------------------------------------------------------------- 24 25 Make sure the CVS executable is on your PATH. 26 27 Checkout the code: 28 29 cvs -d :pserver:[email protected]:2402/usr/local/global-cvs/gsdl-src co gsdl3 30 31 Build and install: 32 33 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. 34 35 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. 36 37 Configuring your installation: 38 ------------------------------------ 40 39 41 40 The file build.properties contains various parameters that can be set by the user. Please check these settings before running the install. 42 41 43 Greenstone uses the Tomcat servlet container. If you already have Tomcat running, you can set the tomcat.installed.path property to the base directory of your Tomcat installation, and Greenstone will not download its own Tomcat. 44 It is intended that the same thing will be available for mysql, but this has not been implemented yet. 45 46 Greenstone 3 uses some parts of Greenstone 2 for collection building using the Librarian Interface. It downloads the relevant parts during install. If you have Greenstone 2 already installed, please set the gsdl2.installed.path property to be the root of your Greenstone 2 installation. Greenstone 3 will then use this installation rather than downloading the extra Greenstone 2 bits. If you do not want to use Greenstone 2 style collection building at all, set the gsdl2.installed.path to any non-empty string. 47 48 The prepare target will ask you if you accept the properties before starting. 42 Greenstone 3 uses the Tomcat servlet container. If you already have Tomcat running, you can set the 'tomcat.installed.path' property to the base directory of your Tomcat installation, and Greenstone will not download/install its own Tomcat. Please read the section "Using External Tomcat" for details about how to configure Tomcat for Greenstone. 43 44 Greenstone 3 uses mysql for the collection database (with Greenstone 3 native building). If you already have mysql installed, set the 'mysql.installed.path' property to the base directory of your mysql installation, and Greenstone will not download/install mysql. Please read the section "Using external mysql server" for details about how to configure mysql for Greenstone. 45 46 Greenstone 3 uses some parts of Greenstone 2 for collection building using the Librarian Interface. These will be installed during the Greenstone 3 installation process. If you have Greenstone 2 already installed and want to use that version instead, please set the gsdl2.installed.path property to be the root of your Greenstone 2 installation. Greenstone 3 will then use this installation rather than its own bits. (Note, be careful about compatibility between versions.) If you are using Greenstone 3 from CVS, and don't want to download the Greenstone 2 stuff, set the gsdl2.installed.path to any non-empty string. 47 48 The prepare/install target will ask you if you accept the properties before starting. 49 49 To suppress this prompt, use the -Dproperties.accepted=yes flag. E.g. 50 ant -Dproperties.accepted=yes prepare install 50 ant -Dproperties.accepted=yes prepare install (from CVS), or 51 ant -Dproperties.accepted=yes install (from binary dist). 51 52 52 53 To log the output in build.log, run 53 ant -Dproperties.accepted=yes -logfile build.log prepare install 54 55 The prepare target will download additional code, so you need to be online to run it. install can be run offline. 56 57 Under Linux, Java and C/C++ compilation is carried out. For windows, since Visual Studio is not a standard component, only Java compilation is carried out. Pre-compiled binaries are provided for the C/C++ components (packages and Greenstone 2 style building). If you have Visual Studio installed (version 6), you can run the compile-windows-c++ targets to compile the code locally. (Don't forget to setup the Visual Studio environment first, by running, e.g. C:/Program Files/Microsoft Visual Studio/VC98/Bin/VCVARS32.BAT or equivalent.) 54 ant -Dproperties.accepted=yes -logfile build.log prepare install (from CVS), or 55 ant -Dproperties.accepted=yes -logfile build.log install (from binary dist). 56 57 The compile target, under Linux, does Java and C/C++ compilation. For Windows, since Visual Studio is not a standard component, only Java compilation is carried out. Pre-compiled binaries are provided for the C/C++ components (packages and Greenstone 2 style building). If you have Visual Studio installed (version 6), you can run the compile-windows-c++ targets to compile the code locally. (Don't forget to setup the Visual Studio environment first, by running, e.g. C:/Program Files/Microsoft Visual Studio/VC98/Bin/VCVARS32.BAT or equivalent.) 58 58 59 59 Common install/update targets. 60 60 ------------------------------- 61 1. Install for the first time :61 1. Install for the first time from CVS: 62 62 cvs co gsdl3 63 63 cd gsdl3 64 64 ant prepare install 65 65 66 2. Install for the first time ,offline:66 2. Install for the first time from CVS, mostly offline: 67 67 [online] 68 68 cvs co gsdl3 … … 72 72 ant install 73 73 74 3. Install for the first time, cvs done outside of Ant (if you have problems running cvs commands from Ant): 75 cvs co [-P] gsdl3 76 cd gsdl3 77 cvs update -P (run this if you haven't done the checkout with the -P option) 78 cd packages 74 3. Install for the first time, with CVS done outside of Ant (if you have problems running CVS commands from Ant): 75 cvs co -P gsdl3 76 cd gsdl3/packages 79 77 cvs co mgpp 80 78 cd .. … … 88 86 ant -Dnocvs.mode=yes prepare install (prepare needs to be online, install can be done offline) 89 87 90 4. Updating your Greenstone installation from cvs(and reconfigure/recompile):88 4. Updating your Greenstone installation from CVS (and reconfigure/recompile): 91 89 cd gsdl3 92 90 ant update 93 91 94 5. Updating your Greenstone installation , offline:92 5. Updating your Greenstone installation from CVS, offline: 95 93 cd gsdl3 96 94 [online] … … 99 97 ant -Dnocvs.mode=yes update 100 98 101 6. Updating your Greenstone installation, cvsoutside of Ant:99 6. Updating your Greenstone installation, with CVS done outside of Ant: 102 100 cd gsdl3 103 101 cvs update -l … … 125 123 These will only start/stop local servers (ones installed by Greenstone). You will need to manually start/stop external Tomcat/mysql. 126 124 127 On Windows, if you have installed a binary version, you can also start Greenstone by selecting Greenstone 3 Digital Library from the Start menu.128 129 125 Greenstone will be available in a browser at "http://localhost:8080/gsdl3". 130 126 131 You can change the port number by changing the tomcat.portproperty in build.properties, then running 'ant configure'.127 You can change the port number by changing the 'tomcat.port' property in build.properties, then running 'ant configure'. 132 128 133 129 … … 135 131 ------------------------------- 136 132 137 Greenstone comes with Apache Axis installed as a webapp in Tomcat. A SOAP server on localsite is deployed during installation. You should be able to see all localsite's collections through the gateway servlet.133 Greenstone comes with Apache Axis installed as part of the Greenstone web application. A SOAP server on localsite is deployed during installation. You should be able to see all localsite's collections through the gateway servlet. 138 134 139 135 To set up a SOAP server on a new site, run … … 144 140 ant -Daxis.sitename=xxx -Daxis.siteuri=yyy soap-deploy-site 145 141 142 The service is accessible at http://localhost:8080/gsdl3/services/<siteuri> 143 (or http://<computer-web-address>:<port>/gsdl3/services/<siteuri>) 144 146 145 Building Collections: 147 146 ----------------------- … … 151 150 Greenstone 2: 152 151 153 You need to have Perl installed and on your PATH. 154 run 'ant gli", or cd to gsdl3/gli and run gli4gs3.sh/bat. This is a graphical tool for building collections. 152 You need to have Perl installed and on your PATH. Perl is included as part of the Windows binary distribution. 153 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. 155 154 156 155 Greenstone 3: 157 156 158 In the gsdl3 directory, run: 'source gs3-setup.sh' ( linux) or 'gs3-setup' (windows).157 In the gsdl3 directory, run: 'source gs3-setup.sh' (Linux/Mac OS X) or 'gs3-setup' (windows). 159 158 To create a new collection, run 'gs3-mkcol.sh/bat <sitename> <collname>' 160 159 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>' … … 193 192 194 193 B. Alternatively, you can move (and rename) the gsdl3/web directory to tomcat/webapps/gsdl3 (i.e. the resulting directories will be like 195 tomcat/webapps/gsdl3/WEB-INF, no web directory). This should be done after running the initial 'ant prepareinstall'.194 tomcat/webapps/gsdl3/WEB-INF, no web directory). This should be done after running the initial 'ant [prepare] install'. 196 195 You will need to set the web.home property in the build.properties file 197 196 i.e.
Note:
See TracChangeset
for help on using the changeset viewer.
