Greenstone Wiki

User Tools

Site Tools

You are here: index » en » release » 3.11_release_notes
en:release:3.11_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
Next revisionBoth sides next revision
en:release:3.11_release_notes [2023/07/10 06:57] – anupamaen:release:3.11_release_notes [2023/07/24 02:58] – [Important Changes and Bug Fixes] kjdon
Line 34: Line 34:
   * 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.11  on Mac Catalina as follows:+=== Mac OS Notes === 
 + 
 +  * 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.11  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 41: Line 43:
   - 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. \\ In a terminal ''chmod a+x Greenstone-3.11-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.+=== Linux Notes === 
 + 
 +  * You will need to set the file to be executable before running it. e.g. \\ In a terminal ''chmod a+x Greenstone-3.11-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
Line 50: Line 54:
 <code> TMPDIR=/something/else ./Greenstone-3.11-linux</code> <code> TMPDIR=/something/else ./Greenstone-3.11-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.+===Windows Notes === 
 +  *  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 ===+==== Installer options ====
 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 67:
   * Choosing a password for the administration pages. These pages allow the admin user to inspect and manage the list of registered Greenstone users. You can add new users, and change group settings for existing users. Greenstone user registration is needed if you want to use remote GLI login to the Greenstone server, or if you want to make collections/documents only accessible by certain groups of users. (//If the password is not set during installation, the default password for the 'admin' user is 'admin'. You can change the password any time after installation, by running the Greenstone 3 server and visiting the Administration pages. See [[#disabling_admin_access_in_installer| below]]//).    * Choosing a password for the administration pages. These pages allow the admin user to inspect and manage the list of registered Greenstone users. You can add new users, and change group settings for existing users. Greenstone user registration is needed if you want to use remote GLI login to the Greenstone server, or if you want to make collections/documents only accessible by certain groups of users. (//If the password is not set during installation, the default password for the 'admin' user is 'admin'. You can change the password any time after installation, by running the Greenstone 3 server and visiting the Administration pages. See [[#disabling_admin_access_in_installer| below]]//). 
  
 +==== Running Greenstone ====
 Once you have successfully installed Greenstone3, you can start up the server by choosing Grenstone3 Digital Library from the Start menu (Windows) or running gs3-server.sh/bat. This launches a small server program which starts up Tomcat and launches a browser. A small window pops up which allows you to change some settings for your library and restart the Tomcat server. Closing this program will stop Tomcat running. By default, your library will be available at localhost:8383/greenstone3/library. File->Settings in the Greenstone Server window gives you options to change the port number and which browser it uses by default. Once you have successfully installed Greenstone3, you can start up the server by choosing Grenstone3 Digital Library from the Start menu (Windows) or running gs3-server.sh/bat. This launches a small server program which starts up Tomcat and launches a browser. A small window pops up which allows you to change some settings for your library and restart the Tomcat server. Closing this program will stop Tomcat running. By default, your library will be available at localhost:8383/greenstone3/library. File->Settings in the Greenstone Server window gives you options to change the port number and which browser it uses by default.
 More notes about running Greenstone can be found in the README.txt file in the top level Greenstone folder. More notes about running Greenstone can be found in the README.txt file in the top level Greenstone folder.
  
 +==== Building Collections ====
 To build collections, run GLI from the Start menu (Windows) or by running gli/gli.sh/bat in the top level Greenstone3 folder. Tutorial exercises about building collections in Greenstone 3 can be found [[en:tutorials | here]]. Make sure you select the Greenstone3 tab at the top if it is not already selected. To build collections, run GLI from the Start menu (Windows) or by running gli/gli.sh/bat in the top level Greenstone3 folder. Tutorial exercises about building collections in Greenstone 3 can be found [[en:tutorials | here]]. Make sure you select the Greenstone3 tab at the top if it is not already selected.
  
Line 100: Line 107:
 ====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'.
 +
 +Alternatively, you can set the admin password from the command line. See[[#using_the_command_line_to_reset_the_admin_password_when_it_isn_t_recognised| below]].
  
 ==== Setting up your Greenstone OAI Server and using GLI to download over OAI from a Greenstone server ====  ==== Setting up your Greenstone OAI Server and using GLI to download over OAI from a Greenstone server ==== 
Line 128: Line 137:
  
 ===== Important Changes and Bug Fixes ===== ===== Important Changes and Bug Fixes =====
 +  * Minimum Java version is now 1.8, and this is the version that is bundled in the releases.
 +
   * This release introduces the **WebSwing GLI feature: GLI is now built into your browser.** (But regular, desktop GLI is not going away, and still available as before.) WebSwing GLI replaces the client-GLI with Remote GS3 server combination and GLI applet/GLI Webstart application. Refer to [[https://files.greenstone.org/tutorial/gs3-current/en/all_tutorials.html#webswing_gli|Using WebSwing GLI (Web GLI)]] for instructions on how to start using WebSwing GLI. It's mostly the same as Desktop GLI, so the linked tutorial runs you through just the differences.    * This release introduces the **WebSwing GLI feature: GLI is now built into your browser.** (But regular, desktop GLI is not going away, and still available as before.) WebSwing GLI replaces the client-GLI with Remote GS3 server combination and GLI applet/GLI Webstart application. Refer to [[https://files.greenstone.org/tutorial/gs3-current/en/all_tutorials.html#webswing_gli|Using WebSwing GLI (Web GLI)]] for instructions on how to start using WebSwing GLI. It's mostly the same as Desktop GLI, so the linked tutorial runs you through just the differences. 
 +
 +  * GLI Changes: Support added for SOLR indexing, and for specifying sortfields (Lucece/SOLR) and facets (SOLR).
 +
 +  * CSVPlugin Changed - we have a new CSVPlugin which replaces the old CVSPlugin and MetadataCSVPlugin plugins. This new plugin will assign the metadata to existing documents (specified by Filename field) or create dummy documents if no associated file is present. It handles input_encoding, and spaces in field names, There are many new options for finetuning its behaviour.
      
-  * From perl 5.22 and later, perl no longer comes with the perl CGI module, but Greenstone 3.11 bundles its own CGIModule and unpacks it for perl v5.22 onwards, so you should be good to go.+  * The perl code has been updated to handle UTF16 surrogate pairs. 
 + 
 +  * The C++ code now compiles natively on Windows 64 bit. 
 + 
 +  * SOLR changes - support has been added for subcollections and language partitions, to match what you can do with other indexers. While faceted searching provides an equivalent functionality, there may be some cases where these index partitions suit the situation better. 
 + 
 +  * A cookie consent functionality has been implemented. 
 + 
 +  * Namespaced user groups, eg nz.ac.waikato - ANU to explain. 
 + 
 +  *  Developing a custom interface? You can now put the interface property files into web/interfaces/<my-interface>/resources instead of having to put them into the main we/WEB-INF/classes folder.
  
-If however, you find you don't have perl CGI module installed when you want to use remote gli or do online document editing, then manually unpack it as follows:+  * Berry baskets have been replaced by Favourites - a more streamlined, accessible version. 
 +  *  
 +  * From perl 5.22 and later, perl no longer comes with the perl CGI module, but Greenstone 3.11 bundles its own CGIModule and unpacks it for perl v5.22 onwards, so you should be good to go. If however, you find you don't have perl CGI module installed when you want to use remote gli or do online document editing, then manually unpack it as follows:
 <code> <code>
 cd web/WEB-INF/cgi  cd web/WEB-INF/cgi 
Line 138: Line 165:
 mv CGIModule/* . mv CGIModule/* .
 </code> </code>
-  +   * Google SignIn - allows users to login to the library using their google credentials. Loggin in will create a greenstone account for the user with no permissions. Requires 
 ===== IMPORTANT information ===== ===== IMPORTANT information =====
  
Line 144: Line 171:
  
 ==== Patches to 3.11 ==== ==== Patches to 3.11 ====
-  * Shift to bundling JRE 1.8 + 
- +
 ==== Useful information ==== ==== Useful information ====
  
Line 248: Line 273:
 The fix is often in the form of adding hex encoded entities into the metadata.xml file and decoding them back for display in GLI's Enrich pane. The fix is often in the form of adding hex encoded entities into the metadata.xml file and decoding them back for display in GLI's Enrich pane.
  
-===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 255: Line 280:
 Scroll down to the property: Scroll down to the property:
 <code>dom.ipc.plugins.java.enabled</code> <code>dom.ipc.plugins.java.enabled</code>
-Set it to true (rightclick and choose //toggle//).+Set it to true (rightclick and choose //toggle//).-->
  
 ===PDF to image conversion error on Linux=== ===PDF to image conversion error on Linux===
Line 297: Line 322:
 ===== Updated Translations ===== ===== Updated Translations =====
  
 +Thanks to the following people for new and updated translations since 3.10: 
 +
 +  * Lavji Zala for Gujarati translations
 +  * Hilario Seo for Korean translations
 +  * Yvan Arnaud for French translations
 +  * John Rose for French translations
 +  * 
en/release/3.11_release_notes.txt · Last modified: 2024/02/15 02:14 by kjdon