Borsmenta

Egy nyílt forráskódú hibakezelő és ügyfélszolgálati megoldás.

Hozzáférés

Webes felület: https://<SERVER_IP>

API-végpont: https://<SERVER_IP>:5004

Alapértelmezett rendszergazdai bejelentkezési adatok:

Az első bejelentkezés után azonnal módosítsa az adminisztrátori bejelentkezési adatokat.

Értesítés az önaláírt tanúsítványról

Ez a telepítés önaláírt TLS-tanúsítványt használ.

A böngésző várhatóan SSL-figyelmeztetést jelenít meg.

Az alábbiakat használó API-hívások esetén curl, akkor figyelmen kívül kell hagynia a tanúsítvány érvényesítését:

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

A -k A flag utasítja a curl-t, hogy hagyja ki a TLS-tanúsítvány ellenőrzését.

Példa az API-tokennak a megszerzésére:

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

Ez egy tokent tartalmazó JSON-választ ad vissza.

Példa az API-tokennak a megszerzésére:

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

Termelési környezetben cserélje ki az önaláírt tanúsítványt egy megbízható SSL-tanúsítványra (pl. Let’s Encrypt).

Fontos fájlok és könyvtárak

  • Telepítési könyvtár: /root/peppermint
  • Környezeti változók (adatbázis-hitelesítő adatok, titkos kulcsok, BASE_URL): /root/peppermint/.env
  • Docker Compose konfiguráció: /root/peppermint/docker-compose.yml
  • PostgreSQL állandó adatállomány (Docker-kötet): /var/lib/docker/volumes/pgdata/_data
  • Nginx fordított proxy konfigurációk: /etc/nginx/conf.d/peppermint-client.conf & /etc/nginx/conf.d/peppermint-api.conf
  • TLS-tanúsítványok (önaláírt vagy Let’s Encrypt): /etc/nginx/ssl/

SSL engedélyezése domainnel

1. Irányítsa domainjét a szerver IP-címére.

2. Szerkessze a /root/peppermint/.env fájl a domain név beállításához: BASE_URL=https://your.domain.com

3. A szolgáltatások újbóli létrehozása:

cd /root/peppermint/
docker compose up -d

4. Szerkessze az Nginx-konfigurációkat, és cserélje ki server_name <IP>; a domainjével (<your-domain>) mind a HTTP (80-as port), mind a HTTPS (443-as port) blokkok esetében:

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

5. Telepítse a Certbotot:

apt install -y certbot python3-certbot-nginx

6. Futtassa a következő parancsot egy érvényes Let’s Encrypt tanúsítvány létrehozásához:

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

7. Cserélje ki az SSL útvonalakat az Nginx konfigurációban (TLS szakasz):

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. Indítsa újra az Nginx-et a változások alkalmazásához:

systemctl restart nginx

9. Nyissa meg a böngészőjét, és látogasson el a következő webhelyre: https://yourdomain.com

Az alkalmazás részletei