View source for Yate as H323 GateKeeper and YateClient as H323 client

After you read this, you'll know how to:

* modify Yate's configuration files in order to use it as H.323 GateKeeper;
* use YateClient as an H.323 client;
* set up a telephony account on a SNOM 360 phone.

===Main concepts===

The first important issue in this article is H.323 series standard. It is a set of recommendations made by ITU, and its primary goal is to provide audio-visual communication sessions on any packet network. 

You can read more about it in the [http://en.wikipedia.org/wiki/H323 H.323] is the wiki-page on H.323, [http://www.ncesd.net/IVC/WhitePaperS/H323/h323primer.pdf H.323 Primer] is a very nice and short manual on the protocol and [[H323_Gatekeeper_And_Multiple_Endpoint_Server|H323 Gatekeeper And Multiple Endpoint Server]] directs you to more details on Yate.

=== Test situation – scheme and presentation===

The goal is to make a call. A call to show Yate's capabilities to connect 2 ends that only know either SIP or H.323.

One end will be the IP phone, snom 360, on which will set up the SIP account. The other is the H.323 account logged by means of YateClient.

They will both be logged at the Yate server. See the scheme below:

[[File:configuration_schema_h323.png]]

So from a SIP account, logged and set up on SNOM phone, a call will be made, using Yate as a telephony server, a H.323 account, logged at the same Yate server. And the other way around.

The following steps begin to be clear:

a) Enable Yate with H.323 support.<br>
b) Set up Yate to process calls using H.323 (that is, function as H.323 GateKeeper).<br>
c) Create, set up the H.323 account on the YateClient. Log it in.<br>
d) Create, set up the SIP account on the phone. Log it in.<br> 
e) Make the calls: SIP-to-H.323 and H.323-to-SIP.

==Install Yate==

First of all, install Yate on the computer you'll replicate this test. More information about this you can find [[Installation]]. 

This test is done on a server that has Mandriva 2010 Spring with Yate downloaded from http://yate.null.ro/tarballs/yate4/yate-4.2.0-2.tar.gz.

== Compiling H323 library ==

There are two libraries that can be used:
* OpenH323 library
 <font color="green">Note!</font> OpenH323 is the recommanded library to use with Yate because is the stable version.
