JC Brand 9 years ago
parent
commit
28f5ee855b
1 changed files with 7 additions and 2 deletions
  1. 7 2
      docs/source/configuration.rst

+ 7 - 2
docs/source/configuration.rst

@@ -201,12 +201,17 @@ auto_login
 This option can be used to let converse.js automatically log the user in as
 This option can be used to let converse.js automatically log the user in as
 soon as the page loads.
 soon as the page loads.
 
 
-It should be used either with ``authentication`` set to ``anonymous`` or to
-``login``.
+It should be used either with ``authentication`` set to ``anonymous`` or to ``login``.
 
 
 If ``authentication`` is set to ``login``, then you will also need to provide a
 If ``authentication`` is set to ``login``, then you will also need to provide a
 valid ``jid`` and ``password`` values.
 valid ``jid`` and ``password`` values.
 
 
+This is a useful setting if you'd like to create a custom login form in your
+website. You'll need to write some Javascript to accept that custom form's
+login credentials, then you can pass those credentials (``jid`` and
+``password``) to ``converse.initialize`` to start converse.js and log the user
+into their XMPP account.
+
 auto_away
 auto_away
 ---------
 ---------