README-ESGFDeployment

DESCRIPTION

This README gives the requirements for deployment of the demo of next generation ESG web application, including installation procedure and ESG backend (esg-search) search integration with the ESG ui (esgf).  Note that much is borrowed from the previous esg-search README and INSTALL files, which should be referenced for further details.


Important: Note the following definitions are used in this README:

${esgsearch.home} - root directory of downloaded esg search repository
${esgf.home} - root directory of downloaded esg ui repository


***PREREQUISITES***

- Installation and configuration of apache solr for ESG

Download the latest version of Apache Solr from the the web site: http://lucene.apache.org/solr/ 
(at the time of this writing, the latest distribution is apache-solr-1.4.1.tar)
	- tar xvf apache-solr-1.4.1.tar
	- cd apache-solr-1.4.1.tar
Customize the example directory to use the ESGF specific configuration:
	- cd examples
	- cp ${esgsearch.home}/src/java/test/solr/conf/schema.xml solr/conf/.
	- cp ${esgsearch.home}/src/java/test/solr/conf/solrconfig.xml solr/conf/.
start the server:
	- java -jar start.jar
test the server is running by accessing the URL: http://localhost:8983/solr/ in a web browser


- Installation of maven2 in $PATH

Download the latest version of Apache Maven and include in $PATH 


- Installation of ESG-SEARCH backend

Retrieve the software from the ESGF git repository with one of the following commands:

- git clone git@esg-repo.llnl.gov:esg-search.git (if you have an ssh git account)
- git clone git://esg-repo.llnl.gov/esg-search.git (if you don't have an ssh git account)


- Installation of ESG-SEARCH front end

Retrieve the software from the ESGF git repository with one of the following commands:

- git clone git@esg-repo.llnl.gov:esgf-web-fe.git (if you have an ssh git account)
- git clone git://esg-repo.llnl.gov/esgf-web-fe.git (if you don't have an ssh git account)




***INTEGRATION OF ESG-SEARCH WITH ESGF***

Navigate to the esg-search root directory
	- cd ${esgsearch.home} 

Build esg-search distribution jars
	- ant make_dist // (requires at least Ant 1.7)

Navigate and run script to place the distribution jar in the mvn dependency (m2) repository
	- cp ${esgsearch.home}/dist/esg-search.1.0.0.0.jar ${esgf.home}/scripts
	- ${esgf.home}/setup_dep.sh *.jar // requires mvn in the $PATH


***INGESTION OF METADATA RECORDS***

See "RUNNING THE HARVESTING TOOL" section in INSTALL file



***RUNNING THE APPLICATION***

Navigate to the esgf root directory and create .war file using maven package
	- cd ${esgf.home}
	- mvn package

Copy mvn package to webapps folder of tomcat install dir ($CATALINA_HOME)
	- cp ${esgf.home}/target/esg-web.war $CATALINA_HOME/webapps