en:release:3.09_release_notes
Differences
This shows you the differences between two versions of the page.
en:release:3.09_release_notes [2018/02/27 06:03] – created anupama | en: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: | + | **Release Date: |
+ | |||
+ | ** Released: ** | ||
+ | |||
+ | * Binaries for Windows, GNU/Linux 32 and 64 bit machines, a Mac binary for High Sierra/ | ||
+ | * The Mac binary is generated on High Sierra/ | ||
+ | * 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/ | ||
+ | |||
+ | 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 " | + | * **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 " |
- | * **For Linux**, you will need to set the file to be executable before running it. (e.g. chmod a+x Greenstone-3.08-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) |
* The installer initially unpacks into a temporary directory (/tmp on linux). If you wish to change this, set the TMPDIR environment variable. | * The installer initially unpacks into a temporary directory (/tmp on linux). If you wish to change this, set the TMPDIR environment variable. | ||
Note that in some cases, the following **doesn' | Note that in some cases, the following **doesn' | ||
< | < | ||
- | | + | |
Use the following instead | Use the following instead | ||
- | < | + | < |
During the installation process you will be presented with several options. For many, the default settings will be sufficient. Some important options are | During the installation process you will be presented with several options. For many, the default settings will be sufficient. Some important options are | ||
Line 38: | Line 54: | ||
<!-- | <!-- | ||
=== Installing and running GS3.09 on Mac Maverick and Yosemite machines === | === Installing and running GS3.09 on Mac Maverick and Yosemite machines === | ||
- | From GS3.07rc**2** onwards, we're including a JRE with Mac Mountain Lion binaries, so that the **3.08 Mountain Lion binaries should work on Maverick and Yosemite machines out of the box.** (At present the source code still does not compile up on these newer Mac Operating Systems.) | + | From GS3.07rc**2** onwards, we're including a JRE with Mac Mountain Lion binaries, so that the **3.09 Mountain Lion binaries should work on Maverick and Yosemite machines out of the box.** (At present the source code still does not compile up on these newer Mac Operating Systems.) |
--> | --> | ||
Line 56: | Line 72: | ||
===== Further instructions ===== | ===== Further instructions ===== | ||
+ | ==== Setting up your Greenstone to run over https ==== | ||
+ | The more secure https protocol is increasingly required by browsers and gradually superseding http. Given that you meet the following requirements and configure your GS3 as below, Greenstone 3 has now been automated to obtain an https certificate for you from the free Certification Authority " | ||
+ | Requirements: | ||
+ | * on unix (linux and mac) systems you need to have sudo permissions | ||
+ | * on windows, you probably need admin rights | ||
+ | * ensure nothing is running on port 80 when you're ready to set up https certification for your GS3 | ||
+ | |||
+ | Steps: | ||
+ | - Edit build.properties as follows: | ||
+ | * set '' | ||
+ | * set a value for '' | ||
+ | * Ensure '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * By default '' | ||
+ | - Make sure you have read and agree with the [[https:// | ||
+ | - Use a terminal to go into your GS3 installation folder, run '' | ||
+ | source ./ | ||
+ | ant setup-https-cert | ||
+ | </ | ||
+ | - Once the setup-https-cert ant target has finished, you can start your web GS3 server by either running the gs3-server application or by running "ant start" from the terminal. | ||
+ | - If you ran the gs3-server application, | ||
+ | * when visiting your digital library over http**s**, remember to prefix htt**ps** to the address and use the htt**ps** port defined with '' | ||
+ | * If you've also turned on http support alongside https, then to visit your DL over regular http, return the URL to having the htt**p** prefix and remember to change the port number to what's defined for htt**p** in property '' | ||
+ | - Once your https home page has loaded, confirm that your certificate is properly installed by looking for a green padlock next to the address bar. (Depending on your browser, you can click the padlock to get more information on the certificate issuer.) | ||
+ | |||
+ | There are 2 more https-related automated ant targets you can run from the command line: | ||
+ | * '' | ||
+ | * '' | ||
+ | |||
+ | **Important: | ||
+ | |||
+ | |||
+ | ==== PDF plugin restructuring and the NEW PDFv2Plugin ==== | ||
+ | |||
+ | From GS3.09 onward, the GS3 binaries will henceforth include additional tools for converting from PDF to various text/ | ||
+ | |||
+ | We're deprecating the old " | ||
+ | * "// | ||
+ | * **the recommended "// | ||
+ | |||
+ | For the eventual 3.09 release, the old PDFPlugin that you're familiar with, the one which has the '' | ||
+ | |||
+ | |||
+ | The " | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | |||
+ | As always, text is only extracted from a PDF where extractable. This depends on user permissions for a PDF, whether the PDF contains actual extractable text and not just images of text, whether the PDF is undamaged, and any other such factors. | ||
+ | |||
+ | There may be further adjustments made, including to display strings, but so far, we've decided on the above output formats and they seem to work on my regular PDF test documents. | ||
====Changing the admin password==== | ====Changing the admin password==== | ||
Login to the administration page, ' | Login to the administration page, ' | ||
Line 117: | Line 190: | ||
2. Make the Greenstone " | 2. Make the Greenstone " | ||
- | On Unix, use //chmod//. | + | On Unix, you would do |
+ | < | ||
On Windows, run in a DOS prompt: | On Windows, run in a DOS prompt: | ||
Line 140: | 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 '' | + | 4. Set up your Greenstone environment if you've not already done so by running '' |
< | < | ||
ant start | ant start | ||
Line 180: | Line 254: | ||
===GLI Java Web Start application (replacement for GLI Applet) - Additional Steps=== | ===GLI Java Web Start application (replacement for GLI Applet) - Additional Steps=== | ||
- | Many browsers have stopped supporting | + | **You will need a Java Development Kit (JDK) v 7 or 8 installed for this.** |
- | Instructions for using the GLI Java Web Start, which works over the JNLP protocol | + | Many browsers have stopped supporting Java applets including Microsoft Edge, though Microsoft' |
- | | + | Instructions for using the GLI Java Web Start, which works over the JNLP protocol, are below. |
- | - Next, generate the SignedGatherer.jar: | + | |
+ | | ||
+ | - Next, generate the SignedGatherer.jar | ||
* Use a terminal to go into the Greenstone " | * Use a terminal to go into the Greenstone " | ||
- | * Next, run | + | * Next, run < |
- | < | + | When it prompts, enter the password you used above ('' |
- | When it prompts, enter the password you used above. | + | |
- Move the created '' | - Move the created '' | ||
- You need to associate JNLP files with Java Web Start ('' | - You need to associate JNLP files with Java Web Start ('' | ||
* On Windows, create the association in the usual way: when you first access the GLI Web Start application through Greenstone, a JNLP file called " | * On Windows, create the association in the usual way: when you first access the GLI Web Start application through Greenstone, a JNLP file called " | ||
- | * For Linux, create a file with '' | + | |
- | # This file should be adjusted and then copied into ~/ | + | |
- | # as a file with .desktop extension, e.g. javawebstart.desktop | + | # This file should be adjusted and then copied into ~/ |
- | # https:// | + | # as a file with .desktop extension, e.g. javawebstart.desktop |
- | [Desktop Entry] | + | # https:// |
- | Encoding=UTF-8 | + | [Desktop Entry] |
- | Name=Java 7 Web Start | + | Encoding=UTF-8 |
- | Comment=Java 7 Web Start | + | Name=Java 7 Web Start |
- | Exec=/home/ | + | Comment=Java 7 Web Start |
- | Terminal=false | + | Exec=/EDIT-THIS-PATH-TO-YOUR-JAVA-JRE/bin/javaws %u |
- | Type=Application | + | Terminal=false |
- | Icon=javaws | + | Type=Application |
- | Categories=Application; | + | Icon=javaws |
- | MimeType=application/ | + | Categories=Application; |
+ | MimeType=application/ | ||
</ | </ | ||
- | - Launch the Java Control Panel by running '' | + | - Launch the Java Control Panel by running '' |
- | - Once the GS3 code is compiled up, start up the GS3 web server and visit your DL library home page, '' | + | - Make the GLI link on the home page active: Open web/ |
- | - After authorising | + | < |
- | + | </ | |
+ | < | ||
+ | </ | ||
+ | - (Re)Start | ||
+ | - Since you have set up the JNLP file association in a previous step, you can now click on the "The Librarian Interface" | ||
+ | - You will need to **authorise** | ||
=== Converting a GS2 collection to GS3 when working with a remote GS3 server === | === Converting a GS2 collection to GS3 when working with a remote GS3 server === | ||
The new Format Conversion Wizard to convert GS2 format statements to GS3 format statements (see [[en: | The new Format Conversion Wizard to convert GS2 format statements to GS3 format statements (see [[en: | ||
Line 220: | Line 300: | ||
===== Important Changes and Bug Fixes ===== | ===== Important Changes and Bug Fixes ===== | ||
- | + | * **HTTPS support:** Greenstone will obtain a certificate from the Certification Authority Let's Encrypt | |
- | | + | * **GreenstoneSQLPlugin/ |
- | * lots of display items (for indexes, classifiers etc) now come from dictionaries, rather than being defined in the collectionConfig.xml file. Translations are available for many languages. This enables the translated collection interface | + | * **The UnknownConverterPlugin: |
- | * gs3 can work off a read only location such as dvd. | + | * **User comments** are now supported in GS3 as well. Refer to [[http://wiki.greenstone.org/ |
- | | + | * OAI deletion policy |
- | | + | * Better way to run processes from GLI will avoid some occasional |
- | * collection | + | * Bug fixes to file locking issues on Windows when using Lucene as indexer |
- | * < | + | * **SOLR updates and bugfixes:** |
- | * support for classifier tabs that are just linksq | + | * Patch to SOLR extension to circumvent SIGPIPE errors |
- | | + | * fixed bug where multiple metadata values for a single field were concatenated into a single facet term |
- | * Tidied up collection building using manifest files. See the [[http://files.greenstone.org/ | + | * fixed some/all search handling |
- | * | + | * Russian morphology analyzer replaced by more efficient version. |
+ | * Added russian morphology analyzer configuration into solr-jdbm-demo collection | ||
+ | * Standard SOLR highlighter replaced with the faster FastVectorHighlighter | ||
+ | * Patches to perl code upgrading perl syntax to work with newer versions of perl | ||
+ | * GLI updates: | ||
+ | * 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 | ||
===== IMPORTANT information ===== | ===== IMPORTANT information ===== | ||
- | For ease of access this section has been brought across from the [[en: | + | For ease of access this section has been brought across from the [[en: |
+ | |||
+ | ==== 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:// | ||
+ | |||
+ | 2. Fix to solrserver on Windows not detecting that the GS3 server isn't running | ||
+ | |||
+ | Download the file [[http:// | ||
==== 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 '' | ||
+ | |||
+ | === 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**//, | ||
+ | |||
+ | === Content Encoding Error when visiting the local solr servlet page === | ||
+ | If you see a Content Encoding Error when opening your GS3's solr servlet page at '' | ||
+ | |||
+ | **Solution: | ||
+ | - either unset JAVA_HOME and remove this Java's '' | ||
+ | - install a newer version of Java on your system. We found that the current latest one, 1.8.0_191 worked successfully for this purpose. | ||
+ | |||
+ | === SIGPIPE errors when building a collection === | ||
+ | We've added a work around to one kind of SIGPIPE errors which could occur with large collections when using '' | ||
+ | * change the database type from '' | ||
+ | * or leave the database type at '' | ||
+ | === Your browser doesn' | ||
+ | **The issue:** | ||
+ | The following scenario can occur if you set up GS3 with https, and your server.protocols property in build.properties contains both '' | ||
+ | |||
+ | Switching between visiting your Greenstone 3 digital library (DL) using http and https URLs can result in the http version of the pages not remembering your login details despite you logging in. This can happen if you ever started off with the https version of the URL to a Greenstone3 DL page and then moved to using the http version of your GS3 URL, or if you ever logged in to your GS3 over https and then attempt to log in later using http. | ||
+ | |||
+ | **The solution:** | ||
+ | The solution is to either start a private window if you want to access your GS3 DL pages over http, or to first clear your browser cookies related to your GS3 DL before swapping from https to http. | ||
+ | |||
+ | **The cause:** | ||
+ | Using https causes session cookies to have the secure flag set to true. When a session cookie has the secure flag thus set, non http URLs cannot return that cookie in their subsequent requests to the server. Only https URLs can. See https:// | ||
+ | |||
+ | <!-- | ||
+ | If you're on firefox and you just logged in to to a running Greenstone 3 digital library (DL), but visiting subsequent pages in the DL shows you that it has forgotten you're logged in, then you're probably encountering a restriction that your firefox browser has. | ||
+ | |||
+ | **NOTE:** We've encountered this problem on Firefox and only for http URLs that use the domain/ | ||
+ | |||
+ | To confirm that it only happens on firefox, try another browser first. For instance, Chrome. If your being logged in is being remembered on Chrome, then you've confirmed that the phenomenon is firefox-specific. | ||
+ | |||
+ | Things to try: | ||
+ | * Close all tabs in firefox and restart firefox in the usual way. Try logging in and visiting other pages to see if it remembers your login now. | ||
+ | * If that made no difference, try launching a Private Window (Ctrl + Shift + P on firefox), visit your GS3 digital library and login again, then check whether it's being remembered across Greenstone pages now. | ||
+ | * If that also made no difference then the most likely cause is Firefox plugins or extensions or addons, or maybe its hardware acceleration feature needs to be switched off. To find out if any of this is the case, quit firefox once more by first close all tabs in firefox and quit it. Then try re-launching Firefox in Safe Mode as explained at https:// | ||
+ | |||
+ | > [[https:// | ||
+ | > A small dialog should appear. Click Start In Safe Mode (not Refresh). Is the problem still there? | ||
+ | |||
+ | (If that doesn' | ||
+ | |||
+ | After relaunching Firefox in Safe Mode, test whether your login details are being remembered this time. If it works now, it could indeed be an addon/ | ||
+ | --> | ||
=== Mac Installer fails === | === Mac Installer fails === | ||
If running the Mac installer results in a message about having failed to copy to ''/ | If running the Mac installer results in a message about having failed to copy to ''/ | ||
+ | |||
=== Using the command line to reset the admin password when it isn't recognised === | === Using the command line to reset the admin password when it isn't recognised === | ||
If at any stage, your admin password is no longer recognised from the Greenstone Reader interface (the Greenstone pages that you view through the web browser), then you can try to reset your admin password through the command line. | If at any stage, your admin password is no longer recognised from the Greenstone Reader interface (the Greenstone pages that you view through the web browser), then you can try to reset your admin password through the command line. | ||
Line 254: | Line 402: | ||
5. Once you restart the server, try out your new password. | 5. Once you restart the server, try out your new password. | ||
+ | |||
==== 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' | + | 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' |
- | By default, Windows doesn' | + | By default, Windows doesn' |
====Known Issues==== | ====Known Issues==== | ||
Line 282: | 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 | + | ===Filenames in collections should not contain < and >=== |
- | In order to have better handling of different file and filename encodings, | + | [**Note:** [[https:// |
+ | |||
+ | In order to have better handling of different file and filename encodings, | ||
+ | |||
+ | 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 " | ||
===Greenstone applets (Phind, Collage) crash Firefox=== | ===Greenstone applets (Phind, Collage) crash Firefox=== | ||
See [[https:// | See [[https:// | ||
Line 335: | Line 487: | ||
===== Updated Translations ===== | ===== Updated Translations ===== | ||
- | Thanks to the following people for new and updated translations since 3.07: | + | Thanks to the following people for new and updated translations since 3.08: |
- | * Yvan Arnaud | + | |
- | * Tomáš Fiala for Slovak translations | + | * French |
- | * Yamaguchi Gaku for Japanese translations | + | * Arabic to Kamal Salih Mustafa Khalafala. |
- | * Maciej Jaros for Polish translations | + | |
- | * Georgy Litvinov for Russian translations | + | |
* Diego Spano for Spanish translations | * Diego Spano for Spanish translations | ||
+ | * Vano Tsertsvadze for Georgian translations | ||
+ | * Japanese Gaku Yamaguchi | ||
* Lavji Zala for Gujarati translations | * Lavji Zala for Gujarati translations | ||
- | | + | * Catalan |
en/release/3.09_release_notes.txt · Last modified: 2023/03/13 01:46 by 127.0.0.1