Table of Contents
Table of Contents
Oreka is an enterprise telephony recording and retrieval system with web based user interface. The project currently supports recording voice from VoIP SIP, Cisco Skinny (aka SCCP), raw RTP and runs on multiple operating systems and database systems.
It can record audio from most PBX and telephony systems such as BroadWorks, Metaswitch, Asterisk, FreeSwitch, OpenSIPS, Avaya, Nortel, Mitel, Siemens, Cisco Call Manager, Cosmocom, NEC, etc...
It is amongst others being used in Call Centers and Contact Centers for Quality monitoring (QM) purposes.
Oreka is sponsored by OrecX LLC. Professional open source support as well as commercial versions are available here
This program is free software, distributed under the terms of the GNU General Public License. Please refer to the GNU GPL licence for more information.
The Oreka system consists of a combination of the following three services
The system supports multiple instances of OrkAudio reporting to OrkTrack so that multiple recording servers can be seen as one recording system. OrkTrack and OrkWeb can run on the same server or on two separate servers.
The Oreka system runs on Linux, BSD and all versions of Microsoft Windows starting from Windows XP/Server 2003. Oreka supports most major database systems including MySQL, PostgreSQL, Oracle and MS-SQL. MySQL is the default database.
Before Oreka can start recording, ensure that VoIP traffic is seen on a server interface. Use SPAN port mirroring to get the right traffic to the Oreka server. Two configurations are possible:
This is to ensure that both the media traffic (RTP) and signalling (SIP or Skinny) are intercepted by the recorder.
Once the VoIP traffic appears on the server, you are ready to start using the Oreka software.
Mechanisms to get VoIP traffic
In terms of insertion point, Oreka can intercept packets via several mechanisms:
Table of Contents
OrkAudio comes as an automated installer for Linux CentOS/RHEL which you can download from The Oreka sourceforge project page.
tar -xvf orkaudio-1.7-844-os-x86_64.centos6-installer.sh.tar
OrkAudio comes as an automated installer for Windows XP or Windows Server 2003 or newer) which you can download from The Oreka sourceforge project page. Simply run the installer. In order to increase your chances of Oreka working out of the box, accept all defaults.
Audio output files are written to the [install directory]/AudioRecordings under windows and in /var/log/orkaudio under Linux by default. This can be changed using the AudioOutputPath configuration parameter described in the section called “Configuring”. They are classified according to the following scheme:
Audio file themselves are named after the following scheme:
Configuration files are located in the install directory under Windows and in /etc/oreka under Linux. The files are:
config.xml : this is the main OrkAudio configuration file. Plugins also read their configration parameters from subsections of this file.
logging.properties : this is the log4j logging configuration file which allows for great flexibility in logging scope and output format.
Log files are located in the install directory under Windows and in /var/log/oreka under Linux. By default, Oreka produces the following output:
orkaudio.log : this is the main OrkAudio logfile.
tapelist.log : this logfile contains the details (metadata) for each recording that was performed by OrkAudio
Plugins exist as dll files under Windows and as DSO (Dynamic Shared Objects) with .so extensions under Linux. They are located in [install dir]/audiocaptureplugins under Windows and in /usr/lib under Linux.
VoIp.dll - libvoip.so : VoIP recording plugin
Generator.dll - libgenerator.so : Audio generator for faking audio capture (useful when testing)
Configuration of OrkAudio and its plugins is performed by modifying the config.xml file. Core OrkAudio configuring parameters are the following:
EnableReporting this parameter controls wether recording activity is reported to OrkTrack
StorageAudioFormat this parameter controls the final file format of the tapes. valid values are the following: gsm, ulaw, alaw and pcmwav
CapturePlugin this parameter controls which audio capture plugin should be used. Use VoIP.dll under Windows or libvoip.so under Linux
AudioOutputPath this parameter controls the root directory where capture and storage audio files are stored. It can be a relative or absolute path.
TapeFileNaming see the section called “Configure audio files path and file names”
VoIP plugin specific configuration is found in the config.xml file under the VoIpPlugin tag.
It is possible to configure the network device to monitor for VoIP traffic using the <Devices> directive. While OrkAudio attempts to automatically select the server interface on which it detects VoIP traffic, you may need to configure the interface manually if orkaudio.log shows no sign of traffic. E.g.
Several comma-separated interfaces may be configured in the examples above
OrkAudio gives you the ability to configure the path and file name of the recorded audio files. To modify the default naming scheme:
Here are the dynamic keywords accepted as in the TapeFileNaming and TapePathNaming directives:
Under Windows, start the OrkAudio service in the NT services control panel (start/run/services.msc).
Under Linux, start the OrkAudio service by typing:
service orkaudio start
If no recordings appear in the AudioOutputPath directory, Here is the checklist:
Windows users only: Make sure winpcap is properly installed (start/programs should contain a Winpcap entry
Make sure that the VoIP plugin records from the right network interface(s) specified in the Devices xml tag of the config.xml file. A list of all network interfaces is shown in orkaudio.log at startup.
Make sure that RTP traffic is actually present on the specified network interface(s). A packet sniffer such as Wireshark can be useful for that.
Make sure that RTP traffic for both sides is actually seen on the considered network interface. A packet sniffer such as Wireshark can be used for that.
Make sure that the signalling is SIP or Cisco Skinny. It is possible to turn on SIP and Skinny debugging by editing logging.properties such as this:
If those settings do not generate extra entries in orkaudio.log, it means that no SIP or Skinny traffic is detected.
Table of Contents
Start by installing MySQL or any database compatible with hibernate
You can then use the OrkWeb Windows or Linux (RHEL/CentOS) installers that are published on the sourceforge OrkWeb/OrkTrack download page.
If OrkWeb is up and running, any new recording done by OrkAudio should show up in OrkWeb (just do a page refresh)
If OrkTrack is deployed on a different server than OrkAudio, set TrackerHostname to OrkTrack's hostname.
Make sure /etc/orkweb/database.hbm.xml (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.
The retrieval screen has two panes. The left hand pane contains all possible search criteria. Using more than one criteria will filter results by a combination of all criteria. The right hand pane is a list of all entries that match all of the search criteria.
It is possible to sort results by clicking on the appropriate results column headings. Sort order is toggled by multiple clicking of the column headings.
Most likely, the database server is down or there is something wrong in the database URL and credentials in the hibernate configuration file. Please refer to the section called “Installing”
If you fail to replay recordings through OrkWeb, here is the checklist:
$tomcat/conf/server.xmlcontains an entry such as:
<Context path="/audio" docBase="c:/oreka/audio/" ></Context>If this parameter does not exist already, just add it under the <Host> section. Make sure Tomcat is restarted after such a change.