Skip to main content

Quick Start

This page guides you through deploying clmBot within 15 minutes and completing a full certificate renewal workflow.

Before you begin, make sure:

  • You have activated the sslTrus CaaS service and can log in to the admin console.
  • The target server can access cloud services via outbound connections.
  • You have administrator privileges on the server (for installing and initializing clmBot).

Step 1: Generate AccessKey / AccessSecret​

Log in to the admin console, go to sslTrus CaaS Service -> Product Details -> SSL Certificate Details, and click 生成AK/SK to obtain the AccessKey (AK) and AccessSecret (SK).

Note

Keep the AccessKey and AccessSecret secure. Do not commit the AccessSecret to a Git repository, include it in public scripts, or send it to untrusted third-party systems. If you suspect a leak, regenerate them in the admin console.

Step 2: Download clmBot and Upload It to the Server​

Download the program for the corresponding system version from the clmBot release page:

Download clmBot

Select the appropriate version based on your server's operating system and architecture (e.g., clm-bot-linux-amd64), and upload it to the server. It is recommended to create a dedicated installation directory, such as /opt/clm-bot.

mkdir -p /opt/clm-bot && cd /opt/clm-bot
chmod 755 clm-bot-linux-amd64

Step 3: Log In and Connect​

Run the login command in the installation directory to complete the connection:

./clm-bot-linux-amd64 login

Follow the prompts to first select the cloud address sequence number (or directly enter the cloud address), then enter AccessKey and AccessSecret one after another.

After login succeeds, clmBot will generate the config.yaml configuration file in the installation directory to save the access information.

Step 4: Activate the node in the admin console​

Log in to the admin console, go to the clmBot node list, and you can see that a new clmBot node has been added. Click the Allow access toggle on the right side of the node to activate it.

Note

Newly accessed nodes are disabled by default. Only after activation in the admin console can clmBot fetch certificates from the cloud normally.

Step 5: Discover certificates on the server​

Run the certificate discovery command to automatically scan the certificates already deployed on the server and their storage paths:

./clm-bot-linux-amd64 discover-certificate

After the command is executed, the found certificate information will be listed in a table (source, type, issuer, path, domain, etc.). Enter the serial number of the certificate you want to upload to confirm adding it to the backend management:

  • all: Upload all
  • none: Do not upload
  • 1,3-5: Select by serial number, supports range notation

After the upload is successful, these certificates will appear as installation points in the management backend. The clmBot will generate corresponding configuration for each installation point in the config.yaml file in the current directory.

Information

In the automatically generated configuration, each installation point has before_script and after_script fields, where after_script is the reload script executed after certificate renewal, and you need to verify whether it is available based on the actual environment. For the meaning of the fields, see Configuration Reference.

Step 6: Complete the First Certificate Renewal​

After setting an automatic re-issuance cycle for certificates in the admin console (see Certificate Update Method), you can manually trigger an update to verify the entire process:

./clm-bot-linux-amd64 update-certificate

After execution, clmBot will check whether the cloud has a newer certificate:

  • Local certificate is already up to date: outputs a prompt and skips.
  • A new certificate exists in the cloud: attempts to generate a .bak backup, writes the new certificate, and performs after_script according to the configuration. If the backup fails, an error is logged but the update continues; whether the service is fully reloaded should be confirmed based on the script result and middleware status.

Next Steps​