components/rabbitmq/files/rabbitmq-env.conf.5
changeset 1484 01108fd9c6ef
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/components/rabbitmq/files/rabbitmq-env.conf.5	Wed Sep 25 14:55:34 2013 -0700
@@ -0,0 +1,82 @@
+'\" t
+.\"     Title: rabbitmq-env.conf
+.\"    Author: The RabbitMQ Team <[email protected]>
+.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
+.\"      Date: 05/10/2013
+.\"    Manual: RabbitMQ Server
+.\"    Source: RabbitMQ Server
+.\"  Language: English
+.\"
+.TH "RABBITMQ\-ENV\&.CONF" "5" "05/10/2013" "RabbitMQ Server" "RabbitMQ Server"
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+rabbitmq-env.conf \- default settings for RabbitMQ AMQP server
+.SH "DESCRIPTION"
+.PP
+
+/etc/rabbitmq/rabbitmq\-env\&.conf
+contains variable settings that override the defaults built in to the RabbitMQ startup scripts\&.
+.PP
+The file is interpreted by the system shell, and so should consist of a sequence of shell environment variable definitions\&. Normal shell syntax is permitted (since the file is sourced using the shell "\&." operator), including line comments starting with "#"\&.
+.PP
+In order of preference, the startup scripts get their values from the environment, from
+/etc/rabbitmq/rabbitmq\-env\&.conf
+and finally from the built\-in default values\&. For example, for the
+\fBRABBITMQ_NODENAME\fR
+setting,
+.PP
+
+\fBRABBITMQ_NODENAME\fR
+.PP
+from the environment is checked first\&. If it is absent or equal to the empty string, then
+.PP
+
+\fBNODENAME\fR
+.PP
+from
+/etc/rabbitmq/rabbitmq\-env\&.conf
+is checked\&. If it is also absent or set equal to the empty string then the default value from the startup script is used\&.
+.PP
+The variable names in /etc/rabbitmq/rabbitmq\-env\&.conf are always equal to the environment variable names, with the
+\fBRABBITMQ_\fR
+prefix removed:
+\fBRABBITMQ_NODE_PORT\fR
+from the environment becomes
+\fBNODE_PORT\fR
+in the
+/etc/rabbitmq/rabbitmq\-env\&.conf
+file, etc\&.
+.sp
+.fi
+.SH "SEE ALSO"
+.PP
+
+\fBrabbitmq-server\fR(1)
+\fBrabbitmqctl\fR(1)
+.SH "EXAMPLES"
+.sp
+.nf
+      \fB
+# I am a complete /etc/rabbitmq/rabbitmq\-env\&.conf file\&.
+# Comment lines start with a hash character\&.
+# This is a /bin/sh script file \- use ordinary envt var syntax
+NODENAME=hare
+        \fR
+    
+.fi
+.PP
+This is an example of a complete
+/etc/rabbitmq/rabbitmq\-env\&.conf
+file that overrides the default Erlang node name from "rabbit" to "hare"\&.
+.SH "AUTHOR"
+.PP
+\fBThe RabbitMQ Team <\fR\fB\fBinfo@rabbitmq\&.com\fR\fR\fB>\fR