Back to all templates
Peppermint logo

Peppermint

Application1024MB+ RAM

Open source ticket management and help-desk system with team collaboration

applicationsupportpeppermintopen-sourceself-hosteddocker

Deploy Peppermint in 3 Steps

1

Connect Your VPS

Add your server credentials to Server Compass

2

Select Peppermint

Choose from our template library

3

Deploy & Configure

Fill in settings and click Deploy

No Docker knowledge required
Step-by-step deployment guide

Deploy Peppermint on a VPS with Server Compass

Use the Peppermint template in Server Compass to deploy a self-hosted help desk and ticket management app with Postgres, then verify the web UI in a browser.

About 10 minutesBrowser verified
1
Step 1

Open the server Apps tab

Select the tutorial-vps VPS, open the Apps tab, and start a new app deployment. Keep sensitive server details hidden before capturing or sharing screenshots.

Server Compass Apps tab before creating an Peppermint app
2
Step 2

Choose an app template

Click New App and choose the template deployment path so Server Compass can load the built-in catalog.

Choosing to deploy an app from a Server Compass template
3
Step 3

Search for Peppermint

Use the template picker search to find Peppermint in the Server Compass template catalog.

Searching for Peppermint in the Server Compass template picker
4
Step 4

Select the Peppermint template

Choose the Peppermint template. Server Compass fills the web service, public API URL, application secret, Postgres database, and persistent storage volume.

Peppermint template selected in Server Compass
5
Step 5

Review the Peppermint settings

Confirm the app name and web UI port. In this run, the app was named peppermint-demo and used host port 4112.

Reviewing Peppermint project settings and compose service
6
Step 6

Deploy Peppermint

Review the generated compose settings, confirm the Peppermint web port is available, and click Deploy.

Reviewing Peppermint web port before deployment
7
Step 7

Watch the deployment progress

Keep the deployment modal open while Server Compass uploads the compose file, pulls the Peppermint image, starts the container, and verifies the stack.

Server Compass deploying the Peppermint template on the VPS
8
Step 8

Confirm Peppermint is running

After deployment finishes, return to the Apps tab and confirm the Peppermint app is marked Running with its application URL available.

Peppermint template running in the Server Compass Apps tab
9
Step 9

Open Peppermint in the browser

Open the application URL in a browser. The Peppermint installer or login page confirms the billing platform is reachable.

The deployed Peppermint web UI loaded in a browser

After Peppermint Opens

  • Complete the installer and create the initial administrator account.
  • Configure payment gateways such as Stripe or PayPal.
  • Create product categories and your first product.
  • Back up both the Peppermint storage volume and MariaDB volume.

Verified Result

The Peppermint web interface loaded successfully from the deployed container.

Peppermint deployment questions

What does the Peppermint template deploy?

It deploys the Peppermint billing web app with a MariaDB database and persistent application storage.

Which port did the tutorial use?

The tutorial used host port 4112, which maps to the Peppermint web UI on container port 80.

Does Peppermint need setup after deployment?

Yes. Complete the installer, create the first admin account, and configure payment gateways and email.

Should this become a blog post?

No. The deployment guide should live on the Peppermint template detail page and be linked from the reusable template deployment docs page.

After Deployment

After deploying Peppermint with Server Compass, complete these steps to finish setup

1

Visit API_URL and log in with [email protected] / 1234

2

Change the admin password immediately

3

Configure SMTP for outbound notifications

4

Create your first client and ticket

Need help? Check out our documentation for detailed guides.

Peppermint FAQ

Common questions about self-hosting Peppermint

How do I deploy Peppermint with Server Compass?

Simply download Server Compass, connect to your VPS, and select Peppermint from the templates list. Fill in the required configuration and click Deploy. The entire process takes under 3 minutes.

What are the system requirements for Peppermint?

Peppermint requires a minimum of 1024MB RAM. We recommend a VPS with at least 2048MB RAM for optimal performance. Any modern Linux server with Docker support will work.

Can I migrate my existing Peppermint data?

Yes! Server Compass provides volume mapping that allows you to import existing data. You can also use standard Peppermint backup and restore procedures.

How do I update Peppermint to the latest version?

Server Compass makes updates easy. Simply click the Update button in your deployment dashboard, and the latest Peppermint image will be pulled and deployed with zero downtime.

Is Peppermint free to self-host?

Peppermint is open-source software. You only pay for your VPS hosting (typically $5-20/month) and optionally Server Compass ($29 one-time). No subscription fees or per-seat pricing.

Ready to Self-Host Peppermint?

Download Server Compass and deploy Peppermint to your VPS in under 3 minutes. No Docker expertise required.

Download Server Compass