diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/README-for-packages | 20 | ||||
| -rw-r--r-- | docs/rabbitmq.config.example | 49 | ||||
| -rw-r--r-- | docs/rabbitmqctl.1.xml | 47 |
3 files changed, 104 insertions, 12 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 a8e5016524..55c5736994 100644 --- a/docs/rabbitmq.config.example +++ b/docs/rabbitmq.config.example @@ -120,6 +120,12 @@ %% %% {ssl_handshake_timeout, 5000}, + %% Password hashing implementation. Will only affect newly + %% created users. To recalculate hash for an existing user + %% it's necessary to update her password. + %% + %% {password_hashing_module, rabbit_password_hashing_sha256}, + %% %% Default User / VHost %% ==================== @@ -155,6 +161,11 @@ %% %% {frame_max, 131072}, + %% Set the max frame size the server will accept before connection + %% tuning occurs + %% + %% {initial_frame_max, 4096}, + %% Set the max permissible number of channels per connection. %% 0 means "no limit". %% @@ -165,10 +176,7 @@ %% See (http://www.erlang.org/doc/man/inet.html#setopts-2) for %% further documentation. %% - %% {tcp_listen_options, [binary, - %% {packet, raw}, - %% {reuseaddr, true}, - %% {backlog, 128}, + %% {tcp_listen_options, [{backlog, 128}, %% {nodelay, true}, %% {exit_on_close, false}]}, @@ -185,21 +193,47 @@ %% Alternatively, we can set a limit (in bytes) of RAM used by the node. %% %% {vm_memory_high_watermark, {absolute, 1073741824}}, + %% + %% Or you can set absolute value using memory units. + %% + %% {vm_memory_high_watermark, {absolute, "1024M"}}, + %% + %% Supported units suffixes: + %% + %% k, kiB: kibibytes (2^10 bytes) + %% M, MiB: mebibytes (2^20) + %% G, GiB: gibibytes (2^30) + %% kB: kilobytes (10^3) + %% MB: megabytes (10^6) + %% GB: gigabytes (10^9) %% Fraction of the high watermark limit at which queues start to %% page message out to disc in order to free up memory. %% + %% Values greater than 0.9 can be dangerous and should be used carefully. + %% %% {vm_memory_high_watermark_paging_ratio, 0.5}, + %% Interval (in milliseconds) at which we perform the check of the memory + %% levels against the watermarks. + %% + %% {memory_monitor_interval, 2500}, + %% Set disk free limit (in bytes). Once free disk space reaches this %% lower bound, a disk alarm will be set - see the documentation %% listed above for more details. %% %% {disk_free_limit, 50000000}, + %% + %% Or you can set it using memory units (same as in vm_memory_high_watermark) + %% {disk_free_limit, "50MB"}, + %% {disk_free_limit, "50000kB"}, + %% {disk_free_limit, "2GB"}, %% Alternatively, we can set a limit relative to total available RAM. %% - %% {disk_free_limit, {mem_relative, 1.0}}, + %% Values lower than 1.0 can be dangerous and should be used carefully. + %% {disk_free_limit, {mem_relative, 2.0}}, %% %% Misc/Advanced Options @@ -467,10 +501,7 @@ %% TCP/Socket options (as per the broker configuration). %% - %% {tcp_listen_options, [binary, - %% {packet, raw}, - %% {reuseaddr, true}, - %% {backlog, 128}, + %% {tcp_listen_options, [{backlog, 128}, %% {nodelay, true}]} ]}, diff --git a/docs/rabbitmqctl.1.xml b/docs/rabbitmqctl.1.xml index 508cc7a585..fb4959b276 100644 --- a/docs/rabbitmqctl.1.xml +++ b/docs/rabbitmqctl.1.xml @@ -1322,6 +1322,10 @@ <listitem><para>Like <command>message_bytes</command> but counting only those messages which are persistent.</para></listitem> </varlistentry> <varlistentry> + <term>head_message_timestamp</term> + <listitem><para>The timestamp property of the first message in the queue, if present. Timestamps of messages only appear when they are in the paged-in state.</para></listitem> + </varlistentry> + <varlistentry> <term>disk_reads</term> <listitem><para>Total number of times messages have been read from disk by this queue since it started.</para></listitem> </varlistentry> @@ -1954,15 +1958,52 @@ </listitem> </varlistentry> <varlistentry> - <term><cmdsynopsis><command>set_vm_memory_high_watermark absolute</command> <arg choice="req"><replaceable>memory_limit_in_bytes</replaceable></arg></cmdsynopsis></term> + <term><cmdsynopsis><command>set_vm_memory_high_watermark absolute</command> <arg choice="req"><replaceable>memory_limit</replaceable></arg></cmdsynopsis></term> <listitem> <variablelist> <varlistentry> - <term>memory_limit_in_bytes</term> + <term>memory_limit</term> <listitem><para> The new memory limit at which flow control is triggered, expressed in bytes as an integer number - greater than or equal to 0. + greater than or equal to 0 or as a string with memory units + (e.g. 512M or 1G). Available units are: + k, kiB: kibibytes (2^10 bytes) + M, MiB: mebibytes (2^20) + G, GiB: gibibytes (2^30) + kB: kilobytes (10^3) + MB: megabytes (10^6) + GB: gigabytes (10^9) + </para></listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> + <varlistentry> + <term><cmdsynopsis><command>set_disk_free_limit</command> <arg choice="req"><replaceable>disk_limit</replaceable></arg></cmdsynopsis></term> + <listitem> + <variablelist> + <varlistentry> + <term>disk_limit</term> + <listitem><para> + Lower bound limit as an integer in bytes or a string with memory units (see vm_memory_high_watermark), + e.g. 512M or 1G. Once free disk space reaches the limit, a disk alarm will be set. + </para></listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> + <varlistentry> + <term><cmdsynopsis><command>set_disk_free_limit mem_relative</command> <arg choice="req"><replaceable>fraction</replaceable></arg></cmdsynopsis></term> + <listitem> + <variablelist> + <varlistentry> + <term>fraction</term> + <listitem><para> + Limit relative to the total amount available RAM + as a non-negative floating point number. + Values lower than 1.0 can be dangerous and + should be used carefully. </para></listitem> </varlistentry> </variablelist> |