diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/README-for-packages | 20 | ||||
| -rw-r--r-- | docs/rabbitmq.config.example | 4 | ||||
| -rw-r--r-- | docs/rabbitmqctl.1.xml | 47 |
3 files changed, 71 insertions, 0 deletions
diff --git a/docs/README-for-packages b/docs/README-for-packages new file mode 100644 index 0000000000..35a1523ac3 --- /dev/null +++ b/docs/README-for-packages @@ -0,0 +1,20 @@ +This is rabbitmq-server, a message broker implementing AMQP, STOMP and MQTT. + +Most of the documentation for RabbitMQ is provided on the RabbitMQ web +site. You can see documentation for the current version at: + +http://www.rabbitmq.com/documentation.html + +and for previous versions at: + +http://www.rabbitmq.com/previous.html + +Man pages are installed with this package. Of particular interest are +rabbitmqctl(1), to interact with a running RabbitMQ server, and +rabbitmq-plugins(1), to enable and disable plugins. These should be +run as the superuser. + +An example configuration file is provided in the same directory as +this README. Copy it to /etc/rabbitmq/rabbitmq.config to use it. The +RabbitMQ server must be restarted after changing the configuration +file. diff --git a/docs/rabbitmq.config.example b/docs/rabbitmq.config.example index dd1a4e6c87..6be9504b8b 100644 --- a/docs/rabbitmq.config.example +++ b/docs/rabbitmq.config.example @@ -193,6 +193,10 @@ %% %% {vm_memory_high_watermark, 0.4}, + %% Alternatively, we can set a limit (in megabytes) of RAM used by the node. + %% + %% {vm_memory_high_watermark, {absolute, 1024}}, + %% Fraction of the high watermark limit at which queues start to %% page message out to disc in order to free up memory. %% diff --git a/docs/rabbitmqctl.1.xml b/docs/rabbitmqctl.1.xml index 4a5e315ecd..b60e4f02ab 100644 --- a/docs/rabbitmqctl.1.xml +++ b/docs/rabbitmqctl.1.xml @@ -722,6 +722,33 @@ </varlistentry> <varlistentry> + <term> + <cmdsynopsis> + <command>authenticate_user</command> <arg choice="req"><replaceable>username</replaceable></arg> <arg choice="req"><replaceable>password</replaceable></arg> + </cmdsynopsis> + </term> + <listitem> + <variablelist> + <varlistentry> + <term>username</term> + <listitem><para>The name of the user.</para></listitem> + </varlistentry> + <varlistentry> + <term>password</term> + <listitem><para>The password of the user.</para></listitem> + </varlistentry> + </variablelist> + <para role="example-prefix">For example:</para> + <screen role="example">rabbitmqctl authenticate_user tonyg verifyit</screen> + <para role="example"> + This command instructs the RabbitMQ broker to authenticate the + user named <command>tonyg</command> with password + <command>verifyit</command>. + </para> + </listitem> + </varlistentry> + + <varlistentry> <term><cmdsynopsis><command>set_user_tags</command> <arg choice="req"><replaceable>username</replaceable></arg> <arg choice="req"><replaceable>tag</replaceable> ...</arg></cmdsynopsis></term> <listitem> <variablelist> @@ -1230,6 +1257,11 @@ queue is non-exclusive.</para></listitem> </varlistentry> <varlistentry> + <term>exclusive</term> + <listitem><para>True if queue is exclusive (i.e. has + owner_pid), false otherwise</para></listitem> + </varlistentry> + <varlistentry> <term>exclusive_consumer_pid</term> <listitem><para>Id of the Erlang process representing the channel of the exclusive consumer subscribed to this queue. Empty if @@ -1925,6 +1957,21 @@ </variablelist> </listitem> </varlistentry> + <varlistentry> + <term><cmdsynopsis><command>set_vm_memory_high_watermark absolute</command> <arg choice="req"><replaceable>memory_limit_mb</replaceable></arg></cmdsynopsis></term> + <listitem> + <variablelist> + <varlistentry> + <term>memory_limit_mb</term> + <listitem><para> + The new memory limit at which flow control is + triggered, expressed in MB as an integer number + greater than or equal to 0. + </para></listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> </variablelist> </refsect2> </refsect1> |