X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=jappixmini%2FREADME;h=0343d060b27deaf59667a486a98ee13df876ae1d;hb=7afef6b87f30c3e5fbad12de7c4980b7bab47f27;hp=2ef7c2f1ec9e29244114e4467a27bb27fe343308;hpb=60a7952688aa41c25106b2a05cad1f9ecf223e48;p=friendica-addons.git diff --git a/jappixmini/README b/jappixmini/README index 2ef7c2f1..0343d060 100644 --- a/jappixmini/README +++ b/jappixmini/README @@ -1,23 +1,31 @@ -Jappix Mini Plugin +Jappix Mini Addon ================== 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 addon, 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 and recommend it using the configuration help field. If it is on the +same server, you can also deactivate the BOSH proxy. This should improve the +performance. -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. -Installation ------------- +Limitations: + - Jabber passwords can only be encrypted if they are at most 39 characters + long. -Jappix Mini (AGPL license) is not distributed with this addon. You need to -install it manually: +Notes on the license +-------------------- -* Download latest zip file named friendica-addon-* from - https://github.com/Leberwurscht/jappix-friendica-addon/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. +The license of this addon is AGPL, as required by Jappix Mini. If you make +modifications to the addon, you are responsible for providing a proper facility +for downloading the changed source code. +Moreover, it may be necessary that you publish the source code of the Friendica +application and all other used addons if you do not use standard versions.