BerofixDocuV3

From berofix - professional SIP gateway
Jump to: navigation, search
(Preferences)
(BF8FXS (8 ports analog FXS))
 
Line 106: Line 106:
 
=== BFxE1 (1,2 ports ISDN PRI) ===
 
=== BFxE1 (1,2 ports ISDN PRI) ===
  
The bfXE1 PRI modules are available as 1 port (bf1E1) or as 2 port (bf2E1) variants. The bfXE1 module can be configured individually for each port to NT (Network Termination) or TE (Terminal Equipment) mode. If you want to use NT-mode you may need a cross cable which is optionally available (the bnE1Cross). Line termination (120 ohms) is selectable for each port by DIP switches on the module(2 per port).
+
The bfXE1 PRI modules are available as 1 port (bf1E1) or as 2 port (bf2E1) variants. The bfXE1 module can be configured individually for each port to NT (Network Termination) or TE (Terminal Equipment) mode. If you want to use NT-mode you may need a cross cable which is optionally available (the bnE1Cross). Line termination (120 ohm) is selectable for each port by DIP switches on the module(2 per port).
 
<br>
 
<br>
  
Line 169: Line 169:
 
The BF8FXS module is used by small and medium enterprises which need internal analog FXS ports to connect analog phones, faxes and modems. Our 4 port FXS module is fully compatible and combinable with all other beroFix modules, cards and boxes.<br>
 
The BF8FXS module is used by small and medium enterprises which need internal analog FXS ports to connect analog phones, faxes and modems. Our 4 port FXS module is fully compatible and combinable with all other beroFix modules, cards and boxes.<br>
  
The pinout of the bf8FXS module is similar to that of the bf4S0 module. Depending on the module configuration the use of the bfBridge or the bfTAdapters could be neccessary.  The following Examples give you an overview about the Pinout of this module:
+
The following Examples give you an overview about the Pinout of this module:
  
''PinOut port 1,2,3 and 4 of bf8fxs module through Jack 1''
 
  
 
{| class="wikitable"
 
{| class="wikitable"
|-
 
!  colspan="2" | Port 1 !!  colspan="2" |  Port 2 !!  colspan="2" |  Port 3 !!  colspan="2" |  Port 4
 
 
  |-  
 
  |-  
  | | PIN || Usage || PIN|| Usage || PIN|| Usage || PIN|| Usage  
+
  !  colspan="8" | RJ45 1 !!  colspan="8" |  RJ45 2
 +
|-
 +
!  colspan="2" | Port 1 !!  colspan="2" |  Port 2 !!  colspan="2" |  Port 7 !!  colspan="2" |  Port 8 !!  colspan="2" |  Port 3 !!  colspan="2" |  Port 4 !!  colspan="2" |  Port 5 !!  colspan="2" |  Port 6 
 +
|-
 +
|-
 +
| | PIN || Usage || PIN|| Usage || PIN|| Usage || PIN|| Usage || PIN|| Usage || PIN|| Usage || PIN|| Usage || PIN|| Usage
 
  |-
 
  |-
  | 4 || TIP ||  3 || TIP || 2 || TIP ||  1 || TIP
+
  | 4 || RING ||  2 || RING || 3 || RING || 1 || RING || 4 || RING ||  2 || RING || 3 || RING ||  1 || RING
 
  |-
 
  |-
  | 5 || RING ||  6 || RING || 7 || RING ||  8  || RING
+
  | 5 || TIP ||  7 || TIP || 6 || TIP || 8  || TIP || 5 || TIP ||  7 || TIP || 6 || TIP ||  8  || TIP
 
  |}
 
  |}
  
Port 5-8 are similar to the above mentioned scheme only they use Jack 2.
 
  
 
''' Attention: When using this module on a beroFix PCI-/PCIe-card, the card has to be powered additionally, by using the 12V Molex Connector (See berofix product overview)'''
 
