Installation

Oreka installation comprises of 2 mandatory components (orkaudio & orktrack) & one optional component (orkweb)

Orkaudio

OS Compatibility

OS	Version	Variant
Ubuntu	16.x , 18.x, 20.x	Native Support
Debian	9 , 10	Native Support
Debian	<= 8	Docker Support
CentOS	any	Docker Support
Windows	-	Not Maintained

Native Installation

1. Install daemontools and orkaudio

apt-get install daemontools daemontools-run
apt install ./orkaudio.deb

2. Configure /etc/orkaudio/config.xml

   sample config.xml

     <config>
     	<!-- This is an example configuration file for the Oreka orkaudio capture service on Linux -->
     	<!-- Copy this to config.xml and modify according to taste -->
   
     	<AudioOutputPath>/var/log/orkaudio/audio</AudioOutputPath>
   
     	<!-- Uncomment the plugin you want to use: -->
     	<!-- Use libvoip.so for SIP, Cisco Skinny and pure RTP -->
     	<!-- Use libh323voip.so for Avaya, Nortel Unistim, H.323 and MGCP -->
     	<!-- See in <VoIpPlugin> below for more precise protocol tuning -->
     	<CapturePlugin>libvoip.so</CapturePlugin>
     	<!--<CapturePlugin>libh323voip.so</CapturePlugin>-->
     	<!--<CapturePlugin>liborksipua.so</CapturePlugin>-->
   
     	<CapturePluginPath>/usr/lib</CapturePluginPath>
     	<!--<PluginsDirectory>/oreka-src/orkaudio/plugins</PluginsDirectory>-->
   
     	<!-- Audio file storage format: choose from: native, gsm, ulaw, alaw, pcmwav -->
     	<StorageAudioFormat>opus</StorageAudioFormat>
     	<StereoRecording>true</StereoRecording>
     	<TapeNumChannels>2</TapeNumChannels>
     	<AudioFileBitRate>8000</AudioFileBitRate>
   
     	<!-- If you want to keep native audio files as well as compressed, change this to "no" -->
     	<DeleteNativeFile>yes</DeleteNativeFile>
   
     	<TrackerHostname>localhost</TrackerHostname>
     	<TrackerTcpPort>8080</TrackerTcpPort>
   
     	<!-- <CapturePortFilters>LiveMonitoring</CapturePortFilters> -->
     	<TapeProcessors>BatchProcessing, Reporting</TapeProcessors>
   
     	<!-- <ImmediateProcessingQueueSize>1000</ImmediateProcessingQueueSize> -->
     	<BatchProcessingQueueSize>2000</BatchProcessingQueueSize>
     	<BatchProcessingEnhancePriority>true</BatchProcessingEnhancePriority>
     	<NumBatchThreads>8</NumBatchThreads>
   
     	<AudioFileOwner>tomcat8</AudioFileOwner>
     	<AudioFileGroup>tomcat8</AudioFileGroup>
     	<AudioFilePermissions>644</AudioFilePermissions>
     	<TapeDurationMinimumSec>0</TapeDurationMinimumSec>
     	<!-- <CaptureFileBatchSizeKByte>1024</CaptureFileBatchSizeKByte> -->
   
     	<!-- Uncomment the parameter below and fill in a comma-separated -->
     	<!-- list of TCP addresses which you wish to open a connection to. -->
     	<!-- For example 192.168.1.250:1721, 192.168.1.1:8091. A TCP -->
     	<!-- connection shall be opened and a read-loop shall be entered -->
     	<!-- into whereby any data read shall be discarded, and a record -->
     	<!-- maintained of the amount of data which has been read. -->
     	<!-- <SocketStreamerTargets></SocketStreamerTargets> -->
   
     	<VoIpPlugin>
     		<PcapSocketBufferSize>2147483646</PcapSocketBufferSize> <!--INT MAX-1 2047MB -->
     		<IpFragmentsReassemble>true</IpFragmentsReassemble>
   
     		<!--queuemetrics integration, uncomment the following line-->
     		<SipExtractFields>X-Unique-ID</SipExtractFields>
   
     		<!-- Use this for Nortel proprietary VoIP protocol -->
     		<!--<UnistimDetect>yes</UnistimDetect>-->
   
     		<!-- Turn both these on this for Avaya H.323 extensions -->
     		<AvayaDetect>yes</AvayaDetect>
     		<RtcpDetect>yes</RtcpDetect>
   
     		<!-- Set the option below to "true" to enable IAX2 support -->
     		<!-- the default is that IAX2 support is disabled -->
     		<!--<Iax2Support>false</Iax2Support> -->
   
     		<!-- Use this if you want to force capture from a given list of devices. -->
     		<!-- All available devices are listed in orkaudio.log when the service is starting -->
     		<Devices>eth2</Devices>
   
     		<!--<PcapFilter>net 217.14.0.0/16 or host 10.0.0.1</PcapFilter>-->
   
     		<SipOverTcpSupport>yes</SipOverTcpSupport>
     		<SipReportFullAddress>yes</SipReportFullAddress>
     		<!--<SipUse200OkMediaAddress>yes</SipUse200OkMediaAddress>-->
   
     		<!-- Those two parameters are only needed for call direction detection (one or the other) -->
     		<!--<SipDomains>company.com, 65.34.25.87</SipDomains>-->
     		<!--<SipDirectionRefenceIpAddresses>65.34.98.56, 65.34.98.57</SipDirectionRefenceIpAddresses>-->
   
     		<!-- Sangoma wanpipe RTP tap for TDM boards -->
     		<!--<SangomaRxTcpPortStart>9000</SangomaRxTcpPortStart>-->
     		<!--<SangomaTxTcpPortStart>11000</SangomaTxTcpPortStart>-->
   
     		<!-- Mitel Communications Platform -->
     		<!-- Turn on the parameter below to enable support for Mitel -->
     		<!-- <MitelDetect>yes</MitelDetect> -->
   
     		<!-- The parameter below sets the Mitel signalling port. The -->
     		<!-- default is 3999 -->
     		<!-- <MitelSignallingPort>3999</MitelSignallingPort> -->
   
     		<!-- The parameter below sets the amount of time in seconds -->
     		<!-- after which the cached Mitel metadata shall be discarded. -->
     		<!-- The default is 60 seconds. -->
     		<!-- <MitelMetadataTimeoutSec>60</MitelMetadataTimeoutSec> -->
   
     		<!-- Turn on the parameter below to enable extension Mitel -->
     		<!-- extension detection using ARP. Turning on this parameter -->
     		<!-- automatically turns on MitelDetect -->
     		<!-- <MitelArpExtensionDetect>yes</MitelArpExtensionDetect> -->
   
     		<!-- Set MitelSmdrPort to the port where Mitel SMDR records -->
     		<!-- may be accessed. The default is 1752. Note that you -->
     		<!-- shall need to configure SocketStreamerTargets with the -->
     		<!-- host and this port, in order for Oreka to access the -->
     		<!-- SMDR records. See SocketStreamerTargets above for more -->
     		<!-- information on how to configure it. -->
     		<!-- <MitelSmdrPort>1752</MitelSmdrPort> -->
     		<!-- End of Available Configurations for Mitel Communications Platform -->
   
     	</VoIpPlugin>
     </config>

3. Start/Stop the orkaudio service

svc -u /etc/service/orkaudio #to-start
# Verify that is running using `ps aux | grep orkaudio`
svc -d /etc/service/orkaudio #to-stop

Docker Based Installation

docker run -itd --net=host --restart=always --privileged=true -v /var/log/orkaudio:/var/log/orkaudio voiceip/orkaudio:latest

Orktrack

Install orktrack using the following steps:

1. Install MySQL & Tomcat (>8.5)

apt-get install mysql-server-5.7 mysql-client-5.7
apt install tomcat8

2. Create database oreka

3. Proceed with configuration

   Create the folder /etc/oreka and create the following files database.hbm.xml example, logging.properties example, logging.xml example, orktrack.config.xml example and configure them as per your need.

4. Create the log folders.

mkdir /var/log/orkweb
chown -Rv tomcat8:admin /var/log/orkweb/

5. Deploy orktrack.war to tomcat webapps folder, and restart tomcat.

Orkweb

Install orkweb using the following steps:

1. Follow steps 1-3 of orktrack.

2. Deploy orkweb.war to tomcat webapps folder, and restart tomcat.

3. Login using default credentials username : admin password: admin