Welcome to Peppermint Ticket Management 🍵

This project is supported by:

Ticket Management System in order to help helpdesks & service desks manage internal staff & customer requests

Introduction

It's a self hosted alternative to popular services such as zendesk

✨ Features

• Ticket Creation: Bog standard ticket creation with a markdown editor and file uploads
• A log of client history
• Markdown based Notebook with todo lists
• Responsive: Designed for variable screen sizes from mobile up to 4k
• Multi-deployment: Quickly deploy using docker & pm2
• Simple to Use: Designed to be easy to use with a simple logical workflow

🐳 Installation with docker

Currently only linux has been verified as working but we are open to the idea of supporting windows eventually as well.

Keep in mind, this is an alpha so the risk of data loss is real and it may not be stable, we do not recommend anyone runs this in a production enviroment.

Check out the getting started guide if this is the first time you've used Peppermint:

version: "3.1"

services:
  postgres:
    container_name: postgres
    image: postgres:latest
    restart: always
    volumes:
      - peppermint/db:/data/db
    environment:
      POSTGRES_USER: peppermint
      POSTGRES_PASSWORD: 1234
      POSTGRES_DB: peppermint

  client:
    container_name: peppermint
    image: pepperlabs/peppermint
    ports:
      - 5000:5000
    restart: on-failure
    depends_on:
      - postgres
    environment:
      PORT: 5000
      DB_USERNAME: "peppermint"
      DB_PASSWORD: "1234"
      DB_HOST: "postgres"
      BASE_URL: "http://localhost"

Supported Environment Variables

You can utilize the following environment variables in Peppermint. None of them are manditory.

Variable	Description
PUID	Set userid that the container will run as.
PGID	Set groupid that the container will run as.
DB_USERNAME	Enter database username here
DB_PASSWORD	Enter database password here
PORT	Choose a custom port to run the app on rather than the default 5000

Setting up postgres on Macos in a container for local development

docker run --rm -P -p 127.0.0.1:5432:5432 -e POSTGRES_PASSWORD="1234" --name pg postgres:alpine

One click installers

• We are now on linode marketplace we can be viewed here here

Roadmap for new features

There is currently a trello roadmap available which is updated daily - https://trello.com/b/tOMsptar/peppermint

Documentation

We have started working on creating documentation for peppermint which covers development to general usage. Click here to be taken directly there.

Motiviation

• This was initially a project to tie together my react and nodeJS skills and show something for my portfolio
• It looked terrible! But it worked and showed functionaility, which got me a job.
• Learn and deploy with docker
• Redo the UI, completly from the ground up. Which has now been completed and for me looks great.
• Build on this foundation and create a fully fledged product which offers what the big boys offer, but, at a much better ROI than signing up for zendesk etc.

Give a ⭐️ if this project helped you!

Screenshots

Author

👤 Jack Andrews

• Website: peppermint.sh
• Twitter: @andrewsjack18
• Github: @potts99
• LinkedIn: @jack-andrews-146852131