This project is supported by:
Ticket Management System in order to help helpdesks & service desks manage internal staff & customer requests
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:
mongo:
container_name: db
image: mongo:4
restart: always
volumes:
- ./docker-data/db:/data/db
client:
container_name: peppermint
image: pepperlabs/peppermint:latest
ports:
- 5000:5000
restart: on-failure
depends_on:
- mongo
environment:
MONGO_URI_DOCKER: "mongodb://mongo:27017/peppermint"
JWT_SECRET: "ZwfJtS3muY65CaeZ" # This is an example secret
PORT: 5000
We currently do not have any one click installers for any online marketplace as of yet - but once we get more stable and feature rich that will change.
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. |
JWT_SECRET | Keep your passwords and user logins secure with a JWT SECRET |
MONGO_URI_DOCKER | Have a different url for your mongoDB database? Enter that string here |
PORT | Choose a custom port to run the app on rather than the default 5000 |
If you're interested in trying out Peppermint we currently have a demo working here.
The credentials are
email: [email protected]
password: 1234
- ๐ก Job Logging
- ๐ Client History
- ๐ Notes creation & Todo List
- ๐ Admin Page: Admin Dashboard for easy webUI changes and analytics
- ๐ฑ Responsive: Designed for variable screen sizes from mobile up to 4k
- โ๏ธ Docker-Ready: Quickly deploy using docker
- โ Usage: No barriers to use with complete documentation on how to complete tasks
There is currently a trello roadmap available which is updated daily - https://trello.com/b/tOMsptar/peppermint
We have started working on creating documentation for peppermint which covers development to general usage. Click here to be taken directly there.
If you're interested in developing for Peppermint, wether that be a bug fix or locally we have a guide on our wiki
We currently have an image for arm devices but are seeing issues with mongoDB so we do not offically support 32 bit or 64 bit as of this time.
๐ค Jack Andrews
- Website: pmint.dev
- Twitter: @andrewsjack18
- Github: @potts99
- LinkedIn: @jack-andrews-146852131
Contributions, issues and feature requests are welcome!
Feel free to check issues page.
Give a โญ๏ธ if this project helped you!