en:release:3.08_release_notes
no way to compare when less than two revisions
Differences
This shows you the differences between two versions of the page.
Previous revisionNext revision | |||
— | en:release:3.08_release_notes [2020/06/22 08:13] – [Important Changes and Bug Fixes] anupama | ||
---|---|---|---|
Line 1: | Line 1: | ||
+ | ====== Greenstone 3.08 Release Notes ====== | ||
+ | |||
+ | **Release Name:** 3.08 | ||
+ | |||
+ | **Release Date:** 23 Nov 2016. | ||
+ | |||
+ | ** Released: ** | ||
+ | |||
+ | * Binaries for Windows, GNU/Linux 32 and 64 bit machines, Mac Mountain Lion/10.8.* and Mac El Capitan (10.11.*). The two Mac binaries are generated on Mountain Lion/10.8.5 and El Capitan/ | ||
+ | |||
+ | ** Release Candidate History ** | ||
+ | |||
+ | * Greenstone 3.08 rc1: Release Candidate 1. Released 26/29 Aug 2016, for the TPDL workshop. \\ Binaries for Windows, GNU/Linux 32 and 64 bit machines, Mac Mountain-Lion and Mac El-Capitan. (Mac versions generated on Mountain Lion/10.8.5 and El Capitan 10.11. The former may still work on Mac Yosemite as 3.07 did, but is untested.) \\ Download from the [[http:// | ||
+ | | ||
+ | ===== Installation Instructions===== | ||
+ | |||
+ | ==== Installing and running the binary release==== | ||
+ | |||
+ | * 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 " | ||
+ | |||
+ | * **For Linux**, you will need to set the file to be executable before running it. (e.g. chmod a+x Greenstone-3.08-linux) | ||
+ | * 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 | ||
+ | < | ||
+ | |||
+ | 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/ | ||
+ | |||
+ | 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. | ||
+ | |||
+ | To build collections, | ||
+ | |||
+ | === Installing and running GS3.08 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.) | ||
+ | |||
+ | |||
+ | ==== Installing in text-only mode ==== | ||
+ | * Refer to [[http:// | ||
+ | |||
+ | |||
+ | ==== Adding source code to a binary release ==== | ||
+ | |||
+ | * [[http:// | ||
+ | * [[http:// | ||
+ | ==== Installing a source release ==== | ||
+ | |||
+ | * [[http:// | ||
+ | * [[http:// | ||
+ | |||
+ | |||
+ | ===== Further instructions ===== | ||
+ | |||
+ | ====Changing the admin password==== | ||
+ | Login to the administration page, ' | ||
+ | |||
+ | ==== 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: | ||
+ | |||
+ | |||
+ | ==== Setting up a remote Greenstone 3 server ==== | ||
+ | This will allow remote client-GLI applications to connect to your Greenstone server, to remotely create and upload new collections to be built and hosted by your server machine. | ||
+ | |||
+ | |||
+ | **Remote Greenstone 3 Server** | ||
+ | |||
+ | To install the server-side functionality: | ||
+ | |||
+ | 1. If you're on Windows, you will need to teach Greenstone where the perl executable is. | ||
+ | |||
+ | You can do this either manually, by editing a couple of Greenstone config files as explained just below, or you could run the Greenstone server once and press '' | ||
+ | |||
+ | To do this manually on Windows, | ||
+ | |||
+ | a. Open Tomcat' | ||
+ | |||
+ | < | ||
+ | < | ||
+ | < | ||
+ | < | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | b. Edit the first line of the greenstone3/ | ||
+ | On Windows this will be (if installed in the default location): | ||
+ | |||
+ | < | ||
+ | # | ||
+ | </ | ||
+ | |||
+ | <!-- 2. If you're on Linux and working with a binary release, make sure that the webserver user has executable permissions on gliserver.pl: | ||
+ | < | ||
+ | cd greenstone3/ | ||
+ | chmod a+rx gliserver.pl | ||
+ | </ | ||
+ | |||
+ | 2. Make the Greenstone " | ||
+ | |||
+ | On Unix, use //chmod//. | ||
+ | |||
+ | On Windows, run in a DOS prompt: | ||
+ | |||
+ | < | ||
+ | cacls " | ||
+ | </ | ||
+ | |||
+ | 3. Open up the file build.properties located in your greenstone installation folder. Edit the // | ||
+ | < | ||
+ | # tomcat info | ||
+ | tomcat.server=your-server-computer-name | ||
+ | </ | ||
+ | |||
+ | Once the server is started up, this will update the same property in greenstone' | ||
+ | |||
+ | |||
+ | (If you don't know what your machine' | ||
+ | < | ||
+ | Scroll to the top of the output that gets printed to the screen and note what it mentions for //HOST NAME//. Also note the //DNS Suffix Search List//. | ||
+ | |||
+ | 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 '' | ||
+ | < | ||
+ | ant start | ||
+ | </ | ||
+ | (or '' | ||
+ | |||
+ | 5. Check that Tomcat and Greenstone3 are working correctly by visiting | ||
+ | < | ||
+ | </ | ||
+ | |||
+ | 6. Add some user accounts by visiting the Greenstone 3 home page (http:// | ||
+ | |||
+ | Once logged in, go to the Administration page. You can access this via the link on the home page. (Or you can click the admin link, choose '' | ||
+ | |||
+ | Add a new user by providing a new username, setting a password for the user that's a minimum of 3 characters long, and by using the drop-down provided for the '' | ||
+ | |||
+ | Even if only the '' | ||
+ | |||
+ | 7. Finally, visit the following page in the web browser to test that your remote Greenstone server is set up properly: | ||
+ | < | ||
+ | </ | ||
+ | You should get a message saying "Java found" and " | ||
+ | |||
+ | If you get a message saying "Java failed" | ||
+ | * check that the Java run-time is installed and on the webserver' | ||
+ | * consult the more detailed instructions on the [[en: | ||
+ | |||
+ | |||
+ | **Client-GLI** | ||
+ | |||
+ | Assuming that the remote Greenstone server is accessible to the outside world and you're not behind a firewall, you can access the remote Greenstone server from a client-gli application installed on any other machine. To do so, | ||
+ | |||
+ | 1. Run client-gli quite as you would GLI. It's accessible from the Windows Start menu, otherwise you can run the client-gli script (located at the toplevel of a Greenstone installation) from a terminal. | ||
+ | |||
+ | * NOTE: 3.08 client-gli.sh/ | ||
+ | * Linux: client-gli.sh. Look for the two lines starting < | ||
+ | * Windows: client-gli.bat. Look for the two lines starting < | ||
+ | |||
+ | 2. You'll be asked for the gliserver.pl URL of the remote Greenstone 3 server that you wish to connect to. This is of the form | ||
+ | < | ||
+ | It's the same URL as in Step 10 of setting up the remote GS3 server above. | ||
+ | |||
+ | |||
+ | ===GLI Applet Additional Steps=== | ||
+ | Many browsers have stopped supporting Java applets. Microsoft' | ||
+ | |||
+ | If your end users will be using the GLI applet, you also need to do the following steps //in addition to// [[http:// | ||
+ | |||
+ | * In the Greenstone " | ||
+ | < | ||
+ | Enter the appropriate details for your organization. When it asks to enter the key password for < | ||
+ | * Run | ||
+ | < | ||
+ | When it prompts, enter the password you used above. | ||
+ | * For GS3, move the created '' | ||
+ | * The following won't be necessary for future releases of GS3. However, for GS3.08, download the following files and put them into your GS3's '' | ||
+ | * [[http:// | ||
+ | * [[http:// | ||
+ | * [[http:// | ||
+ | * Open '' | ||
+ | * An optional step is to open '' | ||
+ | |||
+ | To use the GLI applet, (re)start | ||
+ | * Use Internet Explorer, and set things up in IE and with Java to be able to run applets.\\ //To be able to view applets in a browser, you will need a JRE installed and, from Java 7 onwards, will need to additionally add the remote Greenstone digital library home URL to the Exception Site List via the Security tab of your Java Control Panel. We have found that installing web browsers before installing a JRE allows browsers to find your JRE and run applets. If you're installing browsers after the JRE has already been installed, then your browser should prompt you to install the JRE again when trying to view Java applets. For further information see http:// | ||
+ | - Click Tools and then Internet Options | ||
+ | - Select the Security tab, and select the Custom Level button | ||
+ | - Scroll down to Scripting of Java applets | ||
+ | - Make sure the Enable radio button is checked | ||
+ | - Click OK to save your preference | ||
+ | * Use Internet Explorer to visit your Greenstone library homepage. Click the "The Librarian Interface" | ||
+ | |||
+ | === 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: | ||
+ | |||
+ | However, if you have a local Greenstone 3 installed, you can still manage to convert a remote collection' | ||
+ | |||
+ | |||
+ | ===== Important Changes and Bug Fixes ===== | ||
+ | |||
+ | * changes to run in a lab environment - " | ||
+ | * lots of display items (for indexes, classifiers etc) now come from dictionaries, | ||
+ | * gs3 can work off a read only location such as dvd. | ||
+ | * hierarchy menu with suggestions for metadata editor thanks to Georgy Litvinov | ||
+ | * a lot of work has been done on getting all the text strings into properties files so the complete interface can be translated. | ||
+ | * collection groups web/ | ||
+ | * < | ||
+ | * support for classifier tabs that are just links | ||
+ | * The raw collectionConfig.xml file can now be edited directly from within GLI: Edit-> | ||
+ | * Tidied up collection building using manifest files. See the [[http:// | ||
+ | * streamlined compilation, | ||
+ | ===== IMPORTANT information ===== | ||
+ | |||
+ | For ease of access this section has been brought across from the [[en: | ||
+ | |||
+ | ==== Troubleshooting ==== | ||
+ | === SIGPIPE errors when building a collection === | ||
+ | - **If your indexer is set to '' | ||
+ | * You could grab a newer version of Greenstone 3. Greenstone 3.09 (still to be released at the time of writing) will contain this fix, as do nightly binaries from http:// | ||
+ | * Get a newer version of the solr extension from SVN that contains the fix from http:// | ||
+ | * Or you can update just the affected files in your solr extension, by following the instructions in the sequence of Greenstone mailing list exchanges with Martín Williman under the subject "SolR bugs". | ||
+ | - **If your indexer is not solr or if updating the solr extension didn't fix the problem and if your collection is using '' | ||
+ | * change the database type to '' | ||
+ | * or leave the database type at jdbm and move your GS3's bundled JRE (the GS3.08' | ||
+ | |||
+ | Many thanks to Martín Williman for 1 and Mariana Pichinini for solution 2. | ||
+ | |||
+ | === Ubuntu/ | ||
+ | This can happen when running GLI or the command line building scripts. | ||
+ | |||
+ | The errors can look like: | ||
+ | < | ||
+ | Running the Greenstone Librarian Interface... | ||
+ | Version: 2.87 | ||
+ | |||
+ | User cache dir: / | ||
+ | Unescaped left brace in regex is deprecated here (and will be fatal in Perl 5.30), passed through in regex; marked by <-- HERE in m/(/.*){ <-- HERE ,41}/ at / | ||
+ | Unescaped left brace in regex is deprecated here (and will be fatal in Perl 5.30), passed through in regex; marked by <-- HERE in m/ | ||
+ | Unescaped left brace in regex is deprecated here (and will be fatal in Perl 5.30), passed through in regex; marked by <-- HERE in m/ | ||
+ | ... | ||
+ | </ | ||
+ | |||
+ | They' | ||
+ | |||
+ | If you would like to continue using GS3.08, we've patched the affected plugins. The instructions to use the patch are: | ||
+ | |||
+ | |||
+ | 0. Exit GLI in the proper manner if it's running. | ||
+ | |||
+ | 1. Optional: Back up your GS3.08' | ||
+ | |||
+ | 2. Download the '' | ||
+ | |||
+ | 3. Five files should have been extracted: | ||
+ | * Put the 3 plugin files into your GS3.08' | ||
+ | * put Escape.pm into the '' | ||
+ | * put PP.pm into into the '' | ||
+ | |||
+ | 4. Use a //new terminal// to launch GLI or any commands that previously failed with errors. Hopefully GLI will launch successfully now. | ||
+ | |||
+ | === 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. | ||
+ | ==== 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' | ||
+ | By default, Windows doesn' | ||
+ | |||
+ | ====Known Issues==== | ||
+ | |||
+ | === 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 === | ||
+ | |||
+ | 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. // | ||
+ | |||
+ | < | ||
+ | Document Editor Build | ||
+ | Command = /bin/perl -S / | ||
+ | Content-type: | ||
+ | |||
+ | ERROR: Can't locate CGI.pm in @INC (@INC contains: / | ||
+ | BEGIN failed--compilation aborted at ./ | ||
+ | Compilation failed in require at (eval 1) line 1. | ||
+ | </ | ||
+ | |||
+ | If you get this error, then please install the CGI module for your system perl. | ||
+ | ====Work Arounds==== | ||
+ | ===Filenames in collections should not contain &, < and >=== | ||
+ | In order to have better handling of different file and filename encodings, a [[http:// | ||
+ | |||
+ | A workaround is to use " | ||
+ | ===Greenstone applets (Phind, Collage) crash Firefox=== | ||
+ | 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. | ||
+ | |||
+ | ===== Updated Translations ===== | ||
+ | |||
+ | Thanks to the following people for new and updated translations since 3.07: | ||
+ | * Yvan Arnaud and Emmanuel Ngoi for French translations | ||
+ | * Tomáš Fiala for Slovak translations | ||
+ | * Yamaguchi Gaku for Japanese translations | ||
+ | * Maciej Jaros for Polish translations | ||
+ | * Georgy Litvinov for Russian translations | ||
+ | * Diego Spano for Spanish translations | ||
+ | * Lavji Zala for Gujarati translations | ||
+ | <!--* Gerhard Riesthuis for Dutch translations (core, GS2)--> | ||
en/release/3.08_release_notes.txt · Last modified: 2023/03/13 01:46 by 127.0.0.1