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

Revision 26777, 4.7 KB (checked in by davidb, 7 years ago)

Additional information added about the new 'local' area on the SVN server

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
29  svn co http://svn.greenstone.org/greenstone3/trunk greenstone3
30
31
32Local Settings
33--------------
34
35You 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
37found from your command line.
38
39To help with getting such local command-line settings right, we have
40started to build up a set of 'local' folder examples available
41on our svn server.  You can browse these at:
42
43  http://trac.greenstone.org/browser/local/
44
45For example, in the top-level folder of your Greenstone3 installation,
46for 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
50You should then check files like 'local/gs3-setup.bash' and
51'local/gs3-devel.bash' and edit the values there, such as JAVA_HOME,
52to reflect where such programs exist on your local filesystem.
53to reflect where
54
55Prior to compiling, 'cd' into this folder and source the appropriate setup
56file (the developer 'gs3-devel' file if it exists, as in the case of cross
57compiling for Anroid), or else the 'gs3-setup' one (for instance gs-setup.sh,
58gs-setup.bash, or setup.bash)
59
60For example:
61
62  cd local
63  source ./gs3-setup.bash
64  cd ..
65
66
67Build and install:
68-----------------
69
70In 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.
73
74Note, 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
76file (a straight copy).
77
78Then, run 'ant prepare install'. The two targets can be run separately if you
79like.
80
81The 'prepare' target will download additional code (using SVN and http), so
82you need to be online to run it. The 'install' target can be run offline.
83
84The prepare/install targets will ask you if you accept the properties before
85starting.
86To suppress this prompt, use the -Dproperties.accepted=yes flag. E.g.
87ant -Dproperties.accepted=yes prepare install
88
89To log the output, run
90ant -Dproperties.accepted=yes -logfile build.log prepare install
91
92On Windows, Visual Studio is used for compiling. The VCVARS32.bat script needs
93to be run in the command prompt before compiling with "ant install".
94
95In the greenstone3 directory, you can run 'ant' which will give you a help
96message.
97Running 'ant -projecthelp' gives a list of the targets that you can run - these
98do various things like compile the source code, start up the server etc.
99
100Extra Configuration notes:
101--------------------------------------------------------------
102
103Greenstone 3 uses some parts of Greenstone 2 for collection building,
104including external packages and the Librarian Interface. These will be
105installed during the Greenstone 3 installation process. If you do not want
106collection building capability, please set the disable.collection.building
107property to true in build.properties.
108
109
110Common install/update targets:
111---------------------------------------------------------------------
1121. Install for the first time from SVN:
113svn co http://svn.greenstone.org/greenstone3/trunk greenstone3
114cd greenstone3
115ant prepare install
116
1172. Install for the first time from SVN, mostly offline:
118[online]
119svn co http://svn.greenstone.org/greenstone3/trunk greenstone3
120cd greenstone3
121ant prepare
122[offline]
123ant install
124
1253. Updating your Greenstone installation from SVN (and reconfigure/recompile):
126cd greenstone3
127ant update
128
1294. Updating your Greenstone installation from SVN, mostly offline:
130cd greenstone3
131[online]
132ant svnupdate
133[offline]
134ant -Dnosvn.mode=yes update
135
Note: See TracBrowser for help on using the browser.