100 lines
3.6 KiB
Groff
100 lines
3.6 KiB
Groff
.\" vim:ft=nroff:
|
|
.\" This Source Code Form is subject to the terms of the Mozilla Public
|
|
.\" License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
.\" file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
|
.\"
|
|
.\" Copyright (c) 2007-2025 Broadcom. All Rights Reserved. The term “Broadcom” refers to Broadcom Inc. and/or its subsidiaries. All rights reserved.
|
|
.\"
|
|
.Dd June 22, 2023
|
|
.Dt RABBITMQ-SERVER 8
|
|
.Os "RabbitMQ Server"
|
|
.Sh NAME
|
|
.Nm rabbitmq-server
|
|
.Nd starts a RabbitMQ node
|
|
.\" ------------------------------------------------------------------
|
|
.Sh SYNOPSIS
|
|
.\" ------------------------------------------------------------------
|
|
.Nm
|
|
.Op Fl detached
|
|
.\" ------------------------------------------------------------------
|
|
.Sh DESCRIPTION
|
|
.\" ------------------------------------------------------------------
|
|
RabbitMQ is an open source multi-protocol messaging broker.
|
|
.Pp
|
|
Running
|
|
.Nm
|
|
starts a RabbitMQ node in the foreground. The node will display a startup
|
|
banner and report when startup is complete.
|
|
To shut down the server, use service management tools or
|
|
.Xr rabbitmqctl 8 .
|
|
.\" ------------------------------------------------------------------
|
|
.Sh ENVIRONMENT
|
|
.\" ------------------------------------------------------------------
|
|
.Bl -tag -width Ds
|
|
.It Ev RABBITMQ_CONFIG_FILE
|
|
Defaults to
|
|
.Pa /etc/rabbitmq/rabbitmq.conf .
|
|
Node configuration file path.
|
|
To learn more, see the
|
|
.Lk https://www.rabbitmq.com/docs/configure "RabbitMQ Configuration guide"
|
|
.It Ev RABBITMQ_MNESIA_BASE
|
|
Defaults to
|
|
.Pa /var/lib/rabbitmq/mnesia .
|
|
Node data directory will be located (or created) in this directory.
|
|
To learn more, see the
|
|
.Lk https://www.rabbitmq.com/docs/relocate "RabbitMQ File and Directory guide"
|
|
.It Ev RABBITMQ_LOG_BASE
|
|
Defaults to
|
|
.Pa /var/log/rabbitmq .
|
|
Log files generated by the server will be placed in this directory.
|
|
To learn more, see the
|
|
.Lk https://www.rabbitmq.com/docs/logging "RabbitMQ Logging guide"
|
|
.It Ev RABBITMQ_NODENAME
|
|
Defaults to
|
|
.Qq rabbit@ .
|
|
followed by the computed hostname.
|
|
Can be used to run multiple nodes on the same host.
|
|
Every node in a cluster must have a unique
|
|
.Ev RABBITMQ_NODENAME
|
|
To learn more, see the
|
|
.Lk https://www.rabbitmq.com/docs/clustering "RabbitMQ Clustering guide"
|
|
.It Ev RABBITMQ_NODE_IP_ADDRESS
|
|
By default RabbitMQ will bind to all IPv6 and IPv4 interfaces available.
|
|
This variable limits the node to one network interface or address
|
|
family.
|
|
To learn more, see the
|
|
.Lk https://www.rabbitmq.com/docs/networking "RabbitMQ Networking guide"
|
|
.It Ev RABBITMQ_NODE_PORT
|
|
AMQP 0-9-1 and AMQP 1.0 port. Defaults to 5672.
|
|
To learn more, see the
|
|
.Lk https://www.rabbitmq.com/docs/networking "RabbitMQ Networking guide"
|
|
.El
|
|
.\" ------------------------------------------------------------------
|
|
.Sh OPTIONS
|
|
.\" ------------------------------------------------------------------
|
|
.Bl -tag -width Ds
|
|
.It Fl detached
|
|
Start the server process in the background.
|
|
Note that this will cause the pid not to be written to the pid file.
|
|
.Pp
|
|
For example, runs RabbitMQ AMQP server in the background:
|
|
.sp
|
|
.Dl rabbitmq-server -detached
|
|
.El
|
|
.\" ------------------------------------------------------------------
|
|
.Sh SEE ALSO
|
|
.\" ------------------------------------------------------------------
|
|
.Xr rabbitmqctl 8 ,
|
|
.Xr rabbitmq-diagnostics 8 ,
|
|
.Xr rabbitmq-plugins 8 ,
|
|
.Xr rabbitmq-queues 8 ,
|
|
.Xr rabbitmq-streams 8 ,
|
|
.Xr rabbitmq-upgrade 8 ,
|
|
.Xr rabbitmq-service 8 ,
|
|
.Xr rabbitmq-env.conf 5 ,
|
|
.Xr rabbitmq-echopid 8
|
|
.\" ------------------------------------------------------------------
|
|
.Sh AUTHOR
|
|
.\" ------------------------------------------------------------------
|
|
.An The RabbitMQ Team Aq Mt contact-tanzu-data.pdl@broadcom.com
|