summaryrefslogtreecommitdiff
path: root/docs/rabbitmq-server.1.pod
blob: d74ab8d94fd2a588f01c61a5cad0f1fe7776af79 (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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
=head1 NAME

rabbitmq-server - start RabbitMQ AMQP server

=head1 SYNOPSIS

rabbitmq-server [-detached]

=head1 DESCRIPTION

RabbitMQ is an implementation of AMQP, the emerging standard for high
performance enterprise messaging. The RabbitMQ server is a robust and
scalable implementation of an AMQP broker.

Running rabbitmq-server in the foreground displays a banner message,
and reports on progress in the startup sequence, concluding with the
message "broker running", indicating that the RabbitMQ broker has been
started successfully. To shut down the server, just terminate the
process or use L<rabbitmqctl(1)>.

=head1 ENVIRONMENT

=over

=item B<RABBITMQ_MNESIA_BASE>

Defaults to F</var/lib/rabbitmq/mnesia>. Set this to the directory where
Mnesia database files should be placed.

=item B<RABBITMQ_LOG_BASE>

Defaults to F</var/log/rabbitmq>. Log files generated by the server will
be placed in this directory.

=item B<RABBITMQ_NODENAME>

Defaults to rabbit. This can be useful if you want to run more than
one node per machine - B<RABBITMQ_NODENAME> should be unique per
erlang-node-and-machine combination. See clustering on a single
machine guide at
L<http://www.rabbitmq.com/clustering.html#single-machine> for details.

=item B<RABBITMQ_NODE_IP_ADDRESS>

Defaults to 0.0.0.0. This can be changed if you only want to bind to
one network interface.

=item B<RABBITMQ_NODE_PORT>

Defaults to 5672. 

=item B<RABBITMQ_CLUSTER_CONFIG_FILE>

Defaults to F</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 L<http://www.rabbitmq.com/clustering.html>
for details.

=back

=head1 OPTIONS

=over

=item B<-detached>

start the server process in the background

=back

=head1 EXAMPLES

Run RabbitMQ AMQP server in the background:

          rabbitmq-server -detached

=head1 SEE ALSO

L<rabbitmq.conf(5)>, L<rabbitmq-multi(1)>, L<rabbitmqctl(1)>

=head1 AUTHOR

The RabbitMQ Team <info@rabbitmq.com>

=head1 REFERENCES

RabbitMQ Web Site: L<http://www.rabbitmq.com>