How to Install Peppermint on Your Synology NAS

How to Install Peppermint on Your Synology NAS

Peppermint is a ticket management system that helps helpdesks and service desks manage internal staff and customer requests. In this step by step guide I will show you how to install Peppermint on your Synology NAS using Docker & Portainer.

Note: This guide works perfectly with the latest Peppermint 0.2.3 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.

Peppermint Synology NAS Set up 1 new 2023

  • STEP 5

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

Peppermint Synology NAS Set up 2 new 2023

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

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

Check Enable HSTS

Destination:
Protocol: HTTP
Hostname: localhost
Port: 5006

Peppermint Synology NAS Set up 3 new 2023

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

Peppermint Synology NAS Set up 4 new 2023

  • STEP 9

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

Peppermint Synology NAS Set up 5 new 2023

  • STEP 10

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

Peppermint Synology NAS Set up 1

  • STEP 11

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 12

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

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

version: "3.9"
services:
  postgres:
    container_name: Peppermint-DB
    image: postgres:latest

    restart: always
    volumes:
      - /volume1/docker/peppermintdb:/var/lib/postgresql/data
    environment: 
      POSTGRES_USER: peppermint
      POSTGRES_PASSWORD: peppermint
      POSTGRES_DB: peppermint

  client:
    container_name: Peppermint
    image: pepperlabs/peppermint:latest
    ports:
      - 5006:5006
    restart: always
    depends_on:
      - postgres
    environment:
      PORT: 5006
      DB_USERNAME: peppermint
      DB_PASSWORD: peppermint
      DB_HOST: postgres
      BASE_URL: https://peppermint.yourname.synology.me

Note: Before you paste the code above in the Stack area, change the value for BASE_URL and add your own synology.me DDNS that you have previously created at STEP 6 with https:// at the beginning.

Peppermint Synology NAS Set up 6 new 2023

  • STEP 13

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.

Peppermint Synology NAS Set up 7 new 2023

  • STEP 14

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

Peppermint Synology NAS Set up 8 new 2023

  • STEP 15

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

  • STEP 16

Now open your browser and type in your HTTPS/SSL certificate like this https://peppermint.yourname.synology.me In my case it’s https://peppermint.mariushosting.synology.me If everything goes right, you will see the Peppermint Login page. Type in the default Email address and the default Password, then click Sign in. Follow the instructions in the image below.

Warning: the default Email address is admin@admin.com and the default password is 1234

Peppermint Synology NAS Set up 9 new 2023

Note: You can change the default Email Address and the default Password, after you log in for the first time.

  • STEP 17

Create your first ticket. Follow the instructions in the image below.

Peppermint Synology NAS Set up 10 new 2023

Enjoy Peppermint!

Note: Find out how to update the Peppermint 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.
Note: Find out the Best NAS Models For Docker.
Note: Activate Gmail SMTP For Docker Containers.

This post was updated on Thursday / January 12th, 2023 at 12:42 PM