1RABBITMQ-SERVICE.BAT(8) BSD System Manager's Manual RABBITMQ-SERVICE.BAT(8)
2
4 rabbitmq-service.bat — tool for managing RabbitMQ Windows service
5
7 rabbitmq-service.bat [command]
8
10 RabbitMQ is an open source multi-protocol messaging broker.
11 Running rabbitmq-service.bat allows the RabbitMQ broker to be run as a
13 service in Windows® environments. The RabbitMQ broker service can be
14 started and stopped using the Windows® services panel.
15 By default the service will run in the authentication context of the
17 local system account. It is therefore necessary to synchronise Erlang
18 cookies between the local system account (typically
19 C:\Windows\.erlang.cookie and the account that will be used to run
20 rabbitmqctl(8).
21
23 help Display usage information.
24 install
26 Install the service. The service will not be started. Subse‐
27 quent invocations will update the service parameters if relevant
28 environment variables were modified.
29 remove Remove the service. If the service is running then it will auto‐
31 matically be stopped before being removed. No files will be
32 deleted as a consequence and rabbitmq-server(8) will remain oper‐
33 able.
34 start Start the service. The service must have been correctly
36 installed beforehand.
37 stop Stop the service. The service must be running for this command
39 to have any effect.
40 disable
42 Disable the service. This is the equivalent of setting the
43 startup type to Disabled using the service control panel.
44 enable Enable the service. This is the equivalent of setting the
46 startup type to Automatic using the service control panel.
47
49 RABBITMQ_SERVICENAME
50 Defaults to RabbitMQ.
51 RABBITMQ_BASE
53 Note: Windows only. Defaults to the application data directory of
54 the current user. This is the location of log and database direc‐
55 tories.
56 RABBITMQ_NODENAME
58 Defaults to "rabbit@". followed by the computed hostname. Can
59 be used to run multiple nodes on the same host. Every node in a
60 cluster must have a unique RABBITMQ_NODENAME To learn more, see
61 the RabbitMQ Clustering guide:
62 https://www.rabbitmq.com/clustering.html
63 RABBITMQ_NODE_IP_ADDRESS
65 By default RabbitMQ will bind to all IPv6 and IPv4 interfaces
66 available. This variable limits the node to one network inter‐
67 face or address family. To learn more, see the RabbitMQ
68 Networking guide:
69 https://www.rabbitmq.com/networking.html
70 RABBITMQ_NODE_PORT
72 AMQP 0-9-1 and AMQP 1.0 port. Defaults to 5672. To learn more,
73 see the RabbitMQ Networking guide:
74 https://www.rabbitmq.com/networking.html
75 ERLANG_SERVICE_MANAGER_PATH
77 Defaults to C:\Program Files\erl{version}\erts-{version}\bin (or
78 C:\Program Files (x86)\erl{version}\erts-{version}\bin for 64-bit
79 environments). This is the installation location of the Erlang
80 service manager.
81 RABBITMQ_CONSOLE_LOG
83 Set this variable to new or reuse to have the console output from
84 the server redirected to a file named SERVICENAME.debug in the
85 application data directory of the user that installed the ser‐
86 vice. Under Vista this will be
87 C:\Users\AppData\username\SERVICENAME. Under previous versions
88 of Windows this will be C:\Documents and
89 Settings\username\Application Data\SERVICENAME. If
90 RABBITMQ_CONSOLE_LOG is set to new then a new file will be cre‐
91 ated each time the service starts. If RABBITMQ_CONSOLE_LOG is
92 set to reuse then the file will be overwritten each time the ser‐
93 vice starts. The default behaviour when RABBITMQ_CONSOLE_LOG is
94 not set or set to a value other than new or reuse is to discard
95 the server output.
96
98 rabbitmqctl(8), rabbitmq-diagnostics(8), rabbitmq-plugins(8),
99 rabbitmq-server(8), rabbitmq-env.conf(5), rabbitmq-echopid(8)
100
102 The RabbitMQ Team <info@rabbitmq.com>
103RabbitMQ Server January 25, 2019 RabbitMQ Server