Greenstone Wiki

User Tools

Site Tools

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

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
en:release:3.10_release_notes [2021/02/28 08:02] – anupamaen:release:3.10_release_notes [2023/07/06 03:05] (current) – anupama
Line 14: Line 14:
  
 ** Release Candidate History ** ** Release Candidate History **
-  * Greenstone 3.10 rc1: Release Candidate 1. Released 6 Dec 2020.\\ Binaries for Windows, GNU/Linux 64 bit, Mac Mojave/Catalina. Mac version generated on MacOS Mojave/10.14 and tested predominantly on Catalina/10.15. See notes immediatebly below.\\ Download from the [[http://www.greenstone.org/snapshots|snapshots]] page\\ [[https://svn.greenstone.org/main/tags/3.10rc1/|svn tag page]] [[https://trac.greenstone.org/browser/main/tags/3.10rc1|trac tag page]]. Code revision up to 34587. Tag revision:34590.+  * Greenstone 3.10 rc1: Release Candidate 1. Released 6 Dec 2020.\\ Binaries for Windows, GNU/Linux 64 bit, Mac Mojave/Catalina. Mac version generated on MacOS Mojave/10.14 and tested predominantly on Catalina/10.15. See notes immediately below.\\ Download from the [[http://www.greenstone.org/snapshots|snapshots]] page\\ [[https://svn.greenstone.org/main/tags/3.10rc1/|svn tag page]] [[https://trac.greenstone.org/browser/main/tags/3.10rc1|trac tag page]]. Code revision up to 34587. Tag revision:34590.
  
 **GS3.10rc1 issues and unknowns on Catalina Mac:** **GS3.10rc1 issues and unknowns on Catalina Mac:**
Line 32: Line 32:
   * 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.\\ **If you are on a Mac Catalina and do not have admin rights**, you can still get around this (for now) and install GS3.10 rc1 on Mac Catalina as follows:+  * **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.\\ **If you are on a Mac Catalina and do not have admin rights**, you can still get around this (for now) and install GS3.10  on Mac Catalina as follows:
   - Ctrl+click (the Mac rightclick) and choose ''Open With'' //or something like that// to launch the installer ''.app'' inside the ''.dmg'' Mac binary file   - Ctrl+click (the Mac rightclick) and choose ''Open With'' //or something like that// to launch the installer ''.app'' inside the ''.dmg'' Mac binary file
   - REPEAT: This //second// time you try to Ctrl+click and choose ''Open With'' to launch the installer ''.app'' inside the ''.dmg'' Mac binary file, Catalina will provide a buttonlink to allow you to "open anyway" and run the installer .app file in the ''.dmg''. After a brief time the attempt to launch the installer will fail without admin rights, mentioning something about ''/tmp/jre'' failing. //This is expected.// Press Cancel.   - REPEAT: This //second// time you try to Ctrl+click and choose ''Open With'' to launch the installer ''.app'' inside the ''.dmg'' Mac binary file, Catalina will provide a buttonlink to allow you to "open anyway" and run the installer .app file in the ''.dmg''. After a brief time the attempt to launch the installer will fail without admin rights, mentioning something about ''/tmp/jre'' failing. //This is expected.// Press Cancel.
Line 39: Line 39:
   - Now return to the installer .app file inside the .dmg. Ctrl+click on it and launch the installer once more. This time the launch process will complete and within a minute or so you should see the Greenstone Installer opening dialog appear.   - Now return to the installer .app file inside the .dmg. Ctrl+click on it and launch the installer once more. This time the launch process will complete and within a minute or so you should see the Greenstone Installer opening dialog appear.
  
-  * **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. \\ In a terminal ''chmod a+x Greenstone-3.10-linux''\\ or on Ubuntu, you can right-click on the installer, choose Properties, Go to the Permissions tab and ensure the "Execute: Allow executing file as program" tickbox is ticked.
     * 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't** work Note that in some cases, the following **doesn't** work
 <code> export TMPDIR=/something/else <code> export TMPDIR=/something/else
- ./Greenstone-3.09-linux</code>+ ./Greenstone-3.10-linux</code>
  
 Use the following instead Use the following instead
-<code> TMPDIR=/something/else ./Greenstone-3.09-linux</code>+<code> TMPDIR=/something/else ./Greenstone-3.10-linux</code>
  
 +* **For Windows users:**  To install, download the file and double-click. On newer versions of Windows 10: If the green installer splash screen doesn't appear after a few seconds, then right click on the installer executable, choose Properties, go to the General tab and at the bottom (in the Security section) look for a tick box labelled Unblock and tick this.
 +
 +
 +=== When the installer is running ===
 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
   * Folder where you want greenstone3 to be installed.    * Folder where you want greenstone3 to be installed. 
Line 62: Line 66:
  
 <!-- <!--
-=== Installing and running GS3.09 on Mac Maverick and Yosemite machines === +=== Installing and running GS3.10 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.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.)+From GS3.07rc**2** onwards, we're including a JRE with Mac Mountain Lion binaries, so that the **3.10 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.)
 --> -->
  
 ==== Installing in text-only mode ====  ==== 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]]+* Refer to [[http://wiki.greenstone.org/doku.php?id=old:user_advanced:installation#running_the_installer_in_text-only_mode|Running the installer in text-only mode]]
  
  
 ==== Adding source code to a binary release ====  ==== Adding source code to a binary release ==== 
  
-  * [[http://wiki.greenstone.org/doku.php?id=en:user_advanced:installation#source_component|Windows: Source Component instructions]] +  * [[http://wiki.greenstone.org/doku.php?id=old: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]]+  * [[http://wiki.greenstone.org/doku.php?id=old:user_advanced:installation#source_component1|Linux/Mac: Source Component instructions]]
 ==== Installing a source release ====  ==== Installing a source release ==== 
  
-  * [[http://wiki.greenstone.org/doku.php?id=en:user_advanced:installation#source_distribution|Windows: Source Distribution instructions]] +  * [[http://wiki.greenstone.org/doku.php?id=old: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]]+  * [[http://wiki.greenstone.org/doku.php?id=old:user_advanced:installation#source_distribution1|Linux/Mac: Source Distribution instructions]]
  
  
Line 107: Line 111:
  
 ==== Setting up your Greenstone to run over https ==== ==== Setting up your Greenstone to run over https ====
-//**Note:** This section is untested for this release, as the prevalent method of supporting https for tomcat based servers appears to be to have a main apache httpd web server that works with https, then set up a ''reverse proxy'' to let apacha httpd redirect requests for GS3's tomcat server internally to Greenstone.//+//**Note:** This section is untested for this release, as the prevalent method of supporting https for tomcat based servers appears to be to have a main apache httpd web server that works with https, then set up a ''reverse proxy'' to let apache httpd redirect requests for GS3's tomcat server internally to Greenstone.//
  
 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 "Let's Encrypt". 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 "Let's Encrypt".
Line 166: Line 170:
  
 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.  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. 
 +
 +
 +==== OpenOffice extension ====
 +If you have LibreOffice or OpenOffice installed, you can use the OpenOffice extension to process some newer versions of Microsoft Word, Excel and Powerpoint documents. Refer to the [[http://wiki.greenstone.org/doku.php?id=en:user_advanced:greenstone_extensions|openoffice greenstone extension]] instructions.
 ====Changing the admin password==== ====Changing the admin password====
 Login to the administration page, 'edit' the admin account, and click 'change password'. Alternatively, you can login as admin via the login button at the top right of each page. Once you are logged in, this button will change to say 'admin'. Click this button and select 'account settings'. From there, you can select 'change password'. Login to the administration page, 'edit' the admin account, and click 'change password'. Alternatively, you can login as admin via the login button at the top right of each page. Once you are logged in, this button will change to say 'admin'. Click this button and select 'account settings'. From there, you can select 'change password'.
Line 277: Line 285:
   * consult the more detailed instructions on the [[en:user_advanced:remote_greenstone|Remote Greenstone page]] for further steps that may be necessary to carry out.   * consult the more detailed instructions on the [[en:user_advanced:remote_greenstone|Remote Greenstone page]] for further steps that may be necessary to carry out.
  
 +If you are using perl 5.22 or later, these no longer come with the perl CGI module. Please download https://trac.greenstone.org/export/36059/main/trunk/greenstone2/common-src/cgi-bin/CGIModule.tar.gz into web/WEB-INF/cgi, untar it, and copy the contents of the resulting CGIModule folder up one level (i.e. outside of that folder).
  
 **Client-GLI** **Client-GLI**
Line 338: Line 347:
  
 ===== Important Changes and Bug Fixes ===== ===== Important Changes and Bug Fixes =====
-  * Bundling of Apache Tika for [[http://wiki.greenstone.org/doku.php?id=en:plugin:unknownconverterplugin|better support for docx files]]. An UnknownConverterPlugin is set up and ready by default to use Tika for docx processing. Tika can also be used as a fallback for extracting text from a wide range of documents, by configuring an UnknownConverterPlugin in similar fashion for other document types as determined by file extensions.+  * Bundling of Apache Tika for [[http://wiki.greenstone.org/doku.php?id=en:plugin:unknownconverterplugin|better support for docx files]]. An UnknownConverterPlugin is largely set up to use Tika for docx processing. But you will need JRE8 installed locally into your GS3 and Windows users will further need to tweak the UnknownConvertPlugin configuration: [[http://wiki.greenstone.org/doku.php?id=en:plugin:unknownconverterplugin#steps_for_310_users|instructions for both here]]. Tika can also be used as a fallback for extracting text from a wide range of documents, by configuring an UnknownConverterPlugin in similar fashion for other document types as determined by file extensions.
  
-  * There has been a change to the naming of custom properties files for a collection. Instead of having resources/collname.properties (eg resources/niupepa.properties), not the file is called resources/interface_custom.properties. If you already have a custom properties file, then please rename it.+  * There has been a change to the naming of custom properties files for a collection. Instead of having resources/collname.properties (eg resources/niupepa.properties), now the file is called resources/interface_custom.properties. If you already have a custom properties file, then please rename it.
  
   * 2 new features in GLI: exporting metadata fron GLI to a CSV file, and some graphical help setting up document or collection level security when editing the collection configuration through GLI. Described [[http://wiki.greenstone.org/doku.php?id=en:release:3.10_release_notes#new_client-_gli_features|in this section]].   * 2 new features in GLI: exporting metadata fron GLI to a CSV file, and some graphical help setting up document or collection level security when editing the collection configuration through GLI. Described [[http://wiki.greenstone.org/doku.php?id=en:release:3.10_release_notes#new_client-_gli_features|in this section]].
Line 369: Line 378:
 === Some perl scripts don't run properly or to completion === === 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]]. //**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]].
 +
 === Content Encoding Error when visiting the local solr servlet page ===  === 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 ''http://127.0.0.1:8383/solr'' or ''http://localhost:8383/solr'' in your browser, then this may have to do with the version of Java you have installed on your machine. From GS3.09 onward, if your machine has its own Java installed, then assuming that its version is sufficient and its bit-architecture (32 or 64 bit) matches, Greenstone will use your Java in preference to the bundled Java Runtime (JRE) that Greenstone ships with. We found that a recent version of Java (version 1.8.0_161 was problematic for us), caused the Content Encoding Error when visiting the solr servlet, whereas the bundled JRE and slightly earlier and much newer versions of Java such as 1.8.0_144 and 1.8.0_191 did not have these issues. If you see a Content Encoding Error when opening your GS3's solr servlet page at ''http://127.0.0.1:8383/solr'' or ''http://localhost:8383/solr'' in your browser, then this may have to do with the version of Java you have installed on your machine. From GS3.09 onward, if your machine has its own Java installed, then assuming that its version is sufficient and its bit-architecture (32 or 64 bit) matches, Greenstone will use your Java in preference to the bundled Java Runtime (JRE) that Greenstone ships with. We found that a recent version of Java (version 1.8.0_161 was problematic for us), caused the Content Encoding Error when visiting the solr servlet, whereas the bundled JRE and slightly earlier and much newer versions of Java such as 1.8.0_144 and 1.8.0_191 did not have these issues.
Line 375: Line 385:
 - either unset JAVA_HOME and remove this Java's ''bin'' folder from the PATH environment variable too, thus helping Greenstone 3 use its bundled JRE instead - either unset JAVA_HOME and remove this Java's ''bin'' folder from the PATH environment variable too, thus helping Greenstone 3 use its bundled JRE instead
 - 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. - 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 === === SIGPIPE errors when building a collection ===
Line 380: Line 391:
   * 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.09 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 459: Line 472:
 Compilation failed in require at (eval 1) line 1. Compilation failed in require at (eval 1) line 1.
 </code> </code>
 +
 +CGI.pm is not included with versions of [[https://stackoverflow.com/questions/45434990/why-does-this-code-have-issues-with-the-cgi-module|perl from 5.22 and onwards]], which is when this issue can result.
  
 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.
en/release/3.10_release_notes.txt · Last modified: 2023/07/06 03:05 by anupama