elestio/peppermint repository overview

⁠

⁠Peppermint, verified and packaged by Elestio

Peppermint⁠ An open source ticket management & help desk solution. A zendesk/freshdesk alternative.

Deploy a fully managed Peppermint⁠ on elest.io⁠ if you want automated backups, reverse proxy with SSL termination, firewall, automated OS & Software updates, and a team of Linux experts and open source enthusiasts to ensure your services are always safe, and functional.

⁠Why use Elestio images?

• Elestio stays in sync with updates from the original source and quickly releases new versions of this image through our automated processes.
• Elestio images provide timely access to the most recent bug fixes and features.
• Our team performs quality control checks to ensure the products we release meet our high standards.

⁠Usage

⁠Git clone

You can deploy it easily with the following command:

git clone https://github.com/elestio-examples/peppermint.git

Copy the .env file from tests folder to the project directory

cp ./tests/.env ./.env

Edit the .env file with your own values.

Run the project with the following command

docker-compose up -d

You can access the Web UI at: http://your-domain:32769

⁠Docker-compose

Here are some example snippets to help you get started creating a container.

version: "3.7"

services:
    peppermint:
      image: elestio/peppermint:latest
      ports:
        - 172.17.0.1:32769:3000
        - 1001:5003
      restart: always
      depends_on:
        - postgres
      environment:
        DB_USERNAME: ${DB_USERNAME}
        DB_PASSWORD: ${DB_PASSWORD}
        DB_HOST: ${DB_HOST}
        SECRET: ${ADMIN_PASSWORD}

    postgres:
      image: elestio/postgres:15
      restart: always
      volumes:
        - ./postgres-data:/var/lib/postgresql/data
      environment:
        - POSTGRES_DB=${DB_DATABASE}
        - POSTGRES_USER=${DB_USERNAME}
        - POSTGRES_PASSWORD=${DB_PASSWORD}
      ports:
        - "172.17.0.1:39530:5432"

⁠Environment variables

⁠Maintenance

⁠Logging

The Elestio Peppermint Docker image sends the container logs to stdout. To view the logs, you can use the following command:

docker-compose logs -f

To stop the stack you can use the following command:

docker-compose down

⁠Backup and Restore with Docker Compose

To make backup and restore operations easier, we are using folder volume mounts. You can simply stop your stack with docker-compose down, then backup all the files and subfolders in the folder near the docker-compose.yml file.

Creating a ZIP Archive For example, if you want to create a ZIP archive, navigate to the folder where you have your docker-compose.yml file and use this command:

zip -r myarchive.zip .

Restoring from ZIP Archive To restore from a ZIP archive, unzip the archive into the original folder using the following command:

unzip myarchive.zip -d /path/to/original/folder

Starting Your Stack Once your backup is complete, you can start your stack again with the following command:

docker-compose up -d

That's it! With these simple steps, you can easily backup and restore your data volumes using Docker Compose.

⁠Links

• Peppermint documentation⁠

• Peppermint Github repository⁠

• Elestio/Peppermint Github repository⁠