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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.docbook.org/xml/4.5/docbookx.dtd">
<refentry lang="en">
<refentryinfo>
<productname>RabbitMQ Server</productname>
<authorgroup>
<corpauthor>The RabbitMQ Team <<ulink url="mailto:info@rabbitmq.com"><email>info@rabbitmq.com</email></ulink>></corpauthor>
</authorgroup>
</refentryinfo>
<refmeta>
<refentrytitle>rabbitmq-service.bat</refentrytitle>
<refmiscinfo class="manual">RabbitMQ Server</refmiscinfo>
</refmeta>
<refnamediv>
<refname>rabbitmq-service.bat</refname>
<refpurpose>manage RabbitMQ AMQP service</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>rabbitmq-service.bat</command>
<arg choice="opt">command</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
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.
</para>
<para>
Running <command>rabbitmq-service</command> 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.
</para>
<para>
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
<filename>C:\WINDOWS\.erlang.cookie</filename> and the account that will be used to
run <command>rabbitmqctl</command>.
</para>
</refsect1>
<refsect1>
<title>Commands</title>
<variablelist>
<varlistentry>
<term>help</term>
<listitem>
<para>
Display usage information.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>install</term>
<listitem>
<para>
Install the service. The service will not be started.
Subsequent invocations will update the service parameters if
relevant environment variables were modified or if the active
plugins were changed.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>remove</term>
<listitem>
<para>
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 <command>rabbitmq-server</command> will remain operable.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>start</term>
<listitem>
<para>
Start the service. The service must have been correctly installed
beforehand.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>stop</term>
<listitem>
<para>
Stop the service. The service must be running for this command to
have any effect.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>disable</term>
<listitem>
<para>
Disable the service. This is the equivalent of setting the startup
type to <code>Disabled</code> using the service control panel.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>enable</term>
<listitem>
<para>
Enable the service. This is the equivalent of setting the startup
type to <code>Automatic</code> using the service control panel.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Environment</title>
<variablelist>
<varlistentry>
<term>RABBITMQ_SERVICENAME</term>
<listitem>
<para>
Defaults to RabbitMQ.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>RABBITMQ_BASE</term>
<listitem>
<para>
Defaults to the application data directory of the current user.
This is the location of log and database directories.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>RABBITMQ_NODENAME</term>
<listitem>
<para>
Defaults to rabbit. This can be useful if you want to run more than
one node per machine - <envar>RABBITMQ_NODENAME</envar> should be unique per
erlang-node-and-machine combination. See the
<ulink url="http://www.rabbitmq.com/clustering.html#single-machine">clustering on a single
machine guide</ulink> for details.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>RABBITMQ_NODE_IP_ADDRESS</term>
<listitem>
<para>
By default RabbitMQ will bind to all interfaces, on IPv4 and IPv6 if
available. Set this if you only want to bind to one network interface
or address family.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>RABBITMQ_NODE_PORT</term>
<listitem>
<para>
Defaults to 5672.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ERLANG_SERVICE_MANAGER_PATH</term>
<listitem>
<para>
Defaults to <filename>C:\Program Files\erl5.5.5\erts-5.5.5\bin</filename>
(or <filename>C:\Program Files (x86)\erl5.5.5\erts-5.5.5\bin</filename> for 64-bit
environments). This is the installation location of the Erlang service
manager.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>RABBITMQ_CONSOLE_LOG</term>
<listitem>
<para>
Set this varable to <code>new</code> or <code>reuse</code> to have the console
output from the server redirected to a file named <code>SERVICENAME</code>.debug
in the application data directory of the user that installed the service.
Under Vista this will be <filename>C:\Users\AppData\username\SERVICENAME</filename>.
Under previous versions of Windows this will be
<filename>C:\Documents and Settings\username\Application Data\SERVICENAME</filename>.
If <code>RABBITMQ_CONSOLE_LOG</code> is set to <code>new</code> then a new file will be
created each time the service starts. If <code>RABBITMQ_CONSOLE_LOG</code> is
set to <code>reuse</code> then the file will be overwritten each time the
service starts. The default behaviour when <code>RABBITMQ_CONSOLE_LOG</code> is
not set or set to a value other than <code>new</code> or <code>reuse</code> is to discard
the server output.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
</refentry>
|
