$Revision$
$Date$

# Administator's Guide

A more complete guide about SIMPLE2Jabber gateway can be found at SER Homepage. The part below will be removed soon, only the manual from web will be updated.

The Jabber server setup is not a subject of this guide. Check http://www.jabber.org for that.

Useful scripts, for creating Jabber Gateway database, or for managing the Jabber accounts form web are located in 'doc' subdirectory of the module.

Main steps of using the Jabber gateway:

- Create the MySQL database.

- Setup the local Jabber server.

- Set the module parameter values in cfg file of SER, load the dependent modules, set up the routing rules for Jabber gateway.

- Run SER.

The administrator of SER/Jabber gateway must inform the users what are the aliases for Jabber/Other IM networks. Other IM systems could be AIM, ICQ, MSN, Yahoo, and so on.

These aliases depend on the server hostname where runs SER and how local Jabber server is setup.

Next is presented a use case. Prologue:

- SER is running on "server.org".

- Local Jabber server is running on "jabsrv.server.org".

- Jabber network alias (first part of "jdomain") is "jabber.server.org"

The aliases for other IM networks must be the same as JID set in Jabber configuration file for each IM transport.

The JIDs of Jabber transports must start with the name of the network. For AIM, JID must start with "aim.", for ICQ with "icq" (that because I use icqv7-t), for MSN with "msn." and for Yahoo with "yahoo.". The gateway needs these to find out what transport is working and which not. For our use case these could be like "aim.server.org", "icq.server.org", "msn.server.org", "yahoo.server.org".

It is indicated to have these aliases in DNS, thus the client application can resolve the DNS name. Otherwise there must be set the outbound proxy to SER server.

*** Routing rules for Jabber gateway First step is to configure SER to recognize messages for Jabber gateway. Look at "doc/xjab.cfg" to see a sample. The idea is to look in messages for destination address and if it contains Jabber alias or other IM alias, that means the message is for Jabber gateway.

Next step is to find out what means that message for Jabber gateway. It could be a special message what triggers the gateway to take an action or is a simple message which should be delivered to Jabber network (using the method "jab_send_message").

The special messages are for:

- Registering to Jabber server (go online in Jabber network)--here must be called "jab_go_online" method.

- Leaving the Jabber network (go offline in Jabber network)--here must be called jab_go_offline method.

- Joining a Jabber conference room--here must be called "jab_join_jconf".

- Leaving a Jabber conference room--here must be called "jab_exit_jconf".

The destination address must follow the following patterns:

- For Jabber network: "username<delim>jabber_server@jabber_alias".

- For Jabber conference: "nickname<delim>room<delim>conference_server@jabber_alias".

- For AIM network: "aim_username@aim_alias".

- For ICQ network: "icq_number@icq_alias".

- For MSN network: "msn_username<delim>msn_server@msn_alias". msn_server can be "msn.com" or "hotmail.com".

- For YAHOO network: "yahoo_username@yahoo_alias".

"jabber_alias" is the first part of "jdomain".