How to Install Trudesk on Your Synology NAS

How to Install Trudesk on Your Synology NAS

Trudesk is an Open Source Help Desk Software built with one goal in mind: to keep workloads organized and simple. It’s used for customer messaging & user support. Trudesk is built with Node.js and MongoDB and you can easily run it with Docker. In this step by step guide I will show you how to install Trudesk on your Synology NAS using Docker and Portainer.

Note: This guide works perfectly with the latest Trudesk v1.2.5 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.

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

Trudesk Synology NAS Set up 1

  • STEP 5

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

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

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

Destination:
Protocol: HTTP
Hostname: localhost
Port: 8118

 

Trudesk Synology NAS Set up 3 new

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

Trudesk Synology NAS Set up 4

  • STEP 8

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

Trudesk Synology NAS Set up 5

  • STEP 9

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

Trudesk Synology NAS Set up 5b

  • STEP 10

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

Trudesk Synology NAS Set up 6

  • STEP 11

Now create four new folders inside the trudesk folder that you created at STEP 10 and name them backups, elasticsearch, mongo, uploads. Follow the instructions in the image below.
Note: Be careful enter only lowercase, not uppercase letters.

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

Trudesk Synology NAS Set up 8

  • STEP 13

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

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

version: '3'
services:
  trudesk:
    image: polonel/trudesk
    restart: always
    ports:
      - 8118:8118
    dns:
      - 8.8.8.8
      - 1.1.1.1
    environment:
      NODE_ENV: production
      TRUDESK_DOCKER: true
      TD_MONGODB_SERVER: mongo
      TD_MONGODB_DATABASE: trudesk
      ELATICSEARCH_URI: http://elasticsearch:9200
      TZ: Romania/Bucharest
    volumes:
      - /volume1/docker/trudesk/uploads:/usr/src/trudesk/public/uploads
      - /volume1/docker/trudesk/backups:/usr/src/trudesk/backups
  mongo:
    image: mongo
    restart: always
    ports:
      - 27017:27017
    volumes:
      - /volume1/docker/trudesk/mongo:/var/lib/mongo
      - /volume1/docker/trudesk/mongo:/data/configdb
      - /volume1/docker/trudesk/mongo:/data/db

  elasticsearch:
    image: elasticsearch:8.0.0
    restart: always
    environment:
      - xpack.security.enabled=false
      - xpack.security.http.ssl.enabled=false
      - node.name=estrudesk01
      - cluster.initial_master_nodes=estrudesk01
      - discovery.seed_hosts=estrudesk01
      - bootstrap.memory_lock=true
    mem_limit: 1073741824
    ulimits:
      memlock:
        soft: -1
        hard: -1
    ports:
      - 9200:9200
      - 9300:9300
    volumes:
      - /volume1/docker/trudesk/elasticsearch:/usr/share/elasticsearch/data

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

Trudesk Synology NAS Set up 9

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

Trudesk Synology NAS Set up 10

  • STEP 15

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

Trudesk Synology NAS Set up 11

  • 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://trudesk.yourname.synology.me In my case it’s https://trudesk.mariushosting.synology.me If everything goes right, you will see the trudesk installation page. Click LET’S START. Follow the instructions in the image below.

Trudesk Synology NAS Set up 12

  • STEP 18

Add your own Username, your Full Name, your own Password and your own Email, then click CREATE ADMIN. Follow the instructions in the image below.

Trudesk Synology NAS Set up 13

  • STEP 19

Click RESTART ME! Follow the instructions in the image below.

Trudesk Synology NAS Set up 14

  • STEP 20

Add your own Username and Password that you have previously created at STEP 18, then click LOGIN. Follow the instructions in the image below.

Trudesk Synology NAS Set up 15

  • STEP 21

Welcome to the trudesk Dashboard!

Trudesk Synology NAS Set up 16

  • STEP 22

On the left sidebar click Settings. Change the Site Url and add https instead of http, then click SAVE. Follow the instructions in the image below.

Trudesk Synology NAS Set up 17

  • STEP 23

On the left sidebar click Settings then Appearance. You can easily change your Site logo, Page Logo, Favicon and Color Scheme. Follow the instructions in the image below.

Trudesk Synology NAS Set up 18

Troubleshooting: Make sure Rule 5 is correctly applied on your Synology NAS Firewall configuration.

Fix: MongoDB 5 requires a CPU with AVX support.
Unsupported NAS Models (that don’t support MongoDB 5): DS218+ DS718+ DS220+ DS720+ DS920+ and older consumer models. You can always run trudesk with an older mongo version. To install trudesk with MongoDB in unsupported NAS models just change the line at STEP 13 from image: mongo to image: mongo:4.0
Supported NAS Models (that support MongoDB 5): All NAS models from the 21+ and 22+ series.
Note: It’s a possibility that older NAS devices have AVX support. Check your NAS CPU to see if it supports AVX.
What is MongoDB? MongoDB is a database. Classified as a NoSQL database program, MongoDB uses JSON-like documents with optional schemas.

Note: Find out how to update the Trudesk 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: Some Docker Containers Need WebSocket.

This post was updated on Friday / August 5th, 2022 at 11:06 PM