mirrors/prosody
1
0
Fork 0
mirror of https://github.com/bjc/prosody.git synced 2025-04-04 13:47:41 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

mod_admin_shell: Add help section about roles

Browse source 
As in the argument to user:create() and user:roles()

Tricky to come up with something sensible to write when Prosody core
only knows of the 'prosody:admin' role so far.
This commit is contained in:
Kim Alvefur 2022-01-23 19:55:32 +01:00
parent 90215f635b
commit 1809c0460f
1 changed files with 12 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

12
plugins/mod_admin_shell.lua
View file

@ -216,6 +216,7 @@ function commands.help(session, data)
print [[module - Commands to load/reload/unload modules/plugins]] print [[module - Commands to load/reload/unload modules/plugins]]
print [[host - Commands to activate, deactivate and list virtual hosts]] print [[host - Commands to activate, deactivate and list virtual hosts]]
print [[user - Commands to create and delete users, and change their passwords]] print [[user - Commands to create and delete users, and change their passwords]]
print [[roles - Show information about user roles]]
print [[muc - Commands to create, list and manage chat rooms]] print [[muc - Commands to create, list and manage chat rooms]]
print [[server - Uptime, version, shutting down, etc.]] print [[server - Uptime, version, shutting down, etc.]]
print [[port - Commands to manage ports the server is listening on]] print [[port - Commands to manage ports the server is listening on]]
@ -253,6 +254,17 @@ function commands.help(session, data)
print [[user:roles(jid, host, roles) - Set roles for an user (see 'help roles')]] print [[user:roles(jid, host, roles) - Set roles for an user (see 'help roles')]]
print [[user:delete(jid) - Permanently remove the specified user account]] print [[user:delete(jid) - Permanently remove the specified user account]]
print [[user:list(hostname, pattern) - List users on the specified host, optionally filtering with a pattern]] print [[user:list(hostname, pattern) - List users on the specified host, optionally filtering with a pattern]]
elseif section == "roles" then
print [[Roles may grant access or restrict users from certain operations]]
print [[Built-in roles are:]]
print [[ prosody:admin - Administrator]]
print [[ (empty set) - Normal user]]
print [[]]
print [[The canonical role format looks like: { ["example:role"] = true }]]
print [[For convenience, the following formats are also accepted:]]
print [["admin" - short for "prosody:admin", the normal admin status (like the admins config option)]]
print [["example:role" - short for {["example:role"]=true}]]
print [[{"example:role"} - short for {["example:role"]=true}]]
elseif section == "muc" then elseif section == "muc" then
-- TODO `muc:room():foo()` commands -- TODO `muc:room():foo()` commands
print [[muc:create(roomjid, { config }) - Create the specified MUC room with the given config]] print [[muc:create(roomjid, { config }) - Create the specified MUC room with the given config]]