source: trunk/gsdl/INSTALL.TXT@ 1162

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

added README.TXT and INSTALL.TXT to cvs - they were generated by running
lynx -dump -nolist on DOWNLOAD.html and INSTALL.html respectively

  • Property svn:keywords set to Author Date Id Revision
File size: 8.9 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). If installing the Collection Builder as well as one of
78 the Libraries, be sure to extract both distributions to the same
79 directory
80 * If Greenstone is not installed to C:\gsdl, edit the gsdlsite.cfg
81 configuration file (in the cgi-bin directory) by setting the
82 gsdlhome field to point to your gsdl directory
83 * Follow the instructions below for the version you have downloaded:
84 Local Library
85 + Run the library.exe executable. This will automatically start
86 your Internet browser and load the Greenstone Digital Library
87 home page. The Demo collection should be accessible from this
88 page.
89 + Access the administration page at
90 http://localhost/cgi-bin/library?a=status
91 Web Library
92 + If you do not already have a webserver, install Apache as
93 described below
94 + If using an existing webserver, check the gsdlsite.cfg
95 configuration file to ensure that httpprefix contains the web
96 path to the gsdl directory and httpimg contains the path to
97 gsdl\images
98 + The Greenstone Digital Library home page will appear as
99 http://localhost/cgi-bin/library (replace "localhost" by the
100 server's URL if your Internet browser is not running on the
101 server computer)
102 + If the Demo Collection does not appear on the home page, run
103 library.exe from the DOS prompt to generate debugging
104 information to help you locate the problem
105 + Access the administration page at
106 http://localhost/cgi-bin/library?a=status
107 Collection Builder
108 + If you do not already have Perl, you will need to install it
109 (see below)
110 + Download a test collection (e.g. the Demo Collection) and
111 build it
112 + Reload the Greenstone home page at
113 http://localhost/cgi-bin/library
114 + If the Demo Collection does not appear on the home page, run
115 library.exe from the DOS prompt to generate debugging
116 information to help you locate the problem
117
118Greenstone Collections
119
120 * Install Greenstone as described above
121 * Download the required collection. Collection distributions with
122 filenames like ***_prebuilt.zip are pre-built collections. All
123 others will require building.
124 * Extract the .zip or .tgz file to your gsdl/collect directory
125 * Build the collection if it was not pre-built
126
127 Once a new collection has been built, Greenstone will automatically
128 notice it and include it on the home page (when you click Reload).
129
130 Building Greenstone Collections on Unix
131 * Source setup.bash or setup.csh from within the gsdl directory to
132 set up environment variables and path (e.g. source setup.bash)
133 * Note that pwd is used to set $GSDLHOME. If you need to be able to
134 source setup.bash or setup.csh from a directory other than gsdl
135 (e.g. from your .profile or .bashrc) you will need to edit the
136 script.
137 * Run build.sh colname, where colname is the directory name of your
138 collection (e.g. demo).
139
140 Building Greenstone Collections on Windows
141 * Make sure the setup.bat batch file is correct (i.e. that it sets
142 the GSDLHOME environment variable to the correct path of your gsdl
143 directory)
144 * run setup.bat
145 * Run build colname, where colname is the directory name of your
146 collection (e.g. demo).
147
148 To find out more about building collections, consult The Greenstone
149 Digital Library Software manual.
150
151Perl for Windows
152
153 * Download Perl (pre-5.6 version)
154 * Doubleclick the self-extracting executable and follow instructions
155
156The Apache Webserver
157
158 * Download the latest version of the Apache distribution
159 * Doubleclick the self-extracting executable and follow instructions
160 * Configure Apache for use with Greenstone by adding the following
161 to your Apache server's httpd.conf configuration file (which
162 resides in the Apache conf directory)
163 * Existing server configurations may need to be configured
164 differently--see your system administrator if necessary
165 _____________________________________________________________
166
167 # Some NT installations complain about an inability to work
168 ServerName
169 # out for themselves -- on most systems you can leave it commented
170 out.
171 # "localhost" should be replaced by www.yourserver.com if you plan
172 # to serve Greenstone to anyone other than the local machine.
173 # ServerName localhost
174 # Make cgi-bin point to your Greenstone cgi-bin directory.
175 # Note the forward
176 # slashes (/) instead of standard Windows
177 # backslashes (\) -- a hangover from Apache's Unix roots.
178 ScriptAlias /cgi-bin/ "c:/gsdl/cgi-bin/"
179 <Directory "c:/gsdl/cgi-bin">
180 AllowOverride None
181 Options None
182 </Directory>
183 # DocumentRoot points to your Greenstone root directory.
184 # Make sure that httpd.conf doesn't contain any other DocumentRoot
185 # directives -- if they come after this they'll override it
186 DocumentRoot "c:/gsdl"
187 <Directory "c:/gsdl">
188 Allow from All
189 </Directory>
190 # Redirect http://localhost to http://localhost/cgi-bin/library
191 # "localhost" should be replaced by www.yourserver.com if you plan
192 # to serve Greenstone to anyone other than the local machine.
193 Redirect /index.html http://localhost/cgi-bin/library
194 _____________________________________________________________
Note: See TracBrowser for help on using the repository browser.