From 023101be7584f454789b5e2a94de03289304ea65 Mon Sep 17 00:00:00 2001 From: Mike Conway Date: Tue, 31 Oct 2017 11:16:58 -0400 Subject: [PATCH] #1 improve config docs to mention database setup --- CONFIGURATION.md | 2 ++ DEVELOPER-README.md | 8 ++++++++ README.md | 2 +- 3 files changed, 11 insertions(+), 1 deletion(-) diff --git a/CONFIGURATION.md b/CONFIGURATION.md index 40821ed58..2004785a8 100644 --- a/CONFIGURATION.md +++ b/CONFIGURATION.md @@ -24,6 +24,8 @@ metalnx.properties is read from /etc/irods-ext/metalnx.properties during deploym image thus expects that file to be mounted as a volume. See the metalnx.properties file in this repository for a template for the /etc/irods-ext/metalnx.properties file expected by the application. +See the DEVELOPER-README.md and the README.md in the src/metalnx-tools for information on configuring the metalnx database. + ## Web app theming and customization By default, MetaLnx uses the resource support of Spring MVC, e.g. https://docs.spring.io/spring/docs/4.1.9.RELEASE/spring-framework-reference/html/mvc.html#mvc-config-static-resources. diff --git a/DEVELOPER-README.md b/DEVELOPER-README.md index 03036a5d7..475023ff4 100644 --- a/DEVELOPER-README.md +++ b/DEVELOPER-README.md @@ -118,3 +118,11 @@ and database are initially installed and configured, and the properties are all correctly in settings.xml (be sure to activate the appropriate profiles in maven!) You should get a clean build running the tests, and once maven has run to get the properties, running unit tests in eclipse, etc should also work fine. + +### Database Setup + +Note that Metalnx needs its own database, and it needs to be initialized. The settings for this initialized +metalnx database are then reflected in the above metalnx profile. + +This involves some plsql to create the database, and the running a tool to initialize or migrate the database. +This is covered in the README.md in the src/metalnx-tools subproject. diff --git a/README.md b/README.md index 803f208fe..382b8e63d 100755 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ ![Metalnx Logo](docs/IMAGES/mlx_logo_blue.png) -## Version: branch for issue13 (resource pipeline) +## Version: branch for issue15 (run versus mysql) ## Git Tag: ## Date: Oct 27, 2017