en:user_advanced:remote_greenstone
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
en:user_advanced:remote_greenstone [2020/05/12 20:55] – kjdon | en:user_advanced:remote_greenstone [2020/05/12 21:24] – kjdon | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | <!-- mv:2 --> | + | ====== Remote Greenstone ====== |
- | ====== Remote Greenstone | + | |
- | This document is also available [[es: | + | |
- | =====Building | + | Remote |
- | Until now, using the GLI has required either | + | |
- | This new functionality keeps the collections on a remote Greenstone server, thus allowing users to collaborate on collections (at different times), and without a local Greenstone installation. | + | Client GLI vs applet - now deprecated. |
- | =====Installation===== | + | =====Setting up Remote Greenstone Functionality===== |
- | This section describes how to install the remote building functionality on server and client. | + | For installation instructions, please see [[en:user_advanced:remote_greenstone3|Setting up Remote |
- | + | ||
- | ====Server==== | + | |
- | + | ||
- | The server can be a Linux, Mac OS X or Windows machine. It must have the [[http:// | + | |
- | + | ||
- | To install the server-side functionality: | + | |
- | * [[http:// | + | |
- | * On Windows, edit your PATH environment variable to include imagemagick and ghostscript: | + | |
- | <!-- < | + | |
- | * Configure your webserver | + | |
- | * **Apache v2.0** | + | |
- | * Later Greenstone releases come with Apache. Or you can ([[http:// | + | |
- | * If installing Apache manually, configure Apache by editing the conf\httpd.conf file as described in the Greenstone | + | |
- | * Start Apache. | + | |
- | * **Apache v1.3** | + | |
- | * Apache v1.3 is not suitable for this application; | + | |
- | * **IIS** (Not recommended) | + | |
- | * See [[en: | + | |
- | * **IIS 6**: Edit the Greenstone " | + | |
- | On Windows: before running the apache web server, rename the Greenstone local library server file server.exe (located in your toplevel Greenstone directory) to something else. | + | |
- | + | ||
- | Check that your webserver and Greenstone are working correctly by visiting | + | |
- | < | + | |
- | + | ||
- | (For Greenstone 2.81 and older: | + | |
- | * use http:< | + | |
- | * and if on Linux, try just " | + | |
- | + | ||
- | The port will be the number you configured your Apache web server to listen on. This tends to be 8080 or 80, unless these are already in use. | + | |
- | + | ||
- | * Make sure you have edited the gsdlsite.cfg file to contain the appropriate values, such as for GSDLHOME. See [[en:developer:linux_source_install | + | |
- | + | ||
- | **Note:** In Greenstone | + | |
- | + | ||
- | Edit the first line of the Greenstone " | + | |
- | + | ||
- | On Unix it is likely to be: | + | |
- | < | + | |
- | On Windows this would be something like (if installed in the default location): | + | |
- | < | + | |
- | Note that when using Greenstone 2.82 on Windows, it has the path to perl slightly wrong, so do correct it: ...\bin\windows\perl\**bin\**perl | + | |
- | + | ||
- | * Visit http:< | + | |
- | in a web browser. (In Greenstone 2.81 and earlier, visit http:< | + | |
- | * If you get a message saying "Java failed", | + | |
- | * If you get "500 Internal Server Error", | + | |
- | + | ||
- | Otherwise, if you're on Linux, it may have to do with not having executable permissions on gliserver.pl. Open an x-term and cd into your greenstone installation folder' | + | |
- | < | + | |
- | If it returns a message like "bash: ./ | + | |
- | < | + | |
- | Now see if it works. | + | |
- | * Otherwise, check the error log of your webserver | + | |
- | + | ||
- | **Important: | + | |
- | * If your web server is running as a different user, make sure the collect directory has the right permissions. In such a case, make the Greenstone | + | |
- | + | ||
- | On Unix, use chmod. | + | |
- | + | ||
- | On Windows, if using the included Apache web server, it will run under your User Account and the following tends not to be necessary. Otherwise, you would run the following in a DOS prompt: | + | |
- | < | + | |
- | If you're working in a language other than English (say German or French), the word " | + | |
- | * In Greenstone versions earlier than 2.82, you will need to edit the Greenstone " | + | |
- | < | + | |
- | # Administration facility to be available. | + | |
- | status | + | |
- | </ | + | |
- | This will make the " | + | |
- | + | ||
- | * Add some user accounts by visiting the Greenstone home page and clicking the " | + | |
- | * Check that your Greenstone server side installation contains the GLIServer.jar file in your greenstone installation folder' | + | |
- | < | + | |
- | On Windows, you'd type the following in the DOS prompt: | + | |
- | < | + | |
- | This will create the GLIServer.jar file in the gli folder which you can manually copy into the bin/java folder. | + | |
- | + | ||
- | If your end users will use the stand-alone GLI client, this is all that is required on the server, and you can skip the next section. | + | |
- | + | ||
- | ===GLI Applet Additional Steps=== | + | |
- | + | ||
- | If your end users will be using the GLI applet, you also need to do the following four steps. These require the Java SDK -- if you don't already have this you can download it from [[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. | + | |
- | * Move the created SignedGatherer.jar file into the Greenstone " | + | |
- | * Edit the Greenstone " | + | |
- | + | ||
- | + | ||
- | ====Client==== | + | |
- | + | ||
- | The clients can be Linux, Mac OS X or Windows machines. | + | |
- | + | ||
- | **To use the stand-alone GLI client:** | + | |
- | * [[http:// | + | |
- | * Run " | + | |
- | The first time you run the GLI client on a machine it will ask for the Greenstone library and gliserver URLs. The first will be < | + | |
- | + | ||
- | **To use the GLI applet:** | + | |
- | * Follow the steps at the end of [[#Server]] first. | + | |
- | * Visit your Greenstone library homepage and click the "The Librarian Interface" | + | |
- | + | ||
- | You can now use the GLI to edit collections on the server or create new collections. The first time a collection is opened on a particular machine the GLI will read the plugin and classifier information from the server (this may take a minute or two). | + | |
=====Notes===== | =====Notes===== | ||
Line 126: | Line 17: | ||
====Authentication==== | ====Authentication==== | ||
- | The existing Greenstone user account system is used for authentication. User information is stored in the etc/ | + | The existing Greenstone user account system is used for authentication and the Administration pages (linked from your Greenstone library homepage) are used for adding, editing and removing users. |
- | Groups are used to control the actions that users are allowed to perform on collections. | + | Groups are used to control the actions that users are allowed to perform on collections. |
- | * **all-collections-editor**: | + | The possible group settings are: |
+ | * **all-collections-editor**: | ||
* **personal-collections-editor**: | * **personal-collections-editor**: | ||
- | * **< | + | * **< |
For example, a user who needs to create and edit their own collections, | For example, a user who needs to create and edit their own collections, | ||
+ | |||
====Collection locking==== | ====Collection locking==== | ||
Each collection may only be open by one person at a time, to prevent synchronization problems. When a request is sent to the server to perform an action on a collection, the server will check for a gli.lck file in the collection directory. This file contains the username of the person who has the collection locked. When the collection is closed, this lock file is deleted. | Each collection may only be open by one person at a time, to prevent synchronization problems. When a request is sent to the server to perform an action on a collection, the server will check for a gli.lck file in the collection directory. This file contains the username of the person who has the collection locked. When the collection is closed, this lock file is deleted. | ||
- | |||
- | |||
Line 146: | Line 37: | ||
====E-mail notifications==== | ====E-mail notifications==== | ||
- | The server can be configured to e-mail the system administrator whenever a collection finishes building. To enable this, edit the Greenstone " | + | The server can be configured to e-mail the system administrator whenever a collection finishes building. To enable this, edit the gliserver.pl file (in cgi-bin for Greenstone2; |
====Missing functionality==== | ====Missing functionality==== | ||
Line 165: | Line 56: | ||
This functionality may be added in the future. | This functionality may be added in the future. | ||
+ | ===== Debugging gliserver.pl ===== | ||
- | + | The commands that gliserver.pl takes are: | |
- | =====Troubleshooting===== | + | ^Command^Arguments^Output^ |
- | + | |cmd=check-installation| | |
- | If you are experiencing problems or error messages when using the client/ | + | |cmd=get-site-names |&site=localsite& |
- | + | |cmd=get-library-url-suffix|& | |
- | + | ||
- | * Make sure you are using the latest version of Greenstone and have downloaded any patches on this page. | + | |
- | * Record any popup GLI error messages, and the last action you performed. | + | |
- | * Check for Java exceptions. If you're using the client version of the GLI, these will appear in the black GLI window (Windows) or in the terminal where you ran the GLI (Unix). If you're using the applet version of the GLI, these will appear in the Java Console (available from one of your browser menus -- for Firefox you may have to download [[https:// | + | |
- | * Check for errors at the bottom of the log files of your webserver. If you're using Apache (recommended), | + | |
- | * If you are having problems with the applet version, please check if you have the same problems with the client version. | + | |
- | + | ||
- | + | ||
- | If you think you have found a bug, or still can' | + | |
- | + | ||
- | + | ||
- | * The operating system of the server machine | + | |
- | * The version of Greenstone installed on the server machine | + | |
- | * The version of Java installed on the server machine | + | |
- | * The operating system of the client machine | + | |
- | * Whether you are using the client or applet version of the GLI | + | |
- | * The actions you performed leading up to where the error or problem occurs | + | |
- | * The complete text of any popup GLI error messages, exceptions or errors in the webserver log file | + | |
- | + | ||
- | + | ||
- | ====Miscellaneous problems==== | + | |
- | + | ||
- | + | ||
- | * Errors such as "An error has occurred on the remote Greenstone server while performing this operation: Collection archives zip file / | + | |
- | * " | + | |
- | * "Stack Overflow Errors" | + | |
- | | + | |
- | Add **-Xss16M** after the -Xmx128M, which increases the stack size from 2 to 16M. | + | |
- | On Windows, in gli.bat, look for the lines starting | + | |
- | | + | |
- | and do the same thing. | + | |
- | + | ||
- | + | ||
- | =====Future Work===== | + | |
- | * When trying to load the dictionary (in Dictionary.java: | + | |
- | * Pressing the " | + | |
- | * When the GLI is quit with jobs still on the remote | + | |
- | * Loading the options for DBPlug.pm causes an exception when using a Windows server. If you need to use DBPlug then you must install the DBI and DBD modules that it requires. | + | |
- | + | ||
- | < | + | |
- | + |
en/user_advanced/remote_greenstone.txt · Last modified: 2023/03/13 01:46 by 127.0.0.1