From 80521778a66f62c71e25c8b32aa093540f0d1cc1 Mon Sep 17 00:00:00 2001 From: Ralph Atallah Date: Fri, 28 Nov 2008 22:54:52 +0000 Subject: Updated user manual for Oreka 1.0 (OrkWeb and OrkTrack related changes) git-svn-id: https://oreka.svn.sourceforge.net/svnroot/oreka/trunk@584 09dcff7a-b715-0410-9601-b79a96267cd0 --- documentation/oreka-user-manual.xml | 163 +++++++++++++++++------------------- 1 file changed, 77 insertions(+), 86 deletions(-) (limited to 'documentation/oreka-user-manual.xml') diff --git a/documentation/oreka-user-manual.xml b/documentation/oreka-user-manual.xml index 30b705e..f701d90 100644 --- a/documentation/oreka-user-manual.xml +++ b/documentation/oreka-user-manual.xml @@ -3,15 +3,15 @@ "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"> - Oreka 0.6 Open Source User Manual + Oreka 1.0 Open Source User Manual - Revision 2 + Revision 3 OrecX LLC - 2007 + 2008 @@ -334,8 +334,14 @@ with a native call ID of FDBCE@69.13.45.6 will result in the following file name quality, 44100 can be used. Recorded file size will be directly proportional to this number. +
+ Logging recordings to the database + + Refer to section below in OrkWeb - OrkTrack for more details. +
+
Running OrkAudio @@ -428,89 +434,80 @@ with a native call ID of FDBCE@69.13.45.6 will result in the following file name
Installing - OrkWeb/OrkTrack need the following prerequiste - software: - - - - The Java Runtime Environment JRE 5.0 from http://java.sun.com - - - - The Apache Tomcat servlet container version 5.X from http://tomcat.apache.org - +
+ Pre-requisites - - The MySQL server version 4.X from http://www.mysql.com - - Install the prerequisite software with all defaults and - make note of the Tomcat admin password as well as the MySQL root - password. + OrkWeb/OrkTrack need the following prerequiste + software: + + + + The Java Runtime Environment JRE 5.0 from http://java.sun.com + The Apache Tomcat servlet container version 5.X from http://tomcat.apache.org + The MySQL server version 4.X from http://www.mysql.com + + +
+ +
+ Using Installers + + Installers for several platforms are provided, e.g. Windows, + CentOS 5 (32-bit), CentOS 4 (32-bit), Linux SuSE (32-bit). + If your platform does not have an installer, use the manual installation + steps described below. + +
- OrkWeb/OrkTrack comes in the form of a zip file such as - oreka-0.5-2-orkweb-orktrack.zip. Unzip this file - into a temporary directory and execute the following steps: +
+ Manual Installation + + Install the prerequisite software above, accepting all defaults, and + make note of the Tomcat admin password as well as the MySQL root password. + + + OrkWeb/OrkTrack comes in the form of a zip file such as + oreka-1.0-orkweb-orktrack.zip. Unzip this file + into a temporary directory and execute the following steps: - - - Copy lib.zip to {TOMCAT_HOME}/shared/lib and "unzip here". + + Copy lib.zip to {TOMCAT_HOME}/shared/lib and "unzip here". You should now have an additional collection of jar files directly - under this shared/lib directory. - - - - Copy ConfigFiles.zip to c:\ and "unzip to here" so as to get + under this shared/lib directory. + Copy ConfigFiles.zip to c:\ and "unzip to here" so as to get a c:\oreka folder with orkaudio and orkweb subdirectories. Under - Linux, you can unzip to a folder such as /etc/oreka/ - - - - Edit c:\oreka\orkweb\mysql.hbm.xml and - c:\oreka\orktrack\mysql.hbm.xml or the linux equivalent files in - order to supply the right DB username, DB password and JDBC - URL. - - - - Copy orkweb.war and orktrack.war to the - {TOMCAT_HOME}/webapps folder - - - - Start Tomcat - - - - Tomcat should automatically deploy orktrack and orkweb to + Linux, you can unzip to a folder such as /etc/oreka/ + Edit /etc/orkweb/database.hbm.xml file (c:\oreka\database.hbm.xml + on Windows) in order to supply the right DB username, DB password + and JDBC URL. + Copy orkweb.war and orktrack.war to the + {TOMCAT_HOME}/webapps folder + Start MySQL (or whatever database engine you are using) + Start Tomcat + Tomcat should automatically deploy orktrack and orkweb to {TOMCAT_HOME}/webapps/orktrack and {TOMCAT_HOME}/webapps/orkweb - folders - - - - Under Linux only, edit - {TOMCAT_HOME}/webapps/orktrack/WEB-INF/web.xml and - {TOMCAT_HOME}/webapps/orkweb/WEB-INF/web.xml and change the paths - to the config files (log4j.properties, mysql.hbm.xml and - orktrack.config.xml) to /etc/oreka/... - - - - Restart Tomcat + folders + Edit {TOMCAT_HOME}/webapps/orktrack/WEB-INF/web.xml and + {TOMCAT_HOME}/webapps/orkweb/WEB-INF/web.xml and ensure that the + paths to the config files (logging.properties, database.hbm.xml and + orktrack.config.xml) are correct, e.g. /etc/orkweb/ for Linux + Restart Tomcat +
Running - Start the database server. Start the Tomcat servlet container and - point your browser to http://localhost:8080/orkweb. This will bring up a - login screen. Login as admin/admin. - - + + Start the database server. + Start Tomcat. + Point your browser to + http://localhost:8080/orkweb. This will bring up a + login screen. + Login as admin/admin. +
@@ -520,19 +517,13 @@ with a native call ID of FDBCE@69.13.45.6 will result in the following file name do the followig changes to OrkAudio's config.xml: - - Set EnableReporting to true. - - - - If OrkTrack is deployed on a different server than OrkAudio, - set TrackerHostname OrkTrack's - hostname. - + Set EnableReporting to true. + If OrkTrack is deployed on a different server than OrkAudio, + set TrackerHostname OrkTrack's hostname. - Make sure c:\oreka\orktrack\mysql.hbm.xml or the equivalent Linux - file contains the right database access URL and credentials. If OrkTrack + Make sure /etc/orkweb/ (Linux) or c:\oreka\database.hbm.xml (Windows) + contains the right database access URL and credentials. If OrkTrack is up and running under Tomcat and the OrkAudio service is recording traffic, database entries should start appearing. Use OrkWeb to browse them. @@ -561,7 +552,7 @@ with a native call ID of FDBCE@69.13.45.6 will result in the following file name
Replaying recordings - Replaying recordings via OrkWeb is currrently only possible + Replaying recordings via OrkWeb is currently only possible using Internet Explorer. Audio Files need to be accessible via http. Here is what needs to be done for that (repeat for each instance of OrkAudio): @@ -644,4 +635,4 @@ with a native call ID of FDBCE@69.13.45.6 will result in the following file name
- \ No newline at end of file + -- cgit v1.2.3