aboutsummaryrefslogtreecommitdiff
path: root/ejabberd.yml.example
diff options
context:
space:
mode:
authorPaweł Chmielowski <pchmielowski@process-one.net>2017-01-13 16:53:48 +0100
committerPaweł Chmielowski <pchmielowski@process-one.net>2017-01-13 16:53:48 +0100
commitce42b6be01a420a55168c8c92c9646370078bd8b (patch)
tree0f8eaf187df610159b825d8c4bcd95aa7508d4fa /ejabberd.yml.example
parentDecode message before checking for expiration (#1458) (diff)
Add example api_permisions: definition to config template
Also expand default config to have rule for admin oauth
Diffstat (limited to '')
-rw-r--r--ejabberd.yml.example34
1 files changed, 34 insertions, 0 deletions
diff --git a/ejabberd.yml.example b/ejabberd.yml.example
index dae839fdc..8c6d026ee 100644
--- a/ejabberd.yml.example
+++ b/ejabberd.yml.example
@@ -524,6 +524,40 @@ access_rules:
## - ip: "XXX.XXX.XXX.XXX/32"
## - allow
+## ===============
+## API PERMISSIONS
+## ===============
+##
+## This section allows you to define who and using what method
+## can execute commands offered by ejabberd.
+##
+## By default "console commands" section allow executing all commands
+## issued using ejabberdctl command, and "admin access" section allows
+## users in admin acl to execute all commands except start and stop
+## with any available access method (ejabberdctl, http-api, xmlrpc
+## depending what is enabled on server).
+##
+## Remember to not remove "console commands" section when doing modifications
+## or ejabberdctl will not be able to execute commands!
+##
+##
+## api_permissions:
+## "console commands":
+## from:
+## - ejabberd_ctl
+## who: all
+## what: "*"
+## "admin access":
+## who:
+## - admin
+## - oauth:
+## - scope: "ejabberd:admin"
+## - admin
+## what:
+## - "*"
+## - "!stop"
+## - "!start"
+
## By default the frequency of account registrations from the same IP
## is limited to 1 account every 10 minutes. To disable, specify: infinity
## registration_timeout: 600