diff --git a/INSTALL.md b/INSTALL.md index 72dd87f6b..61ea2e4d9 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -2,6 +2,28 @@ This file describes how to install mifos platform for use in a production or test environment. +## Release Artifact Structure + +The release artifact (.zip file) has the following structure: + +``` + + mifosplatform-X.Y.Z.RELEASE ... parent folder which will have the release number on it + | + + api-docs ... folder contains html based documentation on the platform API for this release + + database ... folder contains database setup and upgrade scripts required for installation + + pentahoReports ... folder contains any out-of-the-box reports provided through pentaho + | + -- CHANGELOG.MD ... file documents changelog of project up to this release + -- CONTRIBUTORS.MD ... file provides details on contributors to project + -- INSTALL.MD ... file provides details on installation instructions + -- LICENSE.MD ... file provides details on the open source license used by the project + -- mifosng-provider.war ... the platform WAR file to be dropped into Tomcat 7 + -- README.MD ... initial readme file for the project + -- VERSIONING.MD ... file provides details on approach to release versioning +``` + +## How to Install + The two ways to get up and running with mifos platform is: 1. Use Amazon AWS and mifosplatform public AMI to spin up a new instance in the cloud @@ -69,8 +91,118 @@ Launch instance + + + + + + + + + + + + + + + + + + + + + + + + + + + + +``` + +#### 2.3.6 Drop application into tomcat webapps folder + + Drop the following from the release artifact into the [TOMCAT_HOME]/webapps folder: + - mifosng-provider.war + Drop the following from the release artifact into [TOMCAT_HOME]/webapps/ROOT folder: + - The entire IndividualLendingGeneralJavaScript folder + - The entire api-docs folder + +#### 2.3.7 Startup tomcat + Startup tomcat: + - Platform application should be available @ https://[server ip address]:8443/mifosng-provider/api/v1/offices?tenantIdentifier=default&pretty=true + - Reference application should be available @ https://[server ip address]:8443/IndividualLendingGeneralJavaScript/IndivLendHome.html?baseApiUrl=https://[server ip address]:8443/mifosng-provider/api/v1/ + - API docs should be available @ https://[server ip address]:8443/api-docs/apiLive.htm + +