Commit bfeb297f authored by JC Brand's avatar JC Brand

Clarify usage of `locked_domain`.

Also, declare it in the controlbox plugin, not in core, where it's not used.
parent f07f6e7b
...@@ -48,9 +48,9 @@ copyright = u'2014, JC Brand' ...@@ -48,9 +48,9 @@ copyright = u'2014, JC Brand'
# built documents. # built documents.
# #
# The short X.Y version. # The short X.Y version.
version = '3.2.0-rc' version = '3.2.0'
# The full version, including alpha/beta/rc tags. # The full version, including alpha/beta/rc tags.
release = '3.2.0-rc' release = '3.2.0'
# The language for content autogenerated by Sphinx. Refer to documentation # The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages. # for a list of supported languages.
......
...@@ -485,7 +485,7 @@ default_domain ...@@ -485,7 +485,7 @@ default_domain
Specify a domain to act as the default for user JIDs. This allows users to log Specify a domain to act as the default for user JIDs. This allows users to log
in with only the username part of their JID, instead of the full JID. in with only the username part of their JID, instead of the full JID.
For example, if ``default_domain`` is ``example.org``, then the user: For example, if ``default_domain`` is ``example.org``, then the user
``johnny@example.org`` can log in with only ``johnny``. ``johnny@example.org`` can log in with only ``johnny``.
JIDs with other domains are still allowed but need to be provided in full. JIDs with other domains are still allowed but need to be provided in full.
...@@ -701,6 +701,12 @@ locked_domain ...@@ -701,6 +701,12 @@ locked_domain
Similar to `default_domain`_ but no other domains are allowed. Similar to `default_domain`_ but no other domains are allowed.
For example, if ``locked_domain`` is set to ``example.org``, then the user
``johnny@example.org`` can log in with only ``johnny``.
Additionally, only users registered on the ``example.org`` host can log in, no
other users are allowed to log in.
message_archiving message_archiving
----------------- -----------------
......
...@@ -188,6 +188,7 @@ ...@@ -188,6 +188,7 @@
_converse.api.settings.update({ _converse.api.settings.update({
allow_logout: true, allow_logout: true,
default_domain: undefined, default_domain: undefined,
locked_domain: undefined,
show_controlbox_by_default: false, show_controlbox_by_default: false,
sticky_controlbox: false, sticky_controlbox: false,
xhr_user_search: false, xhr_user_search: false,
......
...@@ -276,7 +276,6 @@ ...@@ -276,7 +276,6 @@
include_offline_state: false, include_offline_state: false,
jid: undefined, jid: undefined,
keepalive: true, keepalive: true,
locked_domain: undefined,
message_carbons: true, message_carbons: true,
message_storage: 'session', message_storage: 'session',
password: undefined, password: undefined,
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment