Changeset 26420 for gs3-extensions

Show
Ignore:
Timestamp:
30.10.2012 20:06:39 (7 years ago)
Author:
ak19
Message:

Additional corrections to README for when I tried to follow its instructions for manually creating (and building) a GS3 fedora collection.

Location:
gs3-extensions/fedora/trunk/src
Files:
2 modified

Legend:

Unmodified
Added
Removed
  • gs3-extensions/fedora/trunk/src/README

    r26415 r26420  
    66 
    77B. How to manually build fedora collections 
     8    Deleting a Fedora GS3 collection 
    89 
    910C. The customisations that have been made for the extension 
     
    3536 
    36370. You will need Greenstone 3.05 or a fresh checkout from SVN, already installed. 
     38You need a fresh x-term, one where the GS3 environment hasn't already been set up in. 
    3739 
    38401. Download the Fedora Extension for Greenstone 3: http://trac.greenstone.org/browser/gs3-extensions/fedora/trunk/fedora3-gs3ext.tar.gz 
     
    4345    $ tar -xvzf fedora3-gs3ext.tar.gz 
    4446 
    45 4. This will create a fedora3 folder in your Greenstone3/ext folder.  
     47This will create a fedora3 folder in your Greenstone3/ext folder.  
     48 
     494. Go to your Greenstone3 toplevel folder and now finally set up the GS3 environment: 
     50    $ source gs3-setup.sh    
     51 
     52This will now also have set up the fedora extension environment, such as FEDORA_HOME, FEDORA_VERSION and a PATH variable adjusted for Fedora. 
    4653 
    47545. Open Greenstone3/build.properties and find the section: 
     
    146153 
    1471543. Create a new collection with mkcol.pl. Call it "fedora1" for example  
    148     mkcol.pl -collectdir /<GS3>/web/sites/localsite/collect fedora1 
    149  
    150 4. Run import and build to ingest the new collection 
     155    mkcol.pl -site localsite fedora1 
     156 
     157(Deprecated: mkcol.pl -gs3mode -collectdir /<GS3>/web/sites/localsite/collect fedora1) 
     158 
     1594. Run import and build to ingest the new collection. Make sure to use the correct host and port, as specified in your /<GS3>/build.properties file. 
    151160 
    152161- First put the documents you want into the import directory of your new collection. 
     
    158167 
    159168 
    160 5. If building the GS3 demo collection as a fedora collection: 
    161   
    162 - use FLI to transfer dls to dc metadata upon Gathering the documents. 
    163 - then before building, turn on the description_tags in the HTMLPlugin. 
    164  
    165  
    166 IMPORTANT NOTE: Fedora GSearch for some reason doesn't like the images in the default GS3 demo collection and is unable to index the documents because of them. 
    167 If using the default GS3 demo collection, all the images -- both png and jpg alike -- need to first be resaved as their respective file types. 
    168 Use Imagemagick to resave the many pngs, by going into each document's subfolder of the import folder and running: 
    169     mogrify -format png *.png 
    170  
    171 Also open each folder's jpg document cover image in GIMP and resave under the same name (at 100% quality). 
    172  
    173  
    174 6. If you ran FLI, exit it. It should stop the Greenstone server. 
    175  
    176 With fedora installed, it's always good to check that the java process that launched tomcat has indeed stopped: 
    177     ps aux | grep "tomcat" 
    178  
    179 (Since things will fail if multiple instances of this same tomcat are running, kill any java processes that are referring to tomcat.) 
    180  
    181 7. Create an index folder in the new fedora collection folder. Create a buildConfig.xml file in it containing the following: 
     169NOTE: The buildcol step would have created an index folder in the new fedora collection folder with a buildConfig.xml file in it containing the following: 
    182170 
    183171<buildConfig>  
     
    189177 
    190178 
    191 8. Restart the GS3 server. 
     1795. If building the GS3 demo collection as a fedora collection: 
     180  
     181- use FLI to transfer dls to dc metadata upon Gathering the documents. 
     182- then before building, turn on the description_tags in the HTMLPlugin. 
     183 
     184 
     185IMPORTANT NOTE: Fedora GSearch for some reason doesn't like the images in the default GS3 demo collection and is unable to index the documents because of them. 
     186If using the default GS3 demo collection, all the images -- both png and jpg alike -- need to first be resaved as their respective file types. 
     187Use Imagemagick to resave the many pngs, by going into each document's subfolder of the import folder and running: 
     188    mogrify -format png *.png 
     189 
     190Also open each folder's jpg document cover image in GIMP and resave under the same name (at 100% quality). 
     191 
     192 
     1936. If you ran FLI, exit it. It should stop the Greenstone server. 
     194 
     195With fedora installed, it's always good to check that the java process that launched tomcat has indeed stopped: 
     196    ps aux | grep "tomcat" 
     197 
     198(Since things will fail if multiple instances of this same tomcat are running, kill any java processes that are referring to tomcat.) 
     199 
     200 
     2017. Restart the GS3 server. 
    192202    ant start 
    193203 
    194 9. Visit the collection from the Greenstone collections page 
    195  
    196 10. Deleting a Fedora GS3 collection requires the collection's documents and the collection file to be purged from the Fedora repository and removed from the Fedora Gsearch index. (In the case of a normal GS3 collection, just the GS3 collection's directory will be deleted.) There's now a script to delete a Greenstone Fedora collection which will take care of these additional steps if you are manually managing your collections. (FLI calls this script when a collection is deleted from FLI.) 
     2048. To activate the collection, first visit the web page 
     205http://<host>:<port>/greenstone3/library?a=s&sa=a&st=collection&sn=<COLNAME> 
     206 
     2079. Then visit the collection from the Greenstone collections page 
     208 
     209 
     210***************************************** 
     211DELETING A FEDORA GS3 COLLECTION 
     212***************************************** 
     213 
     214Deleting a fedora GS3 collection requires the collection's documents and the collection file to be purged from the Fedora repository and removed from the Fedora Gsearch index. (In the case of a normal GS3 collection, just the GS3 collection's directory will be deleted.) There's now a script to delete a Greenstone Fedora collection which will take care of these additional steps if you are manually managing your collections. (FLI calls this script when a collection is deleted from FLI.) 
     215 
    197216 
    198217Deleting a Fedora GS3 collection is accomplished with the following 2 steps: 
    199 - Run the g2f-deletecol.pl script over the collection to be deleted. Assuming the collection is called fedora1, you'd run: 
     218 
     2191. Run the g2f-deletecol.pl script over the collection to be deleted. Assuming the collection is called fedora1, you'd run: 
    200220    g2f-deletecol.pl -hostname localhost -port 8383 -password pounamu -collectdir /<GS3>/web/sites/localsite/collect fedora1 
    201 - manually delete the Greenstone collection directory from the filesystem 
     2212. Manually delete the Greenstone collection directory from the filesystem 
    202222 
    203223 
    204224To run this manually,  
    205225- first remove the pids from the GSearch index: 
    206 /<GS3>/packages/tomcat/webapps/fedoragsearch/client>/<GS3>/packages/tomcat/webapps/fedoragsearch/client/runRESTClient.sh localhost:8383 updateIndex deletePID greenstone:fedora1-HASH010313b14474bc72b296b15f 
     226/<GS3>/packages/tomcat/webapps/fedoragsearch/client>/<GS3>/packages/tomcat/webapps/fedoragsearch/client/runRESTClient.sh localhost:8383 updateIndex deletePID <greenstone:fedora1-HASH010313b14474bc72b296b15f> 
    207227 
    208228It will ask for the fedoragsearch username and password, which by default are fedoraAdmin and pounamu, respectively. 
     
    222242You can also visit http://localhost:8383/fedoragsearch/rest?operation=gfindObjects 
    223243then you can search for a query term by prefixing the index field to it, e.g ds.fulltext:computers  
     244 
    224245 
    225246 
  • gs3-extensions/fedora/trunk/src/build.xml

    r26417 r26420  
    120120    <!-- give read execute permissions to all (755) for the fedoragsearch files --> 
    121121    <echo> 
    122       Giving executable permissions to Fedora setup script and GSearch scripts 
     122      Giving executable permissions to Fedora setup script and Fedora GSearch scripts 
    123123    </echo> 
    124124    <chmod file="${basedir}/gs3-setup.sh" perm="755"/>