Portainer Templates logo

Portainer Templates

Chatwoot Chatwoot

Stack

Business Apps

Chatwoot - open-source customer support: shared team inbox, website live-chat widget, email and social channels, help center, and automations. This template runs the community-edition image (v4-ce, pure MIT - no enterprise code).

Configuration

Type
Compose
Platform
linux
Env vars
ENABLE_ACCOUNT_SIGNUP=trueFRONTEND_URL=http://localhost:5000MAILER_SENDER_EMAIL=Chatwoot <[email protected]>REDIS_AUTH=# openssl rand -hex 24SECRET_KEY_BASE=''SMTP_ADDRESS=''SMTP_PASSWORD=''SMTP_PORT=587SMTP_USERNAME=''
Source
Repo

Template by deployable-sh·Source

Report issue

Services

web

Configuration

Image
chatwoot/chatwoot:v4.15.1-ce
Command
bundle,exec,rails,s,-b,0.0.0.0
Ports
5000:5000
Volumes
/app/storage : storage
Env vars
SECRET_KEY_BASE=${SECRET_KEY_BASE}FRONTEND_URL=${FRONTEND_URL:-http://localhost:5000}RAILS_ENV=productionNODE_ENV=productionINSTALLATION_ENV=dockerRAILS_LOG_TO_STDOUT=truePOSTGRES_HOST=dbPOSTGRES_PORT=5432POSTGRES_USERNAME=chatwootPOSTGRES_PASSWORD=chatwoot-local-onlyPOSTGRES_DATABASE=chatwootREDIS_URL=redis://broker:6379REDIS_PASSWORD=${REDIS_AUTH}ACTIVE_STORAGE_SERVICE=localENABLE_ACCOUNT_SIGNUP=${ENABLE_ACCOUNT_SIGNUP:-true}MAILER_SENDER_EMAIL=${MAILER_SENDER_EMAIL:-Chatwoot <[email protected]>}SMTP_ADDRESS=${SMTP_ADDRESS:-}SMTP_PORT=${SMTP_PORT:-587}SMTP_USERNAME=${SMTP_USERNAME:-}SMTP_PASSWORD=${SMTP_PASSWORD:-}PORT=5000
Restart
unless-stopped

Image details

Pulls: 10.5M
User: chatwoot
Created: Nov 26, 2019
Updated: 15 hours ago
Status: active

worker

Configuration

Image
chatwoot/chatwoot:v4.15.1-ce
Command
bundle,exec,sidekiq,-C,config/sidekiq.yml
Volumes
/app/storage : storage
Env vars
SECRET_KEY_BASE=${SECRET_KEY_BASE}FRONTEND_URL=${FRONTEND_URL:-http://localhost:5000}RAILS_ENV=productionNODE_ENV=productionINSTALLATION_ENV=dockerRAILS_LOG_TO_STDOUT=truePOSTGRES_HOST=dbPOSTGRES_PORT=5432POSTGRES_USERNAME=chatwootPOSTGRES_PASSWORD=chatwoot-local-onlyPOSTGRES_DATABASE=chatwootREDIS_URL=redis://broker:6379REDIS_PASSWORD=${REDIS_AUTH}ACTIVE_STORAGE_SERVICE=localENABLE_ACCOUNT_SIGNUP=${ENABLE_ACCOUNT_SIGNUP:-true}MAILER_SENDER_EMAIL=${MAILER_SENDER_EMAIL:-Chatwoot <[email protected]>}SMTP_ADDRESS=${SMTP_ADDRESS:-}SMTP_PORT=${SMTP_PORT:-587}SMTP_USERNAME=${SMTP_USERNAME:-}SMTP_PASSWORD=${SMTP_PASSWORD:-}
Restart
unless-stopped

Image details

Pulls: 10.5M
User: chatwoot
Created: Nov 26, 2019
Updated: 15 hours ago
Status: active

migrate

Configuration

Image
chatwoot/chatwoot:v4.15.1-ce
Command
sh,-c,bundle exec rails db:chatwoot_prepare && sleep infinity
Env vars
SECRET_KEY_BASE=${SECRET_KEY_BASE}FRONTEND_URL=${FRONTEND_URL:-http://localhost:5000}RAILS_ENV=productionNODE_ENV=productionINSTALLATION_ENV=dockerRAILS_LOG_TO_STDOUT=truePOSTGRES_HOST=dbPOSTGRES_PORT=5432POSTGRES_USERNAME=chatwootPOSTGRES_PASSWORD=chatwoot-local-onlyPOSTGRES_DATABASE=chatwootREDIS_URL=redis://broker:6379REDIS_PASSWORD=${REDIS_AUTH}ACTIVE_STORAGE_SERVICE=localENABLE_ACCOUNT_SIGNUP=${ENABLE_ACCOUNT_SIGNUP:-true}MAILER_SENDER_EMAIL=${MAILER_SENDER_EMAIL:-Chatwoot <[email protected]>}SMTP_ADDRESS=${SMTP_ADDRESS:-}SMTP_PORT=${SMTP_PORT:-587}SMTP_USERNAME=${SMTP_USERNAME:-}SMTP_PASSWORD=${SMTP_PASSWORD:-}
Restart
unless-stopped

Image details

Pulls: 10.5M
User: chatwoot
Created: Nov 26, 2019
Updated: 15 hours ago
Status: active

broker

Configuration

Image
valkey/valkey:8
Command
sh,-c,exec valkey-server --maxmemory-policy noeviction --requirepass "$REDIS_PASSWORD"
Ports
6379
Env vars
REDIS_PASSWORD=${REDIS_AUTH}
Restart
unless-stopped

Image details

Pulls: 302.3M
User: valkey
Created: Apr 02, 2024
Updated: 11 hours ago
Status: active

db

Configuration

Image
pgvector/pgvector:pg16
Ports
5432
Volumes
/var/lib/postgresql/data : dbdata
Env vars
POSTGRES_USER=chatwootPOSTGRES_PASSWORD=chatwoot-local-onlyPOSTGRES_DB=chatwootPGDATA=/var/lib/postgresql/data/pgdata
Restart
unless-stopped

Image details

Pulls: 201.0M
User: pgvector
Created: Jan 29, 2024
Updated: 1 month ago
Status: active

Standalone Install

Select an install method, to see config/commands for deploying Chatwoot

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 Chatwoot, 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: chatwoot

x-chatwoot: &chatwoot
  image: chatwoot/chatwoot:v4.15.1-ce
  restart: unless-stopped

x-chatwoot-env: &chatwoot-env
  SECRET_KEY_BASE: ${SECRET_KEY_BASE}
  FRONTEND_URL: ${FRONTEND_URL:-http://localhost:5000}
  RAILS_ENV: production
  NODE_ENV: production
  INSTALLATION_ENV: docker
  RAILS_LOG_TO_STDOUT: "true"
  POSTGRES_HOST: db
  POSTGRES_PORT: "5432"
  POSTGRES_USERNAME: chatwoot
  POSTGRES_PASSWORD: chatwoot-local-only
  POSTGRES_DATABASE: chatwoot
  REDIS_URL: redis://broker:6379
  REDIS_PASSWORD: ${REDIS_AUTH}
  ACTIVE_STORAGE_SERVICE: local
  ENABLE_ACCOUNT_SIGNUP: ${ENABLE_ACCOUNT_SIGNUP:-true}
  MAILER_SENDER_EMAIL: ${MAILER_SENDER_EMAIL:-Chatwoot <[email protected]>}
  SMTP_ADDRESS: ${SMTP_ADDRESS:-}
  SMTP_PORT: ${SMTP_PORT:-587}
  SMTP_USERNAME: ${SMTP_USERNAME:-}
  SMTP_PASSWORD: ${SMTP_PASSWORD:-}

services:
  web:
    <<: *chatwoot
    command: ["bundle", "exec", "rails", "s", "-b", "0.0.0.0"]
    environment:
      <<: *chatwoot-env
      PORT: "5000"
    ports:
      - "5000:5000"
    volumes:
      - storage:/app/storage
    depends_on:
      - db
      - broker

  worker:
    <<: *chatwoot
    command: ["bundle", "exec", "sidekiq", "-C", "config/sidekiq.yml"]
    environment: *chatwoot-env
    volumes:
      - storage:/app/storage
    depends_on:
      - db
      - broker

  migrate:
    <<: *chatwoot
    command: ["sh", "-c", "bundle exec rails db:chatwoot_prepare && sleep infinity"]
    environment: *chatwoot-env
    depends_on:
      - db

  broker:
    image: valkey/valkey:8
    command: ["sh", "-c", "exec valkey-server --maxmemory-policy noeviction --requirepass \"$REDIS_PASSWORD\""]
    environment:
      REDIS_PASSWORD: ${REDIS_AUTH}
    restart: unless-stopped
    ports:
      - "6379"

  db:
    image: pgvector/pgvector:pg16
    restart: unless-stopped
    ports:
      - "5432"
    environment:
      POSTGRES_USER: chatwoot
      POSTGRES_PASSWORD: chatwoot-local-only
      POSTGRES_DB: chatwoot
      PGDATA: /var/lib/postgresql/data/pgdata
    volumes:
      - dbdata:/var/lib/postgresql/data

volumes:
  storage:
  dbdata:

Or deploy it directly from the source:

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

More install options in our documentation.

Container Documentation

web Documentation

The modern, open source, self-hosted customer support platform. Alternative to Intercom and Zendesk.

worker Documentation

The modern, open source, self-hosted customer support platform. Alternative to Intercom and Zendesk.

migrate Documentation

The modern, open source, self-hosted customer support platform. Alternative to Intercom and Zendesk.

broker Documentation

Valkey is a high-performance data structure server that primarily serves key/value workloads.

db Documentation

Open-source vector similarity search for Postgres

Serve Chatwoot 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 chatwoot.example.com to http://web:5000

Add this to your Caddyfile

chatwoot.example.com {
	reverse_proxy http://web: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 6379 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, chatwoot 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 chatwoot/chatwoot:v4.15.1-ce

  • "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

Chatwoot is a Compose stack, a set of containers (5 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 5 containers that run side by side. Here's each one, with the image it runs and anything it waits for first:

  • web runs chatwoot/chatwoot:v4.15.1-ce, starts after db, broker
  • worker runs chatwoot/chatwoot:v4.15.1-ce, starts after db, broker
  • migrate runs chatwoot/chatwoot:v4.15.1-ce, starts after db
  • broker runs valkey/valkey:8
  • db runs pgvector/pgvector:pg16

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
  • 6379, published on a random host port
  • 5432, published on a random host port

Volumes

A volume is where Chatwoot 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:

  • /app/storage kept in the storage volume Docker manages
  • /var/lib/postgresql/data kept in the dbdata volume Docker manages

Environment variables

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

  • SECRET_KEY_BASE, pulled from your own environment
  • FRONTEND_URL, defaults to http://localhost:5000
  • RAILS_ENV, defaults to production
  • NODE_ENV, defaults to production
  • INSTALLATION_ENV, defaults to docker
  • RAILS_LOG_TO_STDOUT, defaults to true
  • POSTGRES_HOST, defaults to db
  • POSTGRES_PORT, defaults to 5432
  • POSTGRES_USERNAME, defaults to chatwoot
  • POSTGRES_PASSWORD, defaults to chatwoot-local-only
  • POSTGRES_DATABASE, defaults to chatwoot
  • REDIS_URL, defaults to redis://broker:6379
  • REDIS_PASSWORD, pulled from your own environment
  • ACTIVE_STORAGE_SERVICE, defaults to local
  • ENABLE_ACCOUNT_SIGNUP, defaults to true
  • MAILER_SENDER_EMAIL, defaults to Chatwoot <[email protected]>
  • SMTP_ADDRESS, pulled from your own environment
  • SMTP_PORT, defaults to 587
  • SMTP_USERNAME, pulled from your own environment
  • SMTP_PASSWORD, pulled from your own environment
  • PORT, defaults to 5000
  • POSTGRES_USER, defaults to chatwoot
  • POSTGRES_DB, defaults to chatwoot
  • PGDATA, defaults to /var/lib/postgresql/data/pgdata

Restart policy

The restart policy here is unless-stopped, so Docker restarts Chatwoot 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 web) 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 Chatwoot up. Add the template list to Portainer once, then deploying Chatwoot is a click rather than a wall of config.