Skip to main content

Navigation

clmBot is a lightweight client deployed on your intranet server, used to automatically complete SSL certificate deployment and renewal: it retrieves the latest certificates from the cloud, writes them to the certificate installation points on the server, and executes scripts as configured to reload middleware services.

How It Works​

The clmBot certificate renewal process is as follows:

  1. Before a certificate expires, the cloud automatically completes certificate re-issuance and generates a new certificate.
  2. clmBot retrieves the latest certificate via cloud push or scheduled pull.
  3. clmBot attempts to back up and replace the local certificate files on the server; backup failures are logged as errors but do not block subsequent updates.
  4. clmBot executes the reload script (after_script) as configured; whether it takes effect depends on the script execution result and the middleware status.

The entire process requires no manual login to the server to replace certificates, and does not expose the server's management entry point to the outside.

Supported Renewal Methods​

clmBot supports two certificate renewal methods, which can be selected independently on different servers:

Renewal MethodWorking ModePort RequirementsApplicable Scenarios
Cloud PushThe management console initiates a push, and the clmBot service on the server receives and updates the certificateInbound port 8862/tcp must be openedNetwork policies allow opening inbound ports, and immediate renewal is desired
Scheduled PullclmBot runs periodically via crontab or Windows Task Scheduler to check and pull the latest certificateNo inbound port required; only outbound access to the cloud is neededServers where inbound ports cannot be opened (recommended as the default method)

For detailed configuration, refer to Certificate Renewal Methods.

Supported Platforms and Middleware​

Supported operating systems:

  • Linux (amd64, arm64)
  • macOS (amd64, arm64)
  • Windows (amd64; legacy compatibility package for older Windows versions)

Supported middleware and certificate formats:

MiddlewareCertificate FormatDescription
nginxPEMCertificate, CA chain, and private key deployed separately
Apache HTTP ServerPEMCertificate, CA chain, and private key deployed separately
TomcatPEM / JKSSupports PEM certificates or JKS keystore
IISIISImports PFX and updates site bindings via built-in script; requires administrator privileges
ExchangeExchangeRenewal only; discovery, query, and sync-server are not supported; requires administrator privileges
Others (custom scripts)PFX, etc.Supports any scenario via custom after_script

How to Choose a Document​

Use CaseRecommended Page
First-time use, want to quickly deploy and complete a certificate renewalQuick Start
Learn the detailed configuration of the two renewal methodsCertificate Renewal Methods
Manually add installation points, sync installation points from the backend, or use the local web configuration pageInstallation Point Management
View config.yaml field meanings, script template variablesConfiguration Reference
View complete certificate installation and reload examples for middleware such as nginx, Apache, TomcatConfiguration Examples
Tighten clmBot runtime permissions and configure sudoers in production environmentsRuntime Permission Requirements
Register clmBot as a system service, upgrade versions, view logsService Deployment and Upgrade

Quick Start​

If you are using clmBot for the first time, we recommend following the path below:

  1. Generate AccessKey / AccessSecret in the admin console.
  2. Download clmBot and upload it to the server.
  3. Run login to complete the integration and activate the node in the console.
  4. Run discover-certificate to automatically discover certificates on the server.
  5. Configure the update method (push or scheduled pull).

For full steps, refer to Quick Start.