Comment installer le système de page de statut Cachet sur Debian 12

Cachet est un système de page de statut open-source écrit en PHP. Il vous permet de surveiller les temps d’arrêt et les pannes de votre infrastructure. Cachet fournit une API JSO, des rapports, des métriques, plusieurs méthodes de notification et une authentification à deux facteurs.

Dans le tutoriel suivant, nous vous montrerons comment installer la page de statut Cachet sur un serveur Debian 12. Vous exécuterez Cachet en tant que conteneur Docker avec la base de données PostgreSQL et le serveur web Nginx.

Prérequis

Avant de continuer, assurez-vous d’avoir les éléments suivants :

• Un serveur Debian 12.
• Un utilisateur non-root avec des privilèges sudo.
• Un UFW installé et configuré.
• Un nom de domaine pointé vers une adresse IP de serveur.

Installation de Docker Engine

Dans cet exemple, vous allez installer Cachet en tant que conteneur via Docker. Vous devez donc installer le moteur Docker sur votre système Debian. Dans cet exemple, vous utiliserez les paquets officiels du moteur Docker.

Tout d’abord, exécutez la commande ci-dessous pour installer les paquets curl et ca-certificates.

sudo apt install ca-certificates curl -y

Ajoutez maintenant la clé GPG pour le dépôt Docker en exécutant la commande suivante.

sudo install -m 0755 -d /etc/apt/keyrings  
sudo curl -fsSL https://download.docker.com/linux/debian/gpg -o /etc/apt/keyrings/docker.asc  
sudo chmod a+r /etc/apt/keyrings/docker.asc

Ensuite, ajoutez le dépôt Docker Engine pour le système Debian en utilisant la commande ci-dessous.

