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

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 gsdl. 

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/gli/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
2. make
3. make install

This will install the library.cgi and oaiserver.cgi executables to 
Greenstone/cgi-bin. 
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 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.

You'll need to install Apache and set it up 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.  

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]

The major difference between compiling with VC++ 4.2 compared with 
VC++ 6.0/2005 is that 4.2 must use the STLport standard template library 
(packaged with Greenstone) while VC++ 6.0/2005 may use its own built in 
STL implementation.

Perform the following steps to compile and install Greenstone. Note that
some parts of the process described are specific to one or other of the two
compilation options mentioned above. These steps are marked as such.

1. Unzip the following zip archives (into the directories in which the
   zip files themselves are contained).

   * Greenstone\common-src\indexers\packages\windows\iconv\iconv.zip
   * Greenstone\common-src\packages\windows\gdbm\gdbm.zip
   * Greenstone\common-src\packages\windows\crypt\crypt.zip
   * Greenstone\common-src\packages\windows\stlport\stlport.zip (VC++ 4.2 only)

2. To use VC++ command line tools you may need to execute the
   MSDEV\BIN\VCVARS32.BAT batch file to set up your environment.

3. cd to the top level Greenstone directory (i.e. the directory where 
   this file lives).

4. compile the web library (library.cgi) and OAI server (oaiserver.cgi) with
   "nmake /f win32.mak GSDL_VC4=1" (VC++ 4.2)
   or
   "nmake /f win32.mak" (VC++ 6.0/2005)

5. compile the local library (server.exe) with
   "nmake /f win32.mak GSDL_VC4=1 LOCAL_LIBRARY=1" (VC++ 4.2)
   or
   "nmake /f win32.mak LOCAL_LIBRARY=1" (VC++ 6.0/2005)

This will install library.cgi and oaiserver.cgi to the Greenstone\cgi-bin 
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.