Configuring and Running Cipango

Running Cipango

Cipango may be started and stopped as follows:

• From the Command Line
• As a Unix daemon

Command Line

The most straightforward way to start Cipango is to go to your Cipango installation directory and type:

To stop, simply use Ctrl-C in the same terminal. You may also start Cipango so that it listens on a local port for stop commands:

The server can then be stopped using a different terminal window on the same machine:

If you omit the stop port or key, they are displayed on the standard output so that you may know their values.

Unix daemon

To start Cipango under *nix system,

1. set in ${jetty.home}/etc/jetty.conf

   (The line --pre=etc/jetty-logging.xml must be removed)

2. go to ${jetty.home} and type:

This script allows also the commands stop, run, restart, check and supervise.

shell commands

jetty.sh lookup for

• /etc/default/jetty
• $HOME/.jettyrc

If they exist, these files are read at script startup. It may perform any sequence of shell commands, like setting relevant environment variables

Environnement properties

jetty.conf

It also search for jetty.conf in

1. /etc/jetty.conf
2. ${jetty.home}/etc/jetty.conf

This file will be used as this script's configuration.
Each line in the file may contain:

• A comment denoted by the pound (#) sign as first non-blank character.
• The path to a regular file, which will be passed to Cipango as a config.xml file.
• The path to a directory. Each *.xml file in the directory will be passed to Cipango as a config.xml file.

If more than one argument is passed to the script (jetty.sh start etc/cipango.xml), jetty.conf is not read

Absolute path must be used if Cipango is not started from ${jetty.home}/bin

Configuring Cipango

Application Router

Default Application Router

The Default application Router (DAR) looks for its configuration file in the following order:

1. javax.servlet.sip.ar.dar.configuration system property specifying the path to the configuration file
2. if not set the default value ${jetty.home}/etc/dar.properties is used

If the configuration file is not found or is empty, the Default Application Router always selects the first deployed application in alphabetic order.

DAR configuration file

The DAR configuration file format is defined in SIP Servlets 1.1 specification in annex C.1.

In this example, the DAR is setup to invoke two applications on INVITE request, the first in the originating part and the second in the terminating half. The applications are identified by their names as defined in the application deployment descriptors. The subscriber identity returned in this case is the URI from the From and To header respectively for the two applications. The DAR does not return any route to the container and maintains the invocation state in the stateInfo as the index of the latest application in the list.

Routing Outgoing Requests

As defined in JSR289, the Application Router is invoked to route both incoming and outgoing requests. Since it may be useful not to use the Application Router on outgoing requests, it is possible to configure the Default Application Router to prevent it from processing outgoing requests.
To do so, you can set the System property org.cipango.dar.routeOutgoingRequests to false, for instance:

Alternatively, you can use the setRouteOutgoingRequests on the Default Application Router in the cipango.xml configuration file, as shown below:

Custom application router

To add a custom application router, drop the jar file containing your application router in the directory ${jetty.home}/lib/ext.

To make Cipango load your custom application router, you can either:

• remove the default application library: delete the file ${jetty.home}/lib/ext/cipango-dar-VERSION.jar
• or use the system property javax.servlet.sip.ar.spi.SipApplicationRouterProvider to define the custom SipApplicationRouterProvider
• or define the application router in ${jetty.home}/etc/cipango.xml, for instance

JNDI

JNDI is not enabled by default in Cipango.

To add JNDI and SIP Servlet annotation support, Cipango should be started with cipango-plus.xml configuration file:

java -jar start.jar --ini=start-cipango.ini etc/cipango-plus.xml

JNDI support is similar to Jetty's one. Documentation on how to bind objects in JNDI tree is available here

SIP Connectors

TLS

To add TLS support, Cipango should be started with cipango-tls.xml configuration file:

java -jar start.jar --ini=start-cipango.ini etc/cipango-tls.xml

To manage the keys, see Jetty SSL plugin

System properties

In addition to system properties defined by Jetty, Cipango may use the following properties:

file:///${jetty.home}/etc/dar.properties

For instance to set the SIP port to 5070, use:

java -Dsip.port=5070 -jar start.jar  --ini=start-cipango.ini

Some properties like the port can be set in /etc/default/cipango. For more information, see Running Cipango