summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim Watson <tim@rabbitmq.com>2013-09-27 12:47:23 +0100
committerTim Watson <tim@rabbitmq.com>2013-09-27 12:47:23 +0100
commitcccab6b7ac6c029d0c55a202c9e80aa735e3c393 (patch)
tree6a0f55fafe3f991be2db01de1492c94c17a621eb
parent0e762271dba2a857991ea6739a413d92ca15aea7 (diff)
downloadrabbitmq-server-cccab6b7ac6c029d0c55a202c9e80aa735e3c393.tar.gz
Tighten up the sample config a bit more
-rw-r--r--Makefile2
-rw-r--r--docs/rabbitmq.config.example28
2 files changed, 18 insertions, 12 deletions
diff --git a/Makefile b/Makefile
index e8c0ddbb..9a6ad7a6 100644
--- a/Makefile
+++ b/Makefile
@@ -11,7 +11,6 @@ SOURCE_DIR=src
EBIN_DIR=ebin
INCLUDE_DIR=include
DOCS_DIR=docs
-DOC_INSTALL_DIR ?=
INCLUDES=$(wildcard $(INCLUDE_DIR)/*.hrl) $(INCLUDE_DIR)/rabbit_framing.hrl
SOURCES=$(wildcard $(SOURCE_DIR)/*.erl) $(SOURCE_DIR)/rabbit_framing_amqp_0_9_1.erl $(SOURCE_DIR)/rabbit_framing_amqp_0_8.erl $(USAGES_ERL)
BEAM_TARGETS=$(patsubst $(SOURCE_DIR)/%.erl, $(EBIN_DIR)/%.beam, $(SOURCES))
@@ -352,7 +351,6 @@ install_dirs:
mkdir -p $(TARGET_DIR)/sbin
mkdir -p $(SBIN_DIR)
mkdir -p $(MAN_DIR)
- $(ifneq $(DOC_INSTALL_DIR),,$(shell mkdir -p $(DOC_INSTALL_DIR)))
$(foreach XML,$(USAGES_XML),$(eval $(call usage_dep, $(XML))))
diff --git a/docs/rabbitmq.config.example b/docs/rabbitmq.config.example
index 074c6999..ffb4b0c3 100644
--- a/docs/rabbitmq.config.example
+++ b/docs/rabbitmq.config.example
@@ -51,6 +51,7 @@
%% plugins.
%%
%% See http://www.rabbitmq.com/authentication.html for more details.
+ %%
%% {auth_mechanisms, ['PLAIN', 'AMQPLAIN']},
%% Select an authentication database to use. RabbitMQ comes bundled
@@ -84,16 +85,25 @@
%%
%% {auth_backends, [rabbit_auth_backend_ldap]},
- %% Name of the virtual host to create on first start. See
- %% http://www.rabbitmq.com/access-control.html for further information
+ %%
+ %% Misc/Advanced Options:
+ %%
+ %% NB: Change these only if you understand what you are doing!
+ %%
+
+ %% When the broker first starts, it will create a default virtual host
+ %% and default user. These can be customised using the settings below.
+
+ %% Name of the default virtual host.
+ %% See http://www.rabbitmq.com/access-control.html for further information
%% about vhosts and access control.
%%
%% {default_vhost, <<"/">>},
- %% User name to create on first start.
+ %% The default user's name.
%% {default_user, <<"guest">>},
- %% Password for the default user.
+ %% The default user's password.
%% {default_pass, <<"guest">>},
%% Tags for default user.
@@ -103,7 +113,7 @@
%%
%% {default_user_tags, [administrator]},
- %% Set up access control (permissions) for the default user.
+ %% Access control (permissions) for the default user.
%%
%% The permissions list consists of rules for configure, write and read
%% permissions. See http://www.rabbitmq.com/access-control.html for
@@ -112,9 +122,7 @@
%% {default_permissions, [<<".*">>, <<".*">>, <<".*">>]},
%%
- %% Misc/Advanced Options:
- %%
- %% NB: Change these only if you understand what you are doing!
+ %% Additional network and protocol related configuration.
%%
%% Set the default AMQP heartbeat delay (in seconds).
@@ -123,7 +131,7 @@
%% Set the max permissible size of an AMQP frame (in bytes).
%% {frame_max, 131072},
- %% Socket configuration.
+ %% Customising Socket Options.
%%
%% See (http://www.erlang.org/doc/man/inet.html#setopts-2) for
%% further documentation.
@@ -138,7 +146,7 @@
%%
%% Resource Limits & Flow Control.
%%
- %% See http://www.rabbitmq.com/memory.html for more details.
+ %% See http://www.rabbitmq.com/memory.html for full details.
%%
%% Memory-based Flow Control threshold.