Greenstone Wiki

User Tools

Site Tools

You are here: index » en » release » 3.09_release_notes
en:release:3.09_release_notes

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

en:release:3.09_release_notes [2019/04/19 08:39] – [Setting up a remote Greenstone 3 server] anupamaen:release:3.09_release_notes [2023/03/13 01:46] (current) – external edit 127.0.0.1
Line 1: Line 1:
 +
 +
 +
 ====== Greenstone 3.09 Release Notes ====== ====== Greenstone 3.09 Release Notes ======
  
 **Release Name:** 3.09 **Release Name:** 3.09
  
-**Release Date:** unknown+**Release Date:** 30 May 2019 
 + 
 +** Released: ** 
 + 
 +   * Binaries for Windows, GNU/Linux 32 and 64 bit machines, a Mac binary for High Sierra/10.13 and Mac Mojave/10.14 (but may also work on Mac Sierra/10.12).\\ All the binaries have only been spot-tested, since the 3.09 release candidates, which came out a few weeks before, were tested more extensively on all the tutorials. Source distributions and source components compile on Windows 8. \\ [[http://svn.greenstone.org/main/tags/3.09/|svn tag page]] [[http://trac.greenstone.org/browser/main/tags/3.09|trac tag page]]. Code revision up to 33119. Tag revision: 33122. 
 +      * The Mac binary is generated on High Sierra/10.13 and tested partially on that but mostly on Mojave/10.14. 
 +      * The Windows binary was largely tested on Windows 10, but partially on Windows 8.1 
 +      * The Linux binary was largely tested on Ubuntu 18.04.2 LTS and partially on Ubuntu 14.04 and 16.04. 
 + 
 +** Release Candidate History ** 
 + 
 +  * Greenstone 3.09 rc1: Release Candidate 1. Released 6 May 2019. \\ Binaries for Windows, GNU/Linux 32 and 64 bit machines, Mac High Sierra/Mojave. (Mac version generated on MacOS High Sierra/10.13 and tested on Mojave/10.14. It may still work on El Capitan/10.11 and Sierra/10.12, but is untested on these.) \\ Download from the [[http://www.greenstone.org/snapshots | snapshots]] page \\ [[http://svn.greenstone.org/main/tags/3.09rc1/|svn tag page]] [[http://trac.greenstone.org/browser/main/tags/3.09rc1|trac tag page]].  Code revision up to 33051. Tag revision: 33057. 
 + 
 +As always, many thanks to our TSG (tech support) who made this and previous releases possible by setting up test machines for us and getting us access to them, all on short notice. Thanks to TSG, bugs could be found and fixed and 3.09rc1 got a release at last. 
  
-   
 ===== Installation Instructions===== ===== Installation Instructions=====
  
Line 12: Line 28:
   * Download the appropriate binary release for your operating system and run it.    * Download the appropriate binary release for your operating system and run it. 
  
-  * **Note to Mac users:** The security settings in newer Mac OS versions have been altered to by default disallow users from casually opening and running .dmg executables that are not from Apple itself. When attempting to open the Greenstone binary .dmg file, if it pops up an error warning about security, you will need to set up the Security on your Mac to allow you to run .dmg files downloaded from the internet. Otherwise the Greenstone mac binary will not run. To do this, Go to your Mac's System Preferences. Under "Personal", select Security & Privacy. In the General tab, tick "Allow apps downloaded from Anywhere", then confirm that you want to "Allow From Anywhere". You'll need to be admin to do this, otherwise click on the padlock at the bottom left of the Security & Privacy tab and log in as admin.+  * **Note to Mac users:** The security settings in newer Mac OS versions have been altered to by default disallow users from casually opening and running .dmg executables that are not from Apple itself. When attempting to open the Greenstone binary .dmg file, if it pops up an error warning about security, you will need to set up the Security on your Mac to allow you to run .dmg files downloaded from the internet. Otherwise the Greenstone mac binary will not run. To do this, go to your Mac's System Preferences. Under "Personal", select Security & Privacy. In the General tab, tick "Allow apps downloaded from Anywhere", then confirm that you want to "Allow From Anywhere". You'll need to be admin to do this, otherwise click on the padlock at the bottom left of the Security & Privacy tab and log in as admin.
  
   * **For Linux**, you will need to set the file to be executable before running it. (e.g. chmod a+x Greenstone-3.09-linux)   * **For Linux**, you will need to set the file to be executable before running it. (e.g. chmod a+x Greenstone-3.09-linux)
Line 198: Line 214:
 Put these two together with a period mark to separate them and use this as the value for your tomcat.server property.) Put these two together with a period mark to separate them and use this as the value for your tomcat.server property.)
  
-4. Set up your Greenstone environment if you've not already done so by running ''gs3-setup.bat'' in your Greenstone 3 installation folder (''source ./gs3-setup.bash'' on Linux and Mac machines). And then start up your Greenstone 3 server with:+4. Set up your Greenstone environment if you've not already done so by running ''gs3-setup.bat'' in your Greenstone 3 installation folder (''source ./gs3-setup.sh'' on Linux and Mac machines). And then start up your Greenstone 3 server with:
 <code> <code>
 ant start ant start
Line 252: Line 268:
   - You need to associate JNLP files with Java Web Start (''jre/bin/javaws'').   - You need to associate JNLP files with Java Web Start (''jre/bin/javaws'').
       * On Windows, create the association in the usual way: when you first access the GLI Web Start application through Greenstone, a JNLP file called "GLIappWebStart.jnlp" will be offered for launching or download. If JavaWS is not already the default application to open JNLP files with, rightclick on the downloaded GLIappWebStart.jnlp file and choose ''Launch/Open with ...''. Browse to your Greenstone3's ''packages/jre/bin/javaws.exe'' or any installed Java's ''jre/bin/javaws.exe'' to use Java's Web Start application as the launcher.       * On Windows, create the association in the usual way: when you first access the GLI Web Start application through Greenstone, a JNLP file called "GLIappWebStart.jnlp" will be offered for launching or download. If JavaWS is not already the default application to open JNLP files with, rightclick on the downloaded GLIappWebStart.jnlp file and choose ''Launch/Open with ...''. Browse to your Greenstone3's ''packages/jre/bin/javaws.exe'' or any installed Java's ''jre/bin/javaws.exe'' to use Java's Web Start application as the launcher.
 +      * On Mac, .jnlp files may already be associated with the Java Web Start application for launching JNLP files (Java web start applications). Otherwise, see page 3 of http://online.unm.edu/help/learn/faculty/tools/web-conferencing/common/web-conferencing-pdf-files/jnlp-file-association.pdf for instructions on creating the file association for this. Once the file association between the Java Web Start application and .jnlp files has been made, you can just double-click on the ''GLIappWebStart.jnlp'' file you downloaded. 
       * For Linux, create a file with ''.desktop'' extension (e.g. "javawebstart.desktop") containing the following, **edit the path to javaws**, and save this file into ''~/.local/share/applications'':\\ <code># This file makes Ubuntu associate .jnlp files with Java Web Start (javaws)       * For Linux, create a file with ''.desktop'' extension (e.g. "javawebstart.desktop") containing the following, **edit the path to javaws**, and save this file into ''~/.local/share/applications'':\\ <code># This file makes Ubuntu associate .jnlp files with Java Web Start (javaws)
 # This file should be adjusted and then copied into ~/.local/share/applications # This file should be adjusted and then copied into ~/.local/share/applications
Line 267: Line 284:
 MimeType=application/x-java-jnlp-file; MimeType=application/x-java-jnlp-file;
 </code> </code>
-  - Launch the Java Control Panel by running ''jre/bin/javacpl.exe'' on Windows, or ''jre/bin/jcontrol'' (formerly jre/bin/ControlPanel) on Linux. (GS3 binaries now include a JRE in the ''packages'' folder if you want to use the bundled JRE.) In the Java Control Panel, go to the ''Security'' tab, set Security level to ''High'' if not already set. Click ''Edit Site List'', and then press ''Add'' to add the //http:%%//%%host:port// (or //https:%%//%%host:port// if you've [[http://wiki.greenstone.org/doku.php?id=en:release:3.09_release_notes#setting_up_your_greenstone_to_run_over_https|set up https support]]) that the GS3 will run on. Remember, to be accessible to the outside world, the host can't be "localhost", but would be the hostname of your machine or public IP. Click OK to exit the Java Control Panel with your changes in effect.+  - Launch the Java Control Panel by running ''jre/bin/javacpl.exe'' on Windows, or ''jre/bin/jcontrol'' (formerly jre/bin/ControlPanel) on Linux or follow the instructions at https://www.java.com/en/download/help/mac_controlpanel.xml for mac. (GS3 binaries now include a JRE in the ''packages'' folder if you want to use the bundled JRE.) In the Java Control Panel, go to the ''Security'' tab, set Security level to ''High'' if not already set. Click ''Edit Site List'', and then press ''Add'' to add the //http:%%//%%host:port// (or //https:%%//%%host:HTTPS-port// if you've [[http://wiki.greenstone.org/doku.php?id=en:release:3.09_release_notes#setting_up_your_greenstone_to_run_over_https|set up https support]]) that the GS3 will run on. Remember, to be accessible to the outside world, the host can't be "localhost", but would be the hostname of your machine or public IP. Click OK to exit the Java Control Panel with your changes in effect.
   - Make the GLI link on the home page active: Open web/interfaces/default/transform/pages/home.xsl for editing, find the line <code>   - Make the GLI link on the home page active: Open web/interfaces/default/transform/pages/home.xsl for editing, find the line <code>
 <!--<gslib:libraryInterfaceLink/><br/><br/>--> <!--<gslib:libraryInterfaceLink/><br/><br/>-->
 </code> and remove the comments. i.e. change it to <code> </code> and remove the comments. i.e. change it to <code>
 <gslib:libraryInterfaceLink/><br/><br/> <gslib:libraryInterfaceLink/><br/><br/>
-</code>+</code> Save the changes and close the file.
   - (Re)Start the GS3 web server and visit your DL library home page, ''http://[hostname]:8383/greenstone3/library''.   - (Re)Start the GS3 web server and visit your DL library home page, ''http://[hostname]:8383/greenstone3/library''.
   - Since you have set up the JNLP file association in a previous step, you can now click on the "The Librarian Interface" link and your browser should offer to save or launch a file called ''GLIappWebStart.jnlp''. Click ''Open With'' and in the dropdown box beside it, one of the launcher applications, at least on Windows, should be the "Java(TM) Web Start Launcher" application (javaws.exe) that you associated with .jnlp file extensions. Choose that application as the launcher. If the browser is able to successfully launch ''GLIappWebStart.jnlp'', then Java Web Start will be used to run the GLI application indicated by the JNLP file. If launching through the browser is not possible, for example, if the launcher application is not listed, as may happen on Linux machines, then choose to save the JNLP file. It will download the file to a temporary user area (like C:\Users\<user>\AppData\Local\Temp on windows). And then you can rightclick on the downloaded GLIappWebStart.jnlp file, to launch it with the Java Web Start program you already associated with this file type. This way should work on both Linux and Windows.   - Since you have set up the JNLP file association in a previous step, you can now click on the "The Librarian Interface" link and your browser should offer to save or launch a file called ''GLIappWebStart.jnlp''. Click ''Open With'' and in the dropdown box beside it, one of the launcher applications, at least on Windows, should be the "Java(TM) Web Start Launcher" application (javaws.exe) that you associated with .jnlp file extensions. Choose that application as the launcher. If the browser is able to successfully launch ''GLIappWebStart.jnlp'', then Java Web Start will be used to run the GLI application indicated by the JNLP file. If launching through the browser is not possible, for example, if the launcher application is not listed, as may happen on Linux machines, then choose to save the JNLP file. It will download the file to a temporary user area (like C:\Users\<user>\AppData\Local\Temp on windows). And then you can rightclick on the downloaded GLIappWebStart.jnlp file, to launch it with the Java Web Start program you already associated with this file type. This way should work on both Linux and Windows.
Line 299: Line 316:
   * Patches to perl code upgrading perl syntax to work with newer versions of perl   * Patches to perl code upgrading perl syntax to work with newer versions of perl
   * GLI updates:   * GLI updates:
-    * The GLI Applet has been converted to a Java WebStart Application. Java Web Start not supported from Java 9 or onwards. To use the JRE bundled with your Greenstone, ensure no custom installed System Java is in the environment.+    * The GLI Applet has been converted to a Java WebStart Application. Java Web Start not supported from Java 9 or onwards. Therefore, to use the JRE v7 bundled with your Greenstone, ensure no custom installed System Java is in the environment.
     * GEMS can now launch in languages other than English     * GEMS can now launch in languages other than English
 ===== IMPORTANT information ===== ===== IMPORTANT information =====
  
 For ease of access this section has been brought across from the [[en:release:3.08_release_notes|3.08 Release Notes]], but not all of it may be relevant to the 3.09 release. For ease of access this section has been brought across from the [[en:release:3.08_release_notes|3.08 Release Notes]], but not all of it may be relevant to the 3.09 release.
 +
 +==== Patches to 3.09 ====
 +These are corrections to a 3.09 installation that should be easy for Greenstone users to make.
 +
 +1. Bugfix to online document editor not calculating the correct subsection being edited
 +
 +Download the file [[http://trac.greenstone.org/browser/main/trunk/greenstone2/perllib/cgiactions/metadataaction.pm?rev=33311&format=txt|metadataaction.pm revision version 33311]] and put it into your GS3.09's gs2build/perllib/cgiactions folder, replacing the existing file by that name.
 +
 +2. Fix to solrserver on Windows not detecting that the GS3 server isn't running
 +
 +Download the file [[http://trac.greenstone.org/browser/gs3-extensions/solr/trunk/src/perllib/solrserver.pm?rev=33315&format=txt|solrserver.pm revision version 33315]] and put it into your GS3.09's ext/solr/perllib folder, replacing the existing file by that name.
 +
  
 ==== Troubleshooting ==== ==== Troubleshooting ====
 +
 +=== Some perl scripts don't run properly or to completion ===
 +//**If you're running Greenstone 3 on a non-English locale**// and certain perl scripts don't run properly or completely, such as when you run ''perl -S pluginfol.pl -describeall'', then the problem may be locale/encoding related. To resolve this issue, refer to [[en:supporting_other_locales|Supporting running Greenstone in other locales on Windows 10]].
 +
 +=== You see an empty page when visiting the Greenstone 3 library home page on Windows ===
 +//**If you're running Greenstone 3 on a non-English locale on Windows**//, then your library home page may look entirely empty. To resolve these and other locale and encoding related issues, refer to [[en:supporting_other_locales|Supporting running Greenstone in other locales on Windows 10]].
  
 === Content Encoding Error when visiting the local solr servlet page ===  === Content Encoding Error when visiting the local solr servlet page === 
Line 317: Line 352:
 We've added a work around to one kind of SIGPIPE errors which could occur with large collections when using ''solr'' as indexer. However, a couple of people on the mailing list encountered SIGPIPE errors on occasions when solr was not the indexer. **If your collection is using ''jdbm'' as the database type** and the error messages surrounding the SIGPIPE mention issues with "transaction commit", then Mariana Pichinini on the mailing list found that the following helped: We've added a work around to one kind of SIGPIPE errors which could occur with large collections when using ''solr'' as indexer. However, a couple of people on the mailing list encountered SIGPIPE errors on occasions when solr was not the indexer. **If your collection is using ''jdbm'' as the database type** and the error messages surrounding the SIGPIPE mention issues with "transaction commit", then Mariana Pichinini on the mailing list found that the following helped:
   * change the database type from ''jdbm'' to ''gdbm''   * change the database type from ''jdbm'' to ''gdbm''
-  * or leave the database type at ''jdbm'' and move your GS3's bundled JRE (the GS3's ''packages/jre'' subfolder) outside your GS3 installation. Next install a newer Java on your system so that GS3.08 can find that. If on Linux, ensure you open a new terminal before running GLI or command line building your collection.+  * or leave the database type at ''jdbm'' and move your GS3's bundled JRE (the GS3's ''packages/jre'' subfolder) outside your GS3 installation. Next install a newer Java on your system so that GS3.09 can find that. If on Linux, ensure you open a new terminal before running GLI or command line building your collection.
 === Your browser doesn't remember you being logged into greenstone === === Your browser doesn't remember you being logged into greenstone ===
 **The issue:** **The issue:**
Line 369: Line 404:
  
 ==== Useful information ==== ==== 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 to 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. +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 disk 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.+By default, Windows doesn't show you when files on your filesystem are hard-linked. If you choose to install the Windows extension application [[http://schinagl.priv.at/nt/hardlinkshellext/hardlinkshellext.html|Link Shell Extension (LSE)]], it will put red arrows on files that are hard linked.
  
 ====Known Issues==== ====Known Issues====
Line 396: Line 431:
 If you get this error, then please install the CGI module for your system perl. If you get this error, then please install the CGI module for your system perl.
 ====Work Arounds==== ====Work Arounds====
-===Filenames in collections should not contain &, < and >=== +===Filenames in collections should not contain < and >=== 
-In order to have better handling of different file and filename encodings, a [[http://trac.greenstone.org/changeset/29793|sacrifice]] [[http://trac.greenstone.org/timeline?from=19.03.2015&daysback=30&ticket=on&changeset=on&milestone=on&wiki=on&update=Update|was made]] of being unable to support &, < and > characters in filenames. Filenames with such characters will make metadata.xml invalid, as a result of which, GLI won't be able to reload the metadata therein.+[**Note:** [[https://stackoverflow.com/questions/1976007/what-characters-are-forbidden-in-windows-and-linux-directory-names|Windows disallows < and >]] characters in filenames anyway, so it's best to avoid such filenames even on other Operating Systems in cases where you may tranfer a Greenstone collection with documents' filenames containing < or > from one operating system to a GS3 running on Windows at any point.] 
 + 
 +In order to have better handling of different file and filename encodings, an [[http://trac.greenstone.org/changeset/29793|sacrifice]] [[http://trac.greenstone.org/timeline?from=19.03.2015&daysback=30&ticket=on&changeset=on&milestone=on&wiki=on&update=Update|was made]] of being unable to support &, < and > characters in filenames. In Dec 2019, which is months after 3.09's release, Greenstone was modified so that GLI can now accept & in filenames. However, filenames containing < and > characters continue to make metadata.xml invalid, as a result of which, GLI won't be able to reload the metadata therein. 
 + 
 +A workaround is to use different characters for < and >, such as [ and ] or ( and ), or leave them out from filenames.
  
-A workaround is to use "and" in place of "&" in filenames. And either use different characters for < and >, such as [ and ] or ( and ), or leave them out from filenames. 
 ===Greenstone applets (Phind, Collage) crash Firefox=== ===Greenstone applets (Phind, Collage) crash Firefox===
 See [[https://bugzilla.redhat.com/show_bug.cgi?id=789959|bugzilla report]]. See [[https://bugzilla.redhat.com/show_bug.cgi?id=789959|bugzilla report]].
Line 451: Line 489:
 Thanks to the following people for new and updated translations since 3.08: Thanks to the following people for new and updated translations since 3.08:
  
-  *Lavji Zala for Gujarati translations+  * French Yvan Arnaud 
 +  * Arabic to Kamal Salih Mustafa Khalafala. 
 +  * Diego Spano for Spanish translations 
 +  * Vano Tsertsvadze for Georgian translations 
 +  * Japanese Gaku Yamaguchi 
 +  * Lavji Zala for Gujarati translations 
 +  * Catalan (GS2 interface) Eduardo del Valle Perez 
en/release/3.09_release_notes.1555663176.txt.gz · Last modified: 2019/04/19 08:39 by anupama