Aller au contenu principal

Navigation

clmBot est un client léger déployé sur votre serveur intranet, utilisé pour automatiser le déploiement et la mise à jour des certificats SSL : il récupère les derniers certificats depuis le cloud, les écrit dans les points d'installation des certificats sur le serveur, et exécute des scripts selon la configuration pour recharger les services intermédiaires.

Mode de fonctionnement​

Le processus de mise à jour des certificats de clmBot est le suivant :

  1. Avant l'expiration du certificat, le cloud effectue automatiquement la réémission du certificat pour générer un nouveau certificat.
  2. clmBot récupère le dernier certificat via une poussée du cloud ou une récupération périodique.
  3. clmBot tente de sauvegarder et de remplacer les fichiers de certificats locaux sur le serveur ; en cas d'échec de la sauvegarde, une erreur est enregistrée, mais cela n'empêche pas la mise à jour suivante.
  4. clmBot exécute le script de rechargement selon la configuration (after_script) ; son efficacité dépend du résultat d'exécution du script et de l'état de l'intergiciel.

Tout le processus ne nécessite aucune connexion manuelle au serveur pour remplacer les certificats, et n'expose pas non plus l'entrée d'administration du serveur à l'extérieur.

Méthodes de mise à jour prises en charge​

clmBot prend en charge deux méthodes de mise à jour des certificats, qui peuvent être sélectionnées séparément sur différents serveurs :

Méthode de mise à jourMode de fonctionnementExigence de portScénario d'application
Poussée du cloudLa console d'administration initie la poussée, le service clmBot sur le serveur la reçoit et met à jour le certificatDoit ouvrir le port entrant 8862/tcpLa stratégie réseau autorise l'ouverture du port entrant, mise à jour souhaitée en temps réel
Récupération périodiqueExécution périodique de clmBot via crontab ou le Planificateur de tâches Windows pour vérifier et récupérer le dernier certificatAucun port entrant requis, uniquement un accès sortant vers le cloudServeurs ne pouvant pas ouvrir de port entrant (méthode recommandée par défaut)

Pour la configuration détaillée, veuillez consulter Méthodes de mise à jour des certificats.

Plateformes et intergiciels pris en charge​

Systèmes d'exploitation pris en charge :

  • Linux (amd64, arm64)
  • macOS (amd64, arm64)
  • Windows (amd64 ; anciennes versions de Windows utilisent le paquet de compatibilité legacy)

Intergiciels et formats de certificats pris en charge :

IntergicielFormat de certificatDescription
nginxPEMDéploiement séparé du certificat, de la chaîne CA et de la clé privée
Apache HTTP ServerPEMDéploiement séparé du certificat, de la chaîne CA et de la clé privée
TomcatPEM / JKSPrend en charge les certificats PEM ou le keystore JKS
IISIISImporte le PFX via un script intégré et met à jour la liaison du site, nécessite des privilèges administrateur
ExchangeExchangePrend uniquement en charge la mise à jour ; ne prend pas en charge la découverte, la requête ou sync-server, nécessite des privilèges administrateur
Autres (scripts personnalisés)PFX, etc.Prend en charge tout scénario via des after_script personnalisés

Comment choisir le document​

Scénario d'utilisationPage recommandée
Première utilisation, déploiement rapide et réalisation d'une première mise à jour de certificatDémarrage rapide
Comprendre la configuration détaillée des deux méthodes de mise à jourMéthodes de mise à jour des certificats
Ajouter manuellement des points d'installation, synchroniser les points d'installation depuis le backend, utiliser la page de configuration Web localeGestion des points d'installation
Consulter la signification des champs de config.yaml et les variables des modèles de scriptsRéférence de configuration
Consulter des exemples complets d'installation des certificats et de rechargement de nginx, Apache, Tomcat et d'autres middlewaresExemples de configuration
Restreindre les droits d'exécution de clmBot en production et configurer sudoersExigences de droits d'exécution
Enregistrer clmBot comme service système, le mettre à niveau et consulter les journauxDéploiement en service et mise à niveau

Démarrage rapide​

Si vous utilisez clmBot pour la première fois, suivez le cheminement suivant :

  1. Générez un AccessKey / AccessSecret dans le panneau d'administration.
  2. Téléchargez clmBot et téléversez-le sur le serveur.
  3. Exécutez login pour terminer la connexion, puis activez le nœud dans le panneau.
  4. Exécutez discover-certificate pour découvrir automatiquement les certificats sur le serveur.
  5. Configurez la méthode de mise à jour (push ou pull planifié).

Pour la procédure complète, consultez Démarrage rapide.