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.

  • STEP 3

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 4

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.

Peppermint Synology NAS Set up 2

  • STEP 5

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.1"

services:
  postgres:
    container_name: postgres
    image: postgres:latest
    restart: always
    volumes:
      - /volume1/docker/peppermintdb:/data/db
    environment: 
      POSTGRES_USER: peppermint
      POSTGRES_PASSWORD: mariushosting
      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: "mariushosting"
      DB_HOST: "postgres"
      BASE_URL: "http://192.168.1.135:5006"

Note: Before you paste the code above in the Stack area, change the value for POSTGRES_PASSWORD and add your own password. mariushosting is an example for a password. You have to insert your own password.
Note: Before you paste the code above in the Stack area, change the value for DB_PASSWORD and add your own password. mariushosting is an example for a password. You have to insert your own POSTGRES_PASSWORD.
Note: Before you paste the code above in the Stack area, change the value for BASE_URL and add your own LOCAL NAS IP. 192.168.1.135 is my own LOCAL NAS IP. You have to insert your own LOCAL NAS IP.

Peppermint Synology NAS Set up 3

  • STEP 6

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 4

  • STEP 7

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

Peppermint Synology NAS Set up 5

  • STEP 8

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

  • STEP 9

Now open your browser and type in http://Synology-ip-address:5006 Follow the instructions in the image below. Type in the Email address and the Password then click Sign in.

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

Peppermint Synology NAS Set up 6

Note: You can change the password and the default email address after you log in for the first time.

Easy Interface.

Peppermint Synology NAS Set up 7

Start creating your first Ticket:

Peppermint Synology NAS Set up 8

Note: If you want to run the Peppermint container over HTTPS, check out my guide on How to Run Docker Containers Over HTTPS.

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: Some Docker Containers Need WebSocket.

This post was updated on Thursday / May 5th, 2022 at 12:29 PM