libtransport.git Changeset - 9e2907087fad

Changeset - 9e2907087fad

Parent rev.

Child rev.

[Not reviewed]

0 4 0

Jan Kaluza - 10 years ago 2015-12-20 19:46:45
jkaluza@redhat.com

Correct the backends section of documentation

4 files changed with 19 insertions and 12 deletions:

documentation/backends/backends.md

documentation/backends/libpurple.md

documentation/backends/skype.md

documentation/backends/swiften.md

0 comments (0 inline, 0 general)

documentation/backends/backends.md

➞

Show inline comments

 ---
 layout: page
 title: Spectrum 2
 ---
 Spectrum 2 introduces backends. Backends are external application which provides a way how to connect to legacy networks, so it's possible to use even different libraries than Libpurple to connect the legacy network. However, Libpurple is still the best library to use so far.
 This page contains the list of currently supported backends with the basic information about them.
 ### How to change backend
 Backends are switched in Spectrum 2 config file using the following option:
 Section| Option| Value
 -------|-------|------
 service|backend|Full path to the backend binary
 ### List of backends
 Name| Supported networks| Default path to backend
 ----|-------------------|-------------------------
 Libpurple backend|AIM, Jabber, Facebook, GTalk, ICQ, MSN, Yahoo|`/usr/bin/spectrum2_libpurple_backend`
 Swiften backend|Jabber, Facebook, GTalk|`/usr/bin/spectrum2_swiften_backend`
 SLibCommuni backend|IRC|`/usr/bin/spectrum2_libcommuni_backend`
 Libpurple backend|AIM, Jabber, ICQ, MSN, Yahoo, Skype, Telegram, Facebook|`/usr/bin/spectrum2_libpurple_backend`
 LibCommuni backend|IRC|`/usr/bin/spectrum2_libcommuni_backend`
 Frotz backend|Allows playing interactive-fiction games|`/usr/bin/spectrum2_frotz_backend`
 Skype backend|Skype using the official client|`/usr/bin/spectrum2_skype_backend`
 SMSTools3 backend|SMS using connected mobile phone|`/usr/bin/spectrum2_smstools3_backend`
 Twitter backend|Twitter|`/usr/bin/spectrum2_twitter_backend`
 Transwhat backend|Whatsapp|`/opt/transwhat/transwhat.py`

documentation/backends/libpurple.md

➞

Show inline comments

 ---
 layout: page
 title: Spectrum 2
 ---
 ### Description
 Libpurple backend is backend based on Librpurple library supporting all the networks supported by libpurple
+Libpurple backend is backend based on Librpurple library supporting all the networks supported by libpurple.
 ### Configuration
 You have to choose this backend in Spectrum 2 configuration file to use it:
 	[service]
 	backend=/usr/bin/spectrum2_libpurple_backend
 There is also special configuration variable in "service" called @protocol@ which decides which Libpurple's protocol will be used:
 Protocol variable| Description
 -----------------|------------
-prpl-jabber| Jabber/Facebook/GTalk
 prpl-jabber| Jabber
 prpl-aim|AIM
 prpl-icq|ICQ
 prpl-msn|MSN
 prpl-yahoo|Yahoo
 prpl-gg|Gadu Gadu
 prpl-novell|Groupwise
 ### Third-party plugins
-Spectrum 2 should work with any third-party libpurple plugin which is properly installed. For example, popular pidgin-sipe plugin:
+Spectrum 2 should work with any third-party libpurple plugin which is properly installed. For example, popular plugins:
 Protocol variable| Description
+Protocol variable| website | Description
 -----------------|------------
 prpl-sipe| Microsoft OCS/LCS Messaging
 Microsoft LCS account may require username, which is SIP URI, and server login, so use , in username field like this:
 prpl-facebook| [https://github.com/jgeboski/purple-facebook](website) | Facebook
 prpl-telegram| [https://github.com/majn/telegram-purple](website) | Telegram
 prpl-skypeweb| [https://github.com/EionRobb/skype4pidgin/tree/master/skypeweb](website) | Skype
-	username%domain.com,login%loginserver.tld
+These plugins are included by default in our Docker image.

documentation/backends/skype.md

➞

Show inline comments

 ---
 layout: page
 title: Spectrum 2
 ---
 ## Deprecation
 This backend is deprecated. You should use [libpurple](libpurple.html) backend with `prpl-skypeweb` instead.
 ### Description
 Skype is supported by Spectrum 2, but in quite specific way. It's not possible to connect the Skype network without official Skype client running. Therefore you have to have official Skype client installed. Official Skype client is then run for every connected user and Spectrum 2 communicate with it using the DBus interface. One Skype client instance needs approximately 50MB of RAM, therefore Skype transport needs lot of memory (50MB per user).
 ### Configuration
 You have to have:
 * Official Skype client installed in Linux PATH
 * DBus installed and have running DBus daemon
 * xvfb-run tool installed
 If you have those depencencies ready, you just have to set the proper backend configuration variable:
 	[service]
 	backend=/usr/bin/xvfb-run -a -s "-screen 0 10x10x8" -f /tmp/x-skype-gw /usr/bin/spectrum2_skype_backend

documentation/backends/swiften.md

➞

Show inline comments

 ---
 layout: page
 title: Spectrum 2
 ---
 ## Deprecation
 This backend is deprecated. You should use [libpurple](libpurple.html) backend with `prpl-jabber` instead.
 ### Description
 Swiften backend is backend based on Swiften XMPP library. This backend can be used to connect XMPP based networks like Jabber, Facebook or GTalk. In comparison with Libpurple backend, it doesn't need so much memory and CPU time and therefore scales better for XMPP networks.
 ### Configuration
 You have to choose this backend in Spectrum 2 configuration file to use it:
 	[service]
 	backend=/usr/bin/spectrum2_swiften_backend

0 comments (0 inline, 0 general)