Update documentation to 23.10

Author: badlop

content/admin/configuration/modules.md

@@ -1394,6 +1394,12 @@ else can use that nickname in any room in the MUC service. To register a
 nickname, open the Service Discovery in your XMPP client and register in
 the MUC service.
 
+It is also possible to register a nickname in a room, so nobody else can
+use that nickname in that room. If a nick is registered in the MUC
+service, that nick cannot be registered in any room, and vice versa: a
+nick that is registered in a room cannot be registered at the MUC
+service.
+
 This module supports clustering and load balancing. One module can be
 started per cluster node. Rooms are distributed at creation time on all
 available MUC module instances. The multi-user chat module is clustered
@@ -1430,11 +1436,13 @@ To configure who is allowed to modify the *persistent* room option. The
 default value is *all*, which means everyone is allowed to modify that
 option.
 
+<div class="note-left">improved in <a href="/archive/23_10/">23.10</a></div>
+
 - **access\_register**: *AccessName*  
 This option specifies who is allowed to register nickname within the
-Multi-User Chat service. The default is *all* for backward
+Multi-User Chat service and rooms. The default is *all* for backward
 compatibility, which means that any user is allowed to register any free
-nick.
+nick in the MUC service and in the rooms.
 
 <div class="note-left">added in <a href="/archive/22_05/">22.05</a></div>
 
@@ -1457,10 +1465,6 @@ using an XMPP client with MUC capability. The *Options* are:
    Allow occupants to change
     the subject. The default value is *true*.
 
- - **allow\_private\_messages**: *true | false*  
-   Occupants can send
-    private messages to other occupants. The default value is *true*.
-
  - **allow\_private\_messages\_from\_visitors**: *anyone | moderators |
     nobody* Visitors can send private messages to other occupants. The
     default value is *anyone* which means visitors can send private
@@ -1494,6 +1498,10 @@ using an XMPP client with MUC capability. The *Options* are:
    Allow visitors in a
     moderated room to request voice. The default value is *true*.
 
+ - **allowpm**: *anyone | participants | moderators | none*  
+   Who can
+    send private messages. The default value is *anyone*.
+
  - **anonymous**: *true | false*  
    The room is anonymous: occupants don’t
     see the real JIDs of other occupants. Note that the room moderators
@@ -1885,6 +1893,19 @@ conference. The conference name is appended to the URL if *dirname*
 option is set to *room\_name* or a conference JID is appended to the
 *URL* otherwise. There is no default value.
 
