github
/
certd
mirror of https://github.com/certd/certd
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

chore: doc

pull/213/head
xiaojunnuo 2024-10-11 00:48:24 +08:00
parent 614ce97898
commit 52bf8a1bb6
3 changed files with 34 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -29,11 +29,11 @@ https://certd.handsfree.work/
## 三、使用教程 ## 三、使用教程
本案例演示，如何配置自动申请证书，并部署到阿里云CDN，然后快要到期前自动更新证书并重新部署 本案例演示，如何配置自动申请证书，并部署到阿里云CDN，然后快要到期前自动更新证书并重新部署
![演示](packages/ui/certd-client/public/statics/doc/images/5-view.png) ![演示](packages/ui/certd-client/public/static/doc/images/5-view.png)
![演示](packages/ui/certd-client/public/statics/doc/images/9-start.png) ![演示](packages/ui/certd-client/public/static/doc/images/9-start.png)
![演示](packages/ui/certd-client/public/statics/doc/images/10-1-log.png) ![演示](packages/ui/certd-client/public/static/doc/images/10-1-log.png)
![演示](packages/ui/certd-client/public/statics/doc/images/13-3-download.png) ![演示](packages/ui/certd-client/public/static/doc/images/13-3-download.png)
![演示](packages/ui/certd-client/public/statics/doc/images/13-1-result.png) ![演示](packages/ui/certd-client/public/static/doc/images/13-1-result.png)
↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓ ↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓
-------> [点我查看详细使用步骤演示](./step.md) <-------- -------> [点我查看详细使用步骤演示](./step.md) <--------

5
doc/tencent/tencent.md
View File

@ -1,8 +1,7 @@
# 腾讯云 # 腾讯云
## DNSPOD 授权设置 ## DNSPOD 授权设置【已废弃，请使用腾讯云API】
目前腾讯云管理的域名的dns暂时只支持从DNSPOD进行设置
打开 https://console.dnspod.cn/account/token/apikey 打开 https://console.dnspod.cn/account/token/apikey
然后按如下方式获取DNSPOD的授权 然后按如下方式获取DNSPOD的授权
![](./dnspod-token.png) ![](./dnspod-token.png)
@ -13,4 +12,4 @@
腾讯云其他部署需要API密钥，需要在腾讯云控制台进行设置 腾讯云其他部署需要API密钥，需要在腾讯云控制台进行设置
打开 https://console.cloud.tencent.com/cam/capi 打开 https://console.cloud.tencent.com/cam/capi
然后按如下方式获取腾讯云的API密钥 然后按如下方式获取腾讯云的API密钥
![](./tencent-access.png) ![](./tencent-access.png)

54
step.md
View File

