summaryrefslogtreecommitdiff
path: root/docs/rabbitmq.5.pod
blob: 6def480790f6677e588fde09ea455e6a265ebe5b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
=head1 NAME

/etc/rabbitmq/rabbitmq.conf - default settings for RabbitMQ AMQP server

=head1 DESCRIPTION

/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
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 "#".

In order of preference, the startup scripts get their values from the
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 

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/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_>:

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/rabbitmq/rabbitmq.conf file
that overrides the default Erlang node name from "rabbit" to "hare":

    # 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

=head1 SEE ALSO

rabbitmq-server(1), rabbitmq-multi(1), rabbitmqctl(1)

=head1 AUTHOR

Originally written by The RabbitMQ Team <info@rabbitmq.com>

=head1 COPYRIGHT

This package, the RabbitMQ server is licensed under the MPL.

If you have any questions regarding licensing, please contact us at 
info@rabbitmq.com.

=head1 REFERENCES

RabbitMQ Web Site: http://www.rabbitmq.com