Portainer Templates logo

Portainer Templates

RabbitMQ (stack) RabbitMQ (stack)

Streaming Messaging

3-node RabbitMQ 4.x cluster (quorum-queue ready), deployable locally with plain Docker Compose or to Miget as a compose stack.

Configuration

Type
Compose
Platform
linux
Source
Repo

Template by deployable-sh·Source

Report issue

Services

rmq-1

Configuration

Image
miget-rabbitmq:local
Ports
5000:50005672436925672
Volumes
/var/lib/rabbitmq/mnesia : rmqdata-1
Env vars
RABBITMQ_NODENAME=rabbit@rmq-1
Restart
unless-stopped
Build
.

rmq-2

Configuration

Image
miget-rabbitmq:local
Ports
50005672436925672
Volumes
/var/lib/rabbitmq/mnesia : rmqdata-2
Env vars
RABBITMQ_NODENAME=rabbit@rmq-2
Restart
unless-stopped
Build
.

rmq-3

Configuration

Image
miget-rabbitmq:local
Ports
50005672436925672
Volumes
/var/lib/rabbitmq/mnesia : rmqdata-3
Env vars
RABBITMQ_NODENAME=rabbit@rmq-3
Restart
unless-stopped
Build
.

Standalone Install

Select an install method, to see config/commands for deploying RabbitMQ (stack)

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select RabbitMQ (stack), fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo
Original stackfile

The compose file this template deploys, straight from its repo:

name: rabbitmq

x-rmq: &rmq
  build: .
  image: miget-rabbitmq:local
  restart: unless-stopped

services:
  rmq-1:
    healthcheck:
      test: ["CMD", "rabbitmq-diagnostics", "-q", "ping"]
      interval: 30s
      timeout: 5s
      retries: 5
      start_period: 30s
    <<: *rmq
    hostname: rmq-1
    environment:
      RABBITMQ_NODENAME: rabbit@rmq-1
    ports:
      - "5000:5000"
      - "5672"
      - "4369"
      - "25672"
    volumes:
      - rmqdata-1:/var/lib/rabbitmq/mnesia

  rmq-2:
    healthcheck:
      test: ["CMD", "rabbitmq-diagnostics", "-q", "ping"]
      interval: 30s
      timeout: 5s
      retries: 5
      start_period: 30s
    <<: *rmq
    hostname: rmq-2
    environment:
      RABBITMQ_NODENAME: rabbit@rmq-2
    ports:
      - "5000"
      - "5672"
      - "4369"
      - "25672"
    volumes:
      - rmqdata-2:/var/lib/rabbitmq/mnesia

  rmq-3:
    healthcheck:
      test: ["CMD", "rabbitmq-diagnostics", "-q", "ping"]
      interval: 30s
      timeout: 5s
      retries: 5
      start_period: 30s
    <<: *rmq
    hostname: rmq-3
    environment:
      RABBITMQ_NODENAME: rabbit@rmq-3
    ports:
      - "5000"
      - "5672"
      - "4369"
      - "25672"
    volumes:
      - rmqdata-3:/var/lib/rabbitmq/mnesia

volumes:
  rmqdata-1:
  rmqdata-2:
  rmqdata-3:

Or deploy it directly from the source:

git clone https://github.com/deployable-sh/stacks
cd stacks
docker compose -f rabbitmq/compose.yaml up -d

More install options in our documentation.

Serve RabbitMQ (stack) on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying rabbitmq-stack.example.com to http://rmq-1:5000

Add this to your Caddyfile

rabbitmq-stack.example.com {
	reverse_proxy http://rmq-1:5000
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs <container>
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:5000 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :5000
  • Stop the other service, or pick a different host port. In 5000:5000 only the left number is yours to change, the right one belongs to the app.

Published on a random port

This template exposes 5672 without setting a host port, so Docker picks a random free one on every deploy.

  • Find it in the Ports column of Portainer's container list, or with docker port <container>

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:5000. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, rabbitmq can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 5000

Image won't pull

Test the pull directly on the host: docker pull miget-rabbitmq:local

  • "manifest unknown" means the tag no longer exists.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect <container> --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Stack won't deploy

Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.

  • YAML only accepts spaces for indentation, a single tab breaks the whole file.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A Compose stack

RabbitMQ (stack) is a Compose stack, a set of containers (3 of them) defined in one file and brought up together by Portainer, then started and stopped as a single app.

The services

This stack is built from 3 containers that run side by side. Here's each one, with the image it runs and anything it waits for first:

  • rmq-1 runs miget-rabbitmq:local
  • rmq-2 runs miget-rabbitmq:local
  • rmq-3 runs miget-rabbitmq:local

Ports

A port is the door the app answers on. A mapping like 5000:5000 means it's reachable on port 5000 of your server, where the left number is yours to change and the right one belongs to the app. It opens:

  • 5000:5000
  • 5672, published on a random host port
  • 4369, published on a random host port
  • 25672, published on a random host port
  • 5000, published on a random host port
  • 5672, published on a random host port
  • 4369, published on a random host port
  • 25672, published on a random host port
  • 5000, published on a random host port
  • 5672, published on a random host port
  • 4369, published on a random host port
  • 25672, published on a random host port

Volumes

A volume is where RabbitMQ (stack) keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /var/lib/rabbitmq/mnesia kept in the rmqdata-1 volume Docker manages
  • /var/lib/rabbitmq/mnesia kept in the rmqdata-2 volume Docker manages
  • /var/lib/rabbitmq/mnesia kept in the rmqdata-3 volume Docker manages

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. RabbitMQ (stack) takes 1 of them, all with defaults you can leave alone or tweak:

  • RABBITMQ_NODENAME, defaults to rabbit@rmq-3

Restart policy

The restart policy here is unless-stopped, so Docker restarts RabbitMQ (stack) after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Networking

Portainer puts these services on one shared private network, so they can find each other by name (like rmq-1) while only the ports above are open to you.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set RabbitMQ (stack) up. Add the template list to Portainer once, then deploying RabbitMQ (stack) is a click rather than a wall of config.