summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorHubert Plociniczak <hubert@lshift.net>2009-02-04 04:12:17 +0000
committerHubert Plociniczak <hubert@lshift.net>2009-02-04 04:12:17 +0000
commitb9a882564fdd1a66cf30b2c6e58f4105982c4433 (patch)
tree3f6bd5a73ee8faa47a50991001845876426bc20c /docs
parent6f0e6d40c30079764b4e4e7472883d8abb9ff7e9 (diff)
downloadrabbitmq-server-git-b9a882564fdd1a66cf30b2c6e58f4105982c4433.tar.gz
Moved main configuration from /etc/default/rabbitmq to /etc/rabbitmq/rabbitmq.conf. Updated man pages to reflect the changes. To avoid overwriting the variables those in /etc/default/rabbitmq need to be prefix with INITD_. Added checks in scripts to handle those cases. rpm and debian need to handle /etc/rabbitmq directory.
Diffstat (limited to 'docs')
-rw-r--r--docs/rabbitmq-multi.1.pod2
-rw-r--r--docs/rabbitmq-server.1.pod4
-rw-r--r--docs/rabbitmq.5.pod43
3 files changed, 30 insertions, 19 deletions
diff --git a/docs/rabbitmq-multi.1.pod b/docs/rabbitmq-multi.1.pod
index 82c3911681..9a7b683e36 100644
--- a/docs/rabbitmq-multi.1.pod
+++ b/docs/rabbitmq-multi.1.pod
@@ -40,7 +40,7 @@ Start 3 local RabbitMQ nodes with unique, sequential port numbers:
=head1 SEE ALSO
-rabbitmq-server(1), rabbitmqctl(1)
+rabbitmq(5), rabbitmq-server(1), rabbitmqctl(1)
=head1 AUTHOR
diff --git a/docs/rabbitmq-server.1.pod b/docs/rabbitmq-server.1.pod
index 00210c8b5c..5f13f37b3d 100644
--- a/docs/rabbitmq-server.1.pod
+++ b/docs/rabbitmq-server.1.pod
@@ -44,7 +44,7 @@ B<RABBITMQ_NODE_PORT>
Defaults to 5672.
B<RABBITMQ_CLUSTER_CONFIG_FILE>
- Defaults to /etc/default/rabbitmq_cluster.config. If this file is
+ Defaults to /etc/rabbitmq/rabbitmq_cluster.config. If this file is
present it is used by the server to auto-configure a RabbitMQ
cluster.
See the clustering guide at http://www.rabbitmq.com/clustering.html
@@ -62,7 +62,7 @@ Run RabbitMQ AMQP server in the background:
=head1 SEE ALSO
-rabbitmq-multi(1), rabbitmqctl(1)
+rabbitmq(5), rabbitmq-multi(1), rabbitmqctl(1)
=head1 AUTHOR
diff --git a/docs/rabbitmq.5.pod b/docs/rabbitmq.5.pod
index e6972935f5..95416ebf8b 100644
--- a/docs/rabbitmq.5.pod
+++ b/docs/rabbitmq.5.pod
@@ -1,10 +1,10 @@
=head1 NAME
-/etc/default/rabbitmq - default settings for RabbitMQ AMQP server
+/etc/rabbitmq/rabbitmq.conf - default settings for RabbitMQ AMQP server
=head1 DESCRIPTION
-/etc/default/rabbitmq contains variable settings that override the
+/etc/rabbitmq/rabbitmq.conf contains variable settings that override the
defaults built in to the RabbitMQ startup scripts.
The file is interpreted by the system shell, and so should consist of
@@ -13,29 +13,40 @@ syntax is permitted (since the file is sourced using the shell "."
operator), including line comments starting with "#".
In order of preference, the startup scripts get their values from the
-environment, from /etc/default/rabbitmq, and finally from the built-in
-default values. For example, for the B<RABBITMQ_NODENAME> setting,
+environment, from /etc/default/rabbitmq (if starting through the standard
+init.d script), from /etc/rabbitmq/rabbitmq.conf and finally from the
+built-in default values. For example, for the B<RABBITMQ_NODENAME> setting,
B<RABBITMQ_NODENAME>
- from the environment is checked first. If it is absent or equal
- to the empty string, then
+ from the environment is checked first. If it is absent or equal to the
+ empty string, then
+
+B<INITD_NODENAME>
+ from /etc/default/rabbitmq is checked next, only if the server is
+ started through the standard init.d script. If it is also absent or set
+ equal to the empty string, then
B<NODENAME>
- from /etc/default/rabbitmq is checked next. If it is also absent
- or set equal to the empty string, then the default value from the
- startup script is used.
+ from /etc/rabbitmq/rabbitmq.conf is checked. If that is also absent or
+ set equal to the empty string then the default value from the startup
+ script is used.
+
+The variable names in /etc/rabbitmq/rabbitmq.conf are always equal to the
+environment variable names, with the B<RABBITMQ_> prefix removed.
+Similarly, variable names in /etc/default/rabbitmq (loaded only when
+starting through the init.d script) are always equal to the environmental
+variable names, with the B<RABBITMQ_> prefix substituted by B<INITD_>:
-The variable names in /etc/default/rabbitmq are always equal to the
-environment variable names, with the B<RABBITMQ_> prefix removed:
-B<RABBITMQ_NODE_PORT> from the environment becomes B<NODE_PORT> in the
-/etc/default/rabbitmq file, etc.
+B<RABBITMQ_NODE_PORT> from the environment becomes B<INITD_NODE_PORT> in
+the /etc/default/rabbitmq and B<NODE_PORT> in the
+/etc/rabbitmq/rabbitmq.conf file, etc.
=head1 EXAMPLES
-The following is an example of a complete /etc/default/rabbitmq file
+The following is an example of a complete /etc/rabbitmq/rabbitmq.conf file
that overrides the default Erlang node name from "rabbit" to "hare":
- # I am a complete /etc/default/rabbitmq file.
+ # I am a complete /etc/rabbitmq/rabbitmq.conf file.
# Comment lines start with a hash character.
# This is a /bin/sh script file - use ordinary envt var syntax
NODENAME=hare
@@ -46,7 +57,7 @@ rabbitmq-server(1), rabbitmq-multi(1), rabbitmqctl(1)
=head1 AUTHOR
-Originally written by The RabbitMQ Team <info@lshift.net>
+Originally written by The RabbitMQ Team <info@rabbitmq.com>
=head1 COPYRIGHT