开始使用

快速开始

按顺序完成 clmbot 的最小可用部署:下载、校验、初始化、发现证书并执行第一次自动更新。

最后检查: 2026-08-09语言: 简体中文

本指南帮助你完成 clmbot 的最小可用部署。全程以 Linux amd64 为例;其他平台请参考安装

凭证安全提示:请勿把 AccessKey、AccessSecret 等凭证写入截图、示例仓库、公开 Issue 或分析事件。文档中的凭证一律使用 <YOUR_ACCESS_KEY> 类占位符。

第 1 步:选择系统和架构

clmbot v0.6.6 提供五个平台构建:macOS amd64、macOS arm64、Linux amd64、Linux arm64、Windows amd64。

前往下载页选择与你的服务器匹配的版本。

第 2 步:下载并验证 SHA256

下载安装包后,务必对照下载页提供的 SHA256 校验值验证文件完整性。校验命令与官方校验值请以下载页为准。

第 3 步:解压并赋予执行权限

将文件上传到服务器并解压后,为二进制文件添加执行权限:

chmod 755 clm-bot-linux-amd64

压缩包内的二进制文件名以实际发布资产为准;当前兼容名如 clm-bot-linux-amd64

第 4 步:查看帮助

运行 --help 确认二进制可正常执行,并了解可用子命令:

./clm-bot-linux-amd64 --help

第 5 步:配置上游地址及凭证

clmbot 的上游可以是 CaaS 证书即服务,也可以是你自己的证书服务。以 CaaS 为上游时,执行登录初始化:

./clm-bot-linux-amd64 login

按提示依次输入接入地址(Endpoint)、AccessKey 和 AccessSecret,然后在上游管理面板中激活该节点。详见配置

以上 login 工作流只适用于 CaaS 上游。私有 CLM 或其他证书服务应使用对应适配说明;如果当前版本尚未提供该上游说明,请先提交适配需求,不要直接套用 CaaS 凭据流程。

第 6 步:发现证书

让 clmbot 自动扫描服务器上已有的证书:

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

命令会列出找到的证书信息和路径,输入 Y 确认后自动生成 config.yaml。详见证书发现

第 7 步:检查生成的 config.yaml

打开 config.yaml,确认 servers[] 中的证书路径、format(如 PEM、JKS)与实际环境一致。字段说明见配置参考

第 8 步:审核 before_script 和 after_script

before_script(更新前执行)与 after_script(更新后执行,通常用于服务重载)会在证书更新时以 clmbot 运行账号的权限执行。上线前必须逐行人工审核这两个脚本,并遵循最小权限原则授权。

第 9 步:手动执行一次更新

在配置定时任务前,先手动验证更新流程:

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

该命令检查上游是否有新证书,抓取并替换后执行 after_script 重载服务。详见自动更新与服务重载

第 10 步:配置定时任务或远程推送

最后选择一种长期运行方式:

  • 定时拉取(推荐):通过 crontab 或 Windows 计划任务定期执行 update-certificate,无需开放入站端口;
  • 远程推送(高级):以 Server 模式运行,由上游通过双向 TLS 主动推送,需开放入站端口(当前示例为 8862/TCP)。

两种模式的对比见运行模式

下一步