Accès
Web interface: https://<SERVER_IP>
API endpoint: https://<SERVER_IP>:5004
Default admin credentials:
- Courriel :
[email protected] - Mot de passe :
1234
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).
Fichiers et répertoires importants
- Répertoire d'installation :
/root/peppermint - Environment variables (DB credentials, secrets, BASE_URL):
/root/peppermint/.env - Configuration 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/
Activation du protocole SSL avec un domaine
1. Pointez votre domaine vers l'adresse IP du serveur.
2. Modifier le /root/peppermint/.env fichier pour définir votre nom de domaine : BASE_URL=https://your.domain.com
3. Recréer les services :
cd /root/peppermint/
docker compose up -d
4. Edit Nginx configs and replace server_name <IP>; avec votre domaine (<your-domain>) pour les blocs HTTP (port 80) et HTTPS (port 443) :
vim /etc/nginx/conf.d/peppermint-client.conf
vim /etc/nginx/conf.d/peppermint-api.conf
5. Installez Certbot :
apt install -y certbot python3-certbot-nginx
6. Exécutez la commande suivante pour générer un certificat Let's Encrypt valide :
certbot certonly --nginx --non-interactive --agree-tos --email [email protected] -d yourdomain.com
7. Remplacer les chemins SSL dans la configuration Nginx (section 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. Redémarrez Nginx pour appliquer les modifications :
systemctl restart nginx
9. Ouvrez votre navigateur et rendez-vous sur : https://yourdomain.com