Commits

dloy committed 3e8c497

BitBucket

Comments (0)

Files changed (4)

+Copyright (c) 2005-2011, Regents of the University of California
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+*
+- Redistributions of source code must retain the above copyright notice,
+  this list of conditions and the following disclaimer.
+- Redistributions in binary form must reproduce the above copyright
+  notice, this list of conditions and the following disclaimer in the
+  documentation and/or other materials provided with the distribution.
+- Neither the name of the University of California nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+ 
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
+OF THE POSSIBILITY OF SUCH DAMAGE.
+
+ 
+
+ 

README-SETUP.txt

-
-* Requirements
-JDK 1.6(+)
-Java servlet container that accepts .war (e.g. tomcat, resin, jetta, ...)
-ant
-maven
-MySQL
-________________________________
-* Download core
-hg clone https://bitbucket.org/merritt/mrt-core
-________________________________
-
-* Build core project using maven on mrt-core
-cd mrt-core
-mvn clean
-mvn install
-________________________________
-
-
-* 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]
-mail.smtp.host=[[smtp server on the fixity host]
-________________________________
-
-* 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
+Fixity micro-service
+
+Copyright � 2005-2011, Regents of the University of California
+
+All rights reserved
+
+The Fixity micro-service supports the periodic verification of the bit-level integrity of web accessible digital resources, represented by either �http:� or �file:� scheme URIs.  It is a Java application supporting the Adler-32, CRC-32, MD2, MD5, SHA-1, SHA256, SHA-384, and SHA-512 message digest algorithms, and uses a MySQL database as its persistent state mechanism.  The technical specification for the Fixity service is available at <https://confluence.ucop.edu/display/Curation/Fixity>.
+
+The Fixity micro-service is made available by the University of California Curation Center (UC3) under the terms of the BSD open source license.
+
+==============================
+License
+Read included ./LICENSE.txt
+
+==============================
+Set up
+Read included ./SETUP.txt
+
+
+* Requirements
+JDK 1.6(+)
+Java servlet container that accepts .war (e.g. tomcat, resin, jetta, ...)
+ant
+maven
+MySQL
+________________________________
+* Download core
+hg clone https://bitbucket.org/merritt/mrt-core
+________________________________
+
+* Build core project using maven on mrt-core
+cd mrt-core
+mvn clean
+mvn install
+________________________________
+
+
+* 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]
+mail.smtp.host=[[smtp server on the fixity host]
+________________________________
+
+* 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
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.