Difference between revisions of "Documentation"

From berofix - professional SIP gateway
Jump to: navigation, search
(Linux)
(Linux)
Line 170: Line 170:
 
  net.ipv4.ip_forward = 1
 
  net.ipv4.ip_forward = 1
  
If you already have an entry net.ipv4.ip_forward with the value 0 you can change that 1. To enable the changes made in sysctl.conf you will need to run the command:
+
If you already have an entry net.ipv4.ip_forward with the value 0 you can change that to "1". To enable the changes it is necessary to run the command:
 
  sysctl -p /etc/sysctl.conf
 
  sysctl -p /etc/sysctl.conf
 
On Red Hat based systems this is also enabled when restarting the network service:
 
On Red Hat based systems this is also enabled when restarting the network service:
 
  service network restart
 
  service network restart
and on Debian/Ubuntu systems this can be also done restarting the procps service:
+
And on Debian/Ubuntu systems this can be also done restarting the procps service:
 
  /etc/init.d/procps.sh restart
 
  /etc/init.d/procps.sh restart
  
To access the berofix from your LAN you have to setup a route either by adding a static route in your router or just change the standard gateway of the device from where you want to access the berofix to the IP of the host where the berofix is plugged. If everything was successfully setup you can try to login to the berofix using your favorite Web browser by typing the following URL with default username=admin and password admin:
+
To make berofix accessable for other devices in your LAN you have to setup a route either by adding a static route in your router or just change the standard gateway of the device from where you want to reach berofix:
 +
route  add 10.0.0.2 <ip-eth0-of-berofix-host>
 +
or change standard gateway
 +
route add default gw <ip-eth0-of-berofix-host>
 +
If everything was successfully setup you can try to login to the berofix using your favorite Web browser by typing the following URL with default username=admin and password admin:
 
<br><br>
 
<br><br>
 
http://10.0.0.2/
 
http://10.0.0.2/
 +
<br>
 +
