LavinMQ LavinMQ logo
LavinMQ logo
Home Documentation Blog Community
Get started
GitHub Repository

LavinMQ installation guide

Latest stable version: v2.3.0

Check out the changelog for an overview of releases.

How to build LavinMQ from GitHub

LavinMQ is written in the Crystal programming language. It needs Crystal installed to compile.

To build LavinMQ you must first install Crystal. This can be done for a number of platforms by following the instructions on the Crystal site.

Once Crystal is installed you can clone the repo from GitHub and build it with

shards build --release --production
git clone git@github.com:cloudamqp/lavinmq.git
cd lavinmq
shards build --release --production
install bin/lavinmq /usr/local/bin/lavinmq

Now, LavinMQ is ready to be used. You can check the version with:

lavinmq -v

# v2.3.0

Installing LavinMQ on Ubuntu

LavinMQ is a modern message broker that uses the AMQP protocol. It is written in the Crystal programming language. Installation in Ubuntu is a one-step process using Ubuntu’s package manager APT.

System Requirements

LavinMQ is supported on Ubuntu 18.04 and 20.04. Supported processors include ARM, x86_64, and amd64. We recommend using xfs file systems, but ext4 is also supported.

Installation process

LavinMQ releases are hosted in packagecloud. First, you will need a key to access the repository. Evaluate the following commands in a terminal:

curl -L https://packagecloud.io/cloudamqp/lavinmq/gpgkey | sudo apt-key add -
echo "deb https://packagecloud.io/cloudamqp/lavinmq/ubuntu/ $(lsb_release -cs) main" | sudo tee /etc/apt/sources.list.d/lavinmq.list

Now, LavinMQ is ready to be installed. Evaluate the following inputs in a terminal:

sudo apt update
sudo apt install lavinmq

Configuration

After LavinMQ has been installed, it will be running as a service. The ports needed for LavinMQ are 5671 (amqp with TLS), 5672 (amqp), and 15672 (management interface).

Stopping/starting/restarting can be done by using Ubuntu’s service command. For example, to restart the service evaluate this:

service lavinmq restart

The default user for LavinMQ has the username guest with a password set to guest. This user can be deleted using the lavinmqctl CLI or by using the management interface. Additional users can be added in the same way.

Additional configuration settings can be changed in the LavinMQ configuration file, which will be installed in /etc/lavinmq for Ubuntu machines.

Install LavinMQ on MacOS

OS X users can install LavinMQ with brew:

brew install cloudamqp/cloudamqp/lavinmq

Running LavinMQ with Docker

You can run LavinMQ using Docker. Images are available on Docker Hub at cloudamqp/lavinmq

Fetch and run the latest version with:

docker run --rm -it -P -v /var/lib/lavinmq:/tmp/amqp cloudamqp/lavinmq

You can now start publishing and consuming messages at amqp://guest:guest@localhost, and access the management UI by visiting http://localhost:15672

Visit cloudamqp/lavinmq on Docker Hub to learn more.

Ready to take the next steps? Here are some things you should keep in mind:

Managed LavinMQ instance on CloudAMQP

LavinMQ has been built with performance and ease of use in mind - we've benchmarked a throughput of about 1,000,000 messages/sec. You can try LavinMQ without any installation hassle by creating a free instance on CloudAMQP. Signing up is a breeze.

Help and feedback

We welcome your feedback and are eager to address any questions you may have about this piece or using LavinMQ. Join our Slack channel to connect with us directly. You can also find LavinMQ on GitHub.