diff --git a/docs/guide/configure_xmpp_server.textile b/docs/guide/configure_xmpp_server.textile new file mode 100644 index 0000000000000000000000000000000000000000..406dae960568a796c7d333ba4123301ce1e2c966 --- /dev/null +++ b/docs/guide/configure_xmpp_server.textile @@ -0,0 +1,72 @@ + +To use Spectrum 2 in gateway mode, you have to configure your XMPP server to work with your Spectrum 2 instances. +The configuration details you give to your XMPP server of course have to correspond to the details you give in the Spectrum 2 configuration file. + +h2. DNS records configuration + +For every Spectrum 2 instance you have to create a nameserver record for the transport's Jabber ID, if you want users of other servers to connect to your transport. A SRV record for "server to server" connections like in the following example is preferred: + +
+_xmpp-server._tcp.j2j.example.com. IN SRV 0 5 5269 jabber.example.com. ++ +Otherwise you could set an A level record for the JID of your instances. + +See also: "http://prosody.im/doc/dns":http://prosody.im/doc/dns + +h2. Ejabberd + +In the Ejabberd configuration file (by default in /etc/ejabberd/ejabberd.cfg), you have to add a field to the "listen" directive. + +In the section that says: ‘{listen,’ add these lines: + +
+{{5347, "127.0.0.1"}, ejabberd_service, [ + {access, all}, + {host, "icq.example.com", [{password, "secret"}]} +]} ++ +* @5347@ is port on which Ejabberd will listen for Spectrum 2 so Spectrum 2 can connect this port and start serving the hostname you've configured. Each Spectrum 2 instance has to be connected to different port. +* "@icq.example.com@" is the hostname of your Spectrum 2 transport. +* "@secret@" is the password which will be used by Spectrum 2 to authenticate itself to the Ejabberd server. +* "@{access, all}@" lets everybody use your transport. + +To use the new settings, you can either just restart Ejabberd or use Ejabberd's web-interface to add the new port to the running instance. You can find the Settings under Nodes ->
+--Component "gateway.example.com" +-- component_secret = "password" ++ +You have to edit this line to make Spectrum 2 work: + +Example: ICQ + +
+Component "icq.example.com" + component_secret = "mysecreticqpassword" ++ +For every spectrum transport you want to use, you have to add those two lines: + +Example: + +
+Component "icq.example.com" + component_secret = "mysecreticqpassword" + +Component "msn.example.com" + component_secret = "mysecretmsnpassword" + +Component "yahoo.example.com" + component_secret = "mysecretyahoopassword" ++ +Save the file and restart your Prosody server.