''' Attention: When using this module on a beroFix PCI-/PCIe-card, the card has to be powered additionally, by using the 12V Molex Connector (See berofix product overview)'''
Line 203: Line 204:
 
  | | PIN || Usage || PIN|| Usage
 
  | | PIN || Usage || PIN|| Usage
 
  |-
 
  |-
  | 4 || TIP ||  3 || TIP
+
  | 4 || RING ||  2 || RING
 
  |-
 
  |-
  | 5 || RING ||  6 || RING
+
  | 5 || TIP ||  7 || TIP
 
  |}
 
  |}
  
Line 746: Line 747:
 
  none (use nothing for the OAD) <br>
 
  none (use nothing for the OAD) <br>
 
  manual (use a constant string for as OAD for calls to this 'Port-Group') <br>
 
  manual (use a constant string for as OAD for calls to this 'Port-Group') <br>
 +
 +
A deeper explanation on how theses ISDN and SIP Attributes are connected can be found here: [http://wiki.beronet.com/index.php/Howto_modify_what_goes_into_From/P-Preferred-Identity/Callerid_and_so_on Caller-ID Mapping Howto]
  
 
====Additional configuration options====
 
====Additional configuration options====
Line 962: Line 965:
  
 
'''SMS Extension'''
 
'''SMS Extension'''
 +
The destination number for the SMS
  
 
'''Extension'''
 
'''Extension'''
 +
The destination number
  
 
====GSM additional options====
 
====GSM additional options====
Line 1,025: Line 1,030:
  
 
'''Match Type'''
 
'''Match Type'''
:The 'Match type' give you the possibility to choose which part of the from or To header the beroFix should use to match. The match type has the following options and meanings:
+
 
 +
The 'Match type' give you the possibility to choose which part of the from or To header the beroFix should use to match.  
 +
 
 +
''Note:'' The settings only match if you set the Match type in the relevant dialplan to <Default SIP account>.
 +
It has the following options and meanings:
 +
 
  IP Address: By choosing this option, the IP-address from where the call is originated has to match to the 'Server address' of the SIP account, which has been chosen in the 'Server address' field.
 
  IP Address: By choosing this option, the IP-address from where the call is originated has to match to the 'Server address' of the SIP account, which has been chosen in the 'Server address' field.
 
   
 
   
Line 1,031: Line 1,041:
 
   
 
   
 
  To User: additionaly to the IP-address choosen in the server address field, the beroFix will match if the user part of the To Header conforms with the 'user' field of the SIP-account.
 
  To User: additionaly to the IP-address choosen in the server address field, the beroFix will match if the user part of the To Header conforms with the 'user' field of the SIP-account.
 +
 +
Contact User: matches if the contact header conforms with the user field of the SIP-account.
 
   
 
   
 
  Manual: with this option, you can set a manual address (IP-address) which should be used instead of an existing SIP-account. Matching is the same like described in 'IP Addres' above.  
 
  Manual: with this option, you can set a manual address (IP-address) which should be used instead of an existing SIP-account. Matching is the same like described in 'IP Addres' above.  
Line 1,215: Line 1,227:
 
== Dialplan ==
 
== Dialplan ==
  
The dial plan is one of the most important things to set up during the configuration of a beroFix device. The dial plan defines rules concerning how calls should be routed under certain circumstances. The beroFix dial plan engine is based on regular expressions ('Howto RegEx'.) and reads the dial plan entries from the top to the bottom. After the first match beroFix will leave the dial plan and execute the rule. Therefore it is important to know that special dial plan rules should be placed on top while the general ones should be placed below them. This can be done by using the position arrows.  
+
The dial plan is one of the most important things to set up during the configuration of a beroFix device. The dial plan defines rules concerning how calls should be routed under certain circumstances. The beroFix dial plan engine is based on regular expressions ([http://www.zytrax.com/tech/web/regex.htm 'Howto RegEx']) and reads the dial plan entries from the top to the bottom. After the first match beroFix will leave the dial plan and execute the rule. Therefore it is important to know that special dial plan rules should be placed on top while the general ones should be placed below them. This can be done by using the position arrows.  
  
 
[[image:DialplanV3.png]]
 
[[image:DialplanV3.png]]
Line 1,402: Line 1,414:
  
 
This chapter will explain the possible settings you can make in the preferences part of the web-interface.
 
This chapter will explain the possible settings you can make in the preferences part of the web-interface.
 +
  
 
===Network settings===
 
===Network settings===
Line 1,439: Line 1,452:
  
 
'''Route gateway'''
 
'''Route gateway'''
 +
  
 
===Time settings===
 
===Time settings===
Line 1,460: Line 1,474:
 
[[image:Preferences_provisioning.PNG]]
 
[[image:Preferences_provisioning.PNG]]
  
for using the provisioning feature, you can choose either TFTP or HTTP provisioning.  
+
For using the provisioning feature, you can choose either TFTP or HTTP provisioning.  
  
 
'''TFTP / HTTP Host'''
 
'''TFTP / HTTP Host'''
Line 1,468: Line 1,482:
 
  Enter the URL of the configuration file in question of the respective TFTP / HTTP server.
 
  Enter the URL of the configuration file in question of the respective TFTP / HTTP server.
  
Use boot TFTP / HTTP
+
'''Use boot TFTP / HTTP'''
 
  If this option is activated, beroFix will try to start provisioning process during the boot phase.
 
  If this option is activated, beroFix will try to start provisioning process during the boot phase.
 
  
 
===beroFos Heartbeat===
 
===beroFos Heartbeat===
Line 1,488: Line 1,501:
 
  Activates / deactivates the heartbeat process
 
  Activates / deactivates the heartbeat process
  
== Management ==  
+
 
 +
===Logging===
 +
 
 +
[[image:Preferences_logging.PNG]]
 +
 
 +
'''Logging server'''
 +
The IP-address where the beroFix device should send it's logging information to.
 +
 
 +
'''Logging server port'''
 +
The UDP port of the logging server
 +
 
 +
'''Logging Active'''
 +
enable / disable the logging feature.
 +
 
 +
'''Log level'''
 +
Here you can set the logging level. Log level 1 is very low while log level 9 is very high.
 +
 
 +
'''System log'''
 +
 
 +
'''Syslog facility'''
 +
An information field associated with a syslog message. It is defined by the syslog protocol. It is meant to provide a very through clue from what part of a system the message originated from.
 +
LOCAL_0 to LOCAL_7 facilities are traditionally reserved for administrator and application use. The facility can be very helpful to define rules that split messages for example to different log files based on the facility level.
 +
Syslog_facility=[16-23] correlate to local0-local7.
 +
 
 +
'''CIFS enabled'''
 +
 
 +
'''CFIS share'''
 +
 
 +
'''CFIS user'''
 +
 
 +
'''CFIS password'''
 +
 
 +
'''Domain'''
 +
 
 +
'''Max. Log-Size (in MB)'''
 +
 
 +
 
 +
===Security===
 +
 
 +
[[image:Preferences_security.PNG]]
 +
 
 +
'''Old password'''
 +
If you want to change your password, you must first enter the current one here as authentication.
 +
 
 +
'''New password
 +
If you want to change your password, you can enter the new one here.
 +
 
 +
'''Confirm new password'''
 +
If you want to change your password, you need to enter it again for verification.
 +
 
 +
'''Disable API'''
 +
 
 +
'''Disable  API Sessions'''
 +
 
 +
'''Enable SSH-Access'''
 +
 
 +
'''Safe guard'''
 +
 
 +
 
 +
===ACL===
 +
 
 +
[[image: Preferences_ACL.PNG]]
 +
 
 +
 
 +
Access control list:
 +
 
 +
'''SIP'''
 +
Enter an IP-address or an IP-address range, to allow access to the beroFix SIP listening port.
 +
'''SIP-TLS'''
 +
Enter an IP-address or an IP-address range, to allow access to the beroFix SIPS listening port.
 +
'''HTTP '''
 +
Enter an IP-address or an IP-address range, to allow access to the HTTP interface.
 +
'''HTTPS'''
 +
Enter an IP-address or an IP-address range, to allow access to the HTTPS interface.
 +
'''Telnet'''
 +
Enter an IP-address or an IP-address range, to allow access to the telnet interface.
 +
'''SSH'''
 +
Enter an IP-address or an IP-address range, to allow access via SSH.
 +
'''SNMP'''
 +
Enter an IP-address or an IP-address range, to allow access via SNMP.
 +
'''SNMP-Trap'''
 +
Enter an IP-address or an IP-address range, to allow access via SNMP-Trap.
 +
'''bfdetect'''
 +
Enter an IP-address or an IP-address range, to allow responses to the bfdetect requests
 +
'''All'''
 +
'''Manual'''
 +
Note: By default the Network connected to eth0 will be added as an allowed Network i.e. all access via the lan connected to eth0 will be allowed.
 +
 
 +
[[image:Preferences_ACL1.PNG]]
 +
 
 +
Some Examples:
 +
ACL 127.0.0.1 / 32 will limit the access to the IP-address 127.0.0.1 (localhost)
 +
ACL 192.168.1.0 / 24 will limit the access to the network 192.168.1.1-192.168.1.254
 +
ACL 172.20.0.0 / 16 will limit the access to the network 172.20.0.1-172.20.254.254
 +
 
 +
 
 +
===Causes Map===
 +
 
 +
With the causes map you can modify the sended causes.
 +
 
 +
[[image:Preferences_causes_map1.PNG]]
 +
 
 +
The example in the picture converts the SIP status code [486 Busy Here] to the ISDN causes code [17 User busy].
 +
 
 +
 
 +
'''Call direction'''
 +
to choose the direction of a call has to be from this cause to be relevant.
 +
 
 +
'''To cause (ISDN)'''
 +
to choose a cause to which the original cause should be translated to.
 +
 
 +
'''From cause (SIP)'''
 +
  to choose which cause is to be converted to the different cause set above.
 +
 
 +
Please find more detailed info here: [[BeroFix_ISDN_Cause/SIP_Response_map| SIP response map]].
 +
 
 +
 
 +
===Call Progress===
 +
 
 +
[[image:Preferences_call_progress.PNG]]
 +
 
 +
 
 +
[[image:Preferences_call_progress1.PNG]]
 +
 
 +
 
 +
===Miscellaneous===
 +
 
 +
[[image:Preferences misc.PNG]]
 +
 
 +
== Management ==
 +
 
 +
In this menu point you can reach the settings, tools and information to manage the gateway.
 +
 
 +
===State===
 +
 
 +
This will give you an overview about the PSTN, SIP and PCM interconnection state. It shows the state of the PSTN-Ports.
 +
 
 +
 
 +
'''ISDN status'''
 +
 
 +
All ISDN Ports , which are in a port group, with port number, the type of connection [PTP] or [PMP] and the state for layer 1 and layer 2.
 +
If the LED are green the port is up.  You can get more information regarding the state of these ports by hovering over the L1 link and L2 link field.
 +
 
 +
[[Image:Management_state1.PNG]]
 +
 
 +
'''Analog status'''
 +
 
 +
It shows a list of all analog ports which are in an analog-port-group. On FXO and FXS ports you can also see the line voltage by hovering over the Line voltage LED.
 +
 
 +
[[Image:Management_state2.PNG]]
 +
 
 +
'''SIP Registration Status'''
 +
 
 +
 
 +
[[Image:Management_state3.PNG]]
 +
 
 
== Market ==
 
== Market ==
  
 
= Assembly Guide =
 
= Assembly Guide =

Latest revision as of 13:47, 26 May 2016

Personal tools