$Revision: 1514 $ $Date: 2007-01-16 19:01:22 +0200 (Tue, 16 Jan 2007) $

This modules is a gateway between Openser and a jabber server. It enables the exchange of instant messages between SIP clients and XMPP(jabber) clients. The gateway has two modes to run: the component-mode - the gateway requires a standalone XMPP server amd the 'xmpp' module acts as a XMPP component the server-mode - the module acts itself as a XMPP server, no requirement for another XMPP server in the system. NOTE: this is limited implementation of a XMPP server, it does not support SRV or TLS so far. This mode is in beta stage for the moment. In the component mode, you need a local XMPP server (recommended Jabberd2); the xmpp module will relay all your connections to a tcp connection to the local jabber server. The documentation and the source for a Jabber server are located at the following link: http://jabberd.jabberstudio.org/2/#download After you have a running XMPP server, what you need to do is set the following parameters in the Openser configuration file: gateway_domain, xmpp_domain (which can be the same as gateway_domain) and xmpp_host, which are explained in the Exported Parameters section; listen = your ip; alias=openser domain and alias=gateway domain; in the following section of the configuration file, change to your gateway domain: you can also change the jabber server password, which must be the same as the xmpp_password parameter. A use case, for the component-mode, would look like this: Openser is running on sip-server.openser.org; the gateway is running on sip-xmpp.openser.org; the jabber server is running on xmpp.openser.org; the component is running on xmpp-sip.openser.org. In the server mode, the xmpp module is a minimal jabber server, thus you do not need to install another jabber server, the gateway will connect to the jabber servers, where the users you want to chat with have an account. If you want to change to server-mode, you have to change the "backend" parameter, as shown in the Exported Parameters section, from component to server. A use case, for the server-mode, would look like this: Openser is running on sip-server.openser.org; the gateway is running on sip-xmpp.openser.org; the "XMPP server" is running on xmpp-sip.openser.org. In both cases, the destination address must have the same pattern: sip:usernamedelim]]>jabber_server@gateway_domain From a jabber client's point of view, the destination will look like: sip_usernamedelim]]>openser_domain@xmpp_domain

The following modules must be loaded before this module: requires 'tm' module.

The following libraries or applications must be installed before running &ser; with this module loaded: libexpat1-devel - used for parsing/building XML.

The mode you are using the module; it can be either component or server. Default value is "component". ... modparam("xmpp", "backend", "server"); ...

In the destination address we need an extra character as a domain separator, apart from @. The address of the XMPP(jabber) client looks like this: "sip:usernamedomain_separator]]>jabber_server@gateway_domain". The address of a SIP client has the following pattern : "sip_usernamedomain_separator]]>openser_domain@xmpp_domain"; Default value is "*". ... modparam("xmpp", "domain_separator", "*"); ...

The domain of the gateway, which must resolve. It must be the same with the gateway_domain from the destination address of the XMPP(jabber) client, as seen by the SIP client: "sip:usernamedelim]]>jjabber_server@gateway_domain". Default value is "sip-xmpp.openser.org". ... modparam("xmpp", "gateway_domain", "sip-xmpp.openser.org"); ...

The xmpp domain of the component or the server, depending on the mode we are in. It can be the same as the gateway_domain. Default value is "sip-xmpp.openser.org". ... modparam("xmpp", "xmpp_domain", "xmpp-sip.openser.org"); ...

The ip address or the name of the local jabber server, if the backend is set to "component"; or the address to bind to in the server mode. Default value is "xmpp.openser.org". ... modparam("xmpp", "xmpp_host", "xmpp.openser.org"); ...

In the component mode, this is the port of the jabber router we connect to. In the server mode, it is the transport address to bind to. Default value is "5347", if backend is set to "component" and "5269", if backend is set to "server". ... modparam("xmpp", "xmpp_port", "5269"); ...

The password of the local jabber server. Default value is "secret"; if changed here, it must also be changed in the c2s.xml, added by the jabber server. This is how the default configuration for the jabberd2 looks like: ............... ; secret; ; ]]> ... modparam("xmpp", "xmpp_password", "secret"); ...

Converts SIP messages to XMPP(jabber) messages, in order to be relayed to a XMPP(jabber) client. ... xmpp_send_massage(); ...

Next is presented a sample configuration file one can use to implement a standalone SIP-to-XMPP gateway. You can run an instance of OpenSER on a separate machine or on different port with the following config, and have the main SIP server configured to forward all SIP requests for XMPP world to it. .... &cfg; ....