From f92ba2fa570dda18c16591f98ca5d6e9a4ca7e05 Mon Sep 17 00:00:00 2001 From: Bill Branan Date: Thu, 14 Apr 2016 18:20:46 -0400 Subject: [PATCH] Adds additional build and configuration details to the readme --- README.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/README.md b/README.md index 08c2a1b..d0c1e1f 100644 --- a/README.md +++ b/README.md @@ -10,12 +10,48 @@ options. An integration test exists to perform a basic deployment test only and useful just for identifying syntax errors in configuration file updates or third party library version incompatibilities. +# Dependencies +This project has a dependency on the Infinispan Cloud Cache Store, which is not currently available +as a Maven dependency. The [Infinispan Cloud Cache Store](https://github.com/infinispan/infinispan-cachestore-cloud) +project will need to be cloned and built locally. Once cloned, it can be built using: +``` +mvn install +``` + # Default Maven Build The default maven build profile is with S3 capability ``` mvn install ``` +# Integration Test +By default the maven build will execute a simple integration test which attempts to write +test content to cloud storage. To skip this test during the build, use: +``` +mvn install -DskipITs +``` +To run the integration test using Amazon S3 storage, set the MAVEN_OPTS environment variable +to include the necessary connection information: +``` +MAVEN_OPTS="-Dfcrepo.modeshape.configuration=classpath:/config/s3/repository.json -Dfcrepo.ispn.s3.region=us-standard -Dfcrepo.ispn.s3.accessid= -Dfcrepo.ispn.s3.secretkey= -Dfcrepo.ispn.s3.bucketprefix=fcrepo-integration-test -Dfcrepo.ispn.s3.endpoint=https://s3.amazonaws.com" +``` + +# Configuration +To configure and run Fedora against a cloud store, use the [Fedora Application Configuration](https://wiki.duraspace.org/display/FEDORA4x/Application+Configuration) +procedure to define the following properties in the JAVA_OPTS system variable: +``` +JAVA_OPTS="${JAVA_OPTS} -Dfcrepo.modeshape.configuration=classpath:/config/s3/repository.json" +JAVA_OPTS="${JAVA_OPTS} -Dfcrepo.ispn.s3.region=us-standard" +JAVA_OPTS="${JAVA_OPTS} -Dfcrepo.ispn.s3.accessid=" +JAVA_OPTS="${JAVA_OPTS} -Dfcrepo.ispn.s3.secretkey=" +JAVA_OPTS="${JAVA_OPTS} -Dfcrepo.ispn.s3.bucketprefix=" +JAVA_OPTS="${JAVA_OPTS} -Dfcrepo.ispn.s3.endpoint=https://s3.amazonaws.com" +``` + +# Deployment +Follow the [Fedora Deployment](https://wiki.duraspace.org/display/FEDORA4x/Deploying+Fedora+4+Complete+Guide) +procedure to deploy the WAR which is built by the project. + ## Maintainers * [Bill Branan](https://github.com/bbranan)