
YATE - Yet Another Telephony Engine
===================================

Yate is a telephony engine aimed at creating a telephony softswitch that
performs well enough to deal with the PBX (Private Branch eXchange)
requirements, ACD (Advanced Call Distribution) and also flexible enough
for complex VoIP (Voice over Internet Protocol) Gateway, Conferencing
and IVR (Interactive Voice Response) solutions. Currently, all popular
packet voice and, or software protocols SIP, H.323, IAX2 and Jingle as
well as traditional TDM hardware including many a T1, E1, ISDN PRI and
ISDN BRI are supported over various signaling protocols.

It was created to alow developers and users to have more functionality
and scalability. To reach this goal YATE is built from two kinds of
components: 

    1. Main engine:
	- telengine

    2. Modules and, or plugins:
	- channel drivers, both hardware and software
        - codec and format handlers
	- authentication, authorization and accounting handlers
	- call routing and, or remote monitoring handlers
	- interactive voice response and, or voicemail handlers
	- bindings for various scripting languages

The YATE program is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the Free
Software Foundation; either version 2 of the License, or (at your option)
any later version; with EXCEPTIONS (in case of linking with proprietary
software). Please COPYING for further details.

This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
more details.

We specifically have chosen the above said GPL license to help the growth of
this project.


Optional packages
=================

You may need to download, install and, or compile some of the following
packages prior to compiling YATE for some additional features:

Mandatory:

 - LibPTH (libraries and development headers)
     http://www.gnu.org/software/pth/pth.html

Optionally:

 - LibGSM (libraries and development headers)
     ftp://ftp.cs.tu-berlin.de/pub/local/kbs/tubmik/gsm
 - LibGTK+ (libraries and development headers)
     http://www.gtk.org/
 - LibOpenH323 (libraries and development headers)
     http://sourceforge.net/projects/openh323
 - LibPT/PWLib (libraries and development headers)
     http://sourceforge.net/projects/openh323
 - LibPRI (libraries and development headers)
     http://ftp.digium.com/pub/libpri/
 - LibSpanDSP (libraries and development headers)
     http://www.soft-switch.org/downloads/spandsp/
 - LibSPEEX (libraries and development headers)
     http://downloads.us.xiph.org/releases/speex/
 - MySQL (libraries and development headers)
     http://dev.mysql.com/downloads/
 - PostgrsSQL (libraries and development headers)
     http://www.postgresql.org/
 - Zaptel (drivers source for Linux kernel modules and utils)
     http://ftp.digium.com/pub/zaptel/
 - Wanpipe (drivers source for Linux kernel modules and utils)
     http://sangoma.com/main/support/downloads

Navtive versions of the following are included in contrib sub-directory
of YATE sources, but you may want to have look at the latest available
versions of same too (use these at your own risk):

 - LibiLBC (libraries and development headers)
     http://www.ilbcfreeware.org/
 - LibREGEX (libraries and development headers)
     http://www.boost.org/libs/regex/doc/index.html

Building YATE Software
======================

Please read INSTALL to configure, compile, test run,  and, or install YATE on
your machine.


Reporting Bugs
==============

YATE have been tested to run on Linux, FreeBSD and Windows; have also been
reported to be running on other BSD variants. Please report bugs, suggestions
and, or patches to <bugs@voip.null.ro> or bug-tracker at
http://yate.null.ro/mantis/login_page.php
