From 9e2907087fad3645064534d5097fa72f1d839b6c Mon Sep 17 00:00:00 2001 From: Jan Kaluza Date: Sun, 20 Dec 2015 19:46:45 +0100 Subject: [PATCH] Correct the backends section of documentation --- documentation/backends/backends.md | 7 +++---- documentation/backends/libpurple.md | 16 ++++++++-------- documentation/backends/skype.md | 4 ++++ documentation/backends/swiften.md | 4 ++++ 4 files changed, 19 insertions(+), 12 deletions(-) diff --git a/documentation/backends/backends.md b/documentation/backends/backends.md index d1549824..250d736c 100644 --- a/documentation/backends/backends.md +++ b/documentation/backends/backends.md @@ -19,10 +19,9 @@ service|backend|Full path to the backend binary 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` diff --git a/documentation/backends/libpurple.md b/documentation/backends/libpurple.md index 976cede2..1cf5010b 100644 --- a/documentation/backends/libpurple.md +++ b/documentation/backends/libpurple.md @@ -5,7 +5,7 @@ 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 @@ -18,7 +18,7 @@ There is also special configuration variable in "service" called @protocol@ whic Protocol variable| Description -----------------|------------ -prpl-jabber| Jabber/Facebook/GTalk +prpl-jabber| Jabber prpl-aim|AIM prpl-icq|ICQ prpl-msn|MSN @@ -28,12 +28,12 @@ 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 +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 -Microsoft LCS account may require username, which is SIP URI, and server login, so use , in username field like this: - - username%domain.com,login%loginserver.tld +These plugins are included by default in our Docker image. diff --git a/documentation/backends/skype.md b/documentation/backends/skype.md index aa808b43..f2b4260d 100644 --- a/documentation/backends/skype.md +++ b/documentation/backends/skype.md @@ -3,6 +3,10 @@ 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). diff --git a/documentation/backends/swiften.md b/documentation/backends/swiften.md index d2290a63..8982239e 100644 --- a/documentation/backends/swiften.md +++ b/documentation/backends/swiften.md @@ -3,6 +3,10 @@ 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.