source: main/trunk/release-kits/shared/greenstone2/docs/READMEen.txt@ 28205

Last change on this file since 28205 was 28205, checked in by kjdon, 9 years ago

updated some things

File size: 6.7 KB
Line 
1Title Greenstone digital library software
2
3Purpose
4 A suite of digital library software which includes the ability to
5 serve digital library collections and build new collections
6
7Author New Zealand Digital Library Project
8
9License
10 GNU General Public Licence (Version 2)
11 Full terms and conditions are in the file "LICENSE.txt"
12
13Date December 2008
14
15Version svn-trunk
16
17Contents: Programs
18
19 Greenstone library server
20 A cgi program to serve digital library collections
21
22 Greenstone server interface (GSI)
23 A graphical interface to start/stop the library server (see notes below)
24
25 Greenstone oaiserver
26 A cgi program to serve collections using the OAI-PMH protocol.
27
28 Greenstone Librarian Interface (GLI)
29 A graphical tool for collection building
30
31 Greenstone Editor for Metadata Sets (GEMS)
32 A graphical tool for creating and editing metadata sets used by GLI
33
34Contents: Directory Structure
35
36 bin Executable code
37 cgi-bin CGI scripts
38 collect Collections
39 etc Configuration files, log files, user databases etc
40 gli Librarian Interface
41 images Images and CSS files used by the interface
42 macros Display macros
43 mappings Unicode translation tables
44 perllib Perl modules used for collection building
45
46 If source code is present (from a source release or by adding the
47 source component):
48
49 common-src Source code and packages used when building collections and at
50 runtime
51 build-src Source code and packages only used when building collections
52 runtime-src Source code and packages only used at runtime
53
54Contents: Additional Packages (available only in full binary releases)
55
56 Java Runtime 1.6 (installer release only)
57 ImageMagick
58 Ghostscript (Windows, Mac only)
59 Perl (Windows only)
60
61Documentation and Support
62 Greenstone Website:
63 http://www.greenstone.org
64 Greenstone's main website.
65 Greenstone Wiki:
66 http://wiki.greenstone.org
67 Contains documentation, and links to manuals, tutorials etc.
68 Greenstone Mailing List:
69 (to subscribe)
70 http://list.waikato.ac.nz/mailman/listinfo/greenstone-users
71 (to post)
72 greenstone-users@list.waikato.ac.nz
73 New Zealand Digital Library:
74 http://www.nzdl.org
75 A demonstration site containing lots of collections
76
77
78Platform
79 Greenstone runs on Unix, Windows 2000/XP/2003/Vista/2008 and
80 Mac OS 10.5.2 (Leopard).
81
82 The Greenstone Librarian Interface requires version 1.5 or later
83 of the Java Runtime Environment. Java 1.6 is included in binary
84 releases of Greenstone.
85
86 The Greenstone user interface uses a Web browser capable of Javascript,
87 Tables, and Frames. Browsers that meet these requirements include:
88
89 Netscape Navigator 4.0
90 Internet Explorer 4.0
91 Mozilla
92 Safari
93
94 More recent versions of these browsers should also work (recommended).
95
96Unix
97 Source code has been compiled and tested on the following
98 distributions:
99
100 Ubuntu 8.04 & 8.10
101 Mandriva 2008 Spring
102 OpenSUSE 11
103 Fedora 6 & 9
104 CentOS 5.2
105
106
107Windows
108 Source code can be compiled with Microsoft Visual C++ 6.0, 7
109 (VS 2003.Net), 8 (VS 2005 Pro or VC++ Express 2005 with Microsoft
110 Platform SDK 2003 R2).
111
112 Binary code has been tested on 32 bit versions of:
113 Windows 2000
114 Windows XP
115 Windows Server 2003
116 Windows Vista
117 Windows Server 2008
118
119 Greenstone software (version 2.81 and later) no longer runs on
120 Windows 3.1
121 Windows 95
122 Windows 98
123 Windows Me
124 Windows NT
125
126Mac
127 Source code has been compiled with Xcode 3.1 on Intel Mac OS 10.5.2.
128 Binary has been tested on Intel Mac OS 10.5.2 (Leopard).
129
130 However the source code can be compiled with other versions of Mac OS
131 and Xcode, in that case please download Imagemagick and Ghostscript to
132 recompile them from source.
133
134
135
136The Greenstone Server Interface (GSI)
137
138 This is the application with a graphical user interface that allows you to
139 stop and start greenstone's Local Library Server (LLS) and change a few
140 settings like the server's port number. On Linux and Mac it uses the apache
141 web server that comes with Greenstone and on Windows it uses a separate
142 server program.
143
144 The Greenstone 2.8x binary release comes with the Local Library Server
145 ready for use.
146
147 If you're on Windows, then you can click on the Greenstone Server shortcut
148 in your Start Menu to run it.
149
150 If on Linux, you run it by executing the following from your Greenstone
151 installation directory:
152
153 ./gs2-server.sh
154
155 This starts up the Greenstone Server Interface (GSI). Certain server
156 settings can be changed through its File > Settings menu.
157
158 For instructions on how to compile up the Local Library Server on Unix
159 systems and for further details on how to start the server through the
160 command line (without using the graphical interface of the GSI application),
161 see below.
162
163
164Local Library Server (LLS) on LINUX AND MAC
165 We've not tested the Local Library Server on Unix systems other than Linux
166 and Mac, but you can try the following out.
167
168 SUMMARY
169 1. If you're compiling and running it, run the following in sequence from your Greenstone installation directory:
170 ./configure --enable-apache-httpd
171 make
172 make install
173
174 2.a Then you can launch the GSI graphical user application with:
175 ./gs2-server.sh
176
177 2.b OR
178 If working on the command-line, you first need to configure the server
179 after compilation with:
180 ./gsicontrol.sh configure-web
181 Then run it with:
182 ./gsicontrol.sh web-start
183 To stop it, use:
184 ./gsicontrol.sh web-stop
185
186 (If your Unix system can handle Makefiles, you can issue simila
187 commands to "make" as to gsicontrol.sh:
188 make configure-web
189 make web-start
190 make web-stop)
191
192 For a list of all commands that the gsi-control script takes (which is
193 what the Makefile ends up calling anyway), type
194 ./gsicontrol.sh
195 This script can be used to change your Greenstone Admin password and
196 change the port number of your server. The same commands can also be
197 issued by running "make <command>", if your Unix machine can handle
198 Makefiles.
199 Some of this functionality to control the Local Library Server is also
200 available through the graphical GSI application, from its
201 File > Settings menu.
202
203
204 If you've started the Local Libary Server, you can view the collections and
205 the documents it serves up by going to your digital library home. This is at
206 a URL that is of the form:
207 http://localhost:<portnumber>/greenstone/cgi-bin/library.cgi
208 by default it will try to use port 80 if this is available and accessible.
209 If you're using the GSI application and port 80 is in use, it will assign a
210 new one. Alternatively, you can change the port number
211 - through the File > Settings menu of the GSI application.
212 - or change it in the llssite.cfg file located in the Greenstone
213 installation directory and then run
214 ./gsicontrol.sh configure-apache
215
216 The GSI application will launch the library home page for you in your
217 browser if you click the button marked "Enter Library" or "Restart Library".
Note: See TracBrowser for help on using the repository browser.