Greenstone Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Greenstone 2.87 Release Notes ======

**Release Name:** 2.87

**Release Date:** 01 October 2017

** Released: **
  * Greenstone v2.87: The official Greenstone 2.87. 01 Oct 2017 \\ Binaries for Windows, GNU/Linux 32 and 64 bit, Mac Mountain Lion and Mac El Capitan. Mac Mountain Lion and 32 bit linux binaries were only spot tested. The other 3 binaries were tested more extensively. The sole Windows binary is, as usual, for both 32 and 64 bit machines and was largely tested on **Windows 10** this time.\\ [[http://svn.greenstone.org/main/tags/2.87/|svn tag page]] [[http://trac.greenstone.org/browser/main/tags/2.87|trac tag page]].  Code revision up to 32016/32017. Tag revision: 32020.

** Release Candidate History **
  * //**Greenstone v2.87rc1:**// Release Candidate 1. 25 September 2017 \\ Binaries for Windows, GNU/Linux 32 and 64 bit, Mac El Capitan (10.11) and Mountain Lion (10.8). The 32 bit Linux and the Mac Mountain Lion binaries have only been spot tested. \\  [[http://svn.greenstone.org/main/tags/2.87rc1/|svn tag page]] [[http://trac.greenstone.org/browser/main/tags/2.87rc1|trac tag page]]. Tag revision: 31996. Actual binary release revision: 31990.

===== Installation Instructions=====

There's a choice between: 
  * installing **binaries**, which are precompiled. Choose the one for your Operating System:
    * Windows 32 bit binary, which is for both 32 and 64 bit Windows machines
    * Linux 32 bit binary for 32 bit Linux architectures
    * Linux 64 bit binary for 64 bit Linux architectures 
    * MacOS binary for Mountain Lions (10.8) will probably work on Lions (10.7) as well
    * MacOS El Capitan (10.11) binary. You could try this on the older Yosemite and Maverick MacOS, though  we have not tested the El Capitan binary on those.
  * topping up your binary with the source code if you ever decide you want the source: download the **source component**,
  * going straight for the source code to compile Greenstone from scratch: download the **source distribution**


==== Binary distribution ====
Download from www.greenstone.org/download.

Upon downloading the installer, run the executable: On Windows and Mac you need to double-click it to launch the installation dialog, on Linux you first need to set the downloaded executable's permissions to executable before you can run it from the terminal.

It may take some time for the Greenstone installation dialog to appear. Once the installation dialog displays, you generally need to keep pressing the Next button until it is finished. However, when it asks for the location to install Greenstone in, make sure to choose a location on your file system for which you have access privileges. If you want to install Greenstone into C:\Program Files on Windows 7 or Windows Vista you will need to run the installer with administrator permissions (this can be achieved by right clicking on the installer and choosing "Run as administrator"). And if you wish to use the Greenstone Administration pages (which will be needed if you want to create user accounts for a Remote Greenstone server), then now is a good time to set a sensible password for that. It has to be between 3 and 8 characters long.

  * The installer initially unpacks into a temporary directory (/tmp on linux). Set the TMPDIR environment variable to change this.
  * The windows version can be installed anywhere, including paths with spaces and brackets (these caused a problem in releases prior to 2.85).
  * **The Linux and Mac versions must be installed into a path with *no* spaces.**

=== 2.87 on Linux 64 ===
If you get the error ''/bin/sh: 1: ./jre_bin_x64: not found'', please run with the -extract option:
<code>./Greenstone-2.87-linux-x64 -extract</code>
This just extracts the Greenstone jar file, and doesn't try to use the bundled jre to run it.
Then you can run <code>java -jar greenstone.jar [text]</code> to run the installer. The optional text argument will run in text mode, instead of running the graphical installer.

==== Installing in text-only mode ====
* Refer to [[http://wiki.greenstone.org/doku.php?id=en:user_advanced:installation#running_the_installer_in_text-only_mode|Running the installer in text-only mode]].


==== Adding source code to a binary release ==== 
Make sure to select the "Greenstone 2" tab of:
  * [[http://wiki.greenstone.org/doku.php?id=en:user_advanced:installation#source_component|Windows: Source Component instructions]]
  * [[http://wiki.greenstone.org/doku.php?id=en:user_advanced:installation#source_component1|Linux/Mac: Source Component instructions]]


==== Installing a source release ==== 

Make sure to select the "Greenstone 2" tab of:

  * [[http://wiki.greenstone.org/doku.php?id=en:user_advanced:installation#source_distribution|Windows: Source Distribution instructions]]
  * [[http://wiki.greenstone.org/doku.php?id=en:user_advanced:installation#source_distribution1|Linux/Mac: Source Distribution instructions]]

When the installation process is finished, you can run the Greenstone Server or the Greenstone Librarian Interface (GLI).

==== Uninstallation ====
On Windows, the uninstaller is accessible from the Start menu.

For most people under Linux systems, a Greenstone installation can be removed with the usual //rm// command. However, by using this method, any collections you've created will also be deleted. If you're on Linux or Mac and wish to uninstall Greenstone, the recommended way to do so is by using the Uninstaller, as this will give you the option to retain your collections. To launch the Uninstaller, you can either run "bash uninstall.sh" from the //uninstall// folder, or will first need to give execute permissions to the uninstall/Uninstall.sh file in your Greenstone installation before you can run it:
<code>cd uninstall
chmod u+rx Uninstall.sh
./Uninstall.sh</code>

===== Running the Greenstone Server =====

1. On Windows, the included Greenstone Server can be launched from the shortcut in the Start menu. On Mac and Linux, use a terminal (in Macs this is found under Applications > Utilities > Terminal) to go into the Greenstone installation directory and run 
<code>./gs2-server.sh</code>

The small Greenstone Server Interface (GSI) dialog will display. Pressing its Enter Library button will open a browser onto your Greenstone Digital Library home page.(1)

By default, the web servers restrict access to Greenstone pages to the local machine. To change this, go to File > Settings in the Greenstone Server Interface dialog, and tick "Allow external connections". Click OK to save the settings, then press the Restart Library button. <nowiki>(2)</nowiki>

**Note:** The Windows version of Greenstone includes two server applications: server.exe and an apache web server. (Linux and Mac versions of Greenstone include only the apache web server). By default, the server.exe application is launched when you use the Windows Start menu shortcut to launch the server. To use the apache web server included with the Windows version of Greenstone, do one of the following:

  * Rename the server.exe executable found in your Greenstone installation folder. Then the Start menu shortcut will run the Apache web server instead of server.exe. If you are using GLI, GLI will then also start up Apache instead of server.exe. Alternatively you can start the web server by running gs2-server.bat (located in your Greenstone installation folder).
  * Run gs2-web-server.bat - this will start the Apache web server, but won't affect the Start menu shortcut, or GLI's behaviour.

**To change the language in which you view your Greenstone digital library pages**, click on the ''Preferences'' link at the top left of your Greenstone digital library home page. On the Preferences page, select the interface language in the drop down box.

===== Running the Librarian Interface =====

The Greenstone Librarian Interface (GLI) can be run from the Windows Start menu. On Mac and Linux, use a terminal to go into the Greenstone installation directory and run 
<code>./gli/gli.sh</code>

First, as in the section above, the Greenstone Server Interface (GSI) dialog will appear.\\ ** Note**: If you're using the included //apache httpd server// and running GLI starts by requesting you for the Local Library URL, then it expects the library home URL that's of the form ''http://HOST:PORT/greenstone/cgi-bin/library.cgi''. By default, this URL will be ''http://localhost:8282/greenstone/cgi-bin/library.cgi''\\ Eventually the Greenstone Librarian Interface (GLI) dialog will appear. Refer to the [[en:tutorials |Greenstone tutorials]] for examples of using the GLI to create collections of documents. Once you have finished creating a collection, you can preview it by pressing the Preview button from GLI's Create tab. It will open your Greenstone collection in the web browser.(1) <nowiki>(2)</nowiki>

(1) If the web page displays a "Forbidden" message instead, go back to the GSI dialog, and use its File > Settings menu to change the Address Resolution method to one of the other options there. Then press the Restart Library Button in the main GSI dialog and see whether the browser page it opens now is the Greenstone home page. Otherwise try another Address Resolution option from the GSI dialog's Settings menu and see whether the pages are visible now.

<nowiki>(2)</nowiki> If you have your own external web server that you wish to use, then in your Greenstone installation directory, rename the folder apache-httpd to something else. Alternatively, you can rename the file gs2-server.sh (if on Linux/Mac) or gs2-server.bat (if on Windows) to something else.

**To change the GLI interface language**, run GLI, go to the ''File > Preferences'' menu. Then in the General tab, set the Interface Language. If your script is not covered by the Latin 1 charset, then you may also need to set the Font to something that supports your script. In such a case, try setting the value for the ''Font'' field to ''Arial Unicode MS, BOLD, 12''.


==== Setting the Preview Command in GLI====
If you've installed Greenstone and are running GLI (the Greenstone Librarian Interface application) for the first time, and have just finished builing your first collection with it, GLI may not know what to do when you press the Preview Button. If it complains or does nothing when you press the Preview Button, you will need to tell it how to launch your default browser (and tell it to open on the collection page) upon pressing Preview.

The following specifies the commands you are likely to need. Paste the applicable one into GLI's File > Preferences menu > Connection tab > Preview Command field.

  * On Windows: 
<code>cmd.exe /c start "" "%1"</code>
  * On Mac:
<code>open %1</code>
Put %1 in quotes if your Greenstone installation path contains spaces.
  * On Linux systems: 
<code>firefox %1</code>
If you work with another browser, then type the command you'd use to launch that from the terminal, suffixed with %1 once again. (Embed %1 in quotes if you've installed Greenstone in a path containing spaces.)
**NOTE:** If GLI's Preview Button does not succeed in launching the browser with the collection URL, consult [[en:troubleshooting#GLI's_Preview_Button_fails_to_launch_a_web_page| this page]] for a suggested solution.


===== Important Changes and Bug Fixes =====

  * After the GS2.86 release, GS2 was made more secure against Cross-Site Scripting (XSS) vulnerabilities thanks to notifications on the mailing list. These improvements are now available in Greenstone 2 from GS2.87 release candidate 1 onwards.
  * GS2 now implements the OAI deletion policy. The Deletion Record Policy support is of the persistent kind.
  * Downloading support for HTTPS URLs
  * Fixes to Downloading: improved termination of wget processes on cancelling downloads
  * Better handling of internal processes launched by GLI, including improved support for cancelling actions so that they are properly terminated


===== Learning to use Greenstone =====
If your Greenstone is up and running and you're ready to start learning about how to use Greenstone, refer to the [[en:Tutorials | Greenstone 2 Tutorial Exercises]].


===== Troubleshooting and other Questions =====
  * Have a look at the [[http://wiki.greenstone.org/doku.php?id=en:release:2.86_release_notes#known_issues_and_patches | older 2.86 release's Known Issues and Patches]] section, to see if your question is already covered there and has a solution.

  * If not, then please consult the Greenstone FAQ at http://wiki.greenstone.org/wiki/index.php/Greenstone_FAQ\\ to see if any of your questions are answered and for further workarounds of known issues. If any issues persist, write to us on [[http://wiki.greenstone.org/doku.php?id=en:support | the Greenstone Mailing List]].

  * If you're running Greenstone 2.87 on a machine where the version of Perl is later than 5.18 (e.g. perl 5.22), as may happen when you upgrade your Ubuntu to 16.04 or later, and if your GLI does not start up properly, then first stop and restart GLI in debug mode to get better error reporting: ''./gli/gli.sh -debug''. \\ Upon running GLI in debug mode, if you see some error messages such as the following when GLI fails to start:
<code>
Unescaped left brace in regex is deprecated here (and will be fatal in Perl 5.30), passed through in regex; marked by <-- HERE in m/^(\s*)body(\s*){ <-- HERE (\s*)$/ at /home/karl/Greenstone/perllib/plugins/MediaWikiPlugin.pm line 280.
Unescaped left brace in regex is deprecated here (and will be fatal in Perl 5.30), passed through in regex; marked by <-- HERE in m/_content_(\s*){ <-- HERE / at /home/karl/Greenstone/perllib/plugins/MediaWikiPlugin.pm line 506.
Unescaped left brace in regex is deprecated here (and will be fatal in Perl 5.30), passed through in regex; marked by <-- HERE in m/(\s*|\n)_content_(\s*){ <-- HERE / at /home/karl/Greenstone/perllib/plugins/MediaWikiPlugin.pm line 529.
Unescaped left brace in regex is deprecated here (and will be fatal in Perl 5.30), passed through in regex; marked by <-- HERE in m/(\s*|\n)_content_(\s*){ <-- HERE (.|\n)*?}/ at /home/karl/Greenstone/perllib/plugins/MediaWikiPlugin.pm line 534.
Unescaped left brace in regex is deprecated here (and will be fatal in Perl 5.30), passed through in regex; marked by <-- HERE in m/(/.*){ <-- HERE ,41}/ at /home/karl/Greenstone/perllib/plugins/DirectoryPlugin.pm line 199.
AutoLoadConverters: PDFBox Extension to Greenstone detected for PDFPlugin
Unescaped left brace in regex is deprecated here (and will be fatal in Perl 5.30), passed through in regex; marked by <-- HERE in m/^[a-z]{ <-- HERE 2..}/ at /home/karl/Greenstone/perllib/plugins/LaTeXPlugin.pm line 220.
Unescaped left brace in regex is deprecated here (and will be fatal in Perl 5.30), passed through in regex; marked by <-- HERE in m/\\(?:addcontentsline){ <-- HERE .*?}\{.*?}\{.*}/ at /home/karl/Greenstone/perllib/plugins/LaTeXPlugin.pm line 371.
Unescaped left brace in regex is deprecated here (and will be fatal in Perl 5.30), passed through in regex; marked by <-- HERE in m/\\(?:label|begin|end){ <-- HERE .*?}\s*\n?/ at /home/karl/Greenstone/perllib/plugins/LaTeXPlugin.pm line 380.
Unescaped left brace in regex is deprecated here (and will be fatal in Perl 5.30), passed through in regex; marked by <-- HERE in m/(\\[`'="^~\.]){ <-- HERE (\w)}/ at /home/karl/Greenstone/perllib/plugins/LaTeXPlugin.pm line 691.
Unescaped left brace in regex is deprecated here (and will be fatal in Perl 5.30), passed through in regex; marked by <-- HERE in m/(\\[uvcH]){ <-- HERE (\w)}/ at /home/karl/Greenstone/perllib/plugins/LaTeXPlugin.pm line 699.
Unescaped left brace in regex is deprecated here (and will be fatal in Perl 5.30), passed through in regex; marked by <-- HERE in m/^[a-z]{ <-- HERE 2..}/ at /home/karl/Greenstone/perllib/plugins/BibTexPlugin.pm line 315.
Unescaped left brace in regex is deprecated here (and will be fatal in Perl 5.30), passed through in regex; marked by <-- HERE in m/(\\[`'="^~\.]){ <-- HERE (\w)}/ at /home/karl/Greenstone/perllib/plugins/BibTexPlugin.pm line 706.
Unescaped left brace in regex is deprecated here (and will be fatal in Perl 5.30), passed through in regex; marked by <-- HERE in m/(\\[uvcH]){ <-- HERE (\w)}/ at /home/karl/Greenstone/perllib/plugins/BibTexPlugin.pm line 713.
Getting Download Info: [perl, -S, /home/karl/Greenstone/bin/script/downloadinfo.pl, -describeall, -xml, -language, en]
WGet thread is waiting for DownloadJobs.
Failed when trying to parse downloadinfo.pl -describeall
java.lang.Exception: *** Error running Download Info process, process exited with: 255
        at org.greenstone.gatherer.gui.DownloadPane.loadDownloadersInfo(DownloadPane.java:277)
        at org.greenstone.gatherer.gui.DownloadPane.<init>(DownloadPane.java:115)
        at org.greenstone.gatherer.gui.GUIManager.display(GUIManager.java:394)
        at org.greenstone.gatherer.Gatherer.openGUI(Gatherer.java:712)
        at org.greenstone.gatherer.GathererProg.main(GathererProg.java:81)
java.lang.NullPointerException
        at org.greenstone.gatherer.gui.DownloadPane.<init>(DownloadPane.java:116)
        at org.greenstone.gatherer.gui.GUIManager.display(GUIManager.java:394)
        at org.greenstone.gatherer.Gatherer.openGUI(Gatherer.java:712)
        at org.greenstone.gatherer.GathererProg.main(GathererProg.java:81)
java.lang.NullPointerException
        at org.greenstone.gatherer.gui.DownloadPane.<init>(DownloadPane.java:116)
        at org.greenstone.gatherer.gui.GUIManager.display(GUIManager.java:394)
        at org.greenstone.gatherer.Gatherer.openGUI(Gatherer.java:712)
        at org.greenstone.gatherer.GathererProg.main(GathererProg.java:81)
ShutDownHook called...
Attempting to forcibly terminate the GS server...
Issuing stop command to GS2 Local Library Server. Waiting for GS2 server to stop...
Successfully stopped GS2 server.
Done.
</code>\\ Upon seeing such error messages:

0. Exit GLI in the proper manner if it's running.

1. Optional: Back up your  GS2.87's ''gs2build/perllib/plugins'' and ''gs2build/perllib/cpan/'' folders (to restore if the patches below don't work).

2. Download the ''GS287PluginsForNewerPerlUbuntu.tar.gz'' tarball, which contains the patched up files, from [[http://trac.greenstone.org/browser/patches|the patches page]] and extract the tarball's contents.\\ If you're on a Windows machine, you may want to download the ''GS287PluginsForNewerPerlUbuntu.zip'' ZIP file instead and extract that.

3. Five files should have been extracted:
  * Put the 3 Plugin.pm files into your GS2.87's ''gs2build/perllib/plugins'' folder.
  * put Escape.pm into the ''gs2build/perllib/cpan/URI'' folder.
  * put PP.pm into into the ''gs2build/perllib/cpan/JSON'' folder.

4. Use a //new terminal// to launch GLI or any commands that previously failed with errors. Hopefully GLI will launch successfully now.

===== Useful information =====
  * When you've built a collection of documents, you may discover that there appears to be a copy of all these documents in the collection's //import//, //archives// and //index// subfolders and wonder whether Greenstone could really be so  inefficient with space as to keep 3 copies of everything. As it happens though, Greenstone uses **hard-links** both on Linux and **Windows**, in order to keep just one set of your documents. Then it simply hardlinks to these, instead of making copies.
By default, Windows doesn't show you when files on your filesystem are hard-linked. If you choose to install the Windows extension program [[http://schinagl.priv.at/nt/hardlinkshellext/hardlinkshellext.html|Link Shell Extension (LSE)]], it will put red arrows on files that are hard linked.

=====To turn on RSS support:=====
Refer to the Greenstone 2 tab of our [[http://wiki.greenstone.org/doku.php?id=en:user:rss | RSS]] page.

=====Enabling user comments=====
Refer to the Greenstone 2 tab of [[http://wiki.greenstone.org/doku.php?id=en:user:user_comments | Enabling user comments]].

===== For those migrating from earlier versions =====
//This section contributed by John Rose for Greenstone 2.86 and copied here.//

Some of the new Greenstone features which facilitate the creation of institutional repositories and other open access collections:

**1. OAI server**

Your collections can easily be made available for remote harvesting using OAI-PMH protocol, which works silently in parallel with normal web access to the collections. All that you have to do is to add a bit of configuration data in the oai.cfg text file in the etc subdirectory under the Greenstone home directory. The data to specify is explained in comment lines in the above file. If the collections to be made available through OAI-PMH do not all use Dublin Core metadata or one of the two other standard OAI metadata sets, the oai.cfg file will need to contain mapping data to translate your metadata into one of the Greenstone OAI-PMH metadata sets (also explained in the comments to the oai.cfg file).

OAI-PMH support has been provided for some time by Greenstone, but there have previously been a few functional gaps, as well as a bug in version in 2.84. From version 2.85 onwards, all official OAI-PMH validation criteria have been tested and satisfied; you will be able to validate your own OAI-PMH server using instructions given in the release notes. If you don't specify the urls for the associated documents in the metadata, the system can automatically generate internal urls so that users can access the full documents from the harvested OAI records. You will also now be able to harvest OAI-PMH records and the associated documents residing in external Greenstone collections (in 2.84, harvesting worked to access information in non-Greenstone collections, but there was problem in harvesting from other Greenstone collections).

Much information is put up on the web without clear specification of the concerned intellectual property rights. Although this is not good practice in general, when activating the OAI server special care should be taken to ensure that your documents are really available under open access conditions (in the public domain or freely distributable and re-distributable under an open access license such as Creative Commons). Greenstone can only take care of the technical access - for legal and organisational considerations, prospective open access providers may consult, for example, the resource links of the EIFL Open Access programme (http://www.eifl.net/eifl-oa-resources).

Once your OAI server is operational, to provide maximal international visibility for your open access collections you should register them in at least one (and ideally all) of the following: the ROAR directory (http://roar.eprints.org/), the OAI directory (http://www.openarchives.org/Register/BrowseSites) and the OpenDOAR directory (http://www.opendoar.org/). It would also be very nice if you could confirm to this list that your server is operational, providing the url base address.

**2. PDF metadata**

Prior to version 2.83, reliable import of, and metadata extraction from, pdf files was limited to PDF versions 1.4 and earlier. Starting with 2.84 a new "PDF Box extension" has been available as a separate download to handle all PDF versions. This extension file need only be placed in the ext subdirectory of Greenstone for the improved PDF handling facilities to be operational (see the release notes). The PDF Box extension has been further improved from version 2.85 onwards, so be sure to download, unzip and insert an up-to-date PDF Box extension for this version, replacing the version of the file which you may have downloaded for version 2.84.

By using the PDF Box extension, you can extract any metadata entered in standard manner in a pdf file, i.e. the traditional pdf metadata (Author, Title, Subject, Keywords) and/or the newer XMP format metadata (including user defined fields). In general, we recommend that for users interested in extracting PDF metadata, it is better to use the  PDF Box extension, even for pdf files in version 1.4 or earlier.

Using the PDF metadata extraction facility means that for PDF files generated by the users with metadata included (either directly with a tool like Acrobat, or by generating a PDF file from a package like Word which can transfer Word metadata to the generated PDF file), these metadata can be automatically incorporated into a Greenstone collection (without having to enter them in GLI or compile a metadata.xml file). This could clearly be of interest to open access applications, particularly when decentralized input is being submitted.ext subdirectory of Greenstone for the improved PDF handling facilities to be operational (see the release notes)

There is a catch: the metadata extraction procedure may not work flawlessly on recent version PDF files which are not "linearised" (called Fast Web View in Acrobat). So linearised PDF files should be used; the open source QPDF program (http://qpdf.sourceforge.net/) claims to be able to linarise non-linearised PDF files, but this remains to be confirmed in so far as Greenstone treatment is concerned. Feedback from users on the PDF metadata extraction facility is most welcome.

**3. Section handling for PDF files**

For several years Greenstone has proposed a facility to automatically generate internal section (chapter) information from a Microsoft Office (e.g. Word), OpenOffice/Libreoffice or html document, but probably not for those PDF files which do not have a standard way of designating chapter/section headings. This automatic generation of internal section (chapter) information allows for table of contents display of the document and finer chapter-based searching.

Word files can be treated in this way if a compatible version of Word is installed in the computer in which a collection is built (see the tutorial at %%http://wiki.greenstone.org/wiki/gsdoc/tutorial/en/enhanced_word.htm).%% Word, Office Open XML or OpenDocument format files can also be treated without proprietary software if OpenOffice or LibreOffice is installed, by downloading the Greenstone OpenOffice extension into the ext subdirectory of the Greenstone installation (see the release notes), and activating the open office option in the Word (or Powerpoint, or Excel) plugin of Greenstone (similar to activating on Windows/Word scripting option as in the above mentioned tutorial).

An example collection has now been prepared to show how this can be extended to PDF files (see %%http://www.nzdl.org/gsdlmod?a=p&p=about&c=assocext-e).%% Included is an explanation of how to build the collection through the following steps:
a. develop a Word version and a PDF version of the document (conversion of the Word version to PDF or vice-versa);
b. make sure that the heading formats in Word are consistent with what you want for sections and subsections;
c. import the Word file into Greenstone specifying the PDF file as an associated file;
d. use the format statement guidance in the worked example to be able to search on the document subsections and also display the hit terms in the original PDF file (Word or OpenOffice/LibreOffice no longer needed after building - the collection could for example in the meantime have been transferred to a Linux server).

An alternative, more controllable but more labour intensive, method without recourse to word processing software would be to import the pdf file into Greenstone, right click in the Gather view and convert it to html, call an html editor and ensure that the section information is correctly introduced, add the pdf again but as an associated file (by setting the assoc-files parameter in HTMLPlugin), then build and display as per the worked example.

More complete documentation is being developed for all of the above techniques, and we will keep you informed on its progress.

**4. Migrating to 2.87**

To switch to version 2.87 from an earlier Greenstone version with minimal risks, you could i) back up your collections, ii) install 2.87 in a new home directory (to specified to the installer), and iii) copy the collect sub-directory from the old to the new version. If you are presently using a recent previous version of Greenstone (2.8x), the collections should be immediately available for use; if not, particularly for collections built under older versions of Greenstone, it should suffice to rebuild the collections under the new version. Any problems can be addressed to this list or the main Greenstone users list (http://list.waikato.ac.nz/mailman/listinfo/greenstone-users).

If you want to transfer information on users and user groups, the corresponding databases (users.gdb, key.gdb) should be copied from the etc sub-directory in the old collection to the new one. Of course if you have customised your previous version (main.cfg, style.css, macros, etc.), the old versions should also be copied to the new installation. When all is working perfectly, the old installation can be deleted.


===== Further Notes on Installation and Running =====
==== Apache HTTPD Notes ====

Greenstone binary releases come with the Apache HTTPD web server precompiled and installed by default into Greenstone/apache-httpd. 
  * To uninstall it, delete the Greenstone/apache-httpd folder. To disable the use of it, rename the apache-httpd folder to something else (then you can rename it back if you change your mind later).
  * If you have an existing Apache web server installed and you want to set it up to serve your Greenstone, copy the appropriate bits out of Greenstone's Apache httpd.conf file into your existing Apache's httpd.conf file. Then disable (or uninstall) Greenstone's Apache as described above.
  * If you want to use an alternative webserver, then set it up appropriately, and disable the Greenstone Apache server.
  * If you had installed Apache Httpd previously for the sole purpose of serving Greenstone, then you may like to uninstall it and use the one installed by Greenstone.


==== Additional notes related to running Greenstone on Windows ====
On Windows, running the Greenstone Librarian Interface (GLI) or the Greenstone Server Interface (GSI) manually from a DOS prompt could be useful in diagnosing anything that goes wrong, since it keeps any messages that were displayed during program execution visible in the DOS window.

To run GLI or GSI from the DOS prompt, first go into your Greenstone installation directory and then
  * to run the GSI, type:
<code>gs2-server.bat</code>
  * to run GLI, type:
<code>gli\gli.bat</code>

==== Notes on using a Terminal or DOS prompt ====
On Macs, the Terminal is an application that can be found under Applications > Utilities > Terminal.


On Windows, you can start up a DOS prompt by going to Start > Run and then typing cmd.

To go to your Greenstone installation directory using your terminal, you would type:
<code>cd <here you'd type the full path to your Greenstone installation folder></code>
On Windows you would use backslashes (\) in file paths, and on Linux and Mac you would use forward slashes (/).

On Linux and Mac, to run a shell script (Greenstone's shell scripts are files that end on *.sh or *.bash), you would precede the scriptname with a ./


On Windows, to run a batch script (files that end on *.bat), just type its name out in full.

E.g. on Windows:
<code>cd C:\Greenstone
gs2-server.bat</code>

E.g. on Linux or Mac:
<code>cd /home/me/greenstone
./gs2-server.sh</code>

==== Using the gsicontrol script ====

The gsicontrol.sh/bat script is used by gs2-server.sh/bat, and provides much functionality: you can use it to change port number, start and stop the Apache web server, etc. It accepts many parameters like:
<code>
 web-start 
 web-stop
 web-restart 
 
 configure-admin
 configure-web
 configure-apache 
 configure-cgi 
 reset-gsdlhome 
 
 set-port 
 
 test-gsdlhome 
 web-stop-tested
</code>
You can use it as follows

  * In a command window, go to your Greenstone installation folder and run setup.bat (if on Windows) or 'source setup.bash' (for Linux/Mac)
  * Then run "gsicontrol.sh/bat set-port". It will ask for a port number. Use e.g. 8282 (just to avoid conflicts with standard ports).
  * Now run "gsicontrol.sh/bat web-start". (You would use the ".sh" extension on Linux and Mac machines and ".bat" on Windows machines.) Doing so will run the Apache web server.
  * In a browser, enter "http://localhost:8282". It should show the message "It works" indicating that Apache is running.
  * Then type "http://localhost:8282/greenstone/cgi-bin/library.cgi". It should show the Greenstone home page.
  * To stop the webserver at any point, from your command window run "./gsicontrol.sh web-stop" on linux/mac and "gsicontrol.bat web-stop" on windows.
  * If you move your Greenstone 2.87 installation folder to another location at any point, then (with the server still stopped), you may first need to run "./gsicontrol.sh reset-gsdlhome" on Linux and "gsicontrol.bat reset-gsdlhome" on Windows before proceeding.
  * If you forgot the admin password (as is required to access the Administration Pages and to use Remote GLI), this can be reset by running "./gsicontrol.sh configure-admin" on Linux and "gsicontrol.bat configure-admin" on Windows. The password has to be between 3 and 8 characters long.

==== Notes on using GLI ====
In GLI's File > File Associations, you can set which applications are to be called to open files with different file extensions. 
  * On Mac, you can type **''open %1''** for all of these, which then lets the default application on the Mac open the file extension associated with each file. You may need to find the right command for you version of *Nix.  
  * To do the same on Windows, type **''cmd.exe /c start "" "%1"''**.
  * To attempt the same on Linux, try typing ''xdg-open %1'' (or if you are specifically on a gnome system, then try ''gnome-open %1'', while on a kde system you'd use ''kde-open %1''). Beware that not all Unix systems support a signal command to open applications, so you may need to use custom commands like ''firefox %1'' to launch in a browser, or ''gedit %1'' to open with a text editor, etc.
==== Working with Remote Greenstone and the GLI-Client ====

The Client-GLI is the version of the Greenstone Librarian Interface that can be run on a machine different to the one that is running the Greenstone server. The server needs to be set up to work as a remote server, and Client-GLI can be run on a different machine, connecting to that server.

**Instructions**

These instructions are more specific to current and recent Greenstone 2  releases than the [[http://wiki.greenstone.org/wiki/index.php/Remote_Greenstone|general instructions]] for setting up Greenstone 2 as a remote server. 

The following are steps to follow if you're on **Windows**. On **Unix based systems**, you can skip steps 1 and 2, otherwise things are similar. For instance, on Unix systems, you'll want to launch *.bash or *.sh script equivalents to the batch files listed. Also, you'll want to use forward slashes (/) instead of the Windows' backward slash (\) when specifying file paths.


1. If the path to your Greenstone installation contains any spaces (i.e. if any of the containing folders wherein your Greenstone is ultimately located contain spaces in their names), open cgi-bin/gsdlsite.cfg in a plain text editor and make sure that the value for the GSDLHOME line contains quotes around it. E.g.
<code>gsdlhome "C:\Program Files\Greenstone2"</code>
Save any changes.


2. Rename server.exe in your Greenstone installation folder to something else, say "_server.exe".

This is because you will need to use the included Apache web server for the remote Greenstone. By renaming the default library server in Greenstone 2, Greenstone will next look for the apache web server.


3. Now run the Apache web server included with your Greenstone from the Windows Start Menu, or by opening a DOS prompt and typing the path to your Greenstone 2 installation and then running the gs2-server script. E.g.
<code>cd C:\Program Files\Greenstone2
gs2-server.bat</code>

Alternatively, you could use Windows Explorer to locate the gs2-server.bat file in your Greenstone2 installation folder and double click that file.


4. A dialog (the Greenstone Server Interface) will display. If you want remote clients accessing your Remote Greenstone Server, go to File > Settings of this dialog and tick "Allow External Connections" and choose either "Get local IP and resolve to a name" or "Get local IP". Finally, press the dialog's central Enter Library button.

It will open a browser and take you to a page like:  %%http://localhost/greenstone/cgi-bin/library.cgi%%

OR: %%http://<YOUR-MACHINE-NAME:YOURPORT>/greenstone/cgi-bin/library.cgi%% 
(where if port were the default 80 it won't be displayed, e.g.  %%http://<YOUR-MACHINE-NAME>/greenstone/cgi-bin/library.cgi)%%


5. Replace the "library.cgi" part of the URL in the browser with:
<code>gliserver.pl?cmd=check-installation</code>
E.g. %%http://localhost/greenstone/cgi-bin/gliserver.pl?cmd=check-installation%% 
(OR: %%http://<YOUR-MACHINE-NAME:YOURPORT>/greenstone/cgi-bin/gliserver.pl?cmd=check-installation)%%

At the end of the browser page, it is imperative that it says something like:
<code>"Installation OK!"</code>
(If not check the error messages.)


6. You may need to give read and write access to the collect folder. Once again, open a DOS prompt. Type the following, or the equivalent of the following for your computer's locale, but make sure to type the path to *your* Greenstone2 installation (the example below uses C:\Program Files\Greenstone2\collect):
<code>cacls "C:\Program Files\Greenstone2\collect" /P Everyone:F</code>
On Linux you would do:
<code>chmod -R a+rw /my/path/to/my/Greenstone2.87/collect</code>
(If on Vista or Windows 7, you installed Greenstone in an Admin area, such as in Program Files, then you would need change the security settings of the collect directory: Right-click > Properties, then set the folder to "Everyone".)




7. Use the browser to go to your Greenstone home web page again.

  * Now click on the Administration Page link and add a new user:
  * Click the Add a New User link to the left
  * You'll be requested for the admin username (type "admin") and password, which will be what you chose upon installing Greenstone.


8. Enter the username and password for the new user. The password has to be between 3 and 8 characters long.
  * In the Groups field, type "personal-collections-editor".
  * Press the Submit button.

=== Client-GLI ===

9. You can connect to this server from the Client-GLI application included with any Greenstone installation. Either on the current machine or another machine (assuming you want the Greenstone server on one machine and the client on another), use the "Remote Librarian Interface (Client-GLI)" shortcut to launch Client-GLI. Alternatively, you can launch it from the command line, such as by opening a new DOS prompt, going to the gli folder of your Greenstone 2 installation, and running client-gli.bat. E.g.
<code>cd C:\Program Files\Greenstone2\gli
client-gli.bat</code>


10. A dialog will eventually appear asking you for the URL of the Remote Greenstone server's gliserver.pl file.

  * If your client-gli is running from a different machine to where your Greenstone server is running, you need to specify the name of that remote machine hosting the Greenstone server:  %%http://<YOUR-MACHINE-NAME:YOURPORT>/greenstone/cgi-bin/gliserver.pl%%

  * If the client-gli is running on the same machine, you can generally type "localhost":  %%http://localhost:<port>/greenstone/cgi-bin/gliserver.pl%%


11. It will next ask you for a username and password. Type the values you entered for the new user you created in step 8.


12. The client-GLI dialog should finally open, and it will look and behave mostly the same as the usual (local) GLI, except that most of the document processing takes place on the remote machine where the Greenstone server is running. 


==== Setting up your Greenstone OAI Server and using GLI to download over OAI from a Greenstone server ====

**Useful resources**
  * [[http://wiki.greenstone.org/lib/exe/fetch.php?media=gs_oai.pdf|Diego Spano's presentation on Greenstone and OAI.]] This gives a good background about OAI, as well as a very useful overview of Greenstone's OAI support.


To get the Greenstone 2's OAI Server to work, edit the file **etc/oai.cfg** in your GS2 installation directory and provide values for the properties **repositoryName** and **repositoryId**. E.g. 
<code>repositoryName "Greenstone" 
repositoryId "greenstone"</code>
In addition, you will need to edit the same etc/oai.cfg file to also list any collections you want served over OAI. Add such collections by name to the **oaicollection** property. For example, if you have a Greenstone collection called "oaipdf" and want it served over OAI, then you would append its name to the property oaicollection as follows:
<code>oaicollection demo documented-examples/oai-e oaipdf</code>
If you're validating your OAI server and wish to test the resumptionToken, also set the resumeafter property to be a much lower value. E.g.
<code>resumeafter 5</code>

For each collection meant to be served over OAI, edit **the collection's etc/collect.cfg** file by filling in necessary data. At a minimum, the email values for the **creator** and **maintainer** fields need to be set to something sensible if you want to validate your OAI server against an online validator:
<code>creator <type your email here> 
maintainer <type your email here></code>
Moreover, if you wish to validate your OAI server against the OpenArchives validator, you will need to remove the default admin email (greenstone@...) in the **creator** and **maintainer** email fields from the **collect/demo/etc/collect.cfg** file. Check that the "greenstone@..." dummy email is not present in the collect.cfg file of any other demonstration collection that's listed in greenstone's oai.cfg file.


If you wish to validate your OAI server, visit %%http://www.openarchives.org/Register/ValidateSite.%% 

However, before you can validate your OAI server and before you can try testing if GLI can download over OAI from it, there are a few things you need to do to make your Greenstone OAI server accessible to the outside world:
  * If you're on windows, you will likely need to use the included Apache web server intead of the Local Library Server. To change over to using the Apache web server, change the file extension of server.exe which is found in the top-level your Greenstone installation (you can rename it to server.not for instance).
  * Your Greenstone server machine's firewall and virtual server (port-forwarding) settings may need to be set up such that the Greenstone server can be made accessible to the outside world. This is not something Greenstone can do, you will need to do this.
  * Once that's ready, you also need to tell the Greenstone server that it should make itself accessible to the outside world by turning on the "Allow External Connections" option in the File > Settings dialog of the Greenstone Server Interface application. In the same File > Settings dialog, choose the setting that allows the server to use the machine's hostname or host IP instead of "localhost".
  * Press the Enter library button in the Greenstone Server Interface, and it should open the browser on the home page of your digital library. You will see a URL like:
<code>http://<host>:<port>/greenstone/cgi-bin/library.cgi</code>
Change it to 
<code>http://<fully-qualified-host>:<port>/greenstone/cgi-bin/oaiserver.cgi</code>
Note that you want the full hostname including domain. This is the URL you will want to feed into the OAI Validator at %%http://www.openarchives.org/Register/ValidateSite%%
If the URL is not accepted for some reason, try pasting it in a new browser window, and suffix "?verb=Identify" to it, to see what the OAI validator gets to see:
<code>http://<fully-qualified-host>:<port>/greenstone/cgi-bin/oaiserver.cgi?verb=Identify</code>

For further information on your Greenstone OAI Server, read through [[en:OAI]].

==== Notes on setting up your Linux system to work with filename encodings alien to your filesystem settings ====

UTF-8 is a common encoding used in filesystems and for data content.

If you are working on a UTF-8 system, then Java (and therefore GLI) will not give you access to files that do not have UTF-8 filenames. This means that in GLI, attempts to drag and drop files with names that are not UTF-8 will fail on such systems. 

GLI will allow one to drag and drop files if the filesystem encoding was set to something that preserved the byte values of filenames (instead of destructively replacing characters that are not valid for the filesystem encoding with an "invalid" character, as happens with UTF-8 systems). In practice, this means that a filesystem encoding such as "Native Latin 1" (also called ISO-8859-1), which is a subset of Unicode, will preserve the underlying byte values in filenames, allowing you to drag and drop all sorts of filenames in GLI. 

Drag And Drop in GLI will work by default on Windows since it is not a UTF-8 filesystem, but rather one that has a large overlap with Native Latin 1. 

However, some Linux systems are set to UTF-8 by default, while others do not even have other encodings installed so you can't switch over.

The solution to making GLI work with "alien filename encodings" on such Linux systems is to switch the encoding to Native Latin 1 (this is **regardless** of what encoding your filenames are in). Where this is not installed, you would require **Admin rights**' to install Native Latin 1, before switching to it. The following contains instructions on doing both. Note that switching between installed encodings does **not** require Admin rights. 


**INSTALLING AND APPLYING A NEW FILESYSTEM ENCODING ON A LINUX MACHINE:**

The instructions are derived from the thread of questions and answers [[http://mail.openjdk.java.net/pipermail/i18n-dev/2008-September/000048.html|openjdk]] and [[http://ubuntuforums.org/showthread.php?t=423039|this page at Ubuntu Forums]].

First find out whether you are already working with a Linux system set to Native Latin 1 (ISO-8859-1). Check by typing the following in an x-term:
<code>locale -k LC_CTYPE | grep charmap</code>
If the settings are indeed set to Native Latin 1, it should tell you that (en_US.)ISO-8859-1 is active.


A) INSTALLATION OF A NEW FILESYSTEM ENCODING (Native Latin 1/ISO-8859-1): 

Installation of Native Latin 1 (ISO-8859-1), which requires Admin rights, may not be required: check if this encoding is already installed on the machine first. You can check by running the following two commands in an x-term:
<code>export LC_ALL=en_US.ISO8859-1 
export LANG=en_US.ISO8859-1</code>

If it doesn't come back with any messages that look like failure (such as the encoding not being found), then it is installed and should now be active. Otherwise you need Admin permissions to install Native Latin 1 (ISO-8859-1) on your Linux system, as follows:

1. Open /var/lib/locales/supported.d/local as Root user and, at the bottom of the file, add the line:

<code>en_US.ISO-8859-1 ISO-8859-1</code>

2. Repeat the above step with the file /var/lib/locales/supported.d/en 

3. **Optional:** Only if you wish to make the Native Latin 1 encoding the system default would you need to open /etc/default/locale as Root and change LANG="en_US.UTF-8" to LANG="en_US". (Or possibly LANG="en_US.ISO-8859-1".)

4. Then in an x-term, run the following to install the new encoding: 

<code>sudo locale-gen --purge</code>

5. Restart the machine. 

The above 5 steps need to be carried out **once** for en_US.ISO-8859-1 (Native Latin 1) to be supported by the machine. You would still need to apply the new encoding.


B) APPLYING THE NEWLY INSTALLED ENCODING AS THE FILESYSTEM (AND DISPLAY) ENCODINGS: 

6. Having restarted the machine, to make the newly-installed encoding the active one, run the following commands in an x-term again. You do not need Admin rights for issuing the following two commands:

<code>export LC_ALL=en_US.ISO8859-1 

export LANG=en_US.ISO8859-1</code>

7. You can check if it all worked by running: 
<code>locale -k LC_CTYPE | grep charmap</code>
Or by running:
<code>locale</code>
It should tell you that (en_US.)ISO-8859-1 is active.

8. Now run GLI from the same x-term to allow it to work with the Native Latin 1 filesystem encoding settings.



==== Using Greenstone Plugin Extensions to process docx files and recent versions of PDF ====
Two extensions are available for download: **Open Office and PDF Box**, to process more recent versions of MS office documents and PDF document respectively.
==== OpenOffice====
  * The Open Office extension provides a document conversion facility if **Open Office //or// LibreOffice** is already installed on the system. In order to use the Open Office extension, 
   * You will need [[http://www.openoffice.org/|Open Office]] installed. You may need to create an environment variable called SOFFICE_HOME and set this to the full path of your OpenOffice or LibreOffice installation folder, if:
    * you're on Windows and have OpenOffice/LibreOffice installed in a location other than "C:\Program Files\OpenOffice.org 3". In that case, also ensure that your PATH environment variable contains the path to the "program" folder located in your SOFFICE_HOME path (the OpenOffice installation folder). 
    * you're on Linux and have OpenOffice or LibreOffice installed in a location different from "/opt/openoffice.org3" or "/usr/lib/openoffice" (or "/usr/lib/libreoffice"). 
   * Once you have Open Office set up, download the Greenstone extension for it [[http://trac.greenstone.org/browser/main/tags/2.87rc1/gs2-extensions/open-office/trunk|from here]], which is available in tar.gz and zip formats, and unzip into Greenstone's **ext** folder. (If you have any issues try the latest version [[http://trac.greenstone.org/browser/gs2-extensions/open-office/trunk|located here]]. Note that if you get the latest version of the open office extension, you cannot already have an instance of OpenOffice running when using GLI, you will need to terminate any previously running instance. It is also unlikely that you can get a separate instance of OpenOffice running after quitting GLI. If you wish to do so, you will need to use Task Manager to terminate the open office process launched by the extension upon running GLI.)
   * Before you can use this (or any other Greenstone extension), you will need to quit GLI and GS2-server if either are open and then you will need to relaunch GLI (or run Greenstone scripts) from a fresh command terminal, in order for the extension to become available in the Greenstone environment.
   * With OpenOffice and the extension installed and the Greenstone environment set up for this, Greenstone's Word, PowerPoint and Excel Plugins will have a new option, "-openoffice_conversion", allowing conversion with Open Office instead of the existing converter. Switching on this new option means that more recent Office formats like docx can be included in Greenstone collections and processed by Greenstone.
====PDFBox====
  * The PDF Box extension provides support for conversion of PDF documents to text. It supports the latest PDF versions (unlike Greenstone's standard pdftohtml program), so it's useful for collections with new PDF documents. 
   * Download the extension [[http://trac.greenstone.org/browser/main/tags/2.87rc1/gs2-extensions/pdf-box/trunk|from here]], which is available in tar.gz and zip formats, and unzip into Greenstone's **ext** folder. The PDF Box extension does not require additional software to be installed. 
   * Before you can use the extension, you will need to quit GLI and GS2-server if either are open and then you will need to relaunch GLI (or run Greenstone scripts) from a fresh command terminal, in order for the extension to become available in the Greenstone environment.
   * PDFBox generates HTML documents from the PDF that may contain more whitespace between lines and paragraphs than you'd wish. In such a case, you can fix this on a per-collection basis using GLI. Open your collection in GLI, go to the Format panel, select Format Features to the left and DocumentText to the right. In the text-area for HTML Format String below, create an HTML style element to set the top and margin bottoms on a paragraph element to 0. You need to escape curly braces with a back slash. In the end your format statement for DocumentText will look like: <br/>
<code>
<style>
  p \{
    margin-top:0;
    margin-bottom:0;
  \}
</style>
[Text]
</code>

====Usage history====
If you wish to get some usage output into a file:

1. Open up etc/main.cfg and edit the line that says 
<code>logcgiargs      false</code>
to say:
<code>logcgiargs      true</code>
Save the file.

2. You will need to manually create a new text file called "usage.txt" in Greenstone's etc folder. This step will not be necessary in future versions of Greenstone. 

3. Run the web server and usage.txt should become populated with information.


===== Known Issues=====

===== Updated Translations =====

Thanks to the following people for new and updated translations since 2.86:
  * Yamaguchi Gaku for Japanese language translations
  * Diego Spano for Spanish language translations
  * Lavji Zala for Gujarati language translations
  * Yvan Arnaud, John Rose and all others in John Rose's team of French language translators (please contact us if you wish your names to be enumerated here)
  * Kalima Tuenbaeva and Sergey Karpov for Russian and Kazhakh translations
  * Tigran Zargaryan for Armenian language translations
  * Kamal Salih Mustafa Khalafala for Arabic language translations
  * Reza Monajjemi for Farsi language translations
  * Maciej Jaros for Polish language translations
  * Tomáš Fiala for Slovakian language translations
  * Gerhard Riesthuis for Dutch language translations
  * Eduardo del Valle Perez for Catalan language translations