A more current version of this guide is now available. If you are deploying DuraCloud for development, see this page: https://github.com/duracloud/deployment-docs/blob/master/dev-guide-getting-started.md. If you are deploying DuraCloud in production, see the pages here: https://github.com/duracloud/deployment-docs. The following document should be considered deprecated and will be removed in the near future.
If you would prefer to install DuraCloud from a binary distribution, you can find instructions for that process here.
DuraCloud application software is composed of many parts. A breakdown of the primary pieces is as follows:
- DuraStore - this web application provides the access to and management of storage resources, which includes handling the storage portion of the DuraCloud REST API
- StorageProviders - this set is made up of the StorageProvider interfaces and the implementations which connect to distinct cloud stores; the storage providers which are currently supported are listed here.
- DurAdmin - this web application is the UI front end of DuraCloud, it provides users with a view into the information available from the other applications. DurAdmin uses the REST APIs of the other applications to communicate with them.
- Security - handles security for the DuraCloud applications
- Common - a set of projects which provide utilities for other portions of the codebase to reuse
The DuraCloud software, by its very nature, is designed to be integrated with underlying cloud storage providers. As may be expected, these integrations are necessary for the system to be properly exercised. In order for DuraCloud to connect to these underlying providers, appropriate credentials must be provided as part of the application configuration step. It is recommended that you acquire the necessary storage provider credentials prior to attempting to set up DuraCloud. Only one storage provider is required to run DuraCloud.
This guide lays out the steps necessary to begin using DuraCloud:
- Configure DuraCloud database
- Build and deploy the DuraCloud web applications
- Test your installation
Although this document is written from a Linux environment perspective, analogous builds/installations have been tested in Windows (but may have limitations, as noted below). Any comments or feedback are welcomed.
Software that must be installed on your system prior to building/using DuraCloud
- Java: Version 8 required
- The Oracle JDK is recommended for building DuraCloud, as this is the JDK used for DuraCloud testing.
- Maven 3.x
- Tomcat 8.x
- DuraCloud Management Console
- DuraCloud Mill
Setting up DuraCloud
Any portions of the configuration below for which you need to include a replacement value will be written in all capital letters and included in brackets: [LIKE-THIS]
Build and deploy the DuraCloud web applications
Check out latest stable release from GitHub repository. Determine the release number of the latest stable release by going to https://github.com/duracloud/duracloud/releases and making a note of the tag name of the most current release.
Set environment variables
Add to $CATALINA_HOME/conf/tomcat-users.xml
Add to $CATALINA_HOME/conf/server.xml
Add the config attribute "URIEncoding" with value "UTF-8" to your Tomcat Connector. Your connector may look like the following:
Create a duracloud properties file (/any/path/to/duracloud.properties) that contains the following keys:
Add a system property (duracloud.config.file) to point to your duracloud configuration file.
This can be done by adding the property directly to your JAVA_OPTS or CATALINA_OPTS environment variables. You can also set these values in $CATALINA_HOME/bin/setenv.sh (linux,osx) or $CATALINA_HOME/bin/setenv.bat (windows), for example:
The duracloud.config.file system property can also refer to an Amazon S3 address using the s3://<bucket>/<path to file> syntax provided your tomcat instance is running on an instance with the appropriate AWS credentials. More information on AWS credentials management.
- Configure Maven
Add tomcat user to $M2_HOME/conf/settings.xml. Make sure that the username and password used here match those included in the tomcat-users.xml file.
From top of the source tree, execute (note that this build runs unit tests, but not integration tests):
- Bonus, running Integration Tests
- Grab a copy of the file in the codebase under common-json/src/main/resources/test-config.json and place it somewhere on your system
- You'll need an account for each of the providers to be tested. Update the JSON file to include your credentials. These tests actually communicate with each storage provider and verify that the calls being made work properly
- Add an environment variable called DURACLOUD-TEST-CONFIG with the value being the full path to your updated credentials JSON file. A sample credential configuration file can be found in the baseline at <project root>/integration/src/test/resources/test-config.json
From the top of the source tree, execute
Test your installation
- Once all of the above steps have been completed, your DuraCloud should be ready to test.
- Go to (change host or port as necessary).
- Log in using valid DuraCloud Management Console credentials.
- You should be able to view, add, update, and delete spaces and content in Spaces tab
- Congratulations! You now have a functional DuraCloud installation.
- The installers for the Sync Tool (Windows, Mac, Linux) are built using BitRock InstallBuilder Enterprise, so this tool must be installed locally.
- Download and install BitRock InstallBuilder Enterprise version 15.1.0 or above
- Place the license file for InstallBuilder in the InstallBuilder installation directory
- Update the maven settngs.xml file ($M2_HOME/conf/settings.xml) to include the path to the installbuilder executable
Add a duracloud profile to include the InstallBuilder path, and include the duracloud profile in the set of active profiles
From the //synctoolui directory in the DuraCloud source tree, execute
- The installers can be found under the synctoolui/target directory
- DuraCloud uses the SLF4J logging framework backed by the LogBack implementation
- By adding either a logback.xml or logback-test.xml file on the classpath, logging configuration can be customized
DuraCloud internal tools
Building Java client packages
To create a distributable zip of the storeclient or reportclient which includes their dependencies, from within the project directory (//storeclient, //reportclient) run
- The packaged zip will be found under the project's target directory