Siproxd Users Guide
Prev		Next

Chapter 3. Configuration

3.1. The configuration file 'siproxd.conf'

Siproxd by default searches for its configuration file in the following locations:

$HOME/.siproxdrc
<buildingprefix>/etc/siproxd.conf
/etc/siproxd.conf
/usr/etc/siproxd.conf
/usr/local/etc/siproxd.conf

The following is a list of directives that do exist. Note that string values MUST NOT contain spaces or tabs. Also read the explanations included in the supplied example configuration file fro more explanation. Items with a # in front are normally disabled / not defined.

To start with siproxd in the first run, just adapt the interface definition for the inbound and outbound network interfaces (if_inbound and if_outbound).

Definition of network interfaces for the inbound network (local network where your SIP client is connected, this network normally uses IP addresses from on of the private IP ranges like 10.x.x.x, 192.168.x.x) and outbound network (your connection to the Internet, normally this interface has a public IP assigned by your provider).

if_inbound  = eth0
if_outbound = ppp0

Usually only the if_inbound and if_outbound directives will be used. The host_outbound directive comes into play when running siproxd "in front of" a NAT router. Please check the configuration examples in this document for more details. Also check the STUN plugin.

# host_outbound = <my_public_ip_address>

Access control lists for incoming SIP registrations and SIP traffic in general. These are comma separated lists of the form <IP>/<mask>, note that no spaces are allowed within the list (the configuration file parser cannot yet handle spaces).

# hosts_allow_reg = 192.168.1.0/24,192.168.2.0/24
# hosts_allow_sip = 123.45.0.0/16,123.46.0.0/16
# hosts_deny_sip  = 10.0.0.0/8,11.0.0.0/8

Port to listen for incoming SIP messages. 5060 is usually the correct choice, don't change this unless you have a reason to.

sip_listen_port = 5060

Shall siproxd run as daemon? Usually 1 is the correct choice. If you want siproxd not to daemonize and keep running in foreground and writing its output to the terminal set this to 0.

daemonize = 1

Siproxd does log using the syslog() facility when running a daemon. This setting controls how much logging is done:

0 - DEBUGs, INFOs, WARNINGs and ERRORs
1 - INFOs, WARNINGs and ERRORs
2 - WARNINGs and ERRORs
3 - only ERRORs
4 - absolutely nothing

silence_log = 0

If siproxd is started as root, it can drop the root privileges and change its user ID at startup. It also can put itself into a chroot() jail (see 4.2 for details)

user = nobody
# chrootjail = /var/lib/siproxd/

Where to store the current registrations and the cycle in seconds to perform the cyclic writing. This allows siproxd to remember registration across a restart. An empty value means we do not save registrations. The specified directory path must exist.

registration_file = /var/lib/siproxd/siproxd_registrations
autosave_registrations = 300

Where to create the PID file.

pid_file = /var/run/siproxd/siproxd.pid

Enable/disable the RTP proxy. This must always be enabled. In some future release this directive will become obsolete and will be removed.

rtp_proxy_enable = 1

Port range (UDP) that siproxd will use for incoming and outgoing RTP traffic. A firewall must be configured to allow traffic from and to these ports (UDP only). By default the range 7070 up to (and including) 7089 is used. This allows up to 10 simultaneous calls (2 ports per call). If you need more simultaneous calls, increase the range.

rtp_port_low  = 7070
rtp_port_high = 7089