+mod\_muc\_occupantid
+--------------------
+
+This module implements [XEP-0421: Anonymous unique occupant identifiers
+for MUCs](https://xmpp.org/extensions/xep-0421.html).
+
+When the module is enabled, the feature is enabled in all semi-anonymous
+rooms.
+
+This module is available since ejabberd <a href="/archive/23_10/">23.10</a>.
+
+The module has no options.
+
 mod\_muc\_rtbl
 --------------
 
@@ -2211,6 +2232,11 @@ it is a valid XML. One typical usage is storing a bookmark of all user’s
 conferences ([XEP-0048:
 Bookmarks](https://xmpp.org/extensions/xep-0048.html)).
 
+It also implements the bookmark conversion described in [XEP-0402: PEP
+Native Bookmarks](https://xmpp.org/extensions/xep-0402.html), see the
+command
+[bookmarks\_to\_pep](https://docs.ejabberd.im/developer/ejabberd-api/admin-api/#bookmarks-to-pep).
+
 __Available options:__
 
 - **cache\_life\_time**: *timeout()*  
@@ -2682,6 +2708,15 @@ If this option is set to *true*, the sender’s JID is included with push
 notifications generated for incoming messages with a body. The default
 value is *false*.
 
+<div class="note-left">added in <a href="/archive/23_10/">23.10</a></div>
+
+- **notify\_on**: *messages | all*  
+If this option is set to *messages*, notifications are generated only
+for actual chat messages with a body text (or some encrypted payload).
+If it’s set to *all*, any kind of XMPP stanza will trigger a
+notification. If unsure, it’s strongly recommended to stick to *all*,
+which is the default value.
+
 - **use\_cache**: *true | false*  
 Same as top-level [use_cache](/admin/configuration/toplevel/#use-cache) option, but applied to this module only.
 

content/admin/configuration/toplevel.md

@@ -233,6 +233,18 @@ not set, the value from [cache_missed](/admin/configuration/toplevel/#cache-miss
 Same as [cache_size](/admin/configuration/toplevel/#cache-size), but applied to authentication cache only. If not
 set, the value from [cache_size](/admin/configuration/toplevel/#cache-size) will be used.
 
+<div class="note-down">added in <a href="/archive/23_10/">23.10</a></div>
+
+## auth\_external\_user\_exists\_check
+
+*true | false*  
+
+Supplement check for user existence based on *mod\_last* data, for
+authentication methods that don’t have a way to reliable tell if user
+exists (like is the case for *jwt* and certificate based
+authentication). This helps with processing offline message for those
+users. The default value is *true*.
+
 ## auth\_method
 
 *\[mnesia | sql | anonymous | external | jwt | ldap | pam, ...\]*  
@@ -680,6 +692,16 @@ following:
     options in the included file *Filename*. The options that match this
     criteria are not accepted. The default value is an empty list.
 
+<div class="note-down">added in <a href="/archive/23_10/">23.10</a></div>
+
+## install\_contrib\_modules
+
+*\[Module, ...\]*  
+
+Modules to install from
+[ejabberd-contrib](https://docs.ejabberd.im/developer/extending-ejabberd/modules/#ejabberd-contrib)
+at start time. The default value is an empty list of modules: *\[\]*.
+
 ## jwt\_auth\_only\_rule
 
 *AccessName*  
@@ -956,7 +978,7 @@ default value is *1 minute*.
 *true | false*  
 
 Whether to use *new* SQL schema. All schemas are located at
-<https://github.com/processone/ejabberd/tree/23.04/sql>. There are two
+<https://github.com/processone/ejabberd/tree/23.10/sql>. There are two
 schemas available. The default legacy schema allows to store one XMPP
 domain into one ejabberd database. The *new* schema allows to handle
 several XMPP domains in a single ejabberd database. Using this *new*

content/developer/ejabberd-api/admin-api.md

@@ -1552,7 +1552,7 @@ __Examples:__
 Export virtual host information from Mnesia tables to SQL file
 
 
-Configure the modules to use SQL, then call this command. After correctly exported the database of a vhost, you may want to delete from mnesia with the [`delete_mnesia`](/developer/ejabberd-api/admin-api/#delete-mnesia) command.
+Configure the modules to use SQL, then call this command. After correctly exported the database of a vhost, you may want to delete from mnesia with the [delete_mnesia](/developer/ejabberd-api/admin-api/#delete-mnesia) command.
 
 __Arguments:__
 
@@ -2233,12 +2233,15 @@ __Examples:__
 ~~~
 
 
-
+<div class='note-down'>improved in <a href="/archive/23_10/">23.10</a></div>
 
 ## get_roster
 
 
-Get roster of a local user
+Get list of contacts in a local user roster
+
+
+Subscription can be: "none", "from", "to", "both". Pending can be: "in", "out", "none".
 
 __Arguments:__
 
@@ -2247,7 +2250,7 @@ __Arguments:__
 
 __Result:__
 
-- *contacts* :: [{jid::string, nick::string, subscription::string, ask::string, group::string}]
+- *contacts* :: [{jid::string, nick::string, subscription::string, pending::string, groups::[group::string]}]
 
 __Tags:__
 [roster](/developer/ejabberd-api/admin-tags/#roster) 
@@ -2271,15 +2274,21 @@ __Examples:__
         "jid": "aaaaa",
         "nick": "bbbbb",
         "subscription": "ccccc",
-        "ask": "ddddd",
-        "group": "eeeee"
+        "pending": "ddddd",
+        "groups": [
+          "eeeee",
+          "fffff"
+        ]
       },
       {
-        "jid": "fffff",
-        "nick": "ggggg",
-        "subscription": "hhhhh",
-        "ask": "iiiii",
-        "group": "jjjjj"
+        "jid": "ggggg",
+        "nick": "hhhhh",
+        "subscription": "iiiii",
+        "pending": "jjjjj",
+        "groups": [
+          "kkkkk",
+          "lllll"
+        ]
       }
     ]
 ~~~
@@ -2581,6 +2590,37 @@ __Examples:__
 ~~~
 
 
+<div class='note-down'>added in <a href="/archive/23_10/">23.10</a></div>
+
+## halt
+
+
+Halt ejabberd abruptly with status code 1
+
+__Arguments:__
+
+
+__Result:__
+
+- *res* :: integer : Status code (0 on success, 1 otherwise)
+
+__Tags:__
+[server](/developer/ejabberd-api/admin-tags/#server) 
+
+__Examples:__
+
+
+~~~ json
+    POST /api/halt
+    {
+      
+    }
+    
+    HTTP/1.1 200 OK
+    ""
+~~~
+
+
 
 
 ## import_dir
@@ -2751,7 +2791,7 @@ __Examples:__
 Install Mnesia database from a binary backup file
 
 
-The binary backup file is installed as fallback: it will be used to restore the database at the next ejabberd start. This means that, after running this command, you have to restart ejabberd. This command requires less memory than [`restore`](/developer/ejabberd-api/admin-api/#restore).
+The binary backup file is installed as fallback: it will be used to restore the database at the next ejabberd start. This means that, after running this command, you have to restart ejabberd. This command requires less memory than [restore](/developer/ejabberd-api/admin-api/#restore).
 
 __Arguments:__
 
@@ -3007,7 +3047,7 @@ __Examples:__
 Restore Mnesia database from a text dump file
 
 
-Restore immediately. This is not recommended for big databases, as it will consume much time, memory and processor. In that case it's preferable to use [`install_fallback`](/developer/ejabberd-api/admin-api/#backup[backup] and http://./#install-fallback).
+Restore immediately. This is not recommended for big databases, as it will consume much time, memory and processor. In that case it's preferable to use [install_fallback](/developer/ejabberd-api/admin-api/#backup[backup] and http://./#install-fallback).
 
 __Arguments:__
 
@@ -4578,7 +4618,7 @@ __Examples:__
 Restore the Mnesia database from a binary backup file
 
 
-This restores immediately from a binary backup file the internal Mnesia database. This will consume a lot of memory if you have a large database, you may prefer [`install_fallback`](/developer/ejabberd-api/admin-api/#install-fallback).
+This restores immediately from a binary backup file the internal Mnesia database. This will consume a lot of memory if you have a large database, you may prefer [install_fallback](/developer/ejabberd-api/admin-api/#install-fallback).
 
 __Arguments:__
 
@@ -4977,7 +5017,7 @@ __Examples:__
 Send a stanza from an existing C2S session
 
 
-`user`@`host`/`resource` must be an existing C2S session. As an alternative, use [`send_stanza`](/developer/ejabberd-api/admin-api/#send-stanza) instead.
+`user`@`host`/`resource` must be an existing C2S session. As an alternative, use [send_stanza](/developer/ejabberd-api/admin-api/#send-stanza) instead.
 
 __Arguments:__
 

content/developer/ejabberd-api/admin-tags.md

@@ -441,6 +441,9 @@ This section enumerates the tags and their associated API.
 * [gc](/developer/ejabberd-api/admin-api/#gc)
 
 
+* [halt](/developer/ejabberd-api/admin-api/#halt)
+
+
 * [registered_vhosts](/developer/ejabberd-api/admin-api/#registered-vhosts)