From b454e02d01776ebe966293ae5e66910397abf7ce Mon Sep 17 00:00:00 2001 From: xiaojunnuo Date: Sun, 11 May 2025 10:04:54 +0800 Subject: [PATCH] chore: doc --- docs/.vitepress/config.ts | 48 ++++++------------ docs/deploy/index.md | 4 -- docs/guide/feature/safe/hidden/index.md | 4 +- docs/guide/feature/safe/index.md | 34 +++++++++---- docs/guide/feature/safe/suggest.md | 10 ---- .../{deploy => guide/use}/ESXi/images/ssh.png | Bin docs/{deploy => guide/use}/ESXi/index.md | 0 docs/{ => guide/use}/comm/images/index.png | Bin docs/{ => guide/use}/comm/index.md | 0 docs/{ => guide/use}/comm/payments/alipay.md | 0 docs/{ => guide/use}/comm/payments/wxpay.md | 0 docs/{ => guide/use}/comm/payments/yizhifu.md | 0 12 files changed, 42 insertions(+), 58 deletions(-) delete mode 100644 docs/deploy/index.md rename docs/{deploy => guide/use}/ESXi/images/ssh.png (100%) rename docs/{deploy => guide/use}/ESXi/index.md (100%) rename docs/{ => guide/use}/comm/images/index.png (100%) rename docs/{ => guide/use}/comm/index.md (100%) rename docs/{ => guide/use}/comm/payments/alipay.md (100%) rename docs/{ => guide/use}/comm/payments/wxpay.md (100%) rename docs/{ => guide/use}/comm/payments/yizhifu.md (100%) diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index 21a9ddba..02847ebc 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -91,17 +91,14 @@ export default defineConfig({ {text: "多数据库支持", link: "/guide/install/database.md"}, {text: "开放接口", link: "/guide/open/index.md"}, { - text: "站点安全", items: [ - {text: "安全特性", link: "/guide/feature/safe"}, - {text: "站点隐藏", link: "/guide/feature/safe/hidden"}, - {text: "安全生产建议", link: "/guide/feature/safe/suggest"}, - ] + text: "站点安全", link: "/guide/feature/safe" }, - {text: "插件列表", items:[ - {text: "授权提供商", link: "/guide/plugins/access"}, - {text: "DNS提供商", link: "/guide/plugins/dns-provider"}, - {text: "任务插件", link: "/guide/plugins/deploy"}, - {text: "通知插件", link: "/guide/plugins/notification"}, + { + text: "插件列表", items: [ + {text: "授权提供商", link: "/guide/plugins/access"}, + {text: "DNS提供商", link: "/guide/plugins/dns-provider"}, + {text: "任务插件", link: "/guide/plugins/deploy"}, + {text: "通知插件", link: "/guide/plugins/notification"}, ] }, ] @@ -109,6 +106,7 @@ export default defineConfig({ { text: "常见问题", items: [ + {text: "常见报错处理", link: "/guide/qa/"}, {text: "群晖证书部署", link: "/guide/use/synology/"}, {text: "腾讯云密钥获取", link: "/guide/use/tencent/"}, {text: "连接windows主机", link: "/guide/use/host/windows.md"}, @@ -120,8 +118,14 @@ export default defineConfig({ {text: "js脚本插件使用", link: "/guide/use/custom-script/index.md"}, {text: "邮箱配置", link: "/guide/use/email/index.md"}, {text: "IPv6支持", link: "/guide/use/setting/ipv6.md"}, - {text: "其他插件使用", link: "/deploy/"}, - {text: "商业版说明", link: "/comm/"}, + {text: "ESXi", link: "/guide/use/ESXi/index.md"}, + ] + }, + { + text: "商业版配置", link: "/guide/use/comm/", items: [ + {text: "支付宝配置", link: "/guide/use/comm/payments/alipay.md"}, + {text: "微信支付配置", link: "/guide/use/comm/payments/wxpay.md"}, + {text: "彩虹易支付配置", link: "/guide/use/comm/payments/yizhifu.md"}, ] }, { @@ -138,26 +142,6 @@ export default defineConfig({ ] } ], - "/deploy/": [ - { - text: "部署证书插件", - items: [ - {text: "插件说明", link: "/deploy/index.md"}, - {text: "部署到ESXi", link: "/deploy/ESXi/index.md"}, - ] - } - ], - "/comm/": [ - { - text: "商业版", - items: [ - {text: "支付宝配置", link: "/comm/payments/alipay.md"}, - {text: "微信支付配置", link: "/comm/payments/wxpay.md"}, - {text: "彩虹易支付配置", link: "/comm/payments/yizhifu.md"}, - ] - } - ] - , }, socialLinks: [ diff --git a/docs/deploy/index.md b/docs/deploy/index.md deleted file mode 100644 index 2fe18e65..00000000 --- a/docs/deploy/index.md +++ /dev/null @@ -1,4 +0,0 @@ -# 部署插件说明 - -## 待完善 - diff --git a/docs/guide/feature/safe/hidden/index.md b/docs/guide/feature/safe/hidden/index.md index d56e80c9..ffd6e429 100644 --- a/docs/guide/feature/safe/hidden/index.md +++ b/docs/guide/feature/safe/hidden/index.md @@ -22,4 +22,6 @@ ![](./images/hidden2.png) ## 3、忘记解除地址和解除密码怎么办 -登录服务器，在数据库平级的目录下创建`.unhidden`文件即可`临时解除`站点隐藏 +登录服务器，在数据库平级的目录下创建`.unhidden`命名的空白文件，即可临时解除站点隐藏 +临时解除后会自动删除`.unhidden`文件，请尽快设置好新的`解除地址`和`解除密码`，并记住 + diff --git a/docs/guide/feature/safe/index.md b/docs/guide/feature/safe/index.md index b578c95d..6aec4647 100644 --- a/docs/guide/feature/safe/index.md +++ b/docs/guide/feature/safe/index.md @@ -1,36 +1,48 @@ -# 站点安全特性 +# 安全特性 -Certd 存储了证书以及授权等敏感数据，所以需要严格保障安全。 -我们非常重视您的数据安全，提供了以下安全特性 +Certd 存储了证书以及授权等敏感数据，所以需要严格保障安全。 +我们提供了以下安全特性，以及安全生产建议（请遵照建议进行生产部署以保障数据安全） -## 1、 授权数据加密存储【默认开启】 +## 一、站点安全特性 + +### 1、 授权数据加密存储【默认开启】 * 所有的授权敏感字段会加密后存储 * 每个用户独立维护授权数据，连管理员都无权查看 ![星号部分为加密数据](./images/access.png) 星号部分为加密数据 -## 2、 密码防爆破【默认开启】 +### 2、 密码防爆破【默认开启】 * 登录失败次数过多，账号将被锁定，最高24小时(重启服务可解除锁定) * 用户登录密码加密hash后存储，无法计算出密码明文 ![](./images/login.png) -## 3、站点隐藏【建议开启】 +### 3、站点隐藏【建议开启】 * 一般来说Certd设置好之后，后续很少需要访问修改。 * 所以我们平时可以把站点访问关闭，需要的时候再打开，减少站点被攻击的风险 * 请前往 `系统管理->系统设置->安全设置->开启站点隐藏` -* [站点隐藏设置说明](./hidden/) ![](./images/hidden.png) -## 4、登录双重验证 +点击查看 [站点隐藏功能详细使用说明](./hidden/) + + +### 4、登录双重验证 支持2FA双重认证 ![](./images/2fa.png) -## 5、数据库自动备份【建议开启】 +### 5、数据库自动备份【建议开启】 * [自动备份设置说明](../../use/backup/) -## 更多安全生产建议 -[安全生产建议](./suggest.md) \ No newline at end of file +## 二、安全生产建议 + +尽管`Cert`本身实现了很多安全特性，但`外部环境的安全`仍需要您来确保。 +请`务必`遵循如下建议做好安全防护 + +* 请`务必`使用`HTTPS协议`访问本应用，避免被中间人攻击 +* 请`务必`使用`web应用防火墙`防护本应用，防止XSS、SQL注入等攻击 +* 请`务必`做好`服务器本身`的安全防护，防止数据库泄露 +* 请`务必`做好[`数据备份`](../../use/backup/)，避免数据丢失 +* 建议开启[`站点隐藏`](./hidden/)功能 diff --git a/docs/guide/feature/safe/suggest.md b/docs/guide/feature/safe/suggest.md index 87f37fc4..e69de29b 100644 --- a/docs/guide/feature/safe/suggest.md +++ b/docs/guide/feature/safe/suggest.md @@ -1,10 +0,0 @@ -# 安全生产建议 - -尽管`Cert`本身实现了很多安全特性，但`外部环境的安全`仍需要您来确保。 -请`务必`遵循如下建议做好安全防护 - -* 请`务必`使用`HTTPS协议`访问本应用，避免被中间人攻击 -* 请`务必`使用`web应用防火墙`防护本应用，防止XSS、SQL注入等攻击 -* 请`务必`做好`服务器本身`的安全防护，防止数据库泄露 -* 请`务必`做好[`数据备份`](../../use/backup/)，避免数据丢失 -* 建议开启[`站点隐藏`](./hidden/)功能 diff --git a/docs/deploy/ESXi/images/ssh.png b/docs/guide/use/ESXi/images/ssh.png similarity index 100% rename from docs/deploy/ESXi/images/ssh.png rename to docs/guide/use/ESXi/images/ssh.png diff --git a/docs/deploy/ESXi/index.md b/docs/guide/use/ESXi/index.md similarity index 100% rename from docs/deploy/ESXi/index.md rename to docs/guide/use/ESXi/index.md diff --git a/docs/comm/images/index.png b/docs/guide/use/comm/images/index.png similarity index 100% rename from docs/comm/images/index.png rename to docs/guide/use/comm/images/index.png diff --git a/docs/comm/index.md b/docs/guide/use/comm/index.md similarity index 100% rename from docs/comm/index.md rename to docs/guide/use/comm/index.md diff --git a/docs/comm/payments/alipay.md b/docs/guide/use/comm/payments/alipay.md similarity index 100% rename from docs/comm/payments/alipay.md rename to docs/guide/use/comm/payments/alipay.md diff --git a/docs/comm/payments/wxpay.md b/docs/guide/use/comm/payments/wxpay.md similarity index 100% rename from docs/comm/payments/wxpay.md rename to docs/guide/use/comm/payments/wxpay.md diff --git a/docs/comm/payments/yizhifu.md b/docs/guide/use/comm/payments/yizhifu.md similarity index 100% rename from docs/comm/payments/yizhifu.md rename to docs/guide/use/comm/payments/yizhifu.md