source: trunk/gsdl/INSTALL.TXT@ 1199

Last change on this file since 1199 was 1199, checked in by sjboddie, 24 years ago

* empty log message *

  • Property svn:keywords set to Author Date Id Revision
File size: 9.2 KB
Line 
1
2Greenstone installation instructions
3
4 Greenstone software:
5
6 * Unix
7 + Source distribution
8 + Building collections
9 * Windows
10 + Source distribution
11 + Binary distributions
12 + Building collections
13
14 Greenstone Collections
15
16 Other software:
17 * Perl for Windows
18 * Apache web server
19
20 For more information about how to use the software, consult The
21 Greenstone Digital Library Software manual.
22
23Unix source distribution
24
25 * Download the latest version of the source distribution
26 * Extract the gzipped tar archive (tar xvzf gsdl-xx.x.tgz); this
27 will create a directory gsdl into which all software is installed
28 * In the gsdl directory, type ./configure
29 * When the configure script has finished running, type make
30 * Type make install, which copies the compiled library file into the
31 gsdl/cgi-bin directory, and also installs several executables that
32 are used to build collections into gsdl/bin/$GSDLOS
33 * Move both library and the gsdlsite.cfg configuration file to your
34 system's cgi-bin directory, so that the library runs as a cgi
35 script
36 * Edit the gsdlsite.cfg configuration file to suit your site. Set
37 the gsdlhome field to point to your gsdl directory. Other fields
38 that may need changing are httpprefix (the web path to the gsdl
39 directory) and httpimg (the path to gsdl/images)
40 * Build the Demo Collection that comes with the distribution
41 * Access the Greenstone Digital Library home page at
42 http://localhost/cgi-bin/library (replace "localhost" by the
43 server's URL if your Internet browser is not running on the server
44 computer)
45 * If the Demo Collection does not appear on the home page, run
46 library from the Unix command line to generate debugging
47 information to help you locate the problem
48 * Access the administration page at
49 http://localhost/cgi-bin/library?a=status
50
51Windows source distribution
52
53 * Download the latest version of the source distribution--the same
54 source code as for Unix (though for Windows you may want to select
55 a zipped version)
56 * Extract the distribution using WinZip or a similar utility
57 * The default is to extract Greenstone directly into C:\ (i.e. a
58 directory C:\gsdl will be created into which all software is
59 installed)
60 * In the resulting gsdl directory type nmake win32.mak
61 * Type nmake /f win32.mak install, which copies the Web Library
62 version of library.exe into the gsdl\cgi-bin directory and the
63 Local Library version into the gsdl directory; it also installs
64 several executables that are used to build collections into
65 gsdl\bin\windows
66
67Windows binary distributions
68
69 Three separate binary distributions are available for Windows: the
70 Local Library, the Web Library, and the Collection Builder. First
71 decide which distribution you want; then:
72
73 * Download the latest version of the desired binary distribution
74 * Extract the distribution using WinZip or a similar utility
75 * The default is to extract Greenstone directly into C:\ (i.e. a
76 directory C:\gsdl will be created into which all software is
77 installed).
78 * If installing the Collection Builder as well as one of the
79 Libraries, be sure to extract both distributions in the same
80 directory. It is safe to allow files occurring in the second
81 distribution installed to overwrite those in the first.
82 * Follow the instructions below for the version you have downloaded:
83 Local Library
84 + Run the library.exe executable. This will automatically start
85 your Internet browser and load the Greenstone Digital Library
86 home page. The Demo collection should be accessible from this
87 page.
88 + Access the administration page at
89 http://localhost/cgi-bin/library?a=status
90 Web Library
91 + If Greenstone is not installed to C:\gsdl, edit the
92 gsdlsite.cfg configuration file (in the cgi-bin directory) by
93 setting the gsdlhome field to point to your gsdl directory
94 + If you do not already have a webserver, install Apache as
95 described below
96 + If using an existing webserver, check the gsdlsite.cfg
97 configuration file to ensure that httpprefix contains the web
98 path to the gsdl directory and httpimg contains the path to
99 gsdl\images
100 + The Greenstone Digital Library home page will appear as
101 http://localhost/cgi-bin/library (replace "localhost" by the
102 server's URL if your Internet browser is not running on the
103 server computer)
104 + If the Demo Collection does not appear on the home page, run
105 library.exe from the DOS prompt to generate debugging
106 information to help you locate the problem
107 + Access the administration page at
108 http://localhost/cgi-bin/library?a=status
109 Collection Builder
110 + If you do not already have Perl, you will need to install it
111 (see below)
112 + Download a test collection (e.g. the Demo Collection) and
113 build it
114 + Reload the Greenstone home page at
115 http://localhost/cgi-bin/library
116 + If the Demo Collection does not appear on the home page, run
117 library.exe from the DOS prompt to generate debugging
118 information to help you locate the problem
119
120Greenstone Collections
121
122 * Install Greenstone as described above
123 * Download the required collection. Collection distributions with
124 filenames like ***_prebuilt.zip are pre-built collections. All
125 others will require building.
126 * Extract the .zip or .tgz file to your gsdl/collect directory
127 * Build the collection if it was not pre-built
128
129 Once a new collection has been built, Greenstone will automatically
130 notice it and include it on the home page (when you click Reload).
131
132 Building Greenstone Collections on Unix
133 * Source setup.bash or setup.csh from within the gsdl directory to
134 set up environment variables and path (e.g. source setup.bash)
135 * Note that pwd is used to set $GSDLHOME. If you need to be able to
136 source setup.bash or setup.csh from a directory other than gsdl
137 (e.g. from your .profile or .bashrc) you will need to edit the
138 script.
139 * Run build colname, where colname is the directory name of your
140 collection (e.g. demo).
141
142 Building Greenstone Collections on Windows
143 * Make sure the setup.bat batch file is correct (i.e. that it sets
144 the GSDLHOME environment variable to the correct path of your gsdl
145 directory)
146 * run setup.bat
147 * Run build colname, where colname is the directory name of your
148 collection (e.g. demo).
149
150 To find out more about building collections, consult The Greenstone
151 Digital Library Software manual.
152
153Perl for Windows
154
155 * Download Perl (pre-5.6 version)
156 * Doubleclick the self-extracting executable and follow instructions
157
158The Apache Webserver
159
160 * Download the latest version of the Apache distribution
161 * Doubleclick the self-extracting executable and follow instructions
162 * Configure Apache for use with Greenstone by adding the following
163 to your Apache server's httpd.conf configuration file (which
164 resides in the Apache conf directory)
165 * Existing server configurations may need to be configured
166 differently--see your system administrator if necessary
167 _____________________________________________________________
168
169 # Some NT installations complain about an inability to work
170 ServerName
171 # out for themselves -- on most systems you can leave it commented
172 out.
173 # "localhost" should be replaced by www.yourserver.com if you plan
174 # to serve Greenstone to anyone other than the local machine.
175 # ServerName localhost
176 # Make cgi-bin point to your Greenstone cgi-bin directory.
177 # Note the forward
178 # slashes (/) instead of standard Windows
179 # backslashes (\) -- a hangover from Apache's Unix roots.
180 ScriptAlias /cgi-bin/ "c:/gsdl/cgi-bin/"
181 <Directory "c:/gsdl/cgi-bin">
182 AllowOverride None
183 Options None
184 </Directory>
185 # DocumentRoot points to your Greenstone root directory.
186 # Make sure that httpd.conf doesn't contain any other DocumentRoot
187 # directives -- if they come after this they'll override it
188 DocumentRoot "c:/gsdl"
189 <Directory "c:/gsdl">
190 Allow from All
191 </Directory>
192 # Redirect http://localhost to http://localhost/cgi-bin/library
193 # "localhost" should be replaced by www.yourserver.com if you plan
194 # to serve Greenstone to anyone other than the local machine.
195 Redirect /index.html http://localhost/cgi-bin/library
196 _____________________________________________________________
Note: See TracBrowser for help on using the repository browser.