source: main/trunk/greenstone2/Install.txt@ 30562

Note: more up-to-date notes may be available on our website, at
 http://wiki.greenstone.org/wiki/index.php/Installing_Greenstone

The following instructions assume the top level Greenstone folder is called
Greenstone (which is the standard name used for Greenstone 2 releases). 
If you have got Greenstone from SVN, the top level directory will be greenstone2. 

The Greenstone Librarian Interface (GLI) code will be in the gli folder inside
the Greenstone folder. If you are using SVN and you want to use the GLI to 
build collections, you'll need to check it out by running
 svn checkout http://svn.greenstone.org/main/trunk/gli
in the Greenstone folder.

-- Compiling and installing on Unix --

cd to the top level Greenstone directory (i.e. the directory 
where this file lives) and perform the following three steps.

1. ./configure --enable-apache-httpd
2. make
3. make install

This will install the library.cgi and oaiserver.cgi executables to 
Greenstone/cgi-bin/linux. 
If you want to run Greenstone from a system 
cgi-bin directory you'll need to move the library executable and 
gsdlsite.cfg from Greenstone/cgi-bin/linux to your system cgi-bin.

Note that the Greenstone directory structure is important to the operation
of the software. Therefore the --prefix, --bindir etc. options to configure
make no sense and will have no effect. If you want Greenstone to be
installed somewhere specific (say /usr/local) you'll need to move the
entire Greenstone directory there.

Greenstone will install Apache into apache-httpd/linux. You can disable this 
by running ./configure without the -enable-apache-httpd option. In that case 
you'll need to set up your own apache to serve Greenstone. See   See 
http://wiki.greenstone.org/wiki/index.php/Setting_up_an_Apache_Web_Server_for_Greenstone_2_Walkthrough
for more details.  

To compile the GLI, cd to the gli directory and run makegli.sh

-- Compiling on Windows --

Greenstone has been successfully compiled using Microsoft Visual C++
versions 4.2, 6.0 and 2005. If anyone succeeds in compiling Greenstone with
another compiler (or another version of VC++) we'd appreciate hearing about
it at [email protected]

If you have got Greenstone from svn, you'll also need to download some Windows binaries.
1. cd to top-level greenstone2 folder.
2. cd bin
3. svn co http://svn.greenstone.org/main/trunk/binaries/windows/bin windows


There is a batch script you can run to set up and compile Greenstone.

If you want Greenstone to try and guess your Visual Studio setup, edit the 
makegs2.bat file and set SET_GS_ENV to true. Otherwise you'll need to set up 
your Visual Studio environment before running the make script.
For example, run
C:\Program Files\Microsoft Visual Studio\vc\vcvarsall.bat

To compile greenstone:
For 64 bit machines, run 
   * makegs2x64.bat
For 32 bit machines, run
   * makegs2.bat



For more information about compiling Greenstone, or for manual compling 
instructions, see
http://wiki.greenstone.org/wiki/index.php/Compiling_Greenstone

These scripts will unpack necessary zip files, set up paths etc, then compile 
Greenstone. They will install library.cgi and oaiserver.cgi to the 
Greenstone\cgi-bin\windows 
directory and server.exe to the top level Greenstone directory. 

To run the web library you'll need to set up a web server to serve Greenstone. 
Then you'll need to edit Greenstone\cgi-bin\gsdlsite.cfg. See 
http://wiki.greenstone.org/wiki/index.php/Setting_up_an_Apache_Web_Server_for_Greenstone_2_Walkthrough
for more details about using Apache, or 
http://wiki.greenstone.org/wiki/index.php/Installing_Greenstone#How_do_I_use_Greenstone.27s_web_library_with_IIS.3F
for more details about using IIS.

To compile the GLI, cd to the gli directory and run makegli.bat.