diff options
author | dcorbacho <dparracorbacho@piotal.io> | 2020-11-18 14:27:41 +0000 |
---|---|---|
committer | dcorbacho <dparracorbacho@piotal.io> | 2020-11-18 14:27:41 +0000 |
commit | f23a51261d9502ec39df0f8db47ba6b22aa7659f (patch) | |
tree | 53dcdf46e7dc2c14e81ee960bce8793879b488d3 /deps/rabbit/docs/rabbitmq-server.8 | |
parent | afa2c2bf6c7e0e9b63f4fb53dc931c70388e1c82 (diff) | |
parent | 9f6d64ec4a4b1eeac24d7846c5c64fd96798d892 (diff) | |
download | rabbitmq-server-git-stream-timestamp-offset.tar.gz |
Merge remote-tracking branch 'origin/master' into stream-timestamp-offsetstream-timestamp-offset
Diffstat (limited to 'deps/rabbit/docs/rabbitmq-server.8')
-rw-r--r-- | deps/rabbit/docs/rabbitmq-server.8 | 98 |
1 files changed, 98 insertions, 0 deletions
diff --git a/deps/rabbit/docs/rabbitmq-server.8 b/deps/rabbit/docs/rabbitmq-server.8 new file mode 100644 index 0000000000..6a5e411cb3 --- /dev/null +++ b/deps/rabbit/docs/rabbitmq-server.8 @@ -0,0 +1,98 @@ +.\" 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-2020 VMware, Inc. or its affiliates. All rights reserved. +.\" +.Dd September 28, 2019 +.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/configure.html "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/relocate.html "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/logging.html "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/clustering.html "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/networking.html "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/networking.html "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-upgrade 8 , +.Xr rabbitmq-service 8 , +.Xr rabbitmq-env.conf 5 , +.Xr rabbitmq-echopid 8 +.\" ------------------------------------------------------------------ +.Sh AUTHOR +.\" ------------------------------------------------------------------ +.An The RabbitMQ Team Aq Mt info@rabbitmq.com |