Skip to content

Commit a74068b

Browse files
Adda a warning to quickstart about using version numbers when configuring xmpp server plugins. (#3777)
* Update quickstart.rst
1 parent 329c77c commit a74068b

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

docs/source/quickstart.rst

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,19 @@ For example, the following XMPP servers have plugins available:
2121
* **Prosody**: `mod_conversejs <https://modules.prosody.im/mod_conversejs.html>`_
2222
* **ejabberd**: `mod_conversejs <https://docs.ejabberd.im/admin/configuration/modules/#mod-conversejs>`_
2323

24+
.. warning::
25+
When configuring one of these plugins in production, it's good practice to use a specific version of the Converse resources to avoid breaking changes.
26+
27+
For instance, this will configure ejabberd's, mod-conversejs to fetch a specific version instead of whichever is the latest one.
28+
29+
.. code-block:: yml
30+
31+
mod_conversejs:
32+
# Replace 11.0.1 with your desired version
33+
conversejs_css: https://cdn.conversejs.org/11.0.1/dist/converse.min.css
34+
conversejs_script: https://cdn.conversejs.org/11.0.1/dist/converse.min.js
35+
36+
2437
Option 2: Self-hosting
2538
======================
2639

@@ -39,7 +52,7 @@ To use it, add these lines to your HTML page's ``<head>`` section:
3952

4053
.. code-block:: html
4154

42-
<!-- Replace 10.1.5 with your desired version -->
55+
<!-- Replace 11.0.1 with your desired version -->
4356
<link rel="stylesheet" href="https://cdn.conversejs.org/11.0.1/dist/converse.min.css">
4457
<script src="https://cdn.conversejs.org/11.0.1/dist/converse.min.js" charset="utf-8"></script>
4558

0 commit comments

Comments
 (0)