Source

mrt-fixity / README-SETUP.txt


* Requirements
JDK 1.6(+)
Java servlet container that accepts .war (e.g. tomcat, resin, jetta, ...)
ant
maven
MySQL
________________________________

* Create mrt-fixity/fixity-conf/properties/Fixity.properties
FixityService=[absolute file path to fixity home]
db.url=[jdbc path to my MySQL]
    example: db.url=jdbc:mysql://127.0.0.1:3306/merritt?characterEncoding=UTF-8&characterSetResults=UTF-8
db.user=[write access MySQL user]
db.password=[write access password for this user]
________________________________

* Build projects using maven on mrt-fixity
cd mrt-fixity
mvn clean
mvn install
________________________________

* Build needed MySQL tables
The MySQL commands used to create the needed tables for fixity can be found at:
mrt-fixity/fixity-src/src/main/java/sql/current.db.sql
________________________________

* Create a fixity home directory
Fixity uses a home directory. See spec for architecture.
A demo version of the home directory can be created by 

cd mrt-fixity/fixity-demo
mvn install

The demo home location is based on the mrt-fixity/fixity-conf/properties/Fixity.properties
FixityService=[absolute file path to fixity home] property 
(see step above for setting these properties)
________________________________

Edit  <fixity home>/fixity-info.txt - these ant properties define the fixity processing
Note that the defaults will probably work
To receive periodic status reports it is necessary to modify the notificationEmail property

Default:

name: UC3
description: UC3 fixity micro-service
intervalDays: 0
threadPool: 1
queueSleepSeconds: 1
serviceScheme: Fixity/0.2/1.0
baseURI: http://fixity.cdlib.org/
notificationEmail: mailto:xxx@ucop.edu
supportURI: mailto:uc3-support@ucop.edu
periodicReportFrequencyHours: 1
periodicReportFormat: xhtml

Properties:
-name=any value
Required

-description=description of this fixity service
Required

-intervalDays=minimum number of days between evaluations of any file
=0 - continuous cycling
Required

-threadPool=number of concurrent threads processing fixity
Required

-queueSleepSeconds=number of seconds that fixity processing thread waits before processing next queued element
Required

-serviceScheme="Fixity/0.2/1.0" 
use this constant for now
Required

-baseURI=information only value - URL of this fixity
Required

-queueSleepSeconds=number of seconds that fixity processing thread waits before processing next queued element
Required

-notificationEmail=To value of periodic status emails. ; may be used as a delimiter for multiple values
Required

-supportURI=From value of periodic status emails
Required

-periodicReportFrequencyHours=Hours between delivery of periodic email status
Required

-periodicReportFormat=Periodic email - format of response: xhtml, json, anvl, xml
Required