summaryrefslogtreecommitdiff
path: root/documentation/oreka-documentation.xml
blob: 05e74459288da56dced67b3e56138f393a9870c5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">
<book>
  <title>Oreka</title>

  <chapter>
    <title>Introduction</title>
	<section>
		<title>What is Oreka ?</title>
			<para>
Modular and cross-platform system for recording and retrieval of audio streams. The project currently supports VoIP and sound device based capture.
			</para>
			<para>
The platform currently comprises of three services:
				<itemizedlist>
					<listitem>
<emphasis>OrkAudio</emphasis>: the audio capture and storage daemon with pluggable capture modules currently comes with modules for VoIP and sound device recording. This service is written in C++.
					</listitem>
					<listitem>
<emphasis>OrkTrack</emphasis>: logs all activity from one or more orkaudio services to any mainstream database. This service is implemented as a J2EE servlet based application.
					</listitem>
					<listitem>
<emphasis>OrkWeb</emphasis>: Web based user interface for retrieval. This service is implemented as a J2EE servlet based application using the Tapestry web development framework.
					</listitem>
			</itemizedlist>. 			
		</para>			
	</section>
	<section>
		<title>License</title>
		<para>
This program is free software, distributed under the terms of the GNU General Public License. Please refer to <link linkend='http://www.gnu.org/copyleft/gpl.html'>http://www.gnu.org/copyleft/gpl.html</link> for more information.
		</para>
	</section>

  </chapter>
  <chapter>
	<title>Building</title>
	<para>If you only want to run Oreka sofware, you can safely skip this section.</para>
	<section>
		<title>Building OrkAudio</title>
	</section>
	<section>
		<title>Building OrkTrack and OrkWeb</title>
	</section>	
  </chapter>
  <chapter>
	<title>Installing</title>
	<section>
		<title>Installing Prerequisite Software for OrkAudio</title>
		<section>
			<title>Installing Linux Libraries</title>
		</section>	
		<section>
			<title>Installing Windows Libraries</title>
		</section>
		<section>
			<title>Installing Java and Tomcat</title>
		</section>	
		<section>
			<title>Installing a database</title>
		</section>			
	</section>	
	<section>
		<title>Installing OrkAudio</title>
	</section>
	<section>
		<title>Installing Prerequisite Software for OrkTrack and OrkWeb</title>
	</section>	
	<section>
		<title>Installing OrkTrack and OrkWeb</title>
	</section>	
  </chapter>
  <chapter>
	<title>Running</title>
	<section>
		<title>Running OrkAudio</title>
	</section>	
	<section>
		<title>Running OrkTrack and OrkWeb</title>
	</section>	
  </chapter>
</book>