root/main/trunk/greenstone3/README-SVN.txt @ 26467

Revision 20090, 3.5 KB (checked in by kjdon, 10 years ago)

changed ant version

Line 
1Greenstone 3 (GSDL3)
2Copyright (C) 2003 New Zealand Digital Libraries, University Of Waikato
3Greenstone3 comes with ABSOLUTELY NO WARRANTY; for details see LICENSE.txt
4This is free software, and you are welcome to redistribute it
5
6These are some extra notes for installing Greenstone from SVN. Please also
7read the README.txt file for general information as almost all of that applies
8here too.
9
10You will need Java and Ant to run Greenstone 3.
11
12Your Java version should be 1.4 or higher. We recommend Sun Java. You need the
13SDK (development environment). Set the environment variable JAVA_HOME to be
14the root of your Java installation.
15
16Ant (Apache's Java based build tool) can be downloaded from
17http://ant.apache.org/bindownload.cgi. Set the environment variable
18ANT_HOME to be the root of your Ant installation, and make sure the Ant
19executables are on your PATH.
20Greenstone 3 requires Ant 1.7.1 or higher.
21
22Installing Greenstone from an SVN checkout:
23---------------------------------------------------------------------
24
25Make sure an SVN executable is on your PATH.
26
27Checkout the code:
28
29svn co http://svn.greenstone.org/greenstone3/trunk greenstone3
30
31Build and install:
32
33
34In 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.
37
38Note, 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
40file (a straight copy).
41
42Then, run 'ant prepare install'. The two targets can be run separately if you
43like.
44
45The 'prepare' target will download additional code (using SVN and http), so
46you need to be online to run it. The 'install' target can be run offline.
47
48The prepare/install targets will ask you if you accept the properties before
49starting.
50To suppress this prompt, use the -Dproperties.accepted=yes flag. E.g.
51ant -Dproperties.accepted=yes prepare install
52
53To log the output, run
54ant -Dproperties.accepted=yes -logfile build.log prepare install
55
56On Windows, Visual Studio is used for compiling. The VCVARS32.bat script needs
57to be run in the command prompt before compiling with "ant install".
58
59In the greenstone3 directory, you can run 'ant' which will give you a help
60message.
61Running 'ant -projecthelp' gives a list of the targets that you can run - these
62do various things like compile the source code, start up the server etc.
63
64Extra Configuration notes:
65--------------------------------------------------------------
66
67Greenstone 3 uses some parts of Greenstone 2 for collection building,
68including external packages and the Librarian Interface. These will be
69installed during the Greenstone 3 installation process. If you do not want
70collection building capability, please set the disable.collection.building
71property to true in build.properties.
72
73
74Common install/update targets:
75---------------------------------------------------------------------
761. Install for the first time from SVN:
77svn co http://svn.greenstone.org/greenstone3/trunk greenstone3
78cd greenstone3
79ant prepare install
80
812. Install for the first time from SVN, mostly offline:
82[online]
83svn co http://svn.greenstone.org/greenstone3/trunk greenstone3
84cd greenstone3
85ant prepare
86[offline]
87ant install
88
893. Updating your Greenstone installation from SVN (and reconfigure/recompile):
90cd greenstone3
91ant update
92
934. Updating your Greenstone installation from SVN, mostly offline:
94cd greenstone3
95[online]
96ant svnupdate
97[offline]
98ant -Dnosvn.mode=yes update
99
Note: See TracBrowser for help on using the browser.