[15188] | 1 | Greenstone 3 (GSDL3)
|
---|
| 2 | Copyright (C) 2003 New Zealand Digital Libraries, University Of Waikato
|
---|
| 3 | Greenstone3 comes with ABSOLUTELY NO WARRANTY; for details see LICENSE.txt
|
---|
| 4 | This is free software, and you are welcome to redistribute it
|
---|
| 5 |
|
---|
[19839] | 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.
|
---|
[15188] | 9 |
|
---|
[19839] | 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
|
---|
[20090] | 19 | executables are on your PATH.
|
---|
| 20 | Greenstone 3 requires Ant 1.7.1 or higher.
|
---|
[19839] | 21 |
|
---|
[15188] | 22 | Installing Greenstone from an SVN checkout:
|
---|
| 23 | ---------------------------------------------------------------------
|
---|
| 24 |
|
---|
| 25 | Make sure an SVN executable is on your PATH.
|
---|
| 26 |
|
---|
| 27 | Checkout the code:
|
---|
| 28 |
|
---|
[26777] | 29 | svn co http://svn.greenstone.org/greenstone3/trunk greenstone3
|
---|
[15188] | 30 |
|
---|
[26777] | 31 |
|
---|
| 32 | Local Settings
|
---|
| 33 | --------------
|
---|
| 34 |
|
---|
| 35 | You will then need to make sure 'ant' (version 1.7 or greater) and 'javac'
|
---|
| 36 | (along with an appropriate JAVA_HOME environment variable) can be
|
---|
| 37 | found from your command line.
|
---|
| 38 |
|
---|
| 39 | To help with getting such local command-line settings right, we have
|
---|
| 40 | started to build up a set of 'local' folder examples available
|
---|
| 41 | on our svn server. You can browse these at:
|
---|
| 42 |
|
---|
| 43 | http://trac.greenstone.org/browser/local/
|
---|
| 44 |
|
---|
| 45 | For example, in the top-level folder of your Greenstone3 installation,
|
---|
| 46 | for a build on a 64-bit linux computer you might like to check out:
|
---|
| 47 |
|
---|
| 48 | svn co http://svn.greenstone.org/local/greenstone3/linux-64bit local
|
---|
| 49 |
|
---|
| 50 | You should then check files like 'local/gs3-setup.bash' and
|
---|
| 51 | 'local/gs3-devel.bash' and edit the values there, such as JAVA_HOME,
|
---|
| 52 | to reflect where such programs exist on your local filesystem.
|
---|
| 53 | to reflect where
|
---|
| 54 |
|
---|
| 55 | Prior to compiling, 'cd' into this folder and source the appropriate setup
|
---|
| 56 | file (the developer 'gs3-devel' file if it exists, as in the case of cross
|
---|
| 57 | compiling for Anroid), or else the 'gs3-setup' one (for instance gs-setup.sh,
|
---|
| 58 | gs-setup.bash, or setup.bash)
|
---|
| 59 |
|
---|
| 60 | For example:
|
---|
| 61 |
|
---|
| 62 | cd local
|
---|
| 63 | source ./gs3-setup.bash
|
---|
| 64 | cd ..
|
---|
| 65 |
|
---|
| 66 |
|
---|
[15188] | 67 | Build and install:
|
---|
[26777] | 68 | -----------------
|
---|
[15188] | 69 |
|
---|
[19839] | 70 | In the greenstone3 directory, check and/or edit the build.properties file. In
|
---|
| 71 | particular, set the Tomcat port number. See 'Configuring your installation' in
|
---|
| 72 | README.txt for more information.
|
---|
[15188] | 73 |
|
---|
[19839] | 74 | Note, initial checkouts from SVN have a build.properties.in file. Running
|
---|
| 75 | 'ant' will result in the build.properties file being generated from the .in
|
---|
| 76 | file (a straight copy).
|
---|
| 77 |
|
---|
| 78 | Then, run 'ant prepare install'. The two targets can be run separately if you
|
---|
| 79 | like.
|
---|
| 80 |
|
---|
| 81 | The 'prepare' target will download additional code (using SVN and http), so
|
---|
| 82 | you need to be online to run it. The 'install' target can be run offline.
|
---|
| 83 |
|
---|
| 84 | The prepare/install targets will ask you if you accept the properties before
|
---|
| 85 | starting.
|
---|
[15188] | 86 | To suppress this prompt, use the -Dproperties.accepted=yes flag. E.g.
|
---|
[19839] | 87 | ant -Dproperties.accepted=yes prepare install
|
---|
| 88 |
|
---|
[15188] | 89 | To log the output, run
|
---|
[19839] | 90 | ant -Dproperties.accepted=yes -logfile build.log prepare install
|
---|
[15188] | 91 |
|
---|
[19839] | 92 | On Windows, Visual Studio is used for compiling. The VCVARS32.bat script needs
|
---|
| 93 | to be run in the command prompt before compiling with "ant install".
|
---|
| 94 |
|
---|
| 95 | In the greenstone3 directory, you can run 'ant' which will give you a help
|
---|
| 96 | message.
|
---|
| 97 | Running 'ant -projecthelp' gives a list of the targets that you can run - these
|
---|
| 98 | do various things like compile the source code, start up the server etc.
|
---|
| 99 |
|
---|
[15188] | 100 | Extra Configuration notes:
|
---|
| 101 | --------------------------------------------------------------
|
---|
| 102 |
|
---|
| 103 | Greenstone 3 uses some parts of Greenstone 2 for collection building,
|
---|
| 104 | including external packages and the Librarian Interface. These will be
|
---|
| 105 | installed during the Greenstone 3 installation process. If you do not want
|
---|
[19839] | 106 | collection building capability, please set the disable.collection.building
|
---|
| 107 | property to true in build.properties.
|
---|
[15188] | 108 |
|
---|
| 109 |
|
---|
| 110 | Common install/update targets:
|
---|
| 111 | ---------------------------------------------------------------------
|
---|
| 112 | 1. Install for the first time from SVN:
|
---|
| 113 | svn co http://svn.greenstone.org/greenstone3/trunk greenstone3
|
---|
| 114 | cd greenstone3
|
---|
| 115 | ant prepare install
|
---|
| 116 |
|
---|
| 117 | 2. Install for the first time from SVN, mostly offline:
|
---|
| 118 | [online]
|
---|
| 119 | svn co http://svn.greenstone.org/greenstone3/trunk greenstone3
|
---|
| 120 | cd greenstone3
|
---|
| 121 | ant prepare
|
---|
| 122 | [offline]
|
---|
| 123 | ant install
|
---|
| 124 |
|
---|
| 125 | 3. Updating your Greenstone installation from SVN (and reconfigure/recompile):
|
---|
| 126 | cd greenstone3
|
---|
| 127 | ant update
|
---|
| 128 |
|
---|
| 129 | 4. Updating your Greenstone installation from SVN, mostly offline:
|
---|
| 130 | cd greenstone3
|
---|
| 131 | [online]
|
---|
| 132 | ant svnupdate
|
---|
| 133 | [offline]
|
---|
| 134 | ant -Dnosvn.mode=yes update
|
---|
| 135 |
|
---|