]> git.mxchange.org Git - friendica-addons.git/blob - jappixmini/README
jappixmini: improve README
[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 host - so to use this plugin, each users need to
8 know the address of a BOSH host that works with his 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 If you have a larger server, it is recommended that you install your own BOSH
13 server and recommend it using the configuration help field. If it is on the
14 same server, you can also deactivate the BOSH proxy. This should improve the
15 performance.
16
17 The addon has an experimental autosubscribe and autosuggest functionality which
18 tries to add your Friendica contacts to your roster automatically.
19
20 Limitations:
21  - Jabber passwords can only be encrypted if they are at most 39 characters
22    long.
23
24 Installation
25 ------------
26
27 Jappix Mini (AGPL license) is not distributed with this addon. You need to
28 install it manually:
29
30 * Download latest jappix version from https://github.com/jappix/jappix/tags to
31   addon/jappixmini/jappix.zip. Really make sure you name it 'jappix.zip' - the
32   download link required by the AGPL points there.
33 * Unpack the zip file to addon/jappixmini/jappix/. Do not delete jappix.zip.
34 * Delete the file addon/jappixmini/jappix/index.php. This is important, because
35   otherwise the installer of Jappix would be publicly accessible. If you are
36   lucky, the file is deleted automatically by the addon.