README.fr.md

🇺🇸 English | 🇸🇦 العربية | 🇪🇸 Català | 🇨🇿 Čeština | 🇩🇪 Deutsch | 🇪🇸 Español | 🇫🇮 Suomi | 🇫🇷 Français | 🇮🇹 Italiano | 🇯🇵 日本語 | 🇧🇷 Português (Brasil) | 🇷🇺 Русский | 🇹🇭 ไทย | 🇹🇷 Türkçe | 🇺🇦 Українська | 🇻🇳 Tiếng Việt | 🇨🇳 简体中文 | 🇹🇼 繁體中文

Checkmate

Une application open source de surveillance de la disponibilité et de l'infrastructure

Ce dépôt contient à la fois le frontend et le backend de Checkmate, un outil de surveillance open source et auto-hébergeable permettant de suivre le matériel des serveurs, la disponibilité, les temps de réponse et les incidents en temps réel grâce à de belles visualisations. Checkmate vérifie régulièrement la disponibilité et le bon fonctionnement de vos serveurs ou sites web, et fournit des alertes et rapports en temps réel sur la disponibilité, les pannes et les temps de réponse des services surveillés.

Checkmate dispose aussi d'un agent, appelé Capture, pour récupérer des données depuis des serveurs distants. Capture n'est pas requis pour faire tourner Checkmate, mais il apporte des informations supplémentaires sur l'état du CPU, de la RAM, du disque et de la température de vos serveurs. Capture fonctionne sur Linux, Windows, Mac, Raspberry Pi ou tout appareil capable d'exécuter Go.

Checkmate a été testé en charge avec plus de 1 000 moniteurs actifs sans aucun problème ni goulet d'étranglement notable.

📚 Table des matières

• 📦 Démo
• 🔗 Guide utilisateur
• 🛠️ Installation
• 🚀 Performance
• 💚 Questions & idées
• 🧩 Fonctionnalités
• 🏗️ Captures d'écran
• 🏗️ Pile technique
• 🔗 Quelques liens
• 🤝 Contribuer

Démo

Vous pouvez voir la dernière version de Checkmate en action.

L'identifiant est demouser@demo.com et le mot de passe Demouser1! (Note : nous mettons à jour le serveur de démo de temps en temps ; si cela ne fonctionne pas, faites-nous signe sur le canal Discussions).

Guide utilisateur

Les instructions d'utilisation sont disponibles ici.

Prérequis

• Docker installé
• Git installé

Installation

Consultez les instructions d'installation dans le portail de documentation Checkmate.

Vous pouvez également utiliser Coolify, Elestio, K8s, Sive Host (Afrique du Sud), Cloudzy ou Pikapods pour démarrer rapidement une instance Checkmate. Pour surveiller votre infrastructure serveur, vous aurez besoin de l'agent Capture. Le dépôt Capture contient également les instructions d'installation.

Utiliser une autorité de certification personnalisée

Si vous devez surveiller des points d'accès HTTPS internes avec des certificats issus d'autorités de certification privées (comme Smallstep), consultez notre guide de confiance d'autorité de certification personnalisée pour les options de configuration Docker.

Pour plus de documentation, consultez le répertoire docs.

Performance

Grâce à de nombreuses optimisations, Checkmate fonctionne avec une empreinte mémoire exceptionnellement faible, nécessitant un minimum de RAM et de CPU. Voici l'utilisation mémoire d'une instance Node.js sur un serveur qui surveille 323 serveurs chaque minute :

Voici l'empreinte mémoire de MongoDB et Redis sur le même serveur (398 Mo et 15 Mo) pour le même nombre de serveurs :

Questions & idées

Si vous avez des questions, suggestions ou commentaires, plusieurs options s'offrent à vous :

• Canal Discord (préféré)
• Discussions GitHub (nous y passons de temps en temps)

N'hésitez pas à poser vos questions ou partager vos idées — nous adorerions vous entendre !

