Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 79 lines (57 sloc) 2.835 kB
1f63eee @jcbrand Updated the README
jcbrand authored
1 Introduction
2 ============
5e572be @jcbrand Move README.txt to README.rst and make symlink
jcbrand authored
3
c3f35da @jcbrand Update documentation
jcbrand authored
4 ``collective.chat.xmpp`` provides instant messaging for `Plone`_.
5
6 It provides a web-based chat client, by means of `Converse.js`_, a javascript
7 library which makes use of the open and very popular `XMPP`_ messaging protocol.
8
9 You will need an XMPP server (such as `ejabberd`_) for the message handling.
5e572be @jcbrand Move README.txt to README.rst and make symlink
jcbrand authored
10
ec4f6fc @jcbrand Update readme with features.
jcbrand authored
11 Features
87a0ed1 @jcbrand Tweak RST formatting
jcbrand authored
12 ========
ec4f6fc @jcbrand Update readme with features.
jcbrand authored
13
a6a5094 @ichim-david Corrected rst output this time for good by wrapping all links in tild…
ichim-david authored
14 * Manually or automatically subscribe to other users.
ec4f6fc @jcbrand Update readme with features.
jcbrand authored
15 * With manual roster subscriptions, you can accept or decline contact requests.
16 * Chat statuses (online, busy, away, offline)
c3f35da @jcbrand Update documentation
jcbrand authored
17 * Custom status messages
384fab0 @jcbrand Add another feature (typing notifications)
jcbrand authored
18 * Typing notifications (i.e when the contact is typing)
ec4f6fc @jcbrand Update readme with features.
jcbrand authored
19 * Third person messages (/me )
20 * Multi-user chat in chatrooms
c3f35da @jcbrand Update documentation
jcbrand authored
21 * Chatrooms can be configured (privacy, persistency etc.)
ec4f6fc @jcbrand Update readme with features.
jcbrand authored
22 * Topics can be set for chatrooms
c3f35da @jcbrand Update documentation
jcbrand authored
23 * Full name and profile picture support (via VCards)
ec4f6fc @jcbrand Update readme with features.
jcbrand authored
24
1f63eee @jcbrand Updated the README
jcbrand authored
25 Installation
87a0ed1 @jcbrand Tweak RST formatting
jcbrand authored
26 ============
2b6eb6e @alecghica Bump up submodule and some cleanup
alecghica authored
27
1f63eee @jcbrand Updated the README
jcbrand authored
28 XMPP integration with Plone is provided by the `collective.xmpp.core`_ package.
29 Please refer to its README on how to set it up.
5e572be @jcbrand Move README.txt to README.rst and make symlink
jcbrand authored
30
dbe4da7 @jcbrand Update readme
jcbrand authored
31 You can use the buildout at `collective.xmpp.buildout`_.
32
33 The buildout in this egg is used for development purposes.
5e572be @jcbrand Move README.txt to README.rst and make symlink
jcbrand authored
34
2b6eb6e @alecghica Bump up submodule and some cleanup
alecghica authored
35 You'll need to have a working XMPP server and access to the
36 administration account on the server.
1f63eee @jcbrand Updated the README
jcbrand authored
37
38 Your XMPP server will have to support the following extensions
39
40 * `XEP-0045`_ Multi-user Chat
41 * `XEP-0071`_ XHTML-IM.
42 * `XEP-0144`_ Roster Item Exchange.
43 * `XEP-0124`_ Bidirectional-streams Over Synchronous HTTP (BOSH)
44 * `XEP-0206`_ XMPP over BOSH
45
1112a1d @jcbrand Update README with some configuration details.
jcbrand authored
46 Configuration
87a0ed1 @jcbrand Tweak RST formatting
jcbrand authored
47 =============
1112a1d @jcbrand Update README with some configuration details.
jcbrand authored
48
49 You'll need to have an administrator account on the Jabber server you'll be
50 using. Refer to the `collective.xmpp.core`_ README for information on how to
51 set this up.
52
53 Once you've installed ``collective.xmpp.chat``, you should go to the Plone
54 registry in the control panel and set the ``XMPP Domain`` as well as the ``XMPP
55 Admin JID`` and ``XMPP Admin Password`` values.
56
57 Additionally you have the option ``Auto-subscribe XMPP users``, which is
58 disabled by default.
59
60 Enable this option if you don't want your users to manually maintain their
61 rosters (i.e subscribing and unsubscribing to one another) and would rather
62 have everyone subscribe to everyone else. Be careful however, this might cause
63 a lot of overhead (and therefore be quite slow) on sites with large userbases.
64
fedd58a @jcbrand Update README to warn devs about submodule
jcbrand authored
65
a6a5094 @ichim-david Corrected rst output this time for good by wrapping all links in tild…
ichim-david authored
66 .. _`XEP-0045`: http://xmpp.org/extensions/xep-0045.html
67 .. _`XEP-0071`: http://xmpp.org/extensions/xep-0071.html
68 .. _`XEP-0144`: http://xmpp.org/extensions/xep-0144.html
69 .. _`XEP-0124`: http://xmpp.org/extensions/xep-0124.html
70 .. _`XEP-0206`: http://xmpp.org/extensions/xep-0206.html
71 .. _`collective.xmpp.core`: http://github.com/collective/collective.xmpp.core
72 .. _`collective.xmpp.buildout`: http://github.com/collective/collective.xmpp.buildout
73 .. _`Plone`: http://plone.org
74 .. _`XMPP`: http://xmpp.org
75 .. _`ejabberd`: http://ejabberd.im
c3f35da @jcbrand Update documentation
jcbrand authored
76 .. _`Converse.js`: http://conversejs.org
7efa866 @jcbrand Remove submodule stuff, we don't have it anymore
jcbrand authored
77
78
Something went wrong with that request. Please try again.