[[Image:bf-webgui-login.png]
  
 
====Windows====
 
====Windows====

Revision as of 14:13, 15 June 2009

The berofix card overview

The following picture show you the schema of the berofix-baseboards.

Bf ansicht.png
Each Lineinterface socket has access to 2 slots. Slot 1 & 2 are applied to Lineinterface 0, while slot 3 & 4 applies to Lineinterface 1. Depending on the Lineinterface you are using, different slots with different Pin Out's are used.

The bf4S0 4 Port BRI module


The bf4S0 Lineinterface is a 4 Port BRI module. The bf4S0 Lineinterface can be configured individually for each port to NT (Network Termination) or TE (Terminal Equipment) mode. In either modes the module supports Point-To-Multi-Point (PMP) or Point-To-Point (PTP). The TE/NT mode as well as the Line termination of 100 ohms are selectable via software (Jumperfree). If you use a bf4S0 connected on Lineinterface socket 0 and use a bf4S0Bridge on Lineinterface socket 1, the 4 BRI Ports are lead through Slot 1-4 according to picture 2.

Bf ansicht lf.png
If you want to use two bf4S0 modules to get a 8 Port BRI card, you have to plug the first bf4S0module on Lineinterface socket 0 and the second one on Lineinterface socket 1, then the 8 BRI are lead through Slot 1,2,3,4 on a different way as described in picture 3.

Bf ansicht lf2.png
As you can see, on each slot two ports are connected. To help you connect your ISDN Lines in this special scenario we have the optional available external dongles “, the BNTAdapters” which can be used. If you use a bf4S0 modules without the above mentioned BF4S0Bridge (picture2) the Pin-Out is similar according to picture 3.

The bfXE1 1-2 Port PRI module


The bfXE1 PRI module are available as 1 Port BF1E1 or as 2 Port BF2E1 LineInterfaces. The bfXE1 module can be configured individually for each port to NT (Network Termination) or TE (Terminal Equipment) mode. The default Pin-Out of this module is always TE mode with PINS 1,2,4,5. If you want to use NT-mode you may need a cross cable which is optional available (the bnE1Crosscable). Line termination (120/75 ohms) is selectable for each port by DIP switches on the Lineinterface. The following example will show you the Slot and Pin-Out's when you plug a BN2E1 module on Lineinterface socket 0 and a BF1E1 module on Lineinterface socket 1.

Bf ansicht lf pri.png
As you can see, the bf2E1 connected on Lineinterface socket 0, lead out through Slot 1 and 2, while the bf1E1 connected on Lineinterface socket 1 uses Slot3. The next example will show you the Slot usage as well as the Pin-Out's, when you use a bf1E1 mixed with a bf4S0 Lineinterface.

Bf ansicht lf2 pri.png
In any combination of PRI LineInterfaces with BRI LineInterfaces, please always plug the PRI LineInterfaces on Lineinterface socket 0.

The bfXGSM 1-2 Port GSM module


The BFXGSM GSM module will be available as 1 Port BF1GSM or as 2 Port BF2GSM. Digital Audio quality with noise suppression and echo canceling is granted by the use of Quadband Siemens GSM Modules (850/900/1800/1900 Mhz). These LineInterfaces will be available during Q4 2009.

Getting started


The next chapters will describe you the basic steps to bring your new berofix card into your network, and how to configure it, that you can make SIP to ISDN calls and vice versa.

Identifying berofix cards


As mentioned in chapter 1. berofix uses a Realtek PCI/PCIe Network Chip to communicate with the Host PC. Which means that the berofix looks like a network card, when you put it into a PC.
berofix uses MAC addresses beginning with 00:50:C2.
It looks like a network card and you don't have to compile or load any additional driver except of the network card driver (8139too for berofix PCI and R8169 for PCIexpress on Linux based systems). This should normally be done automatic from your Operating System. To make it more clear the network environment looks like:

LAN <-> NIC_LAN (eth0) <-> PC <-> NIC_BEROFIX (eth1) <-> BEROFIX

The following examples will show you how you can identify your berofix card in your system.

Linux

Output from lspci for berofix PCI card:

berofix#lspci
0000:03:01.0 Ethernet controller: Realtek Semiconductor Co., Ltd. RTL-8139/8139C/8139C+ (rev 10)

Output from ifconfig:

 berofix#ifconfig
 eth1    Link encap:Ethernet  HWaddr 00:50:C2:83:D0:04  
         inet addr:10.0.0.1  Bcast:10.255.255.255  Mask:255.255.255.0
         UP BROADCAST RUNNING MULTICAST  MTU:1500  Metric:1
         RX packets:12920014 errors:0 dropped:0 overruns:0 frame:0
         TX packets:11879494 errors:0 dropped:0 overruns:24 carrier:0
         collisions:0 txqueuelen:1000 
         RX bytes:2864269597 (2731.5 Mb)  TX bytes:2590970576 (2470.9 Mb)
         Interrupt:18 Base address:0x2000


Windows

If you plugged in berofix and Windows has booted, please open the device manager and go to the network adapter secion:

Bf win deviemanager.png
If you can see one or more Realtek RTL-8139-Family (or RTL-8136-Family (RTL8101E) for PCI express) NIC's your OS has installed drivers automaticly. If you don't see a Realtek 8139 NIC please refer to Realtek's driver site
To identify berofix card please open a Windows console (cmd.exe) and type:

C:\Dokumente und Einstellungen\Administrator>ipconfig -all

Windows-IP-Konfiguration 

   Hostname  . . . . . . . . . . . . : test-li3hfoglbs
   Primäres DNS-Suffix . . . . . . . :
   Knotentyp . . . . . . . . . . . . : Hybrid
   IP-Routing aktiviert  . . . . . . : Nein
   WINS-Proxy aktiviert  . . . . . . : Nein
   DNS-Suffixsuchliste . . . . . . . : beronetoffice.local

Ethernet-Adapter LAN-Verbindung 2: 

   Verbindungsspezifisches DNS-Suffix:
   Beschreibung  . . . . . . . . . . : Realtek RTL8139-Familie-PCI-Fast Ethernet-NIC #2
   Physikalische Adresse . . . . . . : 00-50-C2-83-D0-00
   DHCP aktiviert  . . . . . . . . . : Nein
   IP-Adresse. . . . . . . . . . . . : 172.20.70.10
   Subnetzmaske  . . . . . . . . . . : 255.255.255.0
   Standardgateway . . . . . . . . . :
 
Ethernet-Adapter LAN-Verbindung:

   Verbindungsspezifisches DNS-Suffix: beronetoffice.local
   Beschreibung  . . . . . . . . . . : Realtek RTL8139-Familie-PCI-Fast Ethernet-NIC
   Physikalische Adresse . . . . . . : 00-0B-6A-EE-E7-4F
   DHCP aktiviert  . . . . . . . . . : Ja
   Autokonfiguration aktiviert . . . : Ja
   IP-Adresse. . . . . . . . . . . . : 172.20.5.75
   Subnetzmaske  . . . . . . . . . . : 255.255.0.0
   Standardgateway . . . . . . . . . : 172.20.0.1
   DHCP-Server . . . . . . . . . . . : 172.20.0.1
   DNS-Server  . . . . . . . . . . . : 172.20.0.11
                                       172.20.0.1
   Primärer WINS-Server  . . . . . . : 172.20.0.11
   Lease erhalten  . . . . . . . . . : Montag, 15. Juni 2009 11:58:46
   Lease läuft ab  . . . . . . . . . : Montag, 15. Juni 2009 23:58:46

Network configuration

To bring the system up and running the only thing you have to do, is to give berofix an ip-address. That is almost all you have to do before you can work with the berofix card. For several reasons, especially for SIP re-invites, which is a must for T.38, it might make sense to advance your network settings so that berofix is reachable from the network too.
There are 2 common ways how to handle this.

  • Ethernet Bridge (the recommended way)
  • IP-Forwarding with a Static Route

These methods will be described in the next chapters more detailed. We recommend to use a the bridge setup, since this makes the easiest setup and allows the most flexibility. It is also possible to use bridges on other operating systems than Linux.

Setup Network using ip-forwarding

Linux

Before we will explain how to setup ip-forwarding we have to give our berofix card an ip-address. As described above we will use ifconfig to check our network settings.

beropbx:#ifconfig -a

  eth0   Link encap:Ethernet  HWaddr 00:0C:6E:D3:86:C6  
            UP BROADCAST RUNNING MULTICAST  MTU:1500  Metric:1
            RX packets:797562 errors:0 dropped:0 overruns:0 frame:0
            TX packets:35206 errors:20 dropped:0 overruns:0 carrier:20
            collisions:7447 txqueuelen:1000 
            RX bytes:141351732 (134.8 MiB)  TX bytes:19431622 (18.5 MiB)
            Interrupt:11 Base address:0xc000 
  
  eth1   Link encap:Ethernet  HWaddr 00:50:C2:83:D0:01
            UP BROADCAST RUNNING MULTICAST  MTU:1500  Metric:1
            RX packets:35124 errors:0 dropped:0 overruns:0 frame:0
            TX packets:276362 errors:0 dropped:0 overruns:0 carrier:0
            collisions:0 txqueuelen:1000 
            RX bytes:20636164 (19.6 MiB)  TX bytes:28931756 (27.5 MiB)
            Interrupt:11 Base address:0xa000 
  
  lo       Link encap:Local Loopback  
          inet addr:127.0.0.1  Mask:255.0.0.0
            UP LOOPBACK RUNNING  MTU:16436  Metric:1
            RX packets:9 errors:0 dropped:0 overruns:0 frame:0
          TX packets:9 errors:0 dropped:0 overruns:0 carrier:0
            collisions:0 txqueuelen:0 
            RX bytes:720 (720.0 b)  TX bytes:720 (720.0 b)
  

In this example eth0 is our NIC from our PC and eth1 is the NIC from the berofix. The internal default IP-address of berofix is 10.0.0.2. So if we give eth1 an ip-address like 10.0.0.1 we will have access to the berofix. This can be done i.e. via ifconfig like described in the following example:

berofix:#ifconfig eth1 10.0.0.1 up

To check if this is working try to ping 10.0.0.2

berofix:#ping 10.0.0.2
PING 10.0.0.2 (10.0.0.2) 56(84) bytes of data.
64 bytes from 10.0.0.2: icmp_seq=1 ttl=63 time=12.2 ms

By default any modern Linux distributions will have ip-forwarding disabled. This is normally a good idea, as most peoples will not need ip-forwarding, but we will need to enable ip-forwarding to support SIP reinvites.
Check if IP Forwarding is enabled: We have to query the sysctl kernel value net.ipv4.ip_forward to see if ip-forwarding is enabled or not. Using sysctl:

sysctl net.ipv4.ip_forward
net.ipv4.ip_forward = 0

or just checking out the value in the /proc system:

cat /proc/sys/net/ipv4/ip_forward

As we can see in both the above examples this was disabled (as show by the value 0). Enable IP-Forwarding on the fly As with any sysctl kernel parameters we can change the value of net.ipv4.ip_forward on the fly (without rebooting the system):

sysctl -w net.ipv4.ip_forward=1

or

echo 1 > /proc/sys/net/ipv4/ip_forward

the setting is changed instantly; the result will not be preserved after rebooting the system.
Permanent setting using /etc/sysctl.conf If we want to make this configuration permanent the best way to do it is using the file /etc/sysctl.conf where we can add the following Line in /etc/sysctl.conf.

net.ipv4.ip_forward = 1

If you already have an entry net.ipv4.ip_forward with the value 0 you can change that to "1". To enable the changes it is necessary to run the command:

sysctl -p /etc/sysctl.conf

On Red Hat based systems this is also enabled when restarting the network service:

service network restart

And on Debian/Ubuntu systems this can be also done restarting the procps service:

/etc/init.d/procps.sh restart

To make berofix accessable for other devices in your LAN you have to setup a route either by adding a static route in your router or just change the standard gateway of the device from where you want to reach berofix:

route  add 10.0.0.2 <ip-eth0-of-berofix-host>

or change standard gateway

route add default gw <ip-eth0-of-berofix-host>

If everything was successfully setup you can try to login to the berofix using your favorite Web browser by typing the following URL with default username=admin and password admin:

http://10.0.0.2/
[[Image:bf-webgui-login.png]

Windows

Setup Network bridge

Linux

Windows

Detecting berofix with bfdetect tool

Configuring berofix via Web-interface

Activating changes

Dialplan

Adding new Dialplan entry

Dialplan entry examples

SIP

SIP Settings Overview

SIP-Options

SIP General Settings

ISDN

ISDN-Options

GSM

Hardware

Modify Hardware Settings

Preferences

Logging

Changing Password

Update Tool

Network settings

Backup and Restore

Management

State

Debug

Info

Reset

Reboot

Loggout

The Telnet Interface

Examples with Asterisk

Support