Software / code / prosody
Changeset
12208:3edf1a38fb15
mod_admin_shell: Add help section about roles
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.
| author | Kim Alvefur <zash@zash.se> |
|---|---|
| date | Sun, 23 Jan 2022 19:55:32 +0100 |
| parents | 12207:65e252940337 |
| children | 12209:3fe2e5da05c3 |
| files | plugins/mod_admin_shell.lua |
| diffstat | 1 files changed, 12 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- a/plugins/mod_admin_shell.lua Fri Jan 21 18:42:38 2022 +0100 +++ b/plugins/mod_admin_shell.lua Sun Jan 23 19:55:32 2022 +0100 @@ -216,6 +216,7 @@ print [[module - Commands to load/reload/unload modules/plugins]] print [[host - Commands to activate, deactivate and list virtual hosts]] 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 [[server - Uptime, version, shutting down, etc.]] print [[port - Commands to manage ports the server is listening on]] @@ -253,6 +254,17 @@ 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: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 -- TODO `muc:room():foo()` commands print [[muc:create(roomjid, { config }) - Create the specified MUC room with the given config]]
