summaryrefslogtreecommitdiff
path: root/docs/rabbitmq-service.pod
blob: 6805c8d4b585f2e139d008f5023611b6f78e4fa4 (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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
=head1 NAME

rabbitmq-service - manage RabbitMQ AMQP service

=head1 SYNOPSIS

rabbitmq-service I<command>

=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-service allows the RabbitMQ broker to be run as a
service on NT/2000/2003/XP/Vista® environments. The RabbitMQ broker 
service can be started and stopped using the Windows® services 
applet. 

By default the service will run in the authentication context of the 
local system account. It is therefore necessary to synchronise Erlang
cookies between the local system account (typically 
C<C:\WINDOWS\.erlang.cookie> and the account that will be used to
run rabbitctl.

=head1 COMMANDS

B<help> 
    Display usage information.

B<install> 
    Install the service. The service will not be started.
    Subsequent invocations will update the service parameters if
    relevant environment variables were modified.

B<remove> 
    Remove the service. If the service is running then it will
    automatically be stopped before being removed. No files will be
    deleted as a consequence and I<rabbitmq-server> will remain operable.

B<start> 
    Start the service. The service must have been correctly installed
    beforehand. 

B<stop> 
    Stop the service. The service must be running.

B<disable> 
    Disable the service. This is the equivalent of setting the startup
    type to I<Disabled> using the service control panel.

B<enable> 
    Enable the service. This is the equivalent of setting the startup
    type to I<Automatic> using the service control panel.

=head1 ENVIRONMENT

B<SERVICENAME>
    Defaults to RabbitMQ.
    This is the location of log and database directories.

B<RABBITMQ_BASE>
    Defaults to the application data directory of the current user.
    This is the location of log and database directories.

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

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

B<NODE_PORT>
    Defaults to 5672. 

B<ERLANG_SERVICE_MANAGER_PATH>
    Defaults to C<C:\Program Files\erl5.5.5\erts-5.5.5\bin>. This is 
    the installation location of the Erlang service manager.

B<CLUSTER_CONFIG_FILE>
    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 for details.


=head1 EXAMPLES

Start a previously-installed RabbitMQ AMQP service:

          rabbitmq-service start

=head1 SEE ALSO

rabbitmq-service(1), rabbitmqctl(1)

=head1 AUTHOR

Originally written by The RabbitMQ Team <info@lshift.net>

=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