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.4.6 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 2024

  • STEP 5

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

Peppermint Synology NAS Set up 2 new 2024

  • 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: 3560

Peppermint Synology NAS Set up 3 new 2024

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

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

  • STEP 10

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

Peppermint Synology NAS Set up 6 new 2024

  • 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:
  peppermint:
    container_name: Peppermint
    image: pepperlabs/peppermint:latest
    ports:
      - 3560:3000
      - 5006:5003
    restart: on-failure:5
    depends_on:
      - db
    healthcheck:
      test: curl -f http://localhost:3000/ || exit 1
      interval: 30s
      timeout: 10s
      retries: 3
    environment:
      DB_USERNAME: peppermintuser
      DB_PASSWORD: peppermintpass
      DB_HOST: db
      SECRET: mariushosting
      BASE_URL: https://peppermint.yourname.synology.me

  db:
    image: postgres:16
    container_name: Peppermint-DB
    hostname: db
    mem_limit: 512m
    cpu_shares: 768
    security_opt:
      - no-new-privileges:true
    healthcheck:
      test: ["CMD", "pg_isready", "-q", "-d", "peppermint", "-U", "peppermintuser"]
      timeout: 45s
      interval: 10s
      retries: 10
    volumes:
      - /volume1/docker/peppermint:/var/lib/postgresql/data:rw
    environment:
      POSTGRES_DB: peppermint
      POSTGRES_USER: peppermintuser
      POSTGRES_PASSWORD: peppermintpass
    restart: on-failure:5

Note: Before you paste the code above in the Web editor area, change the value for SECRET and add your own password. mariushosting is an example for a secret password.
Note: Before you paste the code above in the Web editor 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 7 new 2024

  • 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 8 new 2024

  • 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 9 new 2024

  • 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, then click Sign in. Follow the instructions in the image below.

⚠️Warning: the default Email address is admin@admin.com

Peppermint Synology NAS Set up 10 new 2024

  • STEP 17

Type in the default default Password, then click Sign in. Follow the instructions in the image below.

⚠️Warning: the default password is 1234

Peppermint Synology NAS Set up 11 new 2024

  • STEP 18

Click To dashboard. Follow the instructions in the image below.

Peppermint Synology NAS Set up 12 new 2024

  • STEP 19

At the top right of the page click on your profile icon then change the Profile data with your own data. Click Save and Reload. Follow the instructions in the image below.

Peppermint Synology NAS Set up 13 new 2024

  • STEP 20

Change the default password with your own password. Click Update Password. Follow the instructions in the image below.

Peppermint Synology NAS Set up 14 new 2024

  • STEP 21

Follow the instructions on how to set up email notifications on Peppermint.

  • STEP 22

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

Peppermint Synology NAS Set up 15 new 2024

Enjoy Peppermint!

🆘TROUBLESHOOTING

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

Note: Find out how to update the Peppermint container with the latest image.
Note: How to Back Up Docker Containers on your Synology NAS.
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 Friday / March 29th, 2024 at 8:38 PM