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
marian 2bcacf9525 Added extra parameter used to set relay filter in module install relay.
git-svn-id: http://yate.null.ro/svn/yate/trunk@6531 acf43c95-373e-0410-b603-e72c3f656dc1
2021-12-16 11:37:39 +00:00
clients Added some larger client icon files. 2018-04-06 10:12:44 +00:00
conf.d Added support to enable REFER handling per call leg. Added configurable support (default:disabled) to send a call.update message with operation=transfer before internal handling on REFER. 2021-11-15 14:19:43 +00:00
docs Added extmodule support to put a script requested debug message in yate output/logging. Added support to change script's debug level and debug name. 2021-04-01 09:10:07 +00:00
engine Added extra parameter used to set relay filter in module install relay. 2021-12-16 11:37:39 +00:00
libs Fixed JSON reference resolve string comparison bug revealed by new compiler. 2021-11-25 18:02:25 +00:00
modules Added dump_t/print_t support to handle field name mapping. Added parameter to allow printing empty results (header only). 2021-12-13 07:29:32 +00:00
packing Added G.722 codec from the WebRTC code. 2019-11-06 18:31:54 +00:00
share Replaced usage of curly brackets with square brackets in string element access. 2021-12-06 09:10:12 +00:00
tools Added support for monitoring services with name other than yate. 2018-11-19 21:07:13 +00:00
windows Bumped version to 6.4.0 release. 2021-08-02 12:12:11 +00:00
.cvsignore Made all YateLocal* to be ignored by SVN/CVS. 2008-02-05 12:25:40 +00:00
COPYING Updated copyright and FSF address. 2006-05-27 15:08:43 +00:00
ChangeLog Bumped version to 1.3.0 2007-08-27 17:26:32 +00:00
Makefile.in Updated files to Rev. 6330. 2018-12-04 10:06:04 +00:00
README Added copyright notices to sources and scripts missing them. 2014-02-05 11:42:17 +00:00
autogen.sh Added copyright notices to sources and scripts missing them. 2014-02-05 11:42:17 +00:00
configure.ac Bumped version to 6.4.1 devel. 2021-08-02 15:13:48 +00:00
main.cpp Added copyright notices to sources and scripts missing them. 2014-02-05 11:42:17 +00:00
run.in Added support for running through the "perf" tool. 2019-08-08 11:38:03 +00:00
yate-config.sh Put path where the library is found before the linked library. 2021-07-26 09:01:33 +00:00
yate.pc.in Added to pkgconfig several custom variables like in yate-config. 2008-10-09 14:53:51 +00:00
yatecbase.h Added copyright notices to sources and scripts missing them. 2014-02-05 11:42:17 +00:00
yateclass.h Added String::insert(). 2021-08-16 06:40:44 +00:00
yateiss.inc.in Include code status in installer. 2008-01-08 19:22:51 +00:00
yatemath.h Fixed bug: properly return data pointer when requested offset is not 0. 2016-04-27 08:08:08 +00:00
yatemime.h Added hashing support for MimeSdpBody. 2014-07-02 07:34:19 +00:00
yatengine.h Added support to create arbitrary named lists of shared vars (separate from Engine's global). Added extra functions to shared vars list. Export in javascript. 2021-09-28 10:55:08 +00:00
yatephone.h Added extra parameter used to set relay filter in module install relay. 2021-12-16 11:37:39 +00:00
yateversn.h.in Added copyright notices to sources and scripts missing them. 2014-02-05 11:42:17 +00:00
yatewiresniff.h Update name from wiresniff to yatewiresniff. 2018-11-28 10:13:05 +00:00
yatexml.h Added extra parameter to XmlDocument::saveFile to allow saving flat documents. 2018-04-12 12:38:59 +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 and Windows and was ported to FreeBSD.
Please report bugs at bugs@voip.null.ro

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

If you are lacking both doxygen and kdoc you will need to install without the
API documentation:
  make install-noapi

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 or
doxygen 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.
  ./run -vvv

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

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
  - SIGUSR1 will gracefully restart a supervised engine
  - SIGUSR2 will forcefully restart a supervised engine


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.