Ignore:
Timestamp:
10/31/12 20:21:53 (8 years ago)
Author:
ak19
Message:

While getting GS3-with-Fedora collections to work on Puka discovered more issues. 1. Several additional files needed to become template files with placeholder values for the GS3 tomcat server and port, fedora password and index write lock timeout value. Other files needed further modifications (particularly fedora.fcfg.in and gsearch's fgsconfig-basic.properties) to make sure server and port values weren't fixed to localhost and 8383 defaults. 2. The build.xml had to be updated to make changes to these new and modified files during the installation process. 3. There's now a new target in build.xml: uninstall-fedora. 4. README file update with all this information, as well as corrections and clarifications.

File:
1 edited

Legend:

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

    r26420 r26434  
    44
    55A. To install your GS3 Fedora extension from fedora3-gs3ext.tar.gz
     6    Uninstalling Fedora
    67
    78B. How to manually build fedora collections
     
    2122Fedora GSearch 2.5
    2223
    23 Web services pages once installed:
     24Web services pages once installed (by default GS3 is set to use localhost:8383):
    2425http://localhost:8383/fedora/services
    2526http://localhost:8383/fedoragsearch/services
     
    5859    #fedora.maxpermsize=-XX:MaxPermSize=128m
    5960    #fedora.password=pounamu
     61    #index.writelock.timeout=10000
    6062
    6163Uncomment all these properties and change the value for the fedora password if necessary:
     
    6567    fedora.maxpermsize=-XX:MaxPermSize=128m
    6668    fedora.password=pounamu     
    67 
     69    index.writelock.timeout=10000
    6870
    69716. Use a terminal to go into this folder:
     
    8991    $ ./gli/fli.sh
    9092
     93
     949. Once you've tested everything is working, you may want to set logging level of Fedora GSearch to log ERRORs rather than all DEBUG statements. See the Debugging section in this file.
    9195
    9296
     
    138142
    139143
     144*****************************************
     145UNINSTALLING FEDORA
     146*****************************************
     147
     1481. Make sure tomcat is stopped.
     149
     1502. Go to /GS3/ext/fedora3 and run:
     151    ant uninstall-fedora
     152
     153The above will remove
     154- the deployed webapps (fedora, fedoragsearch, fedora-demo, fop, imagemanip and saxon.war)
     155- as well as the ext/fedora3 folder itself.
     156
     157
     158
    140159********************************************************************************************************************
    141160                    B. Manual building of fedora collections
     
    152171    source gs3-setup.bash
    153172
    154 3. Create a new collection with mkcol.pl. Call it "fedora1" for example
    155     mkcol.pl -site localsite fedora1
    156 
    157 (Deprecated: mkcol.pl -gs3mode -collectdir /<GS3>/web/sites/localsite/collect fedora1)
     1733. Create a new collection with mkcol.pl.
     174    mkcol.pl -site localsite <COLNAME>
     175
     176(Deprecated: mkcol.pl -gs3mode -collectdir /<GS3>/web/sites/localsite/collect <COLNAME>)
    158177
    1591784. 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.
     
    161180- First put the documents you want into the import directory of your new collection.
    162181
    163 - g2f-import.pl -hostname localhost -port 8383 -password pounamu -removeold -collectdir /<GS3>/web/sites/localsite/collect fedora1
     182- g2f-import.pl -hostname localhost -port 8383 -password pounamu -removeold -collectdir /<GS3>/web/sites/localsite/collect <COLNAME>
    164183(password may be optional at this stage, by include it for convenience)
    165184
    166 - g2f-buildcol.pl -hostname localhost -port 8383 -password pounamu -removeold -collectdir /<GS3>/web/sites/localsite/collect fedora1
     185- g2f-buildcol.pl -hostname localhost -port 8383 -password pounamu -removeold -collectdir /<GS3>/web/sites/localsite/collect <COLNAME>
    167186
    168187
     
    181200- use FLI to transfer dls to dc metadata upon Gathering the documents.
    182201- then before building, turn on the description_tags in the HTMLPlugin.
     202Or manually add to the etc/collectionConfig.xml of the demo collection:
     203
     204    <plugin name="HTMLPlugin">
     205      <option name="-description_tags"/>
     206    </plugin>
    183207
    184208
     
    190214Also open each folder's jpg document cover image in GIMP and resave under the same name (at 100% quality).
    191215
    192 
    1932166. If you ran FLI, exit it. It should stop the Greenstone server.
    194217
     
    202225    ant start
    203226
    204 8. To activate the collection, first visit the web page
     2278. Alternatively, to activate the collection, first visit the web page
    205228http://<host>:<port>/greenstone3/library?a=s&sa=a&st=collection&sn=<COLNAME>
    206229
     
    217240Deleting a Fedora GS3 collection is accomplished with the following 2 steps:
    218241
    219 1. Run the g2f-deletecol.pl script over the collection to be deleted. Assuming the collection is called fedora1, you'd run:
    220     g2f-deletecol.pl -hostname localhost -port 8383 -password pounamu -collectdir /<GS3>/web/sites/localsite/collect fedora1
     2421. Run the g2f-deletecol.pl script over the collection to be deleted:
     243    g2f-deletecol.pl -hostname localhost -port 8383 -password pounamu -collectdir /<GS3>/web/sites/localsite/collect <COLNAME>
     244
     245(Note: no -removeold flag, otherwise the command is similar to the g2f-import.pl and g2f-buildcol.pl scripts)
     246
    2212472. Manually delete the Greenstone collection directory from the filesystem
    222248
     
    224250To run this manually,
    225251- first remove the pids from the GSearch index:
    226 /<GS3>/packages/tomcat/webapps/fedoragsearch/client>/<GS3>/packages/tomcat/webapps/fedoragsearch/client/runRESTClient.sh localhost:8383 updateIndex deletePID <greenstone:fedora1-HASH010313b14474bc72b296b15f>
     252/<GS3>/packages/tomcat/webapps/fedoragsearch/client>/<GS3>/packages/tomcat/webapps/fedoragsearch/client/runRESTClient.sh localhost:8383 updateIndex deletePID <DOC-PID e.g. greenstone:fedora1-HASH010313b14474bc72b296b15f>
    227253
    228254It will ask for the fedoragsearch username and password, which by default are fedoraAdmin and pounamu, respectively.
    229255
    230256- then purge the necessary documents (pids) from the fedora repository:
    231 /<GS3>/ext/fedora3/client/bin>./fedora-purge.sh localhost:8383 fedoraAdmin pounamu greenstone:fedora1-HASHe14e36cba08bd41c663237 http "purging"
     257/<GS3>/ext/fedora3/client/bin>./fedora-purge.sh localhost:8383 fedoraAdmin pounamu <DOC-PID e.g. greenstone:fedora1-HASHe14e36cba08bd41c663237> http "purging"
    232258
    233259- You can check it's all been deleted by visiting http://localhost:8383/fedora/search
     
    263289
    264290- ./install/install.properties.in
     291- ./install/server.xml.in
    265292- ./server/config/spring/akubra-llstore.xml.in
     293- ./server/config/spring/web/web.properties.in
    266294- ./server/config/fedora.fcfg.in
    267295- ./server/config/fedora-users.xml.in
     296
     297
     298(The following also need to refer to the servername and custom Greenstone tomcat port
     299- ./client/bin/fedora-ingest-demos.bat.in
     300- ./client/bin/fedora-ingest-demos.sh.in)
     301
    268302
    269303All these files get converted to filenames without the ".in" suffix upon installation, and placeholder strings in these template files get replaced. The replacements are on the strings
     
    394428
    395429The installation process will write out this property into GSearch's FgsConfig/FgsConfigIndexTemplate/Lucene/index.properties:
    396     fgsindex.defaultWriteLockTimeout = 1000
     430    fgsindex.defaultWriteLockTimeout = 10000
     431
     432(Another relevant place to change it would be ./FgsConfig/configDemoOnLucene/fgsconfigFinal/index/FgsIndex/index.properties)
    397433
    398434When fedoragsearch then gets deployed, this value will be propagated into:
     
    576612    </filter>
    577613
    578 7. Start tomcat to have it deploy fedoragsearch.
     6147. Open GSearch's FgsConfig/FgsConfigIndexTemplate/Lucene/index.properties and adjust the lock timeout property to 1000 or 10000 ms:
     615    fgsindex.defaultWriteLockTimeout = 10000
     616
     6178. Start tomcat to have it deploy fedoragsearch.
    579618This will unpack fedoragsearch.
    580619
    581 8. With tomcat running, configure fedoragsearch, which will adjust various config files. You will need to go into the deployed fedoragsearch webapps folder's FgsConfig folder first to be able to run the configuration target:
     6209. With tomcat running, configure fedoragsearch, which will adjust various config files. You will need to go into the deployed fedoragsearch webapps folder's FgsConfig folder first to be able to run the configuration target:
    582621
    583622    <GS3>/packages/tomcat/webapps/fedoragsearch/FgsConfig>ant -f fgsconfig-basic.xml
    584623
    585 9. With tomcat still running, run updateIndex once to create the empty index for the first time (by running the runRESTClient.sh script with the command: "host:port updateIndex createEmpty [indexName]")
     62419. With tomcat still running, run updateIndex once to create the empty index for the first time (by running the runRESTClient.sh script with the command: "host:port updateIndex createEmpty [indexName]")
    586625
    587626    ./<GS3>/packages/tomcat/webapps/fedoragsearch/client/runRESTClient.sh localhost:8383 updateIndex createEmpty FgsIndex
    588627
    589 10. Check fedoragsearch has been properly installed by visiting:
     62811. Check fedoragsearch has been properly installed by visiting:
    590629http://localhost:8383/fedoragsearch/rest
    591630
    592 10. If you wish to remove the various war files from GS3's tomcat webapps folder, you will need to stop tomcat first before deleting the war files, because doing so when tomcat is running will undeploy those webapps.
     63112. If you wish to remove the various war files from GS3's tomcat webapps folder, you will need to stop tomcat first before deleting the war files, because doing so when tomcat is running will undeploy those webapps.
    593632
    594633
Note: See TracChangeset for help on using the changeset viewer.