source: gli/trunk/FLI_README.txt@ 15388

Last change on this file since 15388 was 15388, checked in by ak19, 16 years ago

Readme file on how to run FLI--to be modified in future when some additional required functionality has been added

File size: 3.2 KB
Line 
1FLI, the Fedora Librarian Interface:
2
3
4A Purpose of FLI:
5FLI is built on top of GLI. Just as with GLI, it allows you to drag-and-drop documents into a collection which it will then build. The building process of FLI is different in that it will export the documents into a Fedora repository.
6
7
8B Some limitations and workarounds
9- fli.sh launches a modified gli.sh. But fli.bat launches gli.bat which has yet to be edited to work for both gs3 and gs2. In other words, at present the Windows fli.bat should be used when working with Greenstone 2, and fli4gs3.bat when working with Greenstone 3.
10- You need the Greenstone server to be running on the same machine as where your Fedora machine is running. This may not be a requirement in the future.
11- fli.sh will at present put documents into the Fedora repository if Greenstone is running locally to FLI (as opposed to a remote Greenstone server). It's the intention to fix this discrepancy soon. But if you want an immediate solution, what you need to do is:
12 * Stop the fedora server
13 * Go to $FEDORA_HOME/tomcat/conf/Catalina/<your-fedora-host-name or localhost>/
14(where $FEDORA_HOME is your Fedora installation folder)
15Finding out what the last folder should be is tricky, but if you look inside $FEDORA_HOME/tomcat/conf/Catalina/, there should already be a folder with the required fedora hostname.
16 * Create a file containing this XML:
17<?xml version='1.0' encoding='utf-8'?>
18<Context docBase="/full/path/to/parent/folder/of/greenstone/collectdir" path="/gsdl"></Context>
19Where this would be $GSDLHOME/web/sites/localsite for Greenstone 3, and just plain $GSDLHOME for Greenstone 2. (Note that in both cases, it has to be the full path to the parent directory of the "collect" directory.)
20 * restart the fedora server
21 * Now you can run FLI as described below.
22
23
24C Prerequisites for running FLI:
25- You need Greenstone 2 or 3
26- You need Fedora installed (which would have required you to set the environment variables FEDORA_HOME, CATALINA_HOME and JAVA_HOME). And:
27 * if the version you have installed is Fedora 2.*, then you need to add a new environment variable called FEDORA2_HOME to point to where you have Fedora 2.* installed.
28 * if you have Fedora 3.* installed, then you have to add a new environment variable called FEDORA3_HOME to point to where you have it installed.
29- You need the Greenstone server running on the same machine as where you're Fedora server is installed.
30
31
32D Running FLI:
33- If you're using a linux xterm, you'd go into Greenstone's gli folder and type:
34 ./fli.sh
35If you're on Windows, go into Greenstone's gli folder and double-click on fli.bat
36- Once FLI starts up, it will ask you to the Fedora server details and your Fedora username and password to access the Fedora repository.
37- Drag and drop documents into a collection as before, go to the Build tab and press the Build button. Once the building is finished, pressing the preview button will open the browser onto the Fedora search page.
38- If you have other digital objects in your Fedora repository besides the content generated by Greenstone, you will have to type "greenstone:*" (or just "greenstone*") in the search box--with the quotes.
39If your Fedora repository only contains documents built in FLI, then pressing just the search button should be fine.
Note: See TracBrowser for help on using the repository browser.