-
<!--'''Welcome to the new Yate Wiki Project. This site is currently in development. Please fell free to help us to improve this Wiki!
|+ align="bottom" style="color:#e76700;" |[[File:yate.png|frameless|Yate]] ''Yate Documentation''
8 KB (1,086 words) - 09:08, 31 July 2018
-
Yate is available for multiple platforms.
...o to [[Download| download page]] to see on which platforms you can install Yate.
940 B (131 words) - 09:31, 4 November 2013
-
Yate is available for multiple platforms.
...re some official packages released on [http://yate.null.ro/tarballs/yate6/ Yate Download] for Windows and Mageia Linux.
4 KB (547 words) - 14:06, 17 March 2023
-
...33''' Send DTMFs as RFC2833 RTP signals. This method will be used if media is started and remote party advertised telephone event support in SDP.
...d, the tone generator module is loaded and there is a translator from PCM (yate 'slin' format) to current rtp format.
3 KB (493 words) - 08:59, 4 November 2013
-
A conference room is an N-way audio mixer to which an arbitrary number of conference legs are at
...fic room name, if the ''NAME'' is empty a new, unique conference room name is generated
6 KB (936 words) - 10:35, 4 November 2013
-
The '''VoIP Server''' is the piece of software that the client connects to it to make or to receive
... functionalities in general and an overview of the Yate Server components. Yate Server can control all the types of communication that could take part in a
5 KB (862 words) - 13:42, 21 March 2013
-
One of the most common features requested for Yate is proxying between the H.323 and SIP protocols. This allows equipment that on
[[File:yate_h323toSIP.png]]
6 KB (974 words) - 15:24, 31 October 2013
-
Yate can be used as a VoIP Client.
First of all you mustn’t think on the YateClient as being a totally different component beside the server.
3 KB (473 words) - 08:02, 3 April 2013
-
...tended. Voice, video, data and instant messenging can all be unified under Yate's flexible routing engine, maximizing communications efficiency and minimiz
==Yate usability==
3 KB (376 words) - 12:42, 4 November 2013
-
Yate has the functionality of a VoIP - PSTN gateway. It's main task is to provide signaling interworking and to transform the information it recei
Yate can be configured as a gateway from SIP to ISDN or from SIP to SS7(ISUP) by
10 KB (1,440 words) - 16:11, 31 October 2013
-
... the conclusion that H323 is pretty much the same thing as SIP. Often H323 is associated only with the call signaling part of a VoIP transmission. Actual
...n entire suite of protocols. The exact definition of H323 states that H323 is a recommendation published by the International Telecommunications Union (I
4 KB (562 words) - 15:04, 19 November 2012
-
...gistering and redirect just to mention a few. The implementation of SIP it is done using a VoIP SIP driver based on [[YASS]] library.
== Yate - SIP router ==
4 KB (564 words) - 14:00, 13 May 2013
-
...ocol for communication among others. Besides the SIP router functionality, Yate also can be used like a '''SIP border controller'''.
== What's SIP Border Controller? ==
2 KB (385 words) - 07:27, 27 May 2013
-
The Session Initiation Protocol provides the REGISTER functionality that is used mainly in a proxy configuration case. <br>
This is used to locate individual users in case of a call, which is similar to an INVITE message sent to the server.
3 KB (452 words) - 12:06, 11 April 2013
-
[[File:Yate_jingle_server_with jabber_account.png]]
Since jabberclient is a client module, it's not loaded when Yate is running in server mode. You must explicitly load it.
3 KB (432 words) - 15:20, 31 October 2013
-
'''Note:''' The options=allowplainauth parameter is required, otherwise login will fail.
... to set the gmail account in accfile so Yate will register to it. Then set Yate Server with Jingle in client mode.
2 KB (343 words) - 09:20, 4 November 2013
-
Yate has multiple routing modules. A routing module is a module that handles (sees) the [[call.route]] message.
...nation of modules. If more than one module is used, then the priority that is set in each configuration file determines the order of the modules processi
3 KB (433 words) - 09:01, 10 March 2016
-
When a cluster of multiple servers is used it is important to be able to tell the members of the cluster apart. For this pur
...ration file (usually '''yate.conf'''). A further highest priority override is provided by the '''-N''' command line parameter so the node name can be cha
1 KB (206 words) - 10:51, 15 October 2012
-
The OpenH323 library together with matching PWLib are available at: http://yate.null.ro/tarballs/openh323/
...H323 and PWLib to be installed in '''/usr''' directory. Recent versions of Yate will detect them from '''/usr/local''' as well but if you have multiple ver
3 KB (425 words) - 13:36, 13 December 2013
-
...es the routes using a configuration file in which each number or parameter is matched using regular expressions.
...d in a message parameter named '''context'''. Note that the preroute stage is skipped if the message already has a '''context''' parameter.
20 KB (3,110 words) - 10:27, 4 November 2013
-
...lt negotiation does not take into account possible transcodings since this is route dependent.<br>
Transcoding can work only if RTP passes through Yate. When ''rtp_forward'' is enabled transcoding won't work and you must '''not''' add formats to the li
2 KB (301 words) - 11:06, 3 April 2013
-
This module allows controlling Yate using a simple telnet client.
By controlling Yate means that from a remote console you can:
7 KB (1,041 words) - 13:24, 4 June 2014
-
This is a short list of commands that can be issued from the [[rmanager]] command l
...ds are available even when authentication is configured and the connection is not yet authenticated.
2 KB (335 words) - 13:12, 13 May 2013
-
Yate provides Debugging info on console.
The modalities to enable debug in Yate are:
6 KB (819 words) - 14:08, 16 August 2023
-
* is used for authentication, registration, and routing users stored in a databa
[yateadmin]
14 KB (2,155 words) - 10:47, 11 January 2014
-
Below you can find the database schema for PostgreSQL and MySQL for using yate's [[register]] module.
One of our users suggested a more complex approach. Below is the CDR table with an equivalent MySQL-Function to be called on cdr_insert,
7 KB (1,027 words) - 13:28, 6 August 2020
-
This is done from enumroute.conf file.
; priority: int: Priority in Yate's handlers chain
3 KB (500 words) - 10:28, 4 November 2013
-
This module is used to route a call to multiple alternative targets. The first target that
A call fork is implemented by connecting the incoming call to a ''fork master''.
12 KB (1,844 words) - 11:24, 5 June 2014
-
Regfile is a registration module. It can be used for autentication, registration, and
... another server. The user can use any protocol that allows registration in Yate like SIP, H323, IAX or Jabber.<br>
4 KB (539 words) - 13:59, 31 October 2013
-
...a user registers (on any protocol) the name of the server it registered to is added in front of the user's location.
...walls and NAT and with calls accepted only from the registrar the endpoint is connected to.
3 KB (521 words) - 13:52, 31 October 2013
-
...g inwards Yate and a routing decision needs to be made. The returned value is the logical destination of the call.
...rbitrary value. It must match one of the values defined and implemented in Yate.
2 KB (383 words) - 16:07, 18 November 2013
-
In order to route outside, a gateway is required. To set the gateway you must configure it in [[Accfile|accfile.con
This is the example.js script. <br>
3 KB (425 words) - 10:03, 22 March 2015
-
...es and signalling modules. Here you can find some how to's for configuring Yate using different modules.
{|class="yate-table"
9 KB (1,376 words) - 10:01, 27 October 2017
-
...oe'' is found in regfile.conf, and the originally called number ''123456'' is routed to the user ''johndoe''.
1 KB (151 words) - 13:58, 31 October 2013
-
The main Yate startup configuration is stored in the file yate.conf.
...has to be named "yate-service.conf" if you are running it as a service or "yate-console.conf" while running the console version.
3 KB (440 words) - 13:59, 31 October 2013
-
...slated back into protocol specific codes hopefully an adequate translation is choosen.
...o equivalent in other protocols. For telephony the most important encoding is [http://www.itu.int/rec/T-REC-Q.850/e Q.850] defining cause and location co
3 KB (380 words) - 09:25, 4 November 2013
-
Yate supports RTP forwarding and SDP forwarding (currently only in SIP).<br/>
...rding allows sending any media type or codec, even those not understood by Yate.<br/>
3 KB (449 words) - 09:20, 13 August 2013
-
The Accfile module is used to register Yate to outside gateways to terminate calls. The accounts that are defined in ac
...information will be configured in a file: accfile.conf. A basic connection is defined by: protocol, username, password and the server ip.
8 KB (1,225 words) - 10:07, 6 July 2018
-
The ability of handling a large number of calls is not only a matter of Yate configuration but also of system setup. Hardware devices and VoIP protocols
* CPU number (or cores) - The more you have the best Yate will behave. Hyperthreading also helps but less.
4 KB (758 words) - 16:06, 31 October 2013
-
...a bigger flexibility than with plain functions, mainly because messages in Yate can have an arbitrary number of parameters, and can be sent to more than on
Yate's four main components are:
811 B (119 words) - 13:48, 13 February 2013
-
...orts the Jingle protocol. The configuration file for Jingle channel module is yjinglechan.conf.
...he module detects Yate's run mode and behaves accordingly (as a Server, if is not set, otherwise reads run mode from configuration file).
9 KB (1,391 words) - 09:14, 4 November 2013
-
The implementation of SIP it is done using a VoIP SIP driver based on [[YASS]] library.
Yate can be used as a:
8 KB (1,261 words) - 08:43, 4 November 2013
-
The Session Initiation Protocol(SIP) is an signaling protocol widely used for controlling communication sessions su
{|class="yate-table"
8 KB (1,083 words) - 11:49, 27 October 2017
-
SIP routing in Yate can be done from a single routing module or from a combination of modules.
Another way to route the calls is by using a SIP line(gateway) configured in accfile.conf.
3 KB (422 words) - 08:08, 23 November 2017
-
The configuration file for this module is h323chan.conf.
==Compiling Yate with OpenH323 library==
13 KB (1,916 words) - 09:08, 4 November 2013
-
The '''chan.startup''' message is sent by channel modules when a new channel is instantiated.
...erefore make assumptions about the channel's state at the time the message is received.
1 KB (173 words) - 10:23, 21 January 2013
-
:::the module and module-specific address that is expected (by means of the routing decision) to service the call
''At least for Yate-0.9-CVS'', driver has been renamed to module.
2 KB (314 words) - 13:18, 22 January 2013
-
First, there is nothing to configure with the dumbchan module.
It is only useful for programmers developing applications with YATE. If the description below doesn't make sense to you, you don't need it so d
2 KB (400 words) - 10:10, 4 November 2013
-
Yate has a [[wavefile]] module which is capable of playing audio in a number of formats.
'''The output format should always be mono, 8 kHz as that is required for telephony.'''
2 KB (292 words) - 09:06, 8 October 2012
-
...e implementation of SIP protocol. It only depends on libyate and therefore is very small and flexible.
It can be found in Yate directory libs/ysip.
263 B (48 words) - 11:05, 13 December 2012
-
This documentation has been extracted from the source of ''Yate-0.9-CVS'' and as such it might not be accurate -- technically or semantical
This message is sent by a telephony channel (like ysipchan, h323chan, yiaxchan) when it got
960 B (147 words) - 10:35, 21 January 2013
-
This documentation has been extracted from the source of ''Yate-0.9-CVS'' and as such it might not be accurate -- technically or semantical
The first call in a queue is dropped by sending the queue_name as id. If you want to drop a specific cal
916 B (142 words) - 10:38, 21 January 2013
-
'''engine.halt''' is a message sent by the engine to the modules that have a message handler reg
... them that Yate is stopping and this is the last chance to clean up before Yate kills all module threads.
609 B (91 words) - 11:26, 18 January 2013
-
...t the status of the modules. In fact "status" command from rmanager module is sending this message and each module has to fill one line in the returned v
status (this is the rmanager command)
1 KB (158 words) - 15:58, 18 January 2013
-
...ikipedia.org/wiki/Media_Gateway_Control_Protocol_%28MGCP%29 MGCP] allowing Yate to control analog or digital Media Gateways.
...appear as voice circuits so you need to reference them in the [http://docs.yate.ro/wiki/Analog analog] or [[Ysigchan|signaling module]].
8 KB (1,151 words) - 12:20, 26 October 2017
-
Yate can be monitored with [http://munin-monitoring.org/ Munin].
# This program is free software; you can redistribute it and/or
3 KB (332 words) - 16:02, 31 October 2013
-
... in most cases where Yate is not forwarding (not proxying) RTP traffic and is only doing the signalling work.
# Insure VMware Tools is installed and running
3 KB (545 words) - 16:03, 31 October 2013
-
The analog signaling types supported by Yate are FXO(Foreign Exchange Office) and FXS(Foreign Exchange Station).
This module is used to monitor analog lines(recorders).
17 KB (2,660 words) - 08:04, 21 June 2018
-
...g a standard factory for the common lower layer of SIGTRAN protocols. Here is where the IP addresses, ports and protocols are configured.
Each connection defined by this module is referenced from [[Ysigchan|ysigchan]] or some other module.
4 KB (573 words) - 14:09, 26 October 2017
-
'''Note:''' In Yate's terminology, FXS/FXO indicates the local (Yate) end of the line, not the remote one.
... API calls), not at startup. The configuration file is read when a request is processed.<br>
11 KB (1,770 words) - 10:23, 4 November 2013
-
The wanpipe devices must be started before starting Yate (use the wanrouter script to start all or specific wanpipe device(s)).
... API calls), not at startup. The configuration file is read when a request is processed.<br>
9 KB (1,147 words) - 10:13, 4 November 2013
-
The configuration file is yrtpchan.conf. Below you can see the sections and their description.
: This parameter is applied on reload.
6 KB (870 words) - 14:12, 10 January 2014
-
* modify Yate's configuration files in order to use it as H.323 GateKeeper;
* use YateClient as an H.323 client;
12 KB (2,088 words) - 15:15, 31 October 2013
-
Configuring Yate to act as a SIP Server and YateClient to act as a SIP Client.
* modify Yate's configuration files in order to use it as SIP server;
2 KB (381 words) - 15:16, 31 October 2013
-
Yate can be used as IAX Server and YateClient as IAX Client. This configuration will be done on platforms that have
The purpose of this document is:
12 KB (1,986 words) - 15:13, 31 October 2013
-
...cribe how to use command line with all his available options when starting Yate server on different platforms.
==Instructions to start Yate on linux==
4 KB (588 words) - 09:43, 8 December 2021
-
<font color="red">Note!</font> Yate works with H323plus support but it is not stable.
...s recommended [[OpenH323]] library which is the stable version to use with Yate.
962 B (148 words) - 09:10, 4 November 2013
-
...mmand line with all his available options when starting Yate as server and Yate Client.
To start Yate from a command line you must open a console window.
5 KB (770 words) - 08:44, 7 August 2013
-
...end DTMFs as RFC2833 RTP signals. This method will be used if external RTP is started and remote party advertised RFC2833 support.
...d, the tone generator module is loaded and there is a translator from PCM (yate 'slin' format) to current rtp format.
2 KB (298 words) - 09:11, 4 November 2013
-
Starting with Yate 4.2 or SVN revision 5234, Yate provides a protection mechanism against several types of SIP flood attacks.
The aim of this document is to provide information about this protection and how can it be used.
4 KB (598 words) - 15:43, 31 October 2013
-
This module is used when:
* a user is subscribed to receive notification if another user is called or has messages.
3 KB (456 words) - 09:16, 9 April 2015
-
'''resource.notify''' is a message sent by a module to notify a resource event state change or a sub
:Optional subscription termination reason if subscriptionstate is terminated
2 KB (219 words) - 15:22, 21 January 2013
-
...iate source packages for OpenH323 and PwLib from our web server at: http://yate.null.ro/tarballs/openh323/<br>
Now, let’s see what steps are to be followed after unzipping the packages.
4 KB (721 words) - 13:01, 8 January 2013
-
This page documents how to configure Yate to handle a SIP attended call transfer for an unknown call leg in the clust
'''REMEMBER: It is mandatory to choose node names that can be easily resolved to an IP address
3 KB (472 words) - 09:00, 4 November 2013
-
A listener is a way of telling Yate on which network interfaces to listen.<br>
Yate supports 3 types of listeners: TCP, TLS, UDP and allows you to bind Yate one one ore more network interfaces on different ports.<br>
3 KB (556 words) - 07:52, 31 May 2013
-
...tocol. The module is called yiaxchan and the associated configuration file is yiaxchan.conf.
This module is a VoIP IAX2 driver based on ours [[Yiax]] library.
16 KB (2,483 words) - 09:12, 4 November 2013
-
...e implementation of IAX protocol. It only depends on libyate and therefore is very small and flexible.
It can be found in Yate directory/contrib/yiax
232 B (38 words) - 14:38, 16 November 2012
-
This notes describe how the yate IAX library (YIAX) is implemented. Below are the components of the library and some basic scenari
: Holds a single text Information Element that is attached to a message.
3 KB (399 words) - 11:45, 4 November 2013
-
By default Yate loads modules relevant to its current running mode:
** if yjinglechan is loaded also all modules from the jabber subdirectory
12 KB (1,662 words) - 13:25, 1 October 2019
-
The alsachan module can be used either to test your Yate or to use Yate as a VoIP client with [http://www.alsa-project.org/ ALSA] drivers.
...meter you use to call it from the routing module. The default settings are what you are going to use in most cases.
885 B (146 words) - 09:56, 4 November 2013
-
This module can be used either to test your Yate setup or to use Yate as a VoIP client.
The osschan is intialized depending on what parameter you use to call it from the routing module.
489 B (90 words) - 09:56, 4 November 2013
-
...wpchan or zapchan. Faxing over VoIP using the G.711 A-law or mu-law codecs is possible but unreliable. You can provide tiff files or you can receive faxe
...wnloads/spandsp/spandsp-0.0.6pre3.tgz 0.0.6 pre 3], also available [http://yate.null.ro/tarballs/spandsp-0.0.6pre3.tgz here]. Other versions may not be det
6 KB (1,040 words) - 10:09, 4 November 2013
-
The module is used to play or record wave sounds. The wave sounds are kept in binary data
Or new syntax since Yate 3.3.3
3 KB (409 words) - 10:10, 4 November 2013
-
The module pgsqldb(or mysqdb) can be used to make the connection between Yate and one or more PostgreSQL(or MySQL) databases.
; This parameter is used as groups list separator in messages dispatched by the module
7 KB (1,026 words) - 09:22, 4 November 2013
-
This page describes the steps to follow to build a Jabber server using Yate.
== Install Yate==
21 KB (3,052 words) - 09:24, 4 November 2013
-
The module pgsqldb is used to make the connection between Yate and one or more PostgreSQL databases.
Then in Yate sources run:
5 KB (763 words) - 07:19, 10 June 2014
-
Module mysqldb is used to make the connection between Yate and one or more MySQL databases.
...tep, normally the libraries needed for MySQL will be corrected detected by Yate, if the MySQL packages were installed.<br>
5 KB (810 words) - 11:18, 4 November 2013
-
...tunity of inspecting events generated by the caller and giving commands to Yate - all these by handling or generating Messages.
...ule.yate exist (is compiled and/or installed) and is not disabled from the yate.conf file. Also in extmodule.conf make sure you specify a proper scripts_di
2 KB (408 words) - 15:09, 31 October 2013
-
This is a special module that allows intercepting and mangling ISUP messages that p
...age is dispatched allowing its parameters to be changed before the message is forwarded.
2 KB (359 words) - 13:06, 26 October 2017
-
...resses are not known in advance - like the phones or clients registered to Yate.
...bers are known - not their currently registered location. Other common use is the handling of some [[ENUM Routing|ENUM]] routes pointing back to PSTN.
2 KB (356 words) - 07:22, 23 May 2014
-
YRadius Module adds support for RADIUS in Yate to bill calls using well known RADIUS billing mechanism.
YRadius supports both Authentication (may be Authorization is the best term there) and Accounting. It doesn't support Authentification (R
7 KB (947 words) - 10:30, 4 November 2013
-
...oute is used to make a late route decision in Yate's message flow and fork is used to route the call to multiple targets.
An alternative to forking using lateroute was introduced from Yate 3.3.3, fork with distributive parameters. But in some cases, when routing t
3 KB (419 words) - 14:03, 31 October 2013
-
Cdrbuild module is the module that builds live CDRs (call detail records) and creates a list f
Then it sends the "[[call.cdr]]" message. This message is caught by different [[Modules#CDR modules|cdr modules]] that intend to writ
10 KB (1,558 words) - 13:22, 13 January 2014
-
... to write the CDRs(call detail record) into a file. The configuration file is cdrfile.conf.
Cdrfile is a module that receives a [[call.cdr]] message (maybe from [[CDR Build Modul
6 KB (754 words) - 13:14, 11 January 2014
-
...om the SIP answer (which is supposed to be a 3xx Redirect) the information is extracted according to the query type.
* ''callername'' - if set (even empty) a query is not performed unless overridden
5 KB (700 words) - 10:31, 4 November 2013
-
... automatically create a parking orbit and transfer the call) picking it up is a bit more complicated and requires scripting.
...?repname=yate&path=/trunk/share/scripts/pickup.php pickup.php] included in yate's svn.
913 B (136 words) - 11:07, 4 November 2013
-
...From telnet you can start/stop/restart an external module without stopping Yate (operations needed when you want to update the changes in your script).<br>
Connect to Yate through telnet:
2 KB (255 words) - 15:59, 31 October 2013
-
External Module allows you to use channel or global scripts in Yate.<br>
These modules can be started from Yate and communicate through pipes to the extmodule.<br>
3 KB (459 words) - 11:15, 4 November 2013
-
...' is for you to probe all the messages being generated and, or received by Yate.
The loading of msgsniff.yate is controlled by yate.conf like any other module.
17 KB (1,082 words) - 13:07, 18 August 2022
-
...ed for load testing. It can generate large number of calls originated from Yate on an arbitrary protocol or to some number.
...rolled from the rmanager as it processes "engine.command" messages or from Yate's command line.
3 KB (388 words) - 11:12, 4 November 2013
