@@ -1546,14 +1546,49 @@ mod_options(_Host) ->
1546
1546
1547
1547
% % @format-begin
1548
1548
1549
+ % % All ad-hoc commands implemented by mod_configure are available as API Commands:
1550
+ % % - add-user -> register
1551
+ % % - delete-user -> unregister
1552
+ % % - end-user-session -> kick_session / kick_user
1553
+ % % - change-user-password -> change_password
1554
+ % % - get-user-lastlogin -> get_last
1555
+ % % - user-stats -> user_sessions_info
1556
+ % % - get-registered-users-list -> registered_users
1557
+ % % - get-registered-users-num -> stats
1558
+ % % - get-online-users-list -> connected_users
1559
+ % % - get-online-users-num -> stats
1560
+ % % - stopped nodes -> list_cluster_detailed
1561
+ % % - DB -> mnesia_list_tables and mnesia_table_change_storage
1562
+ % % - restart -> stop_kindly / restart
1563
+ % % - shutdown -> stop_kindly
1564
+ % % - backup -> backup
1565
+ % % - restore -> restore
1566
+ % % - textfile -> dump
1567
+ % % - import/file -> import_file
1568
+ % % - import/dir -> import_dir
1569
+ % %
1570
+ % % An exclusive feature available only in this module is to list items and discover them:
1571
+ % % - outgoing s2s
1572
+ % % - online users
1573
+ % % - all users
1574
+
1549
1575
mod_doc () ->
1550
1576
#{desc =>
1551
- ? T (" The module provides server configuration functionality via "
1552
- " https://xmpp.org/extensions/xep-0050.html[XEP-0050: Ad-Hoc Commands]. "
1553
- " It also implements many commands as defined in "
1554
- " https://xmpp.org/extensions/xep-0133.html[XEP-0133: Service Administration]. "
1555
- " This module requires _`mod_adhoc`_ (to execute the commands), "
1556
- " and recommends _`mod_disco`_ (to discover the commands). " ),
1577
+ [? T (" The module provides server configuration functionalities using "
1578
+ " https://xmpp.org/extensions/xep-0030.html[XEP-0030: Service Discovery] and "
1579
+ " https://xmpp.org/extensions/xep-0050.html[XEP-0050: Ad-Hoc Commands]:" ),
1580
+ " " ,
1581
+ " - List and discover outgoing s2s, online client sessions and all registered accounts" ,
1582
+ " - Most of the ad-hoc commands defined in https://xmpp.org/extensions/xep-0133.html[XEP-0133: Service Administration]" ,
1583
+ " - Additional custom ad-hoc commands specific to ejabberd" ,
1584
+ " " ,
1585
+ ? T (" This module requires _`mod_adhoc`_ (to execute the commands), "
1586
+ " and recommends _`mod_disco`_ (to discover the commands). " ),
1587
+ " " ,
1588
+ ? T (" Please notice that all the ad-hoc commands implemented by this module "
1589
+ " have an equivalent "
1590
+ " https://docs.ejabberd.im/developer/ejabberd-api/[API Command] "
1591
+ " that you can execute using _`mod_adhoc_api`_ or any other API frontend." )],
1557
1592
opts =>
1558
1593
[{access ,
1559
1594
#{value => ? T (" AccessName" ),
0 commit comments