diff --git a/doc/images/1-add.png b/packages/ui/certd-client/public/doc/images/1-add.png similarity index 100% rename from doc/images/1-add.png rename to packages/ui/certd-client/public/doc/images/1-add.png diff --git a/doc/images/10-1-log.png b/packages/ui/certd-client/public/doc/images/10-1-log.png similarity index 100% rename from doc/images/10-1-log.png rename to packages/ui/certd-client/public/doc/images/10-1-log.png diff --git a/doc/images/11-1-error.png b/packages/ui/certd-client/public/doc/images/11-1-error.png similarity index 100% rename from doc/images/11-1-error.png rename to packages/ui/certd-client/public/doc/images/11-1-error.png diff --git a/doc/images/11-2-error.png b/packages/ui/certd-client/public/doc/images/11-2-error.png similarity index 100% rename from doc/images/11-2-error.png rename to packages/ui/certd-client/public/doc/images/11-2-error.png diff --git a/doc/images/12-1-log-success.png b/packages/ui/certd-client/public/doc/images/12-1-log-success.png similarity index 100% rename from doc/images/12-1-log-success.png rename to packages/ui/certd-client/public/doc/images/12-1-log-success.png diff --git a/doc/images/12-2-skip-log.png b/packages/ui/certd-client/public/doc/images/12-2-skip-log.png similarity index 100% rename from doc/images/12-2-skip-log.png rename to packages/ui/certd-client/public/doc/images/12-2-skip-log.png diff --git a/doc/images/13-1-result.png b/packages/ui/certd-client/public/doc/images/13-1-result.png similarity index 100% rename from doc/images/13-1-result.png rename to packages/ui/certd-client/public/doc/images/13-1-result.png diff --git a/doc/images/13-2-result.png b/packages/ui/certd-client/public/doc/images/13-2-result.png similarity index 100% rename from doc/images/13-2-result.png rename to packages/ui/certd-client/public/doc/images/13-2-result.png diff --git a/doc/images/13-3-download.png b/packages/ui/certd-client/public/doc/images/13-3-download.png similarity index 100% rename from doc/images/13-3-download.png rename to packages/ui/certd-client/public/doc/images/13-3-download.png diff --git a/doc/images/14-timer.png b/packages/ui/certd-client/public/doc/images/14-timer.png similarity index 100% rename from doc/images/14-timer.png rename to packages/ui/certd-client/public/doc/images/14-timer.png diff --git a/doc/images/15-1-email.png b/packages/ui/certd-client/public/doc/images/15-1-email.png similarity index 100% rename from doc/images/15-1-email.png rename to packages/ui/certd-client/public/doc/images/15-1-email.png diff --git a/doc/images/15-2-email.png b/packages/ui/certd-client/public/doc/images/15-2-email.png similarity index 100% rename from doc/images/15-2-email.png rename to packages/ui/certd-client/public/doc/images/15-2-email.png diff --git a/doc/images/2-access-provider.png b/packages/ui/certd-client/public/doc/images/2-access-provider.png similarity index 100% rename from doc/images/2-access-provider.png rename to packages/ui/certd-client/public/doc/images/2-access-provider.png diff --git a/doc/images/3-add-access.png b/packages/ui/certd-client/public/doc/images/3-add-access.png similarity index 100% rename from doc/images/3-add-access.png rename to packages/ui/certd-client/public/doc/images/3-add-access.png diff --git a/doc/images/4-add-success.png b/packages/ui/certd-client/public/doc/images/4-add-success.png similarity index 100% rename from doc/images/4-add-success.png rename to packages/ui/certd-client/public/doc/images/4-add-success.png diff --git a/doc/images/5-view.png b/packages/ui/certd-client/public/doc/images/5-view.png similarity index 100% rename from doc/images/5-view.png rename to packages/ui/certd-client/public/doc/images/5-view.png diff --git a/doc/images/6-1-add-task.png b/packages/ui/certd-client/public/doc/images/6-1-add-task.png similarity index 100% rename from doc/images/6-1-add-task.png rename to packages/ui/certd-client/public/doc/images/6-1-add-task.png diff --git a/doc/images/6-2-add-task.png b/packages/ui/certd-client/public/doc/images/6-2-add-task.png similarity index 100% rename from doc/images/6-2-add-task.png rename to packages/ui/certd-client/public/doc/images/6-2-add-task.png diff --git a/doc/images/6-3-add-task.png b/packages/ui/certd-client/public/doc/images/6-3-add-task.png similarity index 100% rename from doc/images/6-3-add-task.png rename to packages/ui/certd-client/public/doc/images/6-3-add-task.png diff --git a/doc/images/7-1-add-host-task.png b/packages/ui/certd-client/public/doc/images/7-1-add-host-task.png similarity index 100% rename from doc/images/7-1-add-host-task.png rename to packages/ui/certd-client/public/doc/images/7-1-add-host-task.png diff --git a/doc/images/7-2-add-host-task.png b/packages/ui/certd-client/public/doc/images/7-2-add-host-task.png similarity index 100% rename from doc/images/7-2-add-host-task.png rename to packages/ui/certd-client/public/doc/images/7-2-add-host-task.png diff --git a/doc/images/7-3-add-host-task.png b/packages/ui/certd-client/public/doc/images/7-3-add-host-task.png similarity index 100% rename from doc/images/7-3-add-host-task.png rename to packages/ui/certd-client/public/doc/images/7-3-add-host-task.png diff --git a/doc/images/8-1-add-host-task.png b/packages/ui/certd-client/public/doc/images/8-1-add-host-task.png similarity index 100% rename from doc/images/8-1-add-host-task.png rename to packages/ui/certd-client/public/doc/images/8-1-add-host-task.png diff --git a/doc/images/8-2-add-host-task.png b/packages/ui/certd-client/public/doc/images/8-2-add-host-task.png similarity index 100% rename from doc/images/8-2-add-host-task.png rename to packages/ui/certd-client/public/doc/images/8-2-add-host-task.png diff --git a/doc/images/8-4-add-host-task.png b/packages/ui/certd-client/public/doc/images/8-4-add-host-task.png similarity index 100% rename from doc/images/8-4-add-host-task.png rename to packages/ui/certd-client/public/doc/images/8-4-add-host-task.png diff --git a/doc/images/8-5-add-host-task.png b/packages/ui/certd-client/public/doc/images/8-5-add-host-task.png similarity index 100% rename from doc/images/8-5-add-host-task.png rename to packages/ui/certd-client/public/doc/images/8-5-add-host-task.png diff --git a/doc/images/9-start.png b/packages/ui/certd-client/public/doc/images/9-start.png similarity index 100% rename from doc/images/9-start.png rename to packages/ui/certd-client/public/doc/images/9-start.png diff --git a/packages/ui/certd-client/src/components/index.ts b/packages/ui/certd-client/src/components/index.ts index 7e003452..582bc740 100644 --- a/packages/ui/certd-client/src/components/index.ts +++ b/packages/ui/certd-client/src/components/index.ts @@ -9,6 +9,7 @@ import CronEditor from "./cron-editor/index.vue"; import { CronLight } from "@vue-js-cron/light"; import "@vue-js-cron/light/dist/light.css"; import Plugins from "./plugins/index"; +import TutorialButton from "./tutorial/index.vue"; export default { install(app: any) { app.component("PiContainer", PiContainer); @@ -24,6 +25,8 @@ export default { app.component("InfoCircleOutlined", InfoCircleOutlined); app.component("UndoOutlined", UndoOutlined); + app.component("TutorialButton", TutorialButton); + app.use(vip); app.use(Plugins); } diff --git a/packages/ui/certd-client/src/components/tutorial/index.vue b/packages/ui/certd-client/src/components/tutorial/index.vue new file mode 100644 index 00000000..f91cc999 --- /dev/null +++ b/packages/ui/certd-client/src/components/tutorial/index.vue @@ -0,0 +1,37 @@ + + + + + diff --git a/packages/ui/certd-client/src/components/tutorial/tutorial-steps.vue b/packages/ui/certd-client/src/components/tutorial/tutorial-steps.vue new file mode 100644 index 00000000..08b69a9e --- /dev/null +++ b/packages/ui/certd-client/src/components/tutorial/tutorial-steps.vue @@ -0,0 +1,295 @@ + + + + + diff --git a/packages/ui/certd-client/src/layout/layout-framework.vue b/packages/ui/certd-client/src/layout/layout-framework.vue index 9dbfc3a1..93392b71 100644 --- a/packages/ui/certd-client/src/layout/layout-framework.vue +++ b/packages/ui/certd-client/src/layout/layout-framework.vue @@ -19,6 +19,7 @@ +
@@ -84,10 +85,23 @@ import FsThemeSet from "/@/layout/components/theme/index.vue"; import { env } from "../utils/util.env"; import FsThemeModeSet from "./components/theme/mode-set.vue"; import VipButton from "/@/components/vip-button/index.vue"; +import TutorialSteps from "/@/components/tutorial/tutorial-steps.vue"; export default { name: "LayoutFramework", // eslint-disable-next-line vue/no-unused-components - components: { FsThemeSet, MenuFoldOutlined, MenuUnfoldOutlined, FsMenu, FsLocale, FsSourceLink, FsUserInfo, FsTabs, FsThemeModeSet, VipButton }, + components: { + TutorialSteps, + FsThemeSet, + MenuFoldOutlined, + MenuUnfoldOutlined, + FsMenu, + FsLocale, + FsSourceLink, + FsUserInfo, + FsTabs, + FsThemeModeSet, + VipButton + }, setup() { const resourceStore = useResourceStore(); const frameworkMenus = computed(() => { diff --git a/packages/ui/certd-client/src/style/common.less b/packages/ui/certd-client/src/style/common.less index 41cb8f55..74f84392 100644 --- a/packages/ui/certd-client/src/style/common.less +++ b/packages/ui/certd-client/src/style/common.less @@ -20,6 +20,7 @@ div#app { h1, h2, h3, h4, h5, h6 { margin-bottom: 0; + margin-top:0; } .fs-desc { @@ -197,4 +198,4 @@ h1, h2, h3, h4, h5, h6 { } .cursor-pointer{ cursor: pointer; -} \ No newline at end of file +} diff --git a/step.md b/step.md index e1d00371..4c7fe308 100644 --- a/step.md +++ b/step.md @@ -19,13 +19,13 @@ ![添加域名的DNS解析服务商的授权](./doc/images/2-access-provider.png) 填写accessKey和accessSecret -![](./doc/images/3-add-access.png) +![](./packages/ui/certd-client/public/doc/images/3-add-access.png) 流水线创建成功 -![](./doc/images/4-add-success.png) +![](./packages/ui/certd-client/public/doc/images/4-add-success.png) ### 2. 任务详情界面 -![](./doc/images/5-view.png) +![](./packages/ui/certd-client/public/doc/images/5-view.png) 到这一步申请证书就已经配置完成了。 点击手动触发,就可以申请证书了。 @@ -34,72 +34,72 @@ ### 3. 添加部署到阿里云CDN任务 点击添加任务 -![](./doc/images/6-1-add-task.png) +![](./packages/ui/certd-client/public/doc/images/6-1-add-task.png) 选择任务类型 -![](./doc/images/6-2-add-task.png) +![](./packages/ui/certd-client/public/doc/images/6-2-add-task.png) 填写任务参数 -![](./doc/images/6-3-add-task.png) +![](./packages/ui/certd-client/public/doc/images/6-3-add-task.png) 点击确定,部署到CDN任务配置成功 ### 4. 添加部署到服务器主机任务 点击新任务,弹出添加任务界面 -![](./doc/images/7-1-add-host-task.png) +![](./packages/ui/certd-client/public/doc/images/7-1-add-host-task.png) 先选择上传到主机任务 填写任务参数,比如证书保存路径 -![](./doc/images/7-2-add-host-task.png) +![](./packages/ui/certd-client/public/doc/images/7-2-add-host-task.png) 需要添加主机ip、用户名、密码,只需添加一次,后续其他任务可以复用 -![](./doc/images/7-3-add-host-task.png) +![](./packages/ui/certd-client/public/doc/images/7-3-add-host-task.png) 然后添加第二个任务,执行主机命令,部署证书 -![](./doc/images/8-1-add-host-task.png) +![](./packages/ui/certd-client/public/doc/images/8-1-add-host-task.png) 选择执行脚本命令任务 -![](./doc/images/8-2-add-host-task.png) +![](./packages/ui/certd-client/public/doc/images/8-2-add-host-task.png) 编写脚本,选择之前添加的主机 -![](./doc/images/8-4-add-host-task.png) +![](./packages/ui/certd-client/public/doc/images/8-4-add-host-task.png) 点击确定,部署到主机任务配置成功 -![](./doc/images/8-5-add-host-task.png) +![](./packages/ui/certd-client/public/doc/images/8-5-add-host-task.png) ### 5. 手动触发执行任务,测试一下 -![](./doc/images/9-start.png) +![](./packages/ui/certd-client/public/doc/images/9-start.png) 点击任务可以查看状态和日志 -![](./doc/images/10-1-log.png) +![](./packages/ui/certd-client/public/doc/images/10-1-log.png) 这里执行失败,可以查看错误日志 -![](./doc/images/11-1-error.png) -![](./doc/images/11-2-error.png) +![](./packages/ui/certd-client/public/doc/images/11-1-error.png) +![](./packages/ui/certd-client/public/doc/images/11-2-error.png) 修改正确后,重新执行 -![](./doc/images/12-1-log-success.png) +![](./packages/ui/certd-client/public/doc/images/12-1-log-success.png) 可以看到前面执行过的就会跳过,不会重复执行 -![](./doc/images/12-2-skip-log.png) +![](./packages/ui/certd-client/public/doc/images/12-2-skip-log.png) ### 6. 查看证书部署效果 可以看到证书已经部署到CDN成功 -![](./doc/images/13-1-result.png) -![](./doc/images/13-2-result.png) +![](./packages/ui/certd-client/public/doc/images/13-1-result.png) +![](./packages/ui/certd-client/public/doc/images/13-2-result.png) 也可以手动下载证书 -![](./doc/images/13-3-download.png) +![](./packages/ui/certd-client/public/doc/images/13-3-download.png) ### 7. 定时触发 配置定时触发,以后每天定时执行 cron格式,例如: `0 0 3 * * *` 表示每天凌晨3点执行 到期前20天会自动申请新证书并部署,没到期前不会重复申请 -![](./doc/images/14-timer.png) +![](./packages/ui/certd-client/public/doc/images/14-timer.png) ### 8. 邮件通知 可以接收邮件通知(支持时机:开始、成功、失败、失败转成功) -![](./doc/images/15-1-email.png) +![](./packages/ui/certd-client/public/doc/images/15-1-email.png) 需要配置邮件服务器 -![](./doc/images/15-2-email.png) +![](./packages/ui/certd-client/public/doc/images/15-2-email.png)