File	Date	Author	Commit
3rdPartyLibs	2016-01-26	Robert Mundkowsky	[b81363] Move JMF to other folder.
JVXML-VM	2017-03-27	langep	[ea08cd] Added name of halefdbwriter and mysql-connector...
scripts	2016-03-28	Robert Mundkowsky	[ab34b7] modified to support current logging approach
README.TXT	2016-03-28	Robert Mundkowsky	[760d4d] updated comments

Read Me

###############################
#Note on how deployment/configuration steps run
###############################

	#for human to deploy and configure, run once
	deploy -> manual configure -> automated configure
	
	#for human to make configuration changes after deployed
	manual configure -> automated configure

	#for automated configuration changes after deployed
	automated -> configure

###############################
#Requirements Halef JVXML
###############################
	Linux (we are using Ubuntu 14.04 LTS)
	
	Enable host resolution (we are using DNS, but you can use /etc/hosts as well)

	#update packages
		sudo apt-get -y  update
		sudo apt-get -y  upgrade
	
	#setup ntp, so that logs to database are consistent
		sudo  apt-get -y install ntp
		
	#We likely do not need all of the following, but we installed them
		sudo apt-get -y  install packaging-dev gnupg pbuilder ubuntu-dev-tools bzr-builddeb apt-file subversion git-core autoconf automake gcc g++ make build-essential linux-headers-$(uname -r)
	
	#Java JDK 1.7
		#Download and install Java (e.g. setup JAVA_HOME and have java in path
		#	Highly recommend Oracle Java
		
	#Maven is required for building Halef JVXML
		sudo apt-get -y  install maven
	#Ant is required for building and running Halef JVXML
		sudo apt-get -y  install ant

	#SVN I think it no longer required, but jsut in case
		sudo  apt-get -y  install libsvn-java

	#xsltproc is used for configuring system
		sudo apt-get -y  install xsltproc

	# JMF is needed by Cairo jars and is included in git repository for this proejct
	
###############################
#How to install (deploy) Halef JVXML, run one of the following:
###############################
	#Note that Halef JVXML is primarily based on http://jvoicexml.sourceforge.net/ which has how to build documentation under ./JVoiceXML/howtobuild,
	#	but you do not have to run anything separately for it, just FYI if you want to read more about it's build details
	
	git clone git://git.code.sf.net/p/halef/JVoiceXML halef-JVoiceXML
		#note that deploy script expects JVoiceXML to be in this location
	
	git clone git://git.code.sf.net/p/halef/halef-jvxml halef-jvxml
	cd halef-jvxml/scripts
	bash deploy.sh


###############################
#How to compile Halef JVXML
###############################
	
	cd halef-jvxml/scripts
	bash ${DEPLOY_PREFIX_DIR}/bin/recompile.sh


###############################
#How to change Halef JVXML settings without deploying again:
###############################

	# Manual way
	
		bash configure_manual.sh
	
	# Automated way, uses two configuration files
		# One config file is bash script that sets environment variables
		# Other config file is text file containing list of
		#		url keyNumber
		
		bash automated_configure.sh <config bash filename> <config txt filename>
		
		
###############################
#How to setup Halef JVXML to run as under specific user account and start/stop via service command
###############################
		
#	XXX This section is not finished
#		chown -R rmundkowsky:halef /export/Apps/jvxml/halef-halef-jvxml

		
###############################
#How to run Halef JVXML
###############################

	bash ${PREFIX_DIR}/bin/restart.sh

	or you can use the following, but log file will not be created
	
	bash ${PREFIX_DIR}/bin/start.sh

	
###############################
#How to stop Halef JVXML
###############################

	${PREFIX_DIR}/bin/stop.sh
	
###############################
#Notes on configuration files
###############################
	
	JVoiceXML is alreday configured, so do NOT run "ant -f configuration.xml" 

	Configuration files are under JVoiceXML/org.jvoicexml/config and the main files are:
		mrcpv2-callmanager.xml
		halef-logging-db.xml
		
	Note that if you run "ant -f configuration.xml" then some files under  ./halef-JVoiceXML/org.jvoicexml/config-props and ./halef-JVoiceXML/org.jvoicexml/config are generated and/or overwritten by
		files in ./halef-JVoiceXML/org.jvoicexml/personal-props