Greenstone 3 (GSDL3) Copyright (C) 2003 New Zealand Digital Libraries, University Of Waikato Greenstone3 comes with ABSOLUTELY NO WARRANTY; for details see LICENSE.txt This is free software, and you are welcome to redistribute it 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. You will need Java, Ant and Perl to run Greenstone 3. Greenstone now includes an easy way to get appropriate version of these for your installation. Installing Greenstone from an SVN checkout: --------------------------------------------------------------------- Make sure an SVN executable is on your PATH. Checkout the code: ------------------ svn co https://svn.greenstone.org/greenstone3/trunk greenstone3 Setting up your environment with Ant, Java and Perl - In the ext-cli folder ---------------------------------------------------------------------------- cd greenstone3/ext-cli Ant: ----- This needs to be version 1.8 or greater. If you don't already have Ant, run get-selfcontained-ant.sh/bat Java: ----- This needs to be version 1.8 or greater. If you don't have a suitable version, run get-selfcontained-jdk.sh/bat If you want to use your system Java, please make sure the JAVA_HOME environment veriable is set. (See Local Settings, below) Perl: ----- Greenstone now requires a specific perl installation with multiple cpan modules installed. We very strongly recommend you use our version. Please run get-selfcontained-perl-with-cpan.sh/bat The other scripts in the ext-cli folder are not needed for standard greenstone, but may be needed for specific extensions. cd ../ (back to greenstone3 folder) To setup the environment to use these now programs you have downloaded, run source ./gs3-setup-cli.sh (unix) or gs3-setup-cli.bat (Windows) Local Settings -------------- Greenstone comes with a local folder. On Linux/Mac, if you are using the ext-cli version of Java and Perl, you shouldn't need to have any local settings. If you want to use a different Java version, please edit local/gs3-setup.sh to set JAVA_HOME and update PATH. On Windows, the same applies to using a non standard Java - edit gs3-setup.bat. On Windows there is one thing necessary - set up the Visual Studio Environment. You will need to edit local/gs3-devel.bat and make sure the paths to the Visual Studio scripts are correct. Note: Sourcing (Unix) or running (Windows) 'gs3-setup.sh/bat or gs3-devel.sh/bat' in the top-level greenstone folder will also source/run the local versions. Build and install: ----------------- Note, before running any ant targets, you need to set up the environment in the terminal. Make sure you have run gs3-setup.bat (Windows) or 'source gs3-setup.sh' (Unix) first. (Running these will also run/source the gs3-setup-cli scripts and the local scripts.) In the greenstone3 directory, check and/or edit the build.properties file. In particular, set the Tomcat port number. See 'Configuring your installation' in README.txt for more information. Note, initial checkouts from SVN have a build.properties.in file. Running 'ant' (no arguments) will result in the build.properties file being generated from the .in file (a straight copy). Then, run 'ant prepare install'. The two targets can be run separately if you like. 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. The prepare target will ask you if you accept the properties before starting. To suppress this prompt, use the -Dproperties.accepted=yes flag. E.g. ant -Dproperties.accepted=yes prepare install To log the output, run ant -Dproperties.accepted=yes -logfile build.log prepare install 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. Extra Configuration notes: -------------------------------------------------------------- Greenstone 3 uses some parts of Greenstone 2 for collection building, including external packages and the Librarian Interface. These will be installed during the Greenstone 3 installation process. If you do not want collection building capability, please set the disable.collection.building property to true in build.properties. Common install/update targets: --------------------------------------------------------------------- 1. Install for the first time from SVN: svn co https://svn.greenstone.org/greenstone3/trunk greenstone3 cd greenstone3 ant prepare install 2. Install for the first time from SVN, mostly offline: [online] svn co https://svn.greenstone.org/greenstone3/trunk greenstone3 cd greenstone3 ant prepare [offline] ant install 3. Updating your Greenstone installation from SVN (and reconfigure/recompile): cd greenstone3 ant update 4. Updating your Greenstone installation from SVN, mostly offline: cd greenstone3 [online] ant svnupdate [offline] ant -Dnosvn.mode=yes update