55 lines
1.6 KiB
ReStructuredText
55 lines
1.6 KiB
ReStructuredText
.. Converse 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.
|
|
|
|
.. 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>
|
|
|
|
======================
|
|
Converse Documentation
|
|
======================
|
|
|
|
Preface
|
|
=======
|
|
|
|
This is the official documentation for Converse. If you'd like to
|
|
contribute, please read the :doc:`documentation` page.
|
|
|
|
Introduction
|
|
============
|
|
|
|
Converse is a free and open-source `XMPP <https://xmpp.org/about-xmpp/>`_
|
|
chat client written in JavaScript which can be tightly integrated into any website.
|
|
|
|
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.
|
|
|
|
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.
|
|
|
|
The :ref:`what-you-will-need` and :ref:`session-support` sections provide more information on how to achieve this.
|
|
|
|
Table of Contents
|
|
=================
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
quickstart
|
|
features
|
|
setup
|
|
session
|
|
configuration
|
|
development
|
|
theming
|
|
security
|
|
translations
|
|
troubleshooting
|
|
documentation
|