]> git.mxchange.org Git - friendica-addons.git/blobdiff - jappixmini/README
jappixmini: add text field for configuration help
[friendica-addons.git] / jappixmini / README
index cf9eb70b8c0d2ce07b2ffca1a14f0227a653476c..822f4391cbe4bc0e8184111ca16895a20b22a7a6 100644 (file)
@@ -4,11 +4,21 @@ Jappix Mini Plugin
 This quick-and-dirty addon allows you to add a Jabber-based, Facebook-like chat
 to Friendica. It uses Jappix Mini.
 
-It is necessary to use a BOSH proxy - so to use this plugin, you need to know the
-address of a BOSH proxy that works with your account.
+It is necessary to use a BOSH host - so to use this plugin, each users need to
+know the address of a BOSH host that works with his account. The BOSH server of
+the Jappix project (https://bind.jappix.com/) is not locked to a specific XMPP
+provider, but keep in mind that only personal usage is approved according to
+http://codingteam.net/project/jappix/doc/BoshServer.
+If you have a larger server, it is recommended that you install your own BOSH
+server, add it to the <bosh> tag in jappix/store/conf/hosts.xml, and disable
+the bosh proxy in jappix/store/conf/main.xml.
 
-The addon has an experimental autosubscribe and autosuggest functionality which tries
-to add your Friendica contacts to your roster automatically.
+The addon has an experimental autosubscribe and autosuggest functionality which
+tries to add your Friendica contacts to your roster automatically.
+
+Limitations:
+ - Jabber passwords can only be encrypted if they are at most 39 characters
+   long.
 
 Installation
 ------------
@@ -17,7 +27,7 @@ Jappix Mini (AGPL license) is not distributed with this addon. You need to
 install it manually:
 
 * Download latest zip file named friendica-addon-* from
-  https://github.com/Leberwurscht/jappix/tags and place the zip file in the addon
-  folder. Make sure to name it 'jappix.zip' - the download link required by the AGPL
-  points there.
+  https://github.com/Leberwurscht/jappix/tags and place the zip file in the
+  addon folder. Make sure to name it 'jappix.zip' - the download link required
+  by the AGPL points there.
 * Unpack the zip file, rename the folder to 'jappix'. Do not delete jappix.zip.