Mirror/Fork of https://github.com/yatevoip/yate (formerly http://yate.null.ro/svn/yate/) with some fixes. We're submitting our patches upstream, but until they actually review/respond, we're collecting them here.
Go to file
paulc cda2d9f1c2 Updated copyright and FSF address.
git-svn-id: http://yate.null.ro/svn/yate/trunk@815 acf43c95-373e-0410-b603-e72c3f656dc1
2006-05-27 15:08:43 +00:00
clients Updated copyright and FSF address. 2006-05-27 15:08:43 +00:00
conf.d Moved all classes in all modules in anonymous namespaces. 2006-05-27 14:53:18 +00:00
contrib Updated copyright and FSF address. 2006-05-27 15:08:43 +00:00
docs Added setlocal parameter "reason". 2006-05-25 09:57:45 +00:00
engine Updated copyright and FSF address. 2006-05-27 15:08:43 +00:00
modules Updated copyright and FSF address. 2006-05-27 15:08:43 +00:00
scripts Updated copyright and FSF address. 2006-05-27 15:08:43 +00:00
tables Imported in new CVS 2004-05-22 00:05:20 +00:00
tarballs Imported in new CVS 2004-05-22 00:05:20 +00:00
test Updated copyright and FSF address. 2006-05-27 15:08:43 +00:00
tools Updated copyright updating scripts, added one for FSF address. 2006-05-27 13:49:50 +00:00
windows Updated copyright and FSF address. 2006-05-27 15:08:43 +00:00
.cvsignore Added capability to include optional YateLocal.mak file. 2005-12-19 17:57:16 +00:00
COPYING Updated copyright and FSF address. 2006-05-27 15:08:43 +00:00
ChangeLog Fixes in Windows 2006-03-30 00:21:37 +00:00
Makefile.in Fixed bug exposed by addition of non-enabled ss7 subdirectory. 2006-04-21 16:17:00 +00:00
README Updated informations. 2005-01-25 12:31:02 +00:00
autogen.sh Bugfix. 2004-12-22 00:06:58 +00:00
configure.in Moved all classes in all modules in anonymous namespaces. 2006-05-27 14:53:18 +00:00
kdoc-filter.sh *** empty log message *** 2005-05-02 18:31:05 +00:00
main.cpp Updated copyright and FSF address. 2006-05-27 15:08:43 +00:00
run.in Comment fixes. 2005-06-17 17:17:24 +00:00
yate-config.8 Added reference to pkg-config. 2005-01-09 06:27:11 +00:00
yate-config.in Minor typo. 2005-11-07 03:51:17 +00:00
yate.8 Updated copyright and FSF address. 2006-05-27 15:08:43 +00:00
yate.init Updated copyright years, fixed %ll formatting. 2005-04-29 22:05:07 +00:00
yate.pc.in Added a fork of oRTP in contrib, made some changes in the build system 2005-01-29 18:34:34 +00:00
yate.spec.in Separated scripts from modules directory. 2005-11-07 03:09:23 +00:00
yate.url no message 2006-05-12 09:52:54 +00:00
yatecbase.h Updated copyright and FSF address. 2006-05-27 15:08:43 +00:00
yateclass.h Updated copyright and FSF address. 2006-05-27 15:08:43 +00:00
yatengine.h Updated copyright and FSF address. 2006-05-27 15:08:43 +00:00
yatephone.h Updated copyright and FSF address. 2006-05-27 15:08:43 +00:00
yateversn.h.in Video and other media support in SIP, removed PosgreSQL modules. 2005-09-06 02:51:09 +00:00

README

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

  The YATE project aims to be a fully featured software PBX.
  
  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. The main engine - telengine.
    2. Modules - routing modules
               - drivers
               - script language bindings
	       - billing modules
  
  Its license is GPL with exceptions (in case of linking with proprietary
  software). We have chosen this license to help the growth of this project.


Building YATE Software
----------------------

YATE have been tested on Linux. Please report bugs at bugs@voip.null.ro

To build Yate the quick way is:
'./configure'
'make'
'make install'


1. Building the engine

You have just to run 'make engine' in the main directory.

2. Building the modules.

Run 'make modules' in the main directory or 'make' in the modules directory.

3. Building the test modules.

Run 'make test' in the main directory or 'make' in the test directory.

After you have create the test modules use 'mktestlinks' in the modules
directory to make links from test modules into modules directory.

4. Building the classes API documentation

Run 'make apidocs' in the main directory. You will need to have kdoc installed.


Alternatively you can just 'make everything' in the main directory which will
build them all.


Running YATE
------------

You can run YATE directly from the build directory - just use 'run' script
from the main directory.

You can also install YATE - then you can run it from anywhere.

On the command line you can use '-v' to increase the verbosity level. If in
doubt run "run --help" (or "yate --help" if installed) to get a list of
possible options. There is also a manual page - "man yate" and read.

While running the following signals and keys are trapped and used:
  - SIGTERM and SIGINT (Ctrl-C) will cleanly stop the engine
  - SIGHUP and SIGQUIT (Ctrl-\) will reinitialize the modules


Configuring YATE
----------------

Some samples for the configuraton files can be found in the conf.d directory.
Note that you must rename them without the .sample extension or create symlinks
to them.