会众云·零搭

Appearance

部署HTTPS插件 ​

本插件采用 Let's Encrypt 的免费证书（有效期三个月），可以实现自动续签并部署https证书（等同于ssl证书）。内置了nginx模块，证书部署成功后即可使用https访问私有化会众云平台

注意

证书实际有效期 90 天，插件会自动执行续签操作。

提示

域名代理-HTTP与自动证书-HTTPS使用的是同一个插件，场景不同故作拆分

特别说明

进行本插件部署前，请确保您已经具备了以下条件（缺一不可）

  1. 服务器的443、80端口可以访问（80端口用于自动校验域名归属权）
  2. 服务器安全组已允许443、80端口访问
  3. 443、80端口未被其他服务占用
  4. 域名已经进行了公安部备案，并且已经获取到了备案编号
  5. 本插件必须和私有化会众云平台部署在同一台服务器

插件将自动读取server_config.json文件中的根域名地址，作为域名

1.创建配置文件：https.json ​

配置参数说明

bash
VERIFY_FILE_NAME          # 【可选】 校验文件名（接入微信、企微、钉钉等开放平台时，需要进行域名校验）
VERIFY_FILE_TEXT          # 【可选】 校验文件值（校验文件的内容值，一般是一串字符）

文件内容示例

json
{
  "VERIFY_FILE_NAME": "test.txt",
  "VERIFY_FILE_TEXT": "xxxxxxxx"
}

参数说明

bash
# 参数说明
VERIFY_FILE_NAME          # 【可选】 校验文件名（接入微信、企微、钉钉等开放平台时，需要进行域名校验）
VERIFY_FILE_TEXT          # 【可选】 校验文件值（校验文件的内容值，一般是一串字符）

1.1.一键创建 ​

下方参数后，将其复制粘贴至命令行，敲击回车键即可

bash
cat > /etc/hzy/https.json <<- EOF
{
  "VERIFY_FILE_NAME": "test.txt",
  "VERIFY_FILE_TEXT": "xxxxxxxx"
}
EOF

如何验证执行结果？

命令行输入：cat /etc/hzy/https.json，后敲击回车键即可查看文件内容

1.2.手动创建 ​

bash
cd /etc/hzy && vim -n https.json

注意

将使用vim编辑文件内容，点击查看vim的使用说明

2.设置校验文件 ​

当接入企微、钉钉、飞书等开放平台时，开放平台一般都会要求进行域名归属权校验，校验的方式几乎都是：将指定的文件放到域名根目录下，然后可以通过域名获取到文件内容

如果存在这样的需求，可以将校验文件配置到https.json

示例

假设：有一个校验文件名字是itg2fyLtiupAWwOt.txt，校验文件内容是pAWwOtitg2fyLtiup

则配置如下：

https配置项配置值示例
VERIFY_FILE_NAME"itg2fyLtiupAWwOt.txt"
VERIFY_FILE_TEXT"pAWwOtitg2fyLtiup"

注意

如果有多个校验文件，单次只能配置一个，配置以后重启docker服务即可生效

3.运行HTTPS服务 ​

启动服务

特别说明

必须使用 --network host 模式启动容器，否则nginx代理无法生效！

注意

插件运行后，将自动在/etc/hzy/log目录下生成日志文件：https.log（包含所有通知消息）

bash
docker run --privileged -e TZ=Asia/Shanghai -itd --restart always --network host -v /etc/hzy:/root/conf --name hzy-https swr.cn-southwest-2.myhuaweicloud.com/hzy0code/hzy-utils:https.x86.2.2.0
bash
docker run --privileged -e TZ=Asia/Shanghai -itd --restart always --network host -v /etc/hzy:/root/conf --name hzy-https swr.cn-southwest-2.myhuaweicloud.com/hzy0code/hzy-utils:https.arm.2.2.0

重启服务

注意

修改了配置文件后，需要使用以下命令重启服务

bash
docker restart hzy-https

4.申请证书 ​

插件部署成功后，则可以使用http 的方式访问https插件：

以下使用域名 apaas.test.com 作为示例域名，请替换为真实的域名

注意

  • 访问地址：http://apaas.test.com/https
  • 由于还未申请证书，所以需要先使用80 端口访问插件进行证书申请
  • 访问地址的后缀固定为：/https

进入证书申请页面后，填写通知邮箱，点击立即申请证书即可开始申请证书

提示

申请完成后即可使用https访问系统，后续将自动续签证书，无需手动操作

系统https访问链接示例：https://apaas.test.com/apaas