diff --git a/README.md b/README.md index 37123c3b..c0e4574a 100644 --- a/README.md +++ b/README.md @@ -71,6 +71,7 @@ This is the official repository for the Tipi App Store. It contains all the apps - [Openbooks](https://github.com/evan-buss/openbooks) - Search and Download eBooks - [Overseerr](https://github.com/sct/overseerr) - Request management and media discovery tool for the Plex ecosystem - [Owncloud](https://github.com/owncloud/core) - A personal cloud which runs on your own server. +- [Peppermint](https://github.com/Peppermint-Lab/peppermint) - An open source ticket management & help desk solution. - [Photoprism](https://github.com/photoprism/photoprism) - AI-Powered Photos App for the Decentralized Web. We are on a mission to protect your freedom and privacy. - [Pihole](https://github.com/pi-hole/pi-hole) - A black hole for Internet advertisements - [Plex](https://github.com/plexinc/pms-docker) - Stream Movies & TV Shows diff --git a/apps/peppermint/config.json b/apps/peppermint/config.json new file mode 100644 index 00000000..65f43e53 --- /dev/null +++ b/apps/peppermint/config.json @@ -0,0 +1,23 @@ +{ + "$schema": "../schema.json", + "name": "Peppermint", + "port": 8176, + "available": true, + "exposable": true, + "id": "peppermint", + "tipi_version": 1, + "version": "latest", + "categories": ["utilities"], + "description": "An open source ticket management & help desk solution.", + "short_desc": "An open source ticket management & help desk solution.", + "author": "Peppermint-Lab", + "source": "https://github.com/Peppermint-Lab/peppermint", + "form_fields": [ + { + "type": "random", + "label": "Peppermint DB Password", + "min": 32, + "env_variable": "PEPPERMINT_DB_PASSWORD" + } + ] +} \ No newline at end of file diff --git a/apps/peppermint/docker-compose.yml b/apps/peppermint/docker-compose.yml new file mode 100644 index 00000000..081c29b6 --- /dev/null +++ b/apps/peppermint/docker-compose.yml @@ -0,0 +1,40 @@ +version: "3.7" + +services: + peppermint: + image: pepperlabs/peppermint:latest + container_name: peppermint + environment: + - PORT=5000 + - DB_USERNAME=tipi + - DB_PASSWORD=${PEPPERMINT_DB_PASSWORD} + - DB_HOST=peppermint-db + - BASE_URL=https://${APP_DOMAIN} + restart: unless-stopped + ports: + - ${APP_PORT}:5000 + depends_on: + - peppermint-db + networks: + - tipi_main_network + labels: + traefik.enable: ${APP_EXPOSED} + traefik.http.routers.peppermint.rule: Host(`${APP_DOMAIN}`) + traefik.http.routers.peppermint.entrypoints: websecure + traefik.http.routers.peppermint.service: peppermint + traefik.http.routers.peppermint.tls.certresolver: myresolver + traefik.http.services.peppermint.loadbalancer.server.port: 5000 + + peppermint-db: + container_name: peppermint-db + image: postgres:latest + restart: unless-stopped + environment: + - POSTGRES_USER=tipi + - POSTGRES_PASSWORD=${PEPPERMINT_DB_PASSWORD} + - POSTGRES_DB=peppermint + volumes: + - ${APP_DATA_DIR}/data/postgres:/var/lib/postgresql/data + networks: + - tipi_main_network + diff --git a/apps/peppermint/metadata/description.md b/apps/peppermint/metadata/description.md new file mode 100644 index 00000000..ae1d8192 --- /dev/null +++ b/apps/peppermint/metadata/description.md @@ -0,0 +1,39 @@ +Ticket Management System in order to help helpdesks & service desks manage internal staff & customer requests + +The default login credentials are + +``` +User: admin@admin.com +Password: 1234 +``` + +## [](https://github.com/Peppermint-Lab/peppermint#introduction)Introduction + +It's a self hosted alternative to popular services such as zendesk + +[![](https://github.com/Peppermint-Lab/peppermint/raw/master/static/homepage.png)](https://github.com/Peppermint-Lab/peppermint/blob/master/static/homepage.png) + +## [](https://github.com/Peppermint-Lab/peppermint#-features)✨ 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 + +## [](https://github.com/Peppermint-Lab/peppermint#documentation)Documentation + +We have started working on creating documentation for peppermint which covers development to general usage. Click [here](https://docs.peppermint.sh) to be taken directly there. + +## [](https://github.com/Peppermint-Lab/peppermint#motivation)Motivation + +- 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. + +## [](https://github.com/Peppermint-Lab/peppermint#screenshots)Screenshots + +[![Logo](https://github.com/Peppermint-Lab/peppermint/raw/master/static/homepage.png)](https://github.com/Peppermint-Lab/peppermint/blob/master/static/homepage.png) [![Logo](https://github.com/Peppermint-Lab/peppermint/raw/master/static/create_a_ticket.png)](https://github.com/Peppermint-Lab/peppermint/blob/master/static/create_a_ticket.png) [![Logo](https://github.com/Peppermint-Lab/peppermint/raw/master/static/tickets.png)](https://github.com/Peppermint-Lab/peppermint/blob/master/static/tickets.png) [![Logo](https://github.com/Peppermint-Lab/peppermint/raw/master/static/detail.png)](https://github.com/Peppermint-Lab/peppermint/blob/master/static/detail.png) \ No newline at end of file diff --git a/apps/peppermint/metadata/logo.jpg b/apps/peppermint/metadata/logo.jpg new file mode 100644 index 00000000..419ac25d Binary files /dev/null and b/apps/peppermint/metadata/logo.jpg differ