2013-04-26 21:01:39 +02:00
|
|
|
.. Converse.js documentation master file, created by
|
|
|
|
sphinx-quickstart on Fri Apr 26 20:48:03 2013.
|
|
|
|
You can adapt this file completely to your liking, but it should at least
|
|
|
|
contain the root `toctree` directive.
|
|
|
|
|
2015-05-02 01:21:25 +02:00
|
|
|
.. raw:: html
|
|
|
|
|
|
|
|
<div id="banner"><a href="https://github.com/jcbrand/converse.js/blob/master/docs/source/index.rst">Edit me on GitHub</a></div>
|
|
|
|
|
2014-10-12 10:42:07 +02:00
|
|
|
=========================
|
2014-12-07 00:53:17 +01:00
|
|
|
Converse.js Documentation
|
2014-08-23 10:56:38 +02:00
|
|
|
=========================
|
2013-05-17 12:48:05 +02:00
|
|
|
|
2014-12-07 00:53:17 +01:00
|
|
|
Preface
|
|
|
|
=======
|
2014-02-12 18:32:25 +01:00
|
|
|
|
2014-12-07 01:19:01 +01:00
|
|
|
This is the official documentation for Converse.js. If you'd like to
|
|
|
|
contribute, please read the :doc:`documentation` page.
|
|
|
|
|
2015-05-02 00:22:50 +02:00
|
|
|
You might instead be looking for the `User Manual <manual.html>`_.
|
|
|
|
|
2014-12-07 01:19:01 +01:00
|
|
|
Introduction
|
|
|
|
============
|
|
|
|
|
2014-12-07 00:53:17 +01:00
|
|
|
Converse.js is a free and open-source `XMPP <http://xmpp.org/about-xmpp/>`_
|
2017-09-03 22:12:17 +02:00
|
|
|
chat client written in JavaScript which can be tightly integrated into any website.
|
2014-02-12 18:32:25 +01:00
|
|
|
|
2014-12-07 00:53:17 +01:00
|
|
|
The benefit of using converse.js as opposed to relying on a SaaS
|
|
|
|
(software-as-a-service) solution, is that your users can have a much more
|
|
|
|
customized, streamlined and integrated webchat experience and that you have
|
|
|
|
control over the data. The latter being a requirement for many sites dealing
|
|
|
|
with sensitive information.
|
2014-02-12 18:32:25 +01:00
|
|
|
|
2014-12-07 00:53:17 +01:00
|
|
|
You'll likely want users who are authenticated on your website, to also
|
|
|
|
automatically be authenticated on the XMPP server. In order to do this, you'll
|
|
|
|
have to add some server-side code for your website.
|
2014-02-12 18:32:25 +01:00
|
|
|
|
2014-12-07 00:53:17 +01:00
|
|
|
The :ref:`what-you-will-need` and :ref:`session-support` sections provide more information on how to achieve this.
|
2014-04-24 09:51:21 +02:00
|
|
|
|
2014-12-07 00:53:17 +01:00
|
|
|
Table of Contents
|
|
|
|
=================
|
2015-02-05 15:58:51 +01:00
|
|
|
|
2014-12-07 00:53:17 +01:00
|
|
|
.. toctree::
|
|
|
|
:maxdepth: 2
|
2014-04-24 09:51:21 +02:00
|
|
|
|
2014-12-07 00:53:17 +01:00
|
|
|
quickstart
|
|
|
|
features
|
|
|
|
setup
|
|
|
|
configuration
|
|
|
|
development
|
2016-12-21 20:19:37 +01:00
|
|
|
security
|
2015-02-05 15:58:51 +01:00
|
|
|
theming
|
2014-12-07 00:53:17 +01:00
|
|
|
translations
|
2016-01-13 08:55:42 +01:00
|
|
|
troubleshooting
|
2014-12-07 01:19:01 +01:00
|
|
|
documentation
|