Chatwoot is an open-source, self-hosted customer engagement suite. Chatwoot lets you view and manage your customer data, communicate with them irrespective of which medium they use, and re-engage them based on their profile. Chatwoot supports the following conversation channels: Website, Facebook, Instagram, Twitter, Telegram, WhatsApp, Line, SMS, API Channel, Email. In this step by step guide I will show you how to install Chatwoot on your Synology NAS using Docker & Portainer.

💡Note: This guide works perfectly with the latest Chatwoot v3.15.0 release.

• STEP 1

Please Support My work by Making a Donation.

• STEP 2

Install Portainer using my step by step guide. If you already have Portainer installed on your Synology NAS, skip this STEP. Attention: Make sure you have installed the latest Portainer version.

• STEP 3

Make sure you have a synology.me Wildcard Certificate. Follow my guide to get a Wildcard Certificate. If you already have a synology.me Wildcard certificate, skip this STEP.

• STEP 4

Go to Control Panel / Login Portal / Advanced Tab / click Reverse Proxy. Follow the instructions in the image below.

• STEP 5

Now click the “Create” button. Follow the instructions in the image below.

• STEP 6

After you click the Create button, the window below will open. Follow the instructions in the image below.

On the General area, set the Reverse Proxy Name description: type in Chatwoot. After that, add the following instructions:

Source:
Protocol: HTTPS
Hostname: chatwoot.yourname.synology.me
Port: 443

Check Enable HSTS

Destination:
Protocol: HTTP
Hostname: localhost
Port: 3248

• STEP 7

On the Reverse Proxy Rules click the Custom Header tab. Click Create and then, from the drop-down menu, click WebSocket. After you click on WebSocket, two Header Names and two Values will be automatically added. Click Save. Follow the instructions in the image below.

• STEP 8

Go to Control Panel / Network / Connectivity tab/ Check Enable HTTP/2 then click Apply. Follow the instructions in the image below.

• STEP 9

Go to Control Panel / Security / Advanced tab/ Check Enable HTTP Compression then click Apply. Follow the instructions in the image below.

• STEP 10

Go to File Station and open the docker folder. Inside the docker folder, create one new folder and name it chatwoot. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

• STEP 11

Now create three new folders inside the chatwoot folder that you created at STEP 10 and name them db, redis, storage. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

• STEP 12

Follow my step by step guide on how to activate SMTP for your Gmail account. This step is mandatory. Note: If you don’t want to use the easiest way for SMTP with Google and you already have SMTP details from your own Mail Server, you can just skip this STEP and use your personalized email SMTP details instead.

• STEP 13

Log into Portainer using your username and password. On the left sidebar in Portainer, click on Stacks then + Add stack. Follow the instructions in the image below.

• STEP 14

In the Name field type in chatwoot. Follow the instructions in the image below.

Note: Copy Paste the code below in the Portainer Stacks Web editor.

services:
  redis:
    image: redis
    command:
      - /bin/sh
      - -c
      - redis-server --requirepass redispass
    container_name: Chatwoot-REDIS
    hostname: chatwoot-redis
    security_opt:
      - no-new-privileges:true
    read_only: true
    user: 1026:100
    healthcheck:
      test: ["CMD-SHELL", "redis-cli ping || exit 1"]
    volumes:
      - /volume1/docker/chatwoot/redis:/data:rw
    environment:
      TZ: Europe/Bucharest
    restart: on-failure:5

  db:
    image: postgres:17
    container_name: Chatwoot-DB
    hostname: chatwoot-db
    security_opt:
      - no-new-privileges:true
    healthcheck:
      test: ["CMD", "pg_isready", "-q", "-d", "chatwoot_production", "-U", "chatwootuser"]
      timeout: 45s
      interval: 10s
      retries: 10
    volumes:
      - /volume1/docker/chatwoot/db:/var/lib/postgresql/data:rw
    environment:
      POSTGRES_DB: chatwoot_production
      POSTGRES_USER: chatwootuser
      POSTGRES_PASSWORD: chatwootpass
    restart: on-failure:5

  rails:
    image: chatwoot/chatwoot:latest
    entrypoint: docker/entrypoints/rails.sh
    command: ['bundle', 'exec', 'rails', 's', '-p', '3000', '-b', '0.0.0.0']
    container_name: Chatwoot-RAILS
    hostname: rails
    security_opt:
      - no-new-privileges:true
    ports:
      - 3248:3000
    volumes:
      - /volume1/docker/chatwoot/storage:/app/storage:rw
    env_file:
      - stack.env
    restart: on-failure:5
    depends_on:
      redis:
        condition: service_healthy
      db:
        condition: service_healthy

  sidekiq:
    image: chatwoot/chatwoot:latest
    command: ['bundle', 'exec', 'sidekiq', '-C', 'config/sidekiq.yml']
    container_name: Chatwoot-SIDEKIQ
    hostname: sidekiq
    security_opt:
      - no-new-privileges:true
    volumes:
      - /volume1/docker/chatwoot/storage:/app/storage:rw
    env_file:
      - stack.env
    restart: on-failure:5
    depends_on:
      redis:
        condition: service_healthy
      db:
        condition: service_healthy

