How to Install Mattermost on Your Synology NAS

How to Install Mattermost on Your Synology NAS

Mattermost is an open-source, self-hostable online chat service with file sharing, search, and integrations. It is designed as an internal chat for organizations and companies, and mostly markets itself as an open-source alternative to Slack and Microsoft Teams. In this step by step guide I will show you how to install Mattermost on your Synology NAS using Docker and Portainer.

Note: This guide works perfectly with the latest Mattermost v7.5.1 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.

Mattermost Synology NAS Set up 1

  • STEP 5

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

Mattermost Synology NAS Set up 2

  • 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 Mattermost Chat. After that, add the following instructions:

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

Destination:
Protocol: HTTP
Hostname: Add your own NAS IP.
Port: 8401

Mattermost Synology NAS Set up 3

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

Synology Proxy WebSocket

  • STEP 8

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

Mattermost Synology NAS Set up 4

  • STEP 9

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

Mattermost Synology NAS Set up 5

  • STEP 10

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

Mattermost Synology NAS Set up 6

  • STEP 11

Now create seven new folders inside the mattermost folder that you created at STEP 10 and name them client, config, data, db, indexes, logs, plugins. Follow the instructions in the image below.
Note: Be careful enter only lowercase, not uppercase letters.

Mattermost Synology NAS Set up 7

  • STEP 12

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.

1 Synology Portainer Add Stack

  • STEP 13

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

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

version: "3.9"
services:
  mattermost-db:
    image: postgres
    container_name: Mattermost-DB
    hostname: mattermost-db
    security_opt:
      - no-new-privileges:true
    pids_limit: 100
    healthcheck:
      test: ["CMD", "pg_isready", "-q", "-d", "mattermost", "-U", "mattermostuser"]
      interval: 10s
      timeout: 5s
      retries: 5
    user: 1026:100
    volumes:
      - /volume1/docker/mattermost/db:/var/lib/postgresql/data
    environment:
      - POSTGRES_DB=mattermost
      - POSTGRES_USER=mattermostuser
      - POSTGRES_PASSWORD=mattermostpw
      - TZ=Europe/Bucharest
    restart: always

  mattermost:
    image: mattermost/mattermost-team-edition:latest
    container_name: Mattermost
    hostname: mattermost
    security_opt:
      - no-new-privileges:true
    pids_limit: 200
    user: 1026:100
    volumes:
      - /volume1/docker/mattermost/config:/mattermost/config:rw
      - /volume1/docker/mattermost/data:/mattermost/data:rw
      - /volume1/docker/mattermost/logs:/mattermost/logs:rw
      - /volume1/docker/mattermost/plugins:/mattermost/plugins:rw
      - /volume1/docker/mattermost/client:/mattermost/client/plugins:rw
      - /volume1/docker/mattermost/indexes:/mattermost/bleve-indexes:rw
    environment:
      - TZ=Europe/Bucharest
      - MM_SQLSETTINGS_DRIVERNAME=postgres
      - MM_SQLSETTINGS_DATASOURCE=postgres://mattermostuser:mattermostpw@mattermost-db:5432/mattermost?sslmode=disable&connect_timeout=10
      - MM_BLEVESETTINGS_INDEXDIR=/mattermost/bleve-indexes
      - MM_SERVICESETTINGS_SITEURL=https://chat.yourname.synology.me
    ports:
      - 192.168.1.18:8401:8065
    restart: always
    depends_on:
      mattermost-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.)
Note: Before you paste the code above in the Web editor area below, change the value for MM_SERVICESETTINGS_SITEURL and type in your own synology.me DDNS that you have previously created at STEP 6.
Note: Before you paste the code above in the Web editor area below, change the value for ports and add your own Synology Local NAS IP. 192.168.1.18 is my own Synology Local NAS IP. You should type in your own Synology Local NAS IP.

Mattermost Synology NAS Set up 8

  • STEP 14

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.

Mattermost Synology NAS Set up 9

  • STEP 15

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

Mattermost Synology NAS Set up 10

  • STEP 16

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

  • STEP 17

Now open your browser and type in your HTTPS/SSL certificate like this https://chat.yourname.synology.me In my case it’s https://chat.mariushosting.synology.me If everything goes right, you will see the Mattermost installation page. Click View in Browser. Follow the instructions in the image below.

Mattermost Synology NAS Set up 11

  • STEP 18

Add your own credentials. Email, Username and Password then click Create Account. Follow the instructions in the image below.

Mattermost Synology NAS Set up 12

  • STEP 19

Click Create a team. Follow the instructions in the image below.

Mattermost Synology NAS Set up 13 new

  • STEP 20

Give a name to the team then click Next. Follow the instructions in the image below.

Mattermost Synology NAS Set up 14

  • STEP 21

Add the Team URL name then click Finish. Follow the instructions in the image below.

Mattermost Synology NAS Set up 15

  • STEP 22

Welcome to Mattermost!

Mattermost Synology NAS Set up 16

  • STEP 23

You can also access Boards. Follow the instructions in the image below.

Mattermost Synology NAS Set up 17

Enjoy Mattermost!

Note: Find out how to update the Mattermost container with the latest image.
Note: Can I run Docker on my Synology NAS? See the supported models.
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.

This post was updated on Monday / November 21st, 2022 at 4:04 AM