root/release-kits/shared/greenstone2/docs/READMEen.txt @ 19457

Revision 19457, 6.6 KB (checked in by oranfry, 11 years ago)

updates to the english README

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