Note: Before you paste the code above in the Web editor area below, change the value numbers for user with your own UID and GID values. (Follow my step by step guide on how to do this.) 1026 is my personal UID value and 100 is my personal GID value. You have to type in your own values.
Note: Before you paste the code above in the Web editor area below, change the value for TZ. (Select your current Time Zone from this list.)

• STEP 15

Click the Upload button after Web editor. Download the stack.env file by clicking the blue link below and then upload it from your computer in the “Load variables from .env files“. Follow the instructions in the image below. 🔒Note: Support my work to unlock the password. You can use this password to download any file on mariushosting forever!

👉🏻Download stack.env file

• STEP 16

Note: On the Environment variables change the value for FRONTEND_URL. Type in your own synology.me DDNS that you have previously created at STEP 6 with https at the beginning.
Note: On the Environment variables change the value for SMTP_USERNAME and add your own Gmail Address. STEP 12.
Note: On the Environment variables change the value for SMTP_PASSWORD and add your own Gmail APP Password. STEP 12.
Note: On the Environment variables change the value for SECRET_KEY_BASE and add your own SECRET KEY. (Generate your own Random alphanumeric 128 length SECRET_KEY.) Warning: Avoid special characters or symbols.

• STEP 17

After you make the changes, click the Web editor button. Follow the instructions in the image below.

• STEP 18

Scroll down on the page until you see a button named Deploy the stack. Click on it. Follow the instructions in the image below. The installation process can take up to a few minutes. It will depend on your Internet speed connection.

⌛Now just wait because the Chatwoot image is about 2GB.

• STEP 19

If everything goes right, you will see the following message at the top right of your screen: “Success Stack successfully deployed“.

• STEP 20

On the left sidebar in Portainer, click Containers. Identify your Chatwoot-RAILS instance, then click on the little terminal icon. Follow the instructions in the image below.

• STEP 21

After you click on the little terminal icon at STEP 20, a new page will open. From the drop-down Command menu select /bin/ash then click Connect. Follow the instructions in the image below.

• STEP 22

After you click Connect at STEP 21, a Console will open. Copy paste the code below and confirm by pressing Enter on your keyboard to start the installation config process. Follow the instructions in the image below.

 bundle exec rails db:chatwoot_prepare

• STEP 23

After you press Enter on your Keyboard at STEP 22, you will get a message that says: “Loading installation config“. Follow the instructions in the image below.

• STEP 24

On the left sidebar in Portainer, click Containers. Identify all your Chatwoot-RAILS instance, select it then click Restart. Follow the instructions in the image below.

• STEP 25

Go back to STEP 1 or you will deal with karma 🙂

• STEP 26

Now open your browser and type in your HTTPS/SSL certificate like this https://chatwoot.yourname.synology.me In my case it’s https://chatwoot.mariushosting.synology.me If everything goes right, you will see the Chatwoot registration page. Type in your own Name, Company Name, Email and Password then click Finish Setup. Follow the instructions in the image below.

• STEP 27

Type in your own Email and Password that you have previously created at STEP 26 then click Login. Follow the instructions in the image below.

• STEP 28

At the bottom left of the page, click on your profile icon, then Change Appearance to switch to Dark theme. Follow the instructions in the image below.

• STEP 29

Your Chatwoot dashboard at a glance!

Enjoy Chatwoot!

🆘TROUBLESHOOTING

If you encounter issues by using this container, make sure to check out the Common Docker issues article.

Note: Can I run Docker on my Synology NAS? See the supported models.
Note: How to Back Up Docker Containers on your Synology NAS.
Note: Find out how to update the Chatwoot container with the latest image.
Note: How to Free Disk Space on Your NAS if You Run Docker.
Note: How to Schedule Start & Stop For Docker Containers.
Note: How to Activate Email Notifications.
Note: How to Add Access Control Profile on Your NAS.
Note: How to Change Docker Containers Restart Policy.
Note: How to Use Docker Containers With VPN.
Note: Convert Docker Run Into Docker Compose.
Note: How to Clean Docker.
Note: How to Clean Docker Automatically.
Note: Best Practices When Using Docker and DDNS.
Note: Some Docker Containers Need WebSocket.
Note: Find out the Best NAS Models For Docker.
Note: Activate Gmail SMTP For Docker Container

This post was updated on Monday / December 16th, 2024 at 10:58 PM