Fonctionnalités

• Entièrement open source, déployable sur vos serveurs ou appareils personnels (par ex. Raspberry Pi 4 ou 5)
• Plusieurs options de surveillance : disponibilité, Docker, ping, SSL, port, serveur de jeu
• Surveillance de la vitesse des pages
• Surveillance de l'infrastructure (mémoire, utilisation du disque, performance CPU, réseau, etc.) — nécessite l'agent Capture
  • Surveillance sélective du disque avec choix de points de montage
• Incidents en un coup d'œil
• Pages de statut avec 4 thèmes élégants
• Notifications par e-mail, webhooks, Discord, Slack, PagerDuty, Matrix, Microsoft Teams, Telegram, Pushover, Twilio (SMS)
• Maintenance planifiée
• Surveillance par requête JSON
• Support multilingue : arabe, chinois (simplifié), chinois (traditionnel, Taïwan), tchèque, anglais, finnois, français, allemand, japonais, portugais (Brésil), russe, espagnol, thaï, turc, ukrainien et vietnamien

Cycle de vie d'un moniteur

1. Un moniteur exécute une vérification (HTTP / ping / port / matériel via l'agent Capture)
2. Le résultat est stocké (succès/échec + temps de réponse)
3. Les résultats récents sont évalués par rapport au seuil de changement de statut configuré pour le moniteur
4. Si le seuil est atteint et que le statut actuel diffère du précédent, l'état du moniteur change (ex. initializing, up, down, breached)
5. Lors d'un changement d'état, un incident est créé ou résolu selon le statut actuel
6. Des notifications sont déclenchées selon la configuration

Captures d'écran

Pile technique

• ReactJs
• MUI (framework React)
• Node.js
• MongoDB
• Recharts
• Beaucoup d'autres composants open source !

Quelques liens

• Si vous souhaitez nous soutenir, merci de mettre une ⭐ et de cliquer sur « watch ».
• Une question ou une suggestion pour la roadmap ou les fonctionnalités ? Rejoignez notre canal Discord ou les Discussions.
• Besoin d'être notifié à chaque nouvelle version ? Utilisez Newreleases, un service gratuit de suivi des sorties.
• Regardez une vidéo d'installation et d'utilisation de Checkmate

Contribuer

Nous sommes Alex (chef d'équipe), Gorkem, Aryaman, Mert et Karen, et nous aidons les particuliers et les entreprises à surveiller leur infrastructure et leurs serveurs.

Nous sommes fiers de construire des liens solides avec les contributeurs à tous les niveaux. Bien que jeune, Checkmate a déjà obtenu plus de 7 000 étoiles et attiré plus de 90 contributeurs du monde entier.

Notre dépôt a été suivi par des employés de Google, Microsoft, Intel, Cisco, Tencent, Electronic Arts, ByteDance, JP Morgan Chase, Deloitte, Accenture, Foxconn, Broadcom, China Telecom, Barclays, Capgemini, Wipro, Cloudflare, Dassault Systèmes et NEC — alors n'hésitez pas, rejoignez-nous, contribuez et apprenez avec nous !

Voici comment contribuer :

0. Mettez une étoile à ce dépôt :)
1. Consultez le guide du contributeur. Les nouveaux contributeurs sont encouragés à consulter le tag good-first-issue.
2. Lisez une structure détaillée de Checkmate si vous souhaitez plonger dans l'architecture.
3. Ouvrez une issue si vous pensez avoir rencontré un bug.
4. Cherchez les good-first-issue si vous débutez.
5. Faites une pull request pour ajouter de nouvelles fonctionnalités, des améliorations ou corriger des bugs.
6. Découvrez ce parcours interactif de la base de code Checkmate sur CodeCanvas ici. Pour affiner les simulations de flux de données existantes ou en créer de nouvelles, suivez le tutoriel rapide ici.