]> git.mxchange.org Git - friendica-addons.git/blob - jappixmini/README
improve README of jappixmini addon
[friendica-addons.git] / jappixmini / README
1 Jappix Mini Plugin
2 ==================
3
4 This quick-and-dirty addon allows you to add a Jabber-based, Facebook-like chat
5 to Friendica. It uses Jappix Mini.
6
7 It is necessary to use a BOSH proxy - so to use this plugin, you need to know
8 the address of a BOSH proxy that works with your account. The BOSH server of
9 the Jappix project (https://bind.jappix.com/) is not locked to a specific XMPP
10 provider, but keep in mind that only personal usage is approved according to
11 http://codingteam.net/project/jappix/doc/BoshServer.
12
13 The addon has an experimental autosubscribe and autosuggest functionality which
14 tries to add your Friendica contacts to your roster automatically.
15
16 Limitations:
17  - The addon can only handle Jabber passwords that are at most 39 characters
18    long.
19
20 Installation
21 ------------
22
23 Jappix Mini (AGPL license) is not distributed with this addon. You need to
24 install it manually:
25
26 * Download latest zip file named friendica-addon-* from
27   https://github.com/Leberwurscht/jappix/tags and place the zip file in the
28   addon folder. Make sure to name it 'jappix.zip' - the download link required
29   by the AGPL points there.
30 * Unpack the zip file, rename the folder to 'jappix'. Do not delete jappix.zip.