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 9878b9cdac Made all YateLocal* to be ignored by SVN/CVS.
git-svn-id: http://yate.null.ro/svn/yate/trunk@1716 acf43c95-373e-0410-b603-e72c3f656dc1
2008-02-05 12:25:40 +00:00
clients Guess the proper instance of MOC in case it's not the first in path. 2008-01-24 12:13:59 +00:00
conf.d Added switchtype parameter for ISDN group. Removed useless display-charset option. 2008-01-31 15:49:47 +00:00
docs New option to report code status and release. 2008-02-04 13:37:20 +00:00
engine Bumped version to 2.0.0 alpha2 and made --version report code status. 2008-02-04 12:54:30 +00:00
libs Changed debug. Broke some code lines (too long). 2008-01-31 15:45:52 +00:00
modules Fixed minor debug message. 2008-01-31 15:53:45 +00:00
packing Package queues.conf 2008-02-04 13:37:40 +00:00
share Fixed parameters transfer, added queue assist scripts. 2008-01-30 19:46:09 +00:00
tools Added script to remove writespaces at end of line. 2006-06-19 12:42:40 +00:00
windows Bumped version to 2.0.0 alpha2 and made --version report code status. 2008-02-04 12:54:30 +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 Added Qt4 package and status tag. 2008-01-07 21:07:07 +00:00
README Minor documentation additions. 2006-12-17 19:20:45 +00:00
autogen.sh Directory reorder #3 2007-11-15 23:06:36 +00:00
configure.in Bumped version to 2.0.0 alpha2 and made --version report code status. 2008-02-04 12:54:30 +00:00
main.cpp Updated copyright and FSF address. 2006-05-27 15:08:43 +00:00
run.in Directory reorder #3 2007-11-15 23:06:36 +00:00
yate-config.in New option to report code status and release. 2008-02-04 13:37:20 +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
yatecbase.h Qt, Yate2 and VS 2005 related fixes. 2008-01-07 18:36:17 +00:00
yateclass.h Added handy parameter inspect operator[]. 2008-01-30 17:55:29 +00:00
yateiss.inc.in Include code status in installer. 2008-01-08 19:22:51 +00:00
yatemime.h Fixed some comments. 2008-01-18 07:56:01 +00:00
yatengine.h Custom message relays can be installed in Modules, relays can be uninstalled. 2008-01-26 20:43:05 +00:00
yatephone.h Made custom relay installer protected so it can be used for private messages. 2008-01-28 17:24:55 +00:00
yateversn.h.in Added Qt4 package and status tag. 2008-01-07 21:07:07 +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.