echo \  
"deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/debian \  
$(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \  
sudo tee /etc/apt/sources.list.d/docker.list > /dev/null

Une fois le dépôt Docker ajouté, mettez à jour et rafraîchissez votre index de paquets avec la commande ci-dessous.

sudo apt update

Installez maintenant Docker Engine sur votre système avec la commande suivante. Tapez Y pour confirmer l’installation.

sudo apt install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin

Après l’installation, le service Docker devrait démarrer automatiquement. Vérifiez l’état du service Docker avec la commande ci-dessous.

sudo systemctl status docker

Vous verrez la sortie en cours d’exécution comme suit :

Pour vous assurer que votre utilisateur peut exécuter et exécuter le conteneur, vous devez l’ajouter au groupe docker avec la commande ci-dessous.

sudo usermod -aG sudo alice

Enfin, connectez-vous en tant qu’utilisateur et exécutez la commande docker ci-dessous pour exécuter un conteneur hello-world.

su - alice  
docker run hello-world

Si votre configuration est réussie, vous devriez obtenir la sortie ‘Hello Docker’ comme suit :

Exécution de Cachet avec Docker et la base de données PostgreSQL

Après avoir installé Docker, vous devez télécharger le projet Cachet et configurer votre installation. Dans ce cas, vous allez installer et exécuter Cachet en tant qu’utilisateur non-root avec un conteneur Docker.

Téléchargez le projet Cachet dans le répertoire cachet-docker et entrez dans celui-ci.

git clone https://github.com/cachethq/Docker.git cachet-docker  
cd cachet-docker

Ouvrez le fichier docker-compose.yml en utilisant la commande de l’éditeur nano suivante.

nano docker-compose.yml

Changez le port d’hôte par défaut en 8000 comme suit. Vous pouvez également personnaliser les détails de la base de données avec vos informations et laisser la version par défaut de Cachet à 2.4 pour l’instant.

 ports:  
 - 8000:8000

Enregistrez le fichier et quittez.

Exécutez maintenant les commandes docker suivantes pour construire votre image Cached et exécuter des conteneurs pour Cachet et PostgreSQL.

docker compose build  
docker compose up

Ci-dessous, vous pouvez voir la capture d’écran lors de la construction de l’image Docker pour Cachet.

Ci-dessous se trouve la capture d’écran lors de l’exécution des conteneurs/services pour Cachet et PostgreSQL.

Dans les journaux détaillés du conteneur Cachet, vous trouverez une erreur concernant la configuration APP_KEY. Copiez la APP_KEY générée et appuyez sur Ctrl+c pour terminer les conteneurs.

Ensuite, rouvrez le fichier docker-compose.yml en utilisant l’éditeur nano.

nano docker-compose.yml

Changez le paramètre APP_KEY par défaut comme suit. Assurez-vous d’inclure la chaîne base64.

APP_KEY=base64:WfKUhY0wAOyr5hkxoctZUSWPGdXbBUWFvNLCoI7kTU8=

Enregistrez le fichier et quittez.

Exécutez maintenant la commande docker ci-dessous pour terminer les conteneurs pour Cachet et PostgreSQL, puis redémarrez-les.

docker compose down  
docker compose up -d

Une fois les conteneurs démarrés, vérifiez la liste des conteneurs en cours d’exécution en utilisant la commande suivante.

docker compose ps

Comme vous pouvez le voir ci-dessous, les conteneurs Cachet et PostgreSQL sont en cours d’exécution. Le conteneur Cachet fonctionne sur le port 8000.

Configuration de Nginx en tant que proxy inverse

Maintenant que Cachet fonctionne en tant que conteneur sur le port 8000, vous allez installer et configurer Nginx en tant que proxy inverse pour Cachet.

Installez Nginx sur votre serveur Debian en utilisant la commande ci-dessous.

sudo apt install nginx -y

Une fois l’installation terminée, créez une nouvelle configuration de bloc de serveur Nginx /etc/nginx/sites-available/cachet en utilisant la commande de l’éditeur nano ci-dessous.

sudo nano /etc/nginx/sites-available/cachet

Insérez la configuration ci-dessous et assurez-vous de changer le paramètre server_name avec votre nom de domaine.

server {  
 listen 80;  
 server_name status.howtoforge.local;  
 location / {  
 proxy_pass http://127.0.0.1:8000;  
 proxy_set_header Host $host;  
 proxy_set_header X-Real-IP $remote_addr;  
 proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;  
 proxy_set_header X-Forwarded-Proto $scheme;  
 }  
}

Enregistrez le fichier et quittez l’éditeur.

Ensuite, exécutez la commande Nginx ci-dessous pour activer le bloc de serveur Cachet et vérifier votre syntaxe Nginx. Si vous avez une syntaxe correcte, vous devriez obtenir une sortie ‘syntax is ok‘.

sudo ln -s /etc/nginx/sites-available/cachet /etc/nginx/sites-enabled/  
sudo nginx -t

Enfin, redémarrez le serveur web Nginx pour appliquer la configuration du bloc de serveur Cachet et vérifiez le service Nginx pour vous assurer qu’il fonctionne.

sudo systemctl restart nginx  
sudo systemctl status nginx

Si Nginx fonctionne, vous devriez obtenir une sortie active(running).

Configuration de UFW (Pare-feu simplifié)

Avant d’accéder à Cachet, vous devez vous assurer que les ports HTTP et HTTPS sont autorisés. Sur Ubuntu, vous autoriserez le trafic vers les protocoles HTTP et HTTPS via UFW (Pare-feu simplifié).

Assurez-vous que UFW est activé, maintenant exécutez la commande suivante pour activer le profil ‘Nginx Full‘ sur UFW. Cela permettra le trafic pour les protocoles HTTP et HTTPS vers votre serveur web Nginx.

sudo ufw allow 'Nginx Full'

Vérifiez maintenant votre liste de règles activées dans UFW avec la commande ci-dessous.

sudo ufw status

Vous verrez que le profil ‘Nginx Full‘ est activé sur UFW.

Sécurisation de Cachet avec HTTPS

À ce stade, votre Cachet devrait être accessible via Nginx. Pour sécuriser votre installation, vous allez activer HTTPS pour Cachet via SSL de Letsencrypt.

Exécutez donc la commande ci-dessous pour installer Certbot et le plugin Certbot Nginx. Entrez Y pour confirmer l’installation.

sudo apt install certbot python3-nginx-certbot

Une fois l’installation terminée, exécutez la commande certbot ci-dessous pour générer des certificats SSL/TLS pour votre installation Cachet. Assurez-vous de changer les détails du nom de domaine et de l’adresse e-mail avec vos informations.

sudo certbot --nginx --agree-tos --redirect --hsts --staple-ocsp --email [email protected] -d status.howtoforge.local

Après tout, vos certificats SSL/TLS devraient être stockés dans le répertoire /etc/lestencrypt/live/status.howtoforge.local. De plus, votre Cachet devrait être sécurisé via HTTPS.

Installation de Cachet

Lancez votre navigateur web préféré et visitez votre installation Cachet https://status.howtoforge.local/. Si votre installation est réussie, vous devriez obtenir la page suivante.

Sélectionnez le Cache Driver, Queue Driver, et Session Driver par défaut sur Database. Ensuite, saisissez les détails de votre serveur de messagerie.

Cliquez sur Next pour continuer.

Maintenant, configurez le nom de la page de statut, le fuseau horaire par défaut et la langue par défaut. Ensuite, cliquez à nouveau sur Next.

Maintenant, créez un nouvel utilisateur administrateur pour Cachet en saisissant votre nom d’utilisateur, votre e-mail et votre mot de passe. Ensuite, cliquez sur Complete Setup pour confirmer.

Une fois terminé, vous verrez ce qui suit - cliquez sur Go to the dashboard.

Connectez-vous à Cachet avec votre nom d’utilisateur et votre mot de passe, puis cliquez sur Login.

Si votre installation est réussie, vous devriez obtenir le tableau de bord Cachet comme suit :

Conclusion

Félicitations ! Vous avez maintenant installé la page de statut Cachet sur le serveur Debian 12 avec Docker. Votre installation Cachet fonctionne avec une base de données PostgreSQL et un serveur web Nginx. Vous pouvez maintenant surveiller vos sites en utilisant Cachet.