diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/rabbitmq.conf.example | 2 | ||||
| -rw-r--r-- | docs/rabbitmq.config.example | 4 | ||||
| -rw-r--r-- | docs/rabbitmqctl.8 | 94 |
3 files changed, 97 insertions, 3 deletions
diff --git a/docs/rabbitmq.conf.example b/docs/rabbitmq.conf.example index 0e8d1e0596..e4c2fff92a 100644 --- a/docs/rabbitmq.conf.example +++ b/docs/rabbitmq.conf.example @@ -386,7 +386,7 @@ ## Disabling background GC may reduce latency for client operations, ## keeping it enabled may reduce median RAM usage. ## -# background_gc_enabled = true +# background_gc_enabled = false ## Target (desired) interval (in milliseconds) at which we run background GC. ## The actual interval will vary depending on how long it takes to execute diff --git a/docs/rabbitmq.config.example b/docs/rabbitmq.config.example index 2be3c74095..4135c5053c 100644 --- a/docs/rabbitmq.config.example +++ b/docs/rabbitmq.config.example @@ -276,7 +276,7 @@ %% See http://www.rabbitmq.com/partitions.html for further details. %% %% {cluster_partition_handling, ignore}, - + %% Mirror sync batch size, in messages. Increasing this will speed %% up syncing but total batch size in bytes must not exceed 2 GiB. %% Available in RabbitMQ 3.6.0 or later. @@ -343,7 +343,7 @@ %% Disabling background GC may reduce latency for client operations, %% keeping it enabled may reduce median RAM usage. %% - %% {background_gc_enabled, true}, + %% {background_gc_enabled, false}, %% %% Target (desired) interval (in milliseconds) at which we run background GC. %% The actual interval will vary depending on how long it takes to execute diff --git a/docs/rabbitmqctl.8 b/docs/rabbitmqctl.8 index e12f6f496f..91b99560d6 100644 --- a/docs/rabbitmqctl.8 +++ b/docs/rabbitmqctl.8 @@ -784,6 +784,100 @@ has been granted access, and the permissions the user has for operations on resources in these virtual hosts: .sp .Dl rabbitmqctl list_user_permissions tonyg +.\" ------------------------------------ +.It Cm set_topic_permissions Oo Fl p Ar vhost Oc Ar user Ar exchange Ar write Ar read +.Bl -tag -width Ds +.It Ar vhost +The name of the virtual host to which to grant the user access, +defaulting to +.Qq / . +.It Ar user +The name of the user the permissions apply to in the target virtual host. +.It Ar exchange +The name of the topic exchange the authorisation check will be applied to. +.It Ar write +A regular expression matching the routing key of the published message. +.It Ar read +A regular expression matching the routing key of the consumed message. +.El +.Pp +Sets user topic permissions. +.Pp +For example, this command instructs the RabbitMQ broker to let the +user named +.Qq tonyg +publish and consume messages going through the +.Qq amp.topic +exchange of the +.Qq /myvhost +virtual host with a routing key starting with +.Qq tonyg- : +.sp +.Dl rabbitmqctl set_topic_permissions -p /myvhost tonyg amq.topic Qo ^tonyg-.* Qc Qo ^tonyg-.* Qc +.Pp +Topic permissions support variable expansion for the following variables: +username, vhost, and client_id. Note that client_id is expanded only when using MQTT. +The previous example could be made more generic by using +.Qq ^{username}-.* : +.sp +.Dl rabbitmqctl set_topic_permissions -p /myvhost tonyg amq.topic Qo ^{username}-.* Qc Qo ^{username}-.* Qc +.\" ------------------------------------ +.It Cm clear_topic_permissions Oo Fl p Ar vhost Oc Ar username Oo Ar exchange Oc +.Bl -tag -width Ds +.It Ar vhost +The name of the virtual host to which to clear the topic permissions, +defaulting to +.Qq / . +.It Ar username +The name of the user to clear topic permissions to the specified virtual host. +.It Ar exchange +The name of the topic exchange to clear topic permissions, defaulting to all the +topic exchanges the given user has topic permissions for. +.El +.Pp +Clear user topic permissions. +.Pp +For example, this command instructs the RabbitMQ broker to remove topic permissions for user +named +.Qq tonyg +for the topic exchange +.Qq amq.topic +in the virtual host called +.Qq /myvhost : +.sp +.Dl rabbitmqctl clear_topic_permissions -p /myvhost tonyg amq.topic +.\" ------------------------------------ +.It Cm list_topic_permissions Op Fl p Ar vhost +.Bl -tag -width Ds +.It Ar vhost +The name of the virtual host for which to list the users topic permissions. +Defaults to +.Qq / . +.El +.Pp +Lists topic permissions in a virtual host. +.Pp +For example, this command instructs the RabbitMQ broker to list all the +users which have been granted topic permissions in the virtual host called +.Qq /myvhost: +.sp +.Dl rabbitmqctl list_topic_permissions -p /myvhost +.\" ------------------------------------ +.It Cm list_user_topic_permissions Ar username +.Bl -tag -width Ds +.It Ar username +The name of the user for which to list the topic permissions. +.El +.Pp +Lists user topic permissions. +.Pp +For example, this command instructs the RabbitMQ broker to list all the +virtual hosts to which the user named +.Qq tonyg +has been granted access, and the topic permissions the user has in these virtual hosts: +.sp +.Dl rabbitmqctl list_topic_user_permissions tonyg + .El .Ss Parameter Management Certain features of RabbitMQ (such as the federation plugin) are |