Self-host Rocket.Chat with Docker Compose

Selbstgehostete Team-Chat-Plattform für Messaging, Sprachanrufe und Video.

rocket-chat

mongodb

mongo:8

mongodb-mongodb-data-init

busybox

mongodb-mongodb-tmp-init

busybox

This is still a work in progress.

The generated compose file and instructions may not be complete or correct for every app yet. Please report any issues you encounter to contact@bitflake.com.

The steps below take a few minutes end to end.

Docker compose setup and file
save the generated compose and env files.
Start Rocket.Chat with Docker Compose
bring the stack up and check it's healthy.

Requirements

You'll need these installed on the machine you're deploying to:

Docker

Packages Rocket.Chat and everything it depends on into an isolated container, so it runs the same way on your machine as it does everywhere else.

Install guide

Docker Compose

Reads docker-compose.ymland starts everything in it together. Ships with Docker Desktop. On Linux servers it's usually a separate install.

Install guide

1. Docker compose setup and file

Create a folder for Rocket.Chat and save the file below into it as docker-compose.yml. It describes every container the stack needs — Rocket.Chatitself and any supporting services, such as its database — along with the ports, volumes and environment variables each one uses. You'll also need an empty .env file in the same folder; Docker Compose reads it automatically and uses it to fill in the ${VARIABLE}references you'll see in the file below.

docker-compose.yml

version: "3.9"
services:
  mongodb:
    image: mongo:8
    restart: unless-stopped
    volumes:
      - mongodb-data:/data/db
      - mongodb-tmp:/tmp
    depends_on:
      mongodb-mongodb-data-init:
        condition: service_completed_successfully
      mongodb-mongodb-tmp-init:
        condition: service_completed_successfully
    entrypoint:
      - sh
      - -c
    command:
      - mongod --replSet rs0 --bind_ip_all & MONGO_PID=$$! ; until mongosh --quiet --eval 'db.runCommand({ping:1})' >/dev/null 2>&1; do sleep 1; done ; mongosh --eval "try { rs.status() } catch(e) { rs.initiate({_id:'rs0',members:[{_id:0,host:'localhost:27017'}]}) }" >/dev/null 2>&1 || true ; wait $$MONGO_PID
  mongodb-mongodb-data-init:
    image: busybox
    volumes:
      - mongodb-data:/data/db
    command:
      - chown
      - 999:999
      - /data/db
  mongodb-mongodb-tmp-init:
    image: busybox
    volumes:
      - mongodb-tmp:/tmp
    command:
      - chown
      - 999:999
      - /tmp
  rocket-chat:
    image: rocketchat/rocket.chat:latest
    restart: unless-stopped
    ports:
      - 3000:3000
    environment:
      MONGO_OPLOG_URL: mongodb://mongodb:27017/local?replicaSet=rs0
      MONGO_URL: mongodb://mongodb:27017/app?replicaSet=rs0
      ROOT_URL: http://rocket-chat.localhost:3000
    volumes:
      - uploads:/app/uploads
      - tmp:/tmp
    depends_on:
      mongodb:
        condition: service_started
volumes:
  mongodb-data: null
  mongodb-tmp: null
  tmp: null
  uploads: null

Volumes

Rocket.Chat stores its data in named Docker volumes, so it survives container restarts and updates:

uploads mounted at /app/uploads: Rocket.Chat's uploaded files and message attachments when stored on the local filesystem.
tmp mounted at /tmp: Temporary working space, including the Apps-Engine's extraction directory and upload staging.

2. Start Rocket.Chat with Docker Compose

From the folder with docker-compose.yml and .env, run:

Terminal

Start Rocket.Chat and all its supporting services in the background.

docker compose up -d

The -d flag runs the stack in the background so it keeps running after you close the terminal. Docker will pull the images the first time, which can take a minute or two.

To check on it afterwards: docker compose ps shows whether containers are healthy, and docker compose logs -f follows their logs if something looks wrong. Once it's running, open http://localhost:3000 in your browser.