2013-04-15 12:03:14 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
mod_admin_extra - Additional ejabberd commands
|
|
|
|
|
|
2015-04-08 15:49:34 +02:00
|
|
|
NOTE: This module is included in ejabberd since 15.04
|
|
|
|
|
|
2013-04-15 12:03:14 +02:00
|
|
|
Author: Badlop
|
|
|
|
|
Homepage: http://www.ejabberd.im/mod_admin_extra
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
CONFIGURATION
|
|
|
|
|
=============
|
|
|
|
|
|
2015-03-13 11:54:26 +01:00
|
|
|
Add the module to your ejabberd.yml, on the modules section:
|
|
|
|
|
modules:
|
|
|
|
|
mod_admin_extra: {}
|
2013-04-15 12:03:14 +02:00
|
|
|
|
|
|
|
|
The configurable options are:
|
|
|
|
|
- module_resource:
|
|
|
|
|
Indicate the resource that the XMPP stanzas must use in the FROM or TO JIDs.
|
|
|
|
|
This is only useful in the vcard set and get commands.
|
|
|
|
|
The default value is "mod_admin_extra".
|
|
|
|
|
|
|
|
|
|
In this example configuration, the users vcards can only be modified
|
|
|
|
|
by executing mod_admin_extra commands.
|
|
|
|
|
Notice that this needs the patch
|
|
|
|
|
https://support.process-one.net/browse/EJAB-797
|
2015-03-13 11:54:26 +01:00
|
|
|
acl:
|
|
|
|
|
adminextraresource:
|
|
|
|
|
resource: "modadminextraf8x,31ad"
|
|
|
|
|
access:
|
|
|
|
|
vcard_set:
|
|
|
|
|
adminextraresource: allow
|
|
|
|
|
all: deny
|
|
|
|
|
modules:
|
|
|
|
|
mod_admin_extra:
|
|
|
|
|
module_resource: "modadminextraf8x,31ad"
|
|
|
|
|
mod_vcard:
|
|
|
|
|
access_set: vcard_set
|
2013-04-15 12:03:14 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
USAGE
|
|
|
|
|
=====
|
|
|
|
|
|
|
|
|
|
Now you have several new commands in ejabberdctl.
|
|
|
|
|
|
|
|
|
|
Description of some commands:
|
|
|
|
|
|
|
|
|
|
- vcard-*
|
|
|
|
|
Example: ejabberdctl vcard-get joe myjab.net email
|
|
|
|
|
|
|
|
|
|
- pushroster*
|
|
|
|
|
The file used by 'pushroster' and 'pushroster-all' must be placed:
|
|
|
|
|
- Windows: on the directory were you installed ejabberd:
|
|
|
|
|
'C:/Program Files/ejabberd'
|
|
|
|
|
- Other OS: on the same directory where the .beam files are.
|
|
|
|
|
Example content for the roster file:
|
2015-03-06 18:45:25 +01:00
|
|
|
[{<<"bob">>, <<"example.org">>, <<"workers">>, <<"Bob">>},
|
|
|
|
|
{<<"mart">>, <<"example.org">>, <<"workers">>, <<"Mart">>},
|
|
|
|
|
{<<"Rich">>, <<"example.org">>, <<"bosses">>, <<"Rich">>}].
|
2013-04-15 12:03:14 +02:00
|
|
|
|
|
|
|
|
- srg-create
|
|
|
|
|
If you want to put a group Name with blankspaces, use the characters
|
|
|
|
|
"' and '" to define when the Name starts and ends.
|
|
|
|
|
For example:
|
|
|
|
|
ejabberdctl srg-create g1 example.org "'Group number 1'" this_is_g1 g1
|
|
|
|
|
|
|
|
|
|
- ban-account
|
|
|
|
|
|
|
|
|
|
This command kicks all the connected sessions of the account from the
|
|
|
|
|
server. It also changes his password to another randomly
|
|
|
|
|
generated, so he can't login anymore unless a server administrator
|
|
|
|
|
changes him again the password.
|
|
|
|
|
|
|
|
|
|
It is possible to define the reason of the ban. The new password
|
|
|
|
|
also includes the reason and the date and time of the ban.
|
|
|
|
|
|
|
|
|
|
For example, if this command is called:
|
|
|
|
|
ejabberdctl vhost example.org ban-account boby Spammed several MUC rooms
|
|
|
|
|
then the sessions of the local account which JID is boby@example.org
|
|
|
|
|
will be kicked, and its password will be set to something like this:
|
|
|
|
|
BANNED_ACCOUNT--20080425T21:45:07--2176635--Spammed_several_MUC_rooms
|
|
|
|
|
|