@ -13,19 +13,19 @@
## 自动化流水线创建 ## 自动化流水线创建
### 1. 创建证书申请部署流水线 ### 1. 创建证书申请部署流水线
![创建证书申请任务](packages/ui/certd-client/public/statics/doc/images/1-add.png) ![创建证书申请任务](packages/ui/certd-client/public/static/doc/images/1-add.png)
需要添加域名的DNS解析服务商的授权 需要添加域名的DNS解析服务商的授权
![添加域名的DNS解析服务商的授权](packages/ui/certd-client/public/statics/doc/images/2-access-provider.png) ![添加域名的DNS解析服务商的授权](packages/ui/certd-client/public/static/doc/images/2-access-provider.png)
填写accessKey和accessSecret 填写accessKey和accessSecret
![](packages/ui/certd-client/public/statics/doc/images/3-add-access.png) ![](packages/ui/certd-client/public/static/doc/images/3-add-access.png)
流水线创建成功 流水线创建成功
![](packages/ui/certd-client/public/statics/doc/images/4-add-success.png) ![](packages/ui/certd-client/public/static/doc/images/4-add-success.png)
### 2. 任务详情界面 ### 2. 任务详情界面
![](packages/ui/certd-client/public/statics/doc/images/5-view.png) ![](packages/ui/certd-client/public/static/doc/images/5-view.png)
到这一步申请证书就已经配置完成了。 到这一步申请证书就已经配置完成了。
点击手动触发，就可以申请证书了。 点击手动触发，就可以申请证书了。
@ -34,72 +34,72 @@
### 3. 添加部署到阿里云CDN任务 ### 3. 添加部署到阿里云CDN任务
点击添加任务 点击添加任务
![](packages/ui/certd-client/public/statics/doc/images/6-1-add-task.png) ![](packages/ui/certd-client/public/static/doc/images/6-1-add-task.png)
选择任务类型 选择任务类型
![](packages/ui/certd-client/public/statics/doc/images/6-2-add-task.png) ![](packages/ui/certd-client/public/static/doc/images/6-2-add-task.png)
填写任务参数 填写任务参数
![](packages/ui/certd-client/public/statics/doc/images/6-3-add-task.png) ![](packages/ui/certd-client/public/static/doc/images/6-3-add-task.png)
点击确定，部署到CDN任务配置成功 点击确定，部署到CDN任务配置成功
### 4. 添加部署到服务器主机任务 ### 4. 添加部署到服务器主机任务
点击新任务，弹出添加任务界面 点击新任务，弹出添加任务界面
![](packages/ui/certd-client/public/statics/doc/images/7-1-add-host-task.png) ![](packages/ui/certd-client/public/static/doc/images/7-1-add-host-task.png)
先选择上传到主机任务 先选择上传到主机任务
填写任务参数，比如证书保存路径 填写任务参数，比如证书保存路径
![](packages/ui/certd-client/public/statics/doc/images/7-2-add-host-task.png) ![](packages/ui/certd-client/public/static/doc/images/7-2-add-host-task.png)
需要添加主机ip、用户名、密码，只需添加一次，后续其他任务可以复用 需要添加主机ip、用户名、密码，只需添加一次，后续其他任务可以复用
![](packages/ui/certd-client/public/statics/doc/images/7-3-add-host-task.png) ![](packages/ui/certd-client/public/static/doc/images/7-3-add-host-task.png)
然后添加第二个任务，执行主机命令，部署证书 然后添加第二个任务，执行主机命令，部署证书
![](packages/ui/certd-client/public/statics/doc/images/8-1-add-host-task.png) ![](packages/ui/certd-client/public/static/doc/images/8-1-add-host-task.png)
选择执行脚本命令任务 选择执行脚本命令任务
![](packages/ui/certd-client/public/statics/doc/images/8-2-add-host-task.png) ![](packages/ui/certd-client/public/static/doc/images/8-2-add-host-task.png)
编写脚本，选择之前添加的主机 编写脚本，选择之前添加的主机
![](packages/ui/certd-client/public/statics/doc/images/8-4-add-host-task.png) ![](packages/ui/certd-client/public/static/doc/images/8-4-add-host-task.png)
点击确定，部署到主机任务配置成功 点击确定，部署到主机任务配置成功
![](packages/ui/certd-client/public/statics/doc/images/8-5-add-host-task.png) ![](packages/ui/certd-client/public/static/doc/images/8-5-add-host-task.png)
### 5. 手动触发执行任务，测试一下 ### 5. 手动触发执行任务，测试一下
![](packages/ui/certd-client/public/statics/doc/images/9-start.png) ![](packages/ui/certd-client/public/static/doc/images/9-start.png)
点击任务可以查看状态和日志 点击任务可以查看状态和日志
![](packages/ui/certd-client/public/statics/doc/images/10-1-log.png) ![](packages/ui/certd-client/public/static/doc/images/10-1-log.png)
这里执行失败，可以查看错误日志 这里执行失败，可以查看错误日志
![](packages/ui/certd-client/public/statics/doc/images/11-1-error.png) ![](packages/ui/certd-client/public/static/doc/images/11-1-error.png)
![](packages/ui/certd-client/public/statics/doc/images/11-2-error.png) ![](packages/ui/certd-client/public/static/doc/images/11-2-error.png)
修改正确后，重新执行 修改正确后，重新执行
![](packages/ui/certd-client/public/statics/doc/images/12-1-log-success.png) ![](packages/ui/certd-client/public/static/doc/images/12-1-log-success.png)
可以看到前面执行过的就会跳过，不会重复执行 可以看到前面执行过的就会跳过，不会重复执行
![](packages/ui/certd-client/public/statics/doc/images/12-2-skip-log.png) ![](packages/ui/certd-client/public/static/doc/images/12-2-skip-log.png)
### 6. 查看证书部署效果 ### 6. 查看证书部署效果
可以看到证书已经部署到CDN成功 可以看到证书已经部署到CDN成功
![](packages/ui/certd-client/public/statics/doc/images/13-1-result.png) ![](packages/ui/certd-client/public/static/doc/images/13-1-result.png)
![](packages/ui/certd-client/public/statics/doc/images/13-2-result.png) ![](packages/ui/certd-client/public/static/doc/images/13-2-result.png)
也可以手动下载证书 也可以手动下载证书
![](packages/ui/certd-client/public/statics/doc/images/13-3-download.png) ![](packages/ui/certd-client/public/static/doc/images/13-3-download.png)
### 7. 定时触发 ### 7. 定时触发
配置定时触发，以后每天定时执行 配置定时触发，以后每天定时执行
cron格式，例如： `0 0 3 * * *` 表示每天凌晨3点执行 cron格式，例如： `0 0 3 * * *` 表示每天凌晨3点执行
到期前20天会自动申请新证书并部署，没到期前不会重复申请 到期前20天会自动申请新证书并部署，没到期前不会重复申请
![](packages/ui/certd-client/public/statics/doc/images/14-timer.png) ![](packages/ui/certd-client/public/static/doc/images/14-timer.png)
### 8. 邮件通知 ### 8. 邮件通知
可以接收邮件通知（支持时机：开始、成功、失败、失败转成功） 可以接收邮件通知（支持时机：开始、成功、失败、失败转成功）
![](packages/ui/certd-client/public/statics/doc/images/15-1-email.png) ![](packages/ui/certd-client/public/static/doc/images/15-1-email.png)
需要配置邮件服务器 需要配置邮件服务器
![](packages/ui/certd-client/public/statics/doc/images/15-2-email.png) ![](packages/ui/certd-client/public/static/doc/images/15-2-email.png)