From 7974a3d410a1c00426488d5fc995bb1365bdc513 Mon Sep 17 00:00:00 2001 From: Adam Vessey Date: Fri, 16 Sep 2022 15:32:56 -0300 Subject: [PATCH] Add blurb RE: islandora_fits_tags migration... ... also, got lost in touching up formatting of things. --- README.md | 68 +++++++++++++++++++++++++++++-------------------------- 1 file changed, 36 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index de6f9d59..ca85bfa1 100644 --- a/README.md +++ b/README.md @@ -1,56 +1,60 @@ # Islandora FITS Config module to make Islandora aware of FITS microservice - - ## Installation #### Install this module -Install and enable this module in the usual way. On installation the module will -add a context causing the creation of A FITs media when an Original File media is ingested. - +Install and enable this module in the usual way. On installation the module will +add a context causing the creation of A FITS media when an Original File media is ingested; however, this process is +predicated on the existence of an `islandora_media_use` term with an external URI of `https://projects.iq.harvard. +edu/fits`--the `islandora_fits_tags` migration might be executed to create such a term. #### Install FITS Webservice -FITS xmls are generated from an easily installed web service. +FITS XMLs are generated from an easily installed web service. Get the latest fits.zip and fits.war from https://projects.iq.harvard.edu/fits/downloads -(on my box I had to install a missing zip library with +(on my box I had to install a missing zip library with ‘sudo apt-get install php7.1-zip’) Install following their instructions. -Copy the .war file to your webapps directory and test. -Edit the catalina.properties file on the Drupal server by adding the -following two lines to the bottom of the file- +Copy the `.war` file to your webapps directory and test. +Edit the `catalina.properties` file on the Drupal server by adding the +following two lines to the bottom of the file: +```properties fits.home=/\/fits - shared.loader=/\/fits/lib/*.jar +``` -Restart Tomcat and test with - -`curl -k -F datafile="@/path/to/myfile.jpg" http://example.com:8080/fits/examine` +Restart Tomcat and test with: +```bash +curl -k -F datafile="@/path/to/myfile.jpg" http://example.com:8080/fits/examine +``` (note: the ‘@’ is required.) -#### Installing Microservice -Get code from https://github.com/roblib/CrayFits and install. This code can live anywhere, including an external server, -but most installations will have it at /var/www/html. - -The App runs by entering php bin/console server:start *:8050 in the App -root folder. -The server is stopped with php bin/console server:stop. -On a production machine you'd probably want to configure an additional +#### Installing Microservice +Get code from https://github.com/roblib/CrayFits and install. This code can live anywhere, including an external server, +but most installations will have it at `/var/www/html`. + +The App runs by entering: +```bash +php bin/console server:start *:8050 +``` +in the App root folder. +The server is stopped with: +```bash +php bin/console server:stop +``` +On a production machine you'd probably want to configure an additional port in Apache. - -Note: The location of the fits webserver is stored in the .env file in the -root dir of the Symfony app. This will have to be reconfigured if the Fits -server is anywhere other than localhost:8080/fits - +Note: The location of the FITS webserver is stored in the `.env` file in the +root dir of the Symfony app. This will have to be reconfigured if the FITS +server is anywhere other than `localhost:8080/fits` #### Adding FITs requests to the queue -Copy the file `assets/ca.islandora.alpaca.connector.ocr.blueprint.xml` +Copy the file `assets/ca.islandora.alpaca.connector.ocr.blueprint.xml` to `/opt/karak/deploy` on your server. There is no need to restart. - #### Adding Checksum to Display -A pseudo field with the computed checksum can be added to Repository Item -display. Navigate to `admin/structure/types/manage/islandora_object/display` -to enable or disable display of `File Checksum`. +A pseudo field with the computed checksum can be added to Repository Item +display. Navigate to `admin/structure/types/manage/islandora_object/display` +to enable or disable display of `File Checksum`.