A more current version of this guide is now available. If you are deploying the Management Console for development, see this page: https://github.com/duracloud/deployment-docs/blob/master/dev-guide-getting-started.md. If you are deploying the Management Console in production, see this page: https://github.com/duracloud/deployment-docs/blob/master/management-console-setup.md. The following document should be considered deprecated and will be removed in the near future. |
This article describes the necessary steps for configuring and running the DuraCloud Management Console. The Management Console is a web application that enables users to manage DuraCloud account and user information as well as global configuration settings for a DuraCloud installation. More information about the capabilities of the DuraCloud Management Console is available here.
If you are not yet familiar with the DuraCloud Management Console please refer to the DuraCloud Architecture document, which describes how the Management Console fits into the DuraCloud ecosystem.
Check out latest stable release from the GitHub repository. Determine the release number of the latest stable release by going to https://github.com/duracloud/management-console/releases and making a note of the tag name of the most current release.
git clone https://github.com/duracloud/management-console.git cd management-console git checkout <latest-release-tag> |
Edit the file to configure the connections to the management console database and AWS (for notifications):
################### # MC DATABASE ################### # Config for the management console database - used to retrieve accounts and storage provider credentials db.host=[fill in] db.port=[fill in] db.name=[fill in] # User must have read permission db.user=[fill in] db.pass=[fill in] mc.host=<hostname> mc.port=443 mc.context=<e.g. /ama> # leave blank if the mc is deployed in the root context. notification.user=<aws access key id> notification.pass=<aws secret key> notification.from-address=<email address> notification.admin-address=<admin email address> |
Add a system property (mc.config.file) to point to your management console 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:
JAVA_OPTS="${JAVA_OPTS} -Dmc.config.file=file:c:/duracloud/mc-config.properties" |
The mc.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 Tomcat and Maven to allow application deployment
On the command line, build the MC codebase
mvn clean install |
Create an SNS topic
Log into the AWS account associated with the Management Console application.
In a web browser, go to https://<yourhost>/<context>