Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
C
converse.js
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
converse.js
Commits
94f91677
Commit
94f91677
authored
May 28, 2019
by
JC Brand
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Update quickstart docs
* Mention plugins for OpenFire and Prosody * Mention demos on conversejs.org
parent
540947dc
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
39 additions
and
5 deletions
+39
-5
docs/source/quickstart.rst
docs/source/quickstart.rst
+39
-5
No files found.
docs/source/quickstart.rst
View file @
94f91677
...
@@ -9,8 +9,40 @@ Quickstart
...
@@ -9,8 +9,40 @@ Quickstart
Getting a demo up and running
Getting a demo up and running
=============================
=============================
You can try out the latest version of Converse on `conversejs.org <https://conversejs.org>`_
for the overlayed version and `conversejs.org/fullscreen.html <https://conversejs.org/fullscreen.html>`_
for the full page version.
If you want to host Converse yourself, there are a few options available to
you.
Let your XMPP server serve Converse for you
-------------------------------------------
If you run your own XMPP server, you might first want to check whether it has
a plugin or module for hosting Converse for you.
* OpenFire has the `inverse <https://www.igniterealtime.org/projects/openfire/plugin-archive.jsp?plugin=inverse>`_ plugin.
* Prosody has `mod_conversejs <https://modules.prosody.im/mod_conversejs.html>`_.
Serving Converse yourself
-------------------------
Alternative you can serve only Converse without requiring any particular
XMPP server.
To do so, you'll need to get the right files to host, for which you have four
options.
.. note::
Pro-tip, if you just want to quickly test things locally, you can quickly start
up an HTTP server with Python by running ``python -m SimpleHTTPServer``
Option 1: Use the content delivery network
Option 1: Use the content delivery network
------------------------------------------
******************************************
Converse has a `CDN <https://en.wikipedia.org/wiki/Content_delivery_network>`_, provided by `KeyCDN <http://keycdn.com/>`_,
Converse has a `CDN <https://en.wikipedia.org/wiki/Content_delivery_network>`_, provided by `KeyCDN <http://keycdn.com/>`_,
which hosts its JavaScript and CSS files.
which hosts its JavaScript and CSS files.
...
@@ -39,7 +71,7 @@ via the *script* and *link* tags:
...
@@ -39,7 +71,7 @@ via the *script* and *link* tags:
Option 2: Download the builds from Github
Option 2: Download the builds from Github
-----------------------------------------
*****************************************
The `Converse releases page on Github <https://github.com/conversejs/converse.js/releases>`_
The `Converse releases page on Github <https://github.com/conversejs/converse.js/releases>`_
has the release notes for every release as well as links to downloadable zip files
has the release notes for every release as well as links to downloadable zip files
...
@@ -50,7 +82,7 @@ the *<head>* element of your page, similar as shown in option 1 above.
...
@@ -50,7 +82,7 @@ the *<head>* element of your page, similar as shown in option 1 above.
Option 3: Building the files yourself
Option 3: Building the files yourself
-------------------------------------
*************************************
Instead of using the CDN, you can also create your own builds and host them yourself.
Instead of using the CDN, you can also create your own builds and host them yourself.
...
@@ -61,13 +93,15 @@ checkout of the `Converse repo <http://github.com/conversejs/converse.js/>`_.
...
@@ -61,13 +93,15 @@ checkout of the `Converse repo <http://github.com/conversejs/converse.js/>`_.
.. note::
.. note::
When hosting Converse yourself without using the CDN (options 2 and
3
),
When hosting Converse yourself without using the CDN (options 2 and
4
),
you'll need to need to make sure that the ``webfonts`` directory is available in
you'll need to need to make sure that the ``webfonts`` directory is available in
the same location as ``converse.min.css``.
the same location as ``converse.min.css``.
Initializing Converse
Initializing Converse
---------------------
=====================
You'll need to initialize Converse with configuration settings relevant to your requirements.
You'll need to initialize Converse with configuration settings relevant to your requirements.
Take a look at the :ref:`configuration-settings` section for info on all the available settings.
Take a look at the :ref:`configuration-settings` section for info on all the available settings.
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment