en:release:3.12_release_notes
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
en:release:3.12_release_notes [2025/06/11 08:40] – [Running Greenstone] anupama | en:release:3.12_release_notes [2025/06/27 01:55] (current) – kjdon | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | |||
====== Greenstone 3.12 Release Notes ====== | ====== Greenstone 3.12 Release Notes ====== | ||
**Release Name:** 3.12 | **Release Name:** 3.12 | ||
+ | <!-- | ||
**Release Date:** Not yet released. Coming early 2025! | **Release Date:** Not yet released. Coming early 2025! | ||
** Released: ** | ** Released: ** | ||
+ | --> | ||
** Release Candidate History ** | ** Release Candidate History ** | ||
+ | * **Greenstone 3.12 rc1:** Release Candidate 1. Released 11 June 2025.\\ Binaries for Windows, GNU/Linux 64 and 32 bit, Mac Monterey. Mac version generated on MacOS Monterey/ | ||
+ | |||
+ | |||
+ | A special thanks to the Mac tech support at ITS who made the Mac Greenstone release possible. | ||
+ | |||
+ | |||
===== Installation Instructions===== | ===== Installation Instructions===== | ||
+ | |||
+ | ==== Installing and running the binary release==== | ||
+ | |||
+ | * [[https:// | ||
+ | |||
+ | === 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 " | ||
+ | - Double click the downloaded dmg file to mount it. The click the Volume image to open it - it will display the Greenstone installer .app. | ||
+ | - Ctrl+click (the Mac rightclick) and choose '' | ||
+ | - REPEAT: This //second// time you try to Ctrl+click and choose '' | ||
+ | - Try running this again - if it passes the jre stage, and gets you to the Greenstone installer dialog, then great. If not, | ||
+ | - Open a Finder window and navigate to the ''/ | ||
+ | - 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. | ||
+ | |||
+ | === Linux Notes === | ||
+ | |||
+ | * You will need to set the file to be executable before running it. e.g. \\ In a terminal '' | ||
+ | * 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' | ||
+ | < | ||
+ | | ||
+ | |||
+ | Use the following instead | ||
+ | < | ||
+ | |||
+ | ===Windows Notes === | ||
+ | * There is increased security for downloaded binary installers from newer versions of Windows 10 onwards.\\ After double clicking on the binary, you may first see Windows pop up a blue dialog ensuring you approve the installation. If you see the blue popup, click //more info// and then the button //Run anyway// that appears. Eventually, the Green splash screen of the installer should appear. | ||
+ | * For slightly older versions of Windows 10, the procedure may be different. After double-clicking, | ||
+ | |||
+ | |||
+ | ==== 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 | ||
+ | * Folder where you want greenstone3 to be installed. | ||
+ | * Choosing which packages to install. | ||
+ | * Greenstone3 will install the Apache Tomcat webserver by default. You can choose not to install it, but then you will need to set up your own version of Tomcat to serve Greenstone. We recommend using Greenstone' | ||
+ | * ImageMagick is bundled with Greenstone for binary web releases for all platforms, and includes JPEG2000 support. You can choose not to install it if you already have ImageMagick previously installed. | ||
+ | * Ghostscript is now bundled with Greenstone for binary web releases for Windows and Mac. You can choose not to install it if you already have Ghostscript previously installed. | ||
+ | * 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/ | ||
+ | |||
+ | ==== Running the installer in text-only mode ==== | ||
+ | |||
+ | You may want to run in text-only mode if you are installing on a headless server for example. | ||
+ | - If you're on Linux or Mac, give the binary of the installer execute permissions | ||
+ | - Then run it by passing in the -textonly flag, as shown below. | ||
+ | - Follow the instructions on the screen thereafter. If you mistype at any stage, press ctrl-C to start again. | ||
+ | |||
+ | < | ||
+ | > ./ | ||
+ | </ | ||
+ | |||
+ | ==== Adding source code to a binary release ==== | ||
+ | |||
+ | * [[http:// | ||
+ | * [[http:// | ||
+ | ==== Installing a source release ==== | ||
+ | |||
+ | * [[http:// | ||
+ | * [[http:// | ||
===== Running Greenstone ===== | ===== Running Greenstone ===== | ||
- | Once you have successfully installed Greenstone3, | + | ==== On a Windows or Linux ==== |
+ | Once you have successfully installed Greenstone3, | ||
- | More notes about running Greenstone can be found in the README.txt file in the top level Greenstone folder. | + | ==== On a Mac ==== |
- | ===== Further instructions ===== | + | You can either |
+ | - open a terminal, navigate to the folder you installed Greenstone in, and run ./ | ||
+ | - Open Finder. Use menu option Go->Go To Folder, and type in the folder where you installed Greenstone (eg / | ||
+ | - gs3-server - double clicking will start the library server, and open a browser to your library home page | ||
+ | - gli - starts the librarian interface, which you can use to build/edit collections. | ||
+ | - gems - used for editing metadata sets. | ||
- | ===== Important Changes and Bug Fixes ===== | ||
- | ==== Tomcat Upgrade | + | ===== Important Changes and Bug Fixes for 3.12 ===== |
+ | * **Tomcat Upgrade:** Tomcat has been upgraded to 8.5.99. This gives a few optimisations, | ||
+ | * To use Greenstone in an iframe: Edit resources/ | ||
+ | * See the [[en: | ||
- | Tomcat has been upgraded | + | * GS3.12 continues |
- | Edit resources/tomcat/greenstone3.xml.in and uncomment | + | |
+ | * **GLI Changes: the Files tab.** Added mainly to support Webswing GLI users, | ||
+ | |||
+ | * **Collage and Phind applets now webswing applications: | ||
+ | |||
+ | * **perl-with-cpan bundled:** perl 5.32.1 (5.32.1.1 on windows, 32 bit) is now bundled with Greenstone 3.12 and includes specific cpan libraries that Greenstone makes use of. Greenstone' | ||
+ | |||
+ | * **-metadata_mapping_file option for plugins:** - using a set of rules specified in a csv file, a plugin can generate new metadata values through manipulation of existing metadata. See greenstone3/ | ||
===== Updated Translations ===== | ===== Updated Translations ===== | ||
Line 33: | Line 113: | ||
* Tigran Zargaryan for Armenian translations | * Tigran Zargaryan for Armenian translations | ||
- | * Diego Spano for Spanich | + | * Diego Spano for Spanish |
+ | * Julian Fox for Italian translations | ||
+ | * Lavji Zala for Gujarati translations | ||
+ | * Upcoming: John Rose, Emmanuel Ngoi, Yvan Arnaud and Sandraghassen Subbaraya Pillai for French translations | ||
+ | |||
+ | |||
+ | ===== Features, issues, troubleshooting sections from earlier release notes ===== | ||
+ | The following sections are from earlier release notes, though any of them may continue to be pertinent now. | ||
+ | |||
+ | ==== Features since 3.11 ==== | ||
+ | |||
+ | * **The old PDF plugin:** From GS3.09 onward, GS3 binaries have been including additional tools for converting from PDF to various text/ | ||
+ | |||
+ | * **OpenOffice extension: | ||
+ | |||
+ | * **Webswing GLI replaces the GLI applet and the Remote GS3 server-client-GLI combination: | ||
+ | |||
+ | * **Google SignIn** allows users to login to the library using their google credentials. Logging in will create a greenstone account for the user with no groups added. Requires a google client ID to be obtained, and set as a servlet parameter in resources/ | ||
+ | |||
+ | * **The C++ code now compiles natively on Windows 64 bit.** | ||
+ | <!-- | ||
+ | * 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: | ||
+ | < | ||
+ | cd web/ | ||
+ | tar xzvf CGIModule.tar.gz | ||
+ | mv CGIModule/* . | ||
+ | </ | ||
+ | |||
+ | --> | ||
+ | ==== Setting up your Greenstone to run over https ==== | ||
+ | The prevalent method of supporting https for tomcat based servers is to have a main apache httpd web server that works with https, then set up a '' | ||
+ | |||
+ | Release notes for [[en: | ||
+ | |||
+ | |||
+ | ==== Building Collections ===== | ||
+ | To build collections, | ||
+ | |||
+ | ====Changing the admin password==== | ||
+ | Login to the administration page, ' | ||
+ | |||
+ | Alternatively, | ||
+ | |||
+ | ==== Setting up your Greenstone OAI Server and using GLI to download over OAI from a Greenstone server ==== | ||
+ | In Greenstone 3, collections should be available over OAI by default. Their collectionConfig.xml files already specify that each collection is OAI enabled, through use of an '' | ||
+ | < | ||
+ | <!-- | ||
+ | < | ||
+ | ... | ||
+ | </ | ||
+ | --> | ||
+ | </ | ||
+ | |||
+ | If you wish to validate the Greenstone 3 OAIServer, edit **resources/ | ||
+ | |||
+ | To validate your OAI server, visit http:// | ||
+ | |||
+ | Setting up your Greenstone 3 OAI Server is covered in further detail in the tutorial http:// | ||
+ | |||
+ | For further information on your Greenstone OAI Server, please read through [[en: | ||
+ | |||
+ | |||
+ | ==== Patches ==== | ||
+ | |||
+ | For ease of access this section has been brought across from the [[en: | ||
+ | |||
+ | ==== Useful information ==== | ||
+ | |||
+ | * To convert a 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' | ||
+ | |||
+ | |||
+ | ==== 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 '' | ||
+ | |||
+ | === 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:// | ||
+ | |||
+ | |||
+ | === Mac Installer fails === | ||
+ | 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 === | ||
+ | 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. | ||
+ | |||
+ | 1. On Linux and Mac, open a terminal and use it to navigate to your Greenstone 3 installation folder. | ||
+ | |||
+ | On Windows, you can either [[http:// | ||
+ | > Hold Shift while Right-Clicking a blank space in the desired folder to bring up a more verbose context menu. One of the options is //Open Command Window Here//. This works in Windows Vista, 7, 8, and 10. | ||
+ | |||
+ | 2. Now that your terminal is at the GS3 installation folder, you can type the following command in the terminal: | ||
+ | < | ||
+ | |||
+ | 4. It will ask for a new admin password. Type the new password and hit enter. | ||
+ | |||
+ | 5. Once you restart the server, try out your new password. | ||
+ | |||
+ | ====Known Issues==== | ||
+ | |||
+ | The issues below were encountered during or prior to the 3.11 release and have not been encountered when running through the Greenstone 3 tutorials for 3.12. | ||
+ | The descriptions of these issues are left in these 3.12 release notes as these issues may still exist but not been triggered by the tutorial tests. | ||
+ | |||
+ | === Java 8.0.362 issues === | ||
+ | |||
+ | In 3.11, we found issues when running GLI using update 362 of Java 8. These may occur with other Java updates, but have not appeared after Greenstone 3.11's release, so perhaps they have been fixed in newer releases of Java 8. The issues are: errors when cancelling a build; GLI hanging when you add a new file type into a collection and add in the suggested new plugin. If you encounter this, please upgrade your Java 8 to the latest update (was 382 at the time of testing 3.11). Note, we bundle Java 8 update 301 with the release, which doesn' | ||
+ | |||
+ | === Changes to Tomcat port affects Solr collections === | ||
+ | |||
+ | Currently when you change your tomcat port (either in build.properties, | ||
+ | If you make changes to Tomcat port, please shutdown and restart the server from the Start Menu. | ||
+ | If you are starting from within a terminal, you will need to shut down Greenstone and restart it from a fresh terminal. | ||
+ | |||
+ | === Web document editor requires perl CGI module === | ||
+ | //**Note:** Greenstone 3.11rc1 and onwards should not exhibit CGIModule related perl issues, as 3.11rc1 and later will install the CGIModule if the perl on your system is version 5.22 or later. However, should you nevertheless encounter perl error messages about CGI.pm being missing, this section could be of help:// | ||
+ | |||
+ | Editing documents through the web interface requires your system perl to have CGI installed. Without CGI, you can edit metadata and save, but your changes won't have been applied. You can tell this is the case by looking at the build log files in the collection, e.g. // | ||
+ | |||
+ | We believe we've fixed the following issue in all instances where it may show up, but should you at any point encounter an error message as below | ||
+ | < | ||
+ | ERROR: Can't locate CGI.pm in @INC (@INC contains: / | ||
+ | BEGIN failed--compilation aborted at ./ | ||
+ | Compilation failed in require at (eval 1) line 1. | ||
+ | </ | ||
+ | |||
+ | CGI.pm is not included with versions of [[https:// | ||
+ | |||
+ | In such a case: | ||
+ | < | ||
+ | cd web/ | ||
+ | tar xzvf CGIModule.tar.gz | ||
+ | mv CGIModule/* . | ||
+ | </ | ||
+ | |||
+ | If you don't have web/ | ||
+ | |||
+ | ====Work Arounds==== | ||
+ | ===Clicking a search result doesn' | ||
+ | // | ||
+ | |||
+ | For those who know to inspect the browser' | ||
+ | |||
+ | // | ||
+ | |||
+ | // | ||
+ | |||
+ | // | ||
+ | - Download the file https:// | ||
+ | - Put it into your GS3's web/ | ||
+ | - Rename the existing '' | ||
+ | - Rename the newly downloaded '' | ||
+ | |||
+ | |||
+ | ===Using filenames containing &, < and > in GS3.11 collections=== | ||
+ | The Enrich panel in GS3.11' | ||
+ | - &, < and > | ||
+ | - and other non-basic ASCII characters. | ||
+ | When you create a collection and assign it metadata in GLI that contains such characters, GLI will now successfully preserve them between GLI sessions. | ||
+ | |||
+ | The second set of characters listed above are still not recommended for use in metadata when dealing with a remote GS3 server, as that has to do with successfully transferring characters from an operating system in one file system encoding on the client side to possibly another operating system using another file system encoding on the GS3 server side. | ||
+ | |||
+ | **Beware:** It is only GLI's Enrich pane that has been fixed up to support both sets of characters in metadata. No other part of Greenstone has been fixed to cope with these characters, should they likewise struggle with them. | ||
+ | |||
+ | 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. | ||
+ | |||
+ | < | ||
+ | See [[https:// | ||
+ | |||
+ | If attempting to view a java applet (like Collage or Phind phrase classifiers) crashes Firefox, then make sure you have the Java Applet plugin installed. If it is installed and Firefox is still crashing, then open firefox and visit the page | ||
+ | < | ||
+ | Scroll down to the property: | ||
+ | < | ||
+ | Set it to true (rightclick and choose // | ||
+ | |||
+ | ===PDF to image conversion error on Linux=== | ||
+ | If you've configured a PDFPlugin to convert PDFs to images, increase the verbosity in Import Options and Build Options to 5 in GLI's Create panel. | ||
+ | |||
+ | When rebuilding the collection, check to see if you encounter the following error message mentioning that ' | ||
+ | < | ||
+ | import.pl> | ||
+ | import.pl> | ||
+ | import.pl> | ||
+ | import.pl> | ||
+ | import.pl> | ||
+ | import.pl> | ||
+ | import.pl> | ||
+ | import.pl> | ||
+ | import.pl> | ||
+ | import.pl> | ||
+ | import.pl> | ||
+ | import.pl> | ||
+ | import.pl> | ||
+ | import.pl> | ||
+ | import.pl> | ||
+ | </ | ||
+ | |||
+ | If you see the above error message, then: | ||
+ | |||
+ | 1. Use a text editor to open your Greenstone 3's gs2build/ | ||
+ | |||
+ | 2. Find the line that would say: | ||
+ | < | ||
+ | |||
+ | The above specifies the PostScript delegate for PNG images. It has the sDEVICE set to **pngalpha**. | ||
+ | |||
+ | 3. Change the line to: | ||
+ | < | ||
+ | |||
+ | The above changes the sDevice to **pnmraw**. | ||
+ | |||
+ | 4. Save the file and re-run the build now. | ||
en/release/3.12_release_notes.1749631243.txt.gz · Last modified: 2025/06/11 08:40 by anupama