Peppermint

An open source issue management & help desk solution.

访问

Web interface: https://<SERVER_IP>

API endpoint: https://<SERVER_IP>:5004

Default admin credentials:

Change the admin credentials immediately after first login.

Self-Signed Certificate Notice

This installation uses a self-signed TLS certificate.

A browser SSL warning is expected.

For API calls using curl, you must ignore certificate validation:

curl -k https://<SERVER_IP>:5004

The -k flag tells curl to skip TLS certificate verification.

Example to obtain API token:

curl -k https://<SERVER_IP>:5004/api/v1/auth/login 
  -H "Content-Type: application/json" 
  -d '{"email":"[email protected]","password":"1234"}'

This returns a JSON response containing a token.

Example to obtain API token:

curl -k -i https://<SERVER_IP>:5004/api/v1/<VALID_ENDPOINT> 
  -H "Authorization: Bearer <TOKEN>"

For production environments, replace the self-signed certificate with a trusted SSL certificate (e.g., Let’s Encrypt).

重要文件与目录

  • 安装目录: /root/peppermint
  • Environment variables (DB credentials, secrets, BASE_URL): /root/peppermint/.env
  • Docker Compose 配置: /root/peppermint/docker-compose.yml
  • PostgreSQL persistent data (Docker volume): /var/lib/docker/volumes/pgdata/_data
  • Nginx reverse proxy configs: /etc/nginx/conf.d/peppermint-client.conf & /etc/nginx/conf.d/peppermint-api.conf
  • TLS certificates (self-signed or Let’s Encrypt): /etc/nginx/ssl/

为域名启用SSL

1. 将您的域名指向服务器IP地址。

2. 编辑 /root/peppermint/.env 文件用于设置您的域名: BASE_URL=https://your.domain.com

3. 重建服务:

cd /root/peppermint/
docker compose up -d

4. Edit Nginx configs and replace server_name <IP>; 使用您的域名 (<your-domain>) 同时适用于 HTTP(端口 80)和 HTTPS(端口 443)的封堵:

vim /etc/nginx/conf.d/peppermint-client.conf
vim /etc/nginx/conf.d/peppermint-api.conf

5. 安装 Certbot:

apt install -y certbot python3-certbot-nginx

6. 运行以下命令生成有效的Let’s Encrypt证书:

certbot certonly --nginx --non-interactive --agree-tos --email [email protected] -d yourdomain.com

7. 在 Nginx 配置文件中替换 SSL 路径(TLS 部分):

vim /etc/nginx/conf.d/peppermint-client.conf
vim /etc/nginx/conf.d/peppermint-api.conf

# Before:
    # ssl_certificate /etc/nginx/ssl/fullchain.pem;
    # ssl_certificate_key /etc/nginx/ssl/privkey.pem;
# After:
    # ssl_certificate /etc/letsencrypt/live/yourdomain.com/fullchain.pem;
    # ssl_certificate_key /etc/letsencrypt/live/yourdomain.com/privkey.pem;

8. 重启 Nginx 以应用更改:

systemctl restart nginx

9. 打开浏览器并访问: https://yourdomain.com

申请详情