Take a look to learn how to [[OpenH323| compile OpenH323]] or [[#Quick how to install OpenH323 library under linux|see the quick how to]].

* H323plus library
 <font color="red">Note!</font> Yate works with H323plus support but it is not stable.  
Here is how to compile Yate with [[Compiling Yate with H323plus support |H323plus]].

=== Quick how to install OpenH323 library under linux===

The OpenH323 library together with matching PWLib are available at: http://yate.null.ro/tarballs/openh323/

Yate needs OpenH323 and PWLib to be installed in '''/usr/local''' directory. 

====Install PwLib====

For doing a basic installation just run in the main PwLib folder:

  ./configure with --prefix=/usr/local/pwlib
  make opt
  make install

====Install OpenH323====

For doing a basic installation just run in the main OpenH323 folder:
 ./configure --disable-ixj --prefix=/usr/local/openh323
 make opt
 make install

====Install Yate with Pwlib and OpenH323====

In Yate folder do:
  
 ./configure --with-pwlib=/usr/local/pwlib --with-openh323=/usr/local/openh323
 make

==Setting Yate as H.323 GateKeeper==

===Set up Yate to process calls using H.323 (that is, function as H.323 GateKeeper).===


 {|class="wikitable" width="80%"
|<br><div style="color:red;text-align:center;"><b>IMPORTANT TIP #1!</b></div><br><font style="text-align:left;">When you install yate on your system, you'll have the necessary files for it to work properly written in several locations:<br><br>shared files directory (/usr/local/share/yate)<br>conf files directory (/usr/local/etc/yate)<br>user files directory (~/.yate)<br>modules directory (/usr/local/lib/yate)<br><br> (Type “yate -h” in your bash to see more details).<br><br> You can make your own modifications on the default files and run yate with the new configuration.<br><br> It is strongly recommended that you write them on a different location on your computer, say <br><br>/usr/local/etc/h323gk. <br><br>Copy the installed version of configuration files, then modify them as you wish. </font>
|}


Take the advice from the tip above and set your own “test location”.<br>
Make a directory called h323gk located in usr/local/etc to hold your configuration files for the server.

Copy the files from /usr/local/etc/yate to /usr/local/etc/h323gk.<br>
 '''Note:''' Make sure that you rename the configuration file(s) you modify, removing the word "sample". The software functions even if you don't, it uses other files
 (the ones in /usr/local/etc/yate). So end your new configuration file with ".conf".

So, go to where you have the configuration files to be modified. <br>
Look for the h323chan.conf (if you want to see what the default file contains, take a look at [[H323 channel module]]).<br>
Open the file (h323chan.conf) and look for the section that deals with the GateKeeper [gk] settings.

Edit the parameter server setting it with the “true” value (yes, we do want Yate to function as a GateKeeper).<br>
De-comment the line so that you make it effective. If you modify it but it's ignored in execution, this won't help our goal, so this is an important step also.<br>
De-comment the line and change 10.0.0.1 to 127.0.0.1. This (127.0.0.1) is the localhost address, and whenever it's met, the computer refers to itself. This implies that your Yate GateKeeper will function at the local address. See more on the localhost/127.0.0.1 use in the references http://www.tech-faq.com/127-0-0-1.html and http://en.wikipedia.org/wiki/Localhost.

h323chan.conf - it should now look like this:

 [gk]
 server=true
 interface1=127.0.0.1

Save and exit the file.

{|class="wikitable" width="80%"
|<br><div style="color:red;text-align:center;"><b>IMPORTANT TIP #2!</b></div><br><font>To run Yate using the configuration files that you modified, and placed in usr/local/etc/h323gk, type:<br><br> $yate -c /usr/local/etc/h323gk -v -d -l log_filename <br><br> Now you'll have yate running as a server with the new configuration files, the rest of the neccessary modules being loaded from their standard location.<br> Strongly recommended:<br> When you start Yate, please make a habit of it and use the following options:<br>
 -v 			 Verbose debugging (you can use more than once)
 -d 			 Daemonify, suppress output unless logged
 -l filename 	 	 Log to file
</font> 
|}

Using the information in the tip above (IMPORTANT TIP #2) run Yate with the configuration files from your own location. If you want to see more options of starting Yate please [[Starting Yate|click here]]. This instance of Yate is able to act as a H.323 GateKeeper.

== Testing YateClient as H.323 client==

===Create, set up the H.323 account on the YateClient. Log it in===

In order to create H.323 account, search for configuration files for regfile.conf.sample and copy to regfile.conf. <br>
Add the credentials for the user that you want to create like:

 [100]
 password=mysecret

Save and exit the file. 

To set the account on a YateClient, first of all make sure the service is assured by the telephony server. <br>
'''When you want to put in place a telephony solution, always start with the server – this ensures you have the core of your communication system.''' <br>
Start the server:
 
 $yate -c /usr/local/etc/h323gk -v -d -l log_filename 
 
Now, run YateClient. I chose to do this from the command line, with the default specifications.<br>
This means go to /user/src/yate/clients and type :

 ./run-qt4

By doing this, YateClient runs locally, from the specified directory, thus using the existing files in that location. <br>
Now is the moment when the graphical interface comes to life. Either using [http://yateclient.yate.ro/index.php/UserGuide/GettingStarted the wizzard to add new accounts], or directly from [http://yateclient.yate.ro/index.php/UserGuide/AddingTelephonyAccount#AddAccountOption Yate -> Add Account], add the "100".

[[File:100addaccYC.png]]

Right now you are logged in YateClient with the h.323 account 100.

One way to test the audio is to see if you can hear the standard tones. In order to do this, you need to make sure you also have a copy of the regexroute.conf.sample file in your chosen directory, under the name of regexroute.conf. This regulates the default routes to these tones. 
Now, from the telephony tab, dial one of the following:
* '''99991001''' - you should hear in your headphones the dial tone;
* '''99991002''' - busy tone
* '''99991003''' - ring tone.
If all works fine, then it means the 100 account is usable.

== Configuring Snom phone==

We have reached the step where another piece of hardware except the computer is involved.<br> 
I mean, of course, the 360 snom phone. <br>
But before we set up the account on the IP phone, we need to create it. <br>

===Creating the 200 account to be used on snom 360 phone===

This is made following the exact same steps as the ones creating the "100" account. So go to regfile.conf and add section:

 [200]
 password=secret200

Now back to our snom phone. I assume that you already have it plugged in both to a network element (like a hub/bridge and so on) and connected to a power source. Also that it's a part of your network, so it is bound to have an address.<br>
Let's say it has the following IP: 192.168.168.XXX <br>
The easiest way to configure the phone is through its web interface. So either in a browser or a file manager (like [http://wiki.mandriva.com/en/Dolphin Dolphin]), type the IP address and access the phone. It will usually require the root password.<br>
Modify the fields that you can see in this picture below:

[[File:snom_config.png]]

{|class="wikitable" width="90%"
!'''Displayname:'''
|In case you have more than one accounts set up on your IP phone, this is very useful as you can see which one is active and usable.
|-
!'''Account:''' 
|This needs to be the exact same account name you set in the regfile. See how to set a new account, this time for the snom phone, in [[#Create.2C_set_up_the_H.323_account_on_the_YateClient._Log_it_in|the previous section]] of this document.
|-
!'''Password:'''
|Again, this has to be the same you set up in regfile.conf
|-
!'''Registrar:'''
|Here, you need to put the IP address of the computer you are running Yate as H323 GateKeeper, say 192.168.168.yyy
|-
!'''Outbound proxy:''' 
|The same as above - if you want to make calls outside your local network, set the address of the telephony server that handles these outbound calls.
|}

Don't forget to make the account active - the first row, showing "Identity active" should be with '''on''' chosen. Pres 'Save'.<br>
Right now the phone should reboot and take the new settings.<br>
Call the test numbers and see if you can hear everything.

== Making the desired calls ==

So, considering you just started your computer, do the following:

Start the Yate server. <br>
Log the H.323 account with YateClient. <br>
Check if the phone has the test account active. <br>
Call 100 from snom. Your YateClient should be ringing. This is the SIP -> H.323 call.<br>
Call 200 from your YateClient. If you have more than one account logged in, make sure that in the telephony tab the h.323 account is selected. This is the H.323 -> SIP call. 

== Common issues ==

When you have a problem, check the log file and see if you can find the cause or an error. Then check the site or the mailing list for solutions.

The only thing I came across at this test exercise is this:

'''"Failed to open audio.Please check your sound card"''' <br>
Sometimes, when I would try to call from/to YateClient, I got this notification. 

The thing is: there was nothing wrong with my sound card. I just had an Internet page that also had sound enabled and this was keeping me from making/receiving calls.
 
The solution? closed the tab with that address. 

Issue: solved.


'''See also'''

* [[H323_Gatekeeper_And_Multiple_Endpoint_Server|H323 Gatekeeper And Multiple Endpoint Server]]
* [[How To's]]
* [[Telephony]]

[[Category:H323]] [[Category:OpenH323]] [[Category:Gatekeeper]] [[Category:Server]] [[Category:Client]]