Ignore:
Timestamp:
2005-06-15T16:14:06+12:00 (19 years ago)
Author:
kjdon
Message:

more info about installation

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/gsdl3/README.txt

    r10105 r10117  
    2727Greenstone is built and installed using Ant (Apache's Java based build tool,
    2828http://ant.apache.org). You will need a Java Development
    29 Environment (1.4 or higher), and Ant installed to use Greenstone. You can download Ant from http://ant.apache.org/bindownload.cgi. Set the environment variable JAVA_HOME to be the root of your Java installation. We recommend Sun's Java.
     29Environment (1.4 or higher), and Ant installed to use Greenstone. You can download Ant from http://ant.apache.org/bindownload.cgi. Set the environment variable JAVA_HOME to be the root of your Java installation. We recommend Sun's Java. Greenstone 3 has not been tested with other types of Java.
    3030
    3131In the gsdl3 directory, you can run 'ant' which will give you a help message.
    … …  
    3333do various things like compile the source code, startup the server etc.
    3434
    35 For a first time install, run 'ant install'.
     35For a first time install, run 'ant prepare install'.
    3636
    37 The file build.properties contains various parameters that can be set by the user. Please check these settings before running 'ant install'.
    38 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.
     37The file build.properties contains various parameters that can be set by the user. Please check these settings before running the install.
    3938
    40  The install process will ask you if you accept the properties before starting.
    41 For a  non-interactive version of the install, run
    42 ant -Dproperties.accepted=yes install
     39Greenstone 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 colleciton building at all, set the gsdl2.installed.path to any non-empty string.
     40
     41 The prepare target will ask you if you accept the properties before starting.
     42To suppress this prompt, use the -Dproperties.accepted=yes flag. E.g.
     43ant -Dproperties.accepted=yes prepare install
    4344
    4445To log the output in build.log, run
    45 ant -Dproperties.accepted=yes -logfile build.log install
     46ant -Dproperties.accepted=yes -logfile build.log prepare install
     47
     48The prepare target will download additional code, so you need to be online to run it. install can be run offline.
    4649
    4750Under 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.)
     51
     52Common install/update targets.
     53-------------------------------
     541. Install for the first time:
     55cvs co gsdl3
     56ant prepare install
     57
     582. Install for the first time, offline:
     59[online]
     60cvs co gsdl3
     61ant prepare
     62[offline]
     63ant install
     64
     653. Updating your Greenstone installation from cvs:
     66ant update
     67
     684. Updating your Greenstone installation, offline:
     69[online]
     70ant cvsupdate
     71[offline]
     72ant -Doffline.mode=yes update
     73
     74The main targets for installation/update are:
     75configure, configure-c++, clean, compile.
     76Any sub targets can be run by themselves. Run 'ant -projecthelp' for a list of public targets, otherwise you can look at the build.xml file to see which targets depend on other ones.
    4877
    4978Running Greenstone:
    5079-------------------
    5180
    52 To startup the servers, run 'ant start'. 'ant restart' and 'ant stop' restarts and shuts down the servers. To start or stop just Tomcat or MYSQL, use the start-tomcat, start-mysql, stop-tomcat, stop-mysql targets.
     81To startup the local servers, run 'ant start'. 'ant restart' and 'ant stop' restarts and shuts down the servers. To start or stop just Tomcat or MYSQL, use the start-tomcat, start-mysql, stop-tomcat, stop-mysql targets.
     82These will only start/stop local servers (ones installed by Greenstone). You will need to manually start/stop external Tomcat/mysql.
    5383
    5484On Windows, if you have installed a binary version, you can also start Greenstone by selecting Greenstone 3 Digital Library from the Start menu.
    5585
    5686Greenstone will be available in a browser at "http://localhost:8080/gsdl3".
     87
     88You can change the port number by changing the tomcat.port property in build.properties, then running 'ant configure'.
     89
    5790
    5891Using SOAP (Linux and Windows):
    … …  
    105138
    106139If you want to use an existing Tomcat, set the path to its base directory
    107 in build.properties (tomcat.installed.path). Then run 'ant install'. If you have already done an install (e.g. using a local Tomcat), you don't need to do it again.
     140in build.properties (tomcat.installed.path). Then run 'ant prepare install'. If you have already done an install (e.g. using a local Tomcat), you don't need to do it again.
    108141
    109142 You will need to modify the Tomcat setup slightly.
    … …  
    117150
    118151B. Alternatively, you can move (and rename) the gsdl3/web directory to tomcat/webapps/gsdl3 (i.e. the resulting directories will be like
    119 tomcat/webapps/gsdl3/WEB-INF, no web directory). This should be done after running 'ant install'.
     152tomcat/webapps/gsdl3/WEB-INF, no web directory). This should be done after running the initial 'ant prepare install'.
    120153You will need to set the web.home property in the build.properties file
    121154i.e.
    122155web.home=${tomcat.installed.path}/webapps/gsdl3
    123 And then run 'ant configure-web-gsdl3' to reset gsdl3home.
     156And then run 'ant configure' to reset gsdl3home.
    124157
    1251582. Set up the JNI libraries and Java wrappers.
    … …  
    131164A: Keep all the Greenstone stuff inside the gsdl3 directory, and just modify the environment that Tomcat runs in
    132165
    133 set LD_LIBRARY_PATH (linux) or PATH (windows) to include gsdl3/lib/jni directory.
    134 add all the jar files in gsdl3/lib/jni directory to the CLASSPATH, then edit tomcats setclasspath.sh/bat to use the system CLASSPATH.
     166Set LD_LIBRARY_PATH (linux) or PATH (windows) to includethe gsdl3/lib/jni directory.
     167Add all the jar files in gsdl3/lib/jni directory to the CLASSPATH, then edit tomcats setclasspath.sh/bat to use the system CLASSPATH.
    135168(in setclasspath.bat, change
    136169set CLASSPATH=%JAVA_HOME%\lib\tools.jar
Note: See TracChangeset for help on using the changeset viewer.