Compare commits
472 Commits
6163c3f08e
..
v2
| Author | SHA1 | Date | |
|---|---|---|---|
| 0f3f8519e0 | |||
| 61e3f5761c | |||
| 2908569841 | |||
| 775226b49f | |||
| e3dacb5b3f | |||
| cdea411136 | |||
| fdb000ee7c | |||
| 4a0be1c29d | |||
| 892d22e225 | |||
| 4958a48b92 | |||
| 28bbea85f0 | |||
| 73b3a29cfc | |||
| 77b8024453 | |||
| 1175e1164b | |||
| 5546af518e | |||
| 99fd3083f2 | |||
| c0df8be832 | |||
| 73cab6a6ee | |||
| 7a71e45799 | |||
| fdb1d1e6dd | |||
| 6dd4d6adeb | |||
| d368f9666a | |||
| ee50458333 | |||
| 9792c616b5 | |||
| 205a7d134e | |||
| 2cbacb4338 | |||
| cdb812ef63 | |||
| ea010f8c9b | |||
| 362bbc5f32 | |||
| 2e19dda72e | |||
| 021155278e | |||
| 3db87218ee | |||
| 91d5c90eb0 | |||
| f8b71a0e61 | |||
| 3e4b7f30ac | |||
| c637985575 | |||
| 2960e2459b | |||
| 81d6289a86 | |||
| dc1507a5ea | |||
| 3d960c3869 | |||
| 5d60e6191f | |||
| 4b49f8a5a6 | |||
| 94459fe922 | |||
| e834e31510 | |||
| 4b57a0d729 | |||
| acd440106b | |||
| 5096df5cc0 | |||
| 3c2d450aa8 | |||
| b083b3cc41 | |||
| 6624769032 | |||
| 55f75c6051 | |||
| 42d9c3ef14 | |||
| c7a9363422 | |||
| 969b6e3288 | |||
| 03ce030754 | |||
| f2c1e362a0 | |||
| 6426aa57a2 | |||
| 7ceb0f6306 | |||
| b26a1944c6 | |||
| 235aec3e42 | |||
| 346fb730a3 | |||
| c87bc22a5f | |||
| 7198e24945 | |||
| 1a08bd340e | |||
| af9047bf3c | |||
| 9566fc4e03 | |||
| 41254d10b7 | |||
| ed97f41884 | |||
| 02b83ce0ad | |||
| f1d2a1033a | |||
| ba1fe54ef8 | |||
| deac92faf8 | |||
| 1c36a79162 | |||
| b6f7042adc | |||
| f721cefb4a | |||
| fc2c947afe | |||
| d0272095cc | |||
| 4a09cf289d | |||
| 89c23fef35 | |||
| 5e59651d45 | |||
| 5e72f75395 | |||
| 0a77fe0169 | |||
| 961abb0f80 | |||
| 4efe12d2d3 | |||
| 67b05e2d75 | |||
| 8edb6f8727 | |||
| b30f02a1fb | |||
| 7e2333a63a | |||
| 0be66cccbc | |||
| ed26ed196d | |||
| a204f270dd | |||
| 7585d7bbd0 | |||
| 2981f086c8 | |||
| 784ef8a6a4 | |||
| 01c91ba294 | |||
| 05629acfa9 | |||
| 12a3afe15b | |||
| 3bb68e3111 | |||
| 5ba33be30f | |||
| 1e7b057946 | |||
| fb5b00d73f | |||
| 09ccfa2624 | |||
| 5c80c99b94 | |||
| adcf570b15 | |||
| 5ccd6e64bc | |||
| ff7e7858c0 | |||
| 37bcd8ce08 | |||
| 678b70cee8 | |||
| c0ca8da4ed | |||
| a07dcb1cf5 | |||
| cb4a86d1d5 | |||
| 0499347588 | |||
| f4bb459b5e | |||
| 83a5a21f95 | |||
| 85c633fddf | |||
| cb08e061d2 | |||
| 787b52bef7 | |||
| 9bf7ca400f | |||
| 9f75e30af3 | |||
| 3f0243ba9a | |||
| 1a9b367c9d | |||
| 73996f055b | |||
| 57ea2f317a | |||
| c66c05b442 | |||
| 6450d2bd56 | |||
| b5368d120d | |||
| f9a310b6c3 | |||
| 1bdcfe646f | |||
| a88d14a3bd | |||
| bdb3d09c09 | |||
| 667e7b185b | |||
| 8483ee0d41 | |||
| c3baaf3ac7 | |||
| c63745d1ba | |||
| 59b9ffadd0 | |||
| d131ea3790 | |||
| b849d34be5 | |||
| 58fc9a551c | |||
| 5801f34b3a | |||
| 17cf16ca92 | |||
| 7015b1b232 | |||
| 3b72ca09c6 | |||
| a815d0245b | |||
| 229f22d5a9 | |||
| 22f5cfcfd8 | |||
| 90ba55c043 | |||
| 9f878a353c | |||
| af7297d671 | |||
| 2f172b56e9 | |||
| 9076c8b20e | |||
| 639756dfcd | |||
| 7aa0c7e491 | |||
| 45dedf5bc7 | |||
| 4681ec9008 | |||
| b91826c6e6 | |||
| 686856d0ae | |||
| 9b09d2578d | |||
| f8f51adf88 | |||
| f8ce639717 | |||
| 1c6dc169ac | |||
| 3e5366c74e | |||
| b49ddbfef9 | |||
| b92fd73f53 | |||
| 41b8f51a6a | |||
| aad9045de5 | |||
| fdd5848df4 | |||
| 118c15d046 | |||
| bae4f8e320 | |||
| e0189a566e | |||
| 1cd8d73cdb | |||
| d6e9e5987b | |||
| 8c5aa37745 | |||
| a18a871ac3 | |||
| 90cbff9cf9 | |||
| bae5a04dcc | |||
| 7146570392 | |||
| ae88f85d8e | |||
| a362860137 | |||
| c966896522 | |||
| 5f88da1985 | |||
| 043b80a298 | |||
| ed0da28896 | |||
| 61a0d69d58 | |||
| 3833a9216e | |||
| e59566b5e2 | |||
| e4be0ce464 | |||
| 022dbf0cab | |||
| 1e6b559b89 | |||
| 74bae2005d | |||
| 1731a35d94 | |||
| 9f7d766cb3 | |||
| 6c0d0b00c9 | |||
| a82a38421d | |||
| c4b01da384 | |||
| 3e1473dba5 | |||
| d383706554 | |||
| e0eb0e21f6 | |||
| 7266af1749 | |||
| f93bc09438 | |||
| fe3bb7c1b4 | |||
| 923676c7d5 | |||
| 4755216505 | |||
| 37d03c10f9 | |||
| 490b724808 | |||
| d8f132919d | |||
| b8a64a6b5b | |||
| 25ad1e6f86 | |||
| 6b6f1604e9 | |||
| 63be1c1cbd | |||
| b75c625ddc | |||
| 7083e7aff7 | |||
| 9d2937dd4b | |||
| a7e281e278 | |||
| 72b6597817 | |||
| 91a1b97550 | |||
| 9951ab678f | |||
| 930aa355e8 | |||
| e0143fa540 | |||
| 7c1d92ff4b | |||
| 0a0f1e90e1 | |||
| 80092823db | |||
| 146098d9ce | |||
| 519743dbdb | |||
| 7ab661ecd7 | |||
| bb46cb08f7 | |||
| 028932c04a | |||
| 73e6480853 | |||
| aa176b081a | |||
| 267243e71b | |||
| 33fbef8380 | |||
| 45a128a050 | |||
| 2ddc668954 | |||
| 898bc9b9f2 | |||
| d8e5928523 | |||
| 36808a953e | |||
| 39d3f79026 | |||
| 6463e1ca22 | |||
| c985a13544 | |||
| ad76c5177c | |||
| 64b3184b28 | |||
| 2f1ad7201f | |||
| cd23ee2055 | |||
| e00830bebc | |||
| 00e6d580c2 | |||
| 9c7b419e8f | |||
| 95edc0d303 | |||
| 5991b1e37c | |||
| 1aa50cf53a | |||
| eab66e2d19 | |||
| 5b504f094f | |||
| 1460cb9ac1 | |||
| 53782cbf49 | |||
| 0ea22dddf0 | |||
| ec466dc818 | |||
| 181064901d | |||
| d1988dc982 | |||
| 1f1d687317 | |||
| edc7bfc230 | |||
| 7b6b3aa293 | |||
| 2f7514a2e7 | |||
| 575415b93a | |||
| c28dfa8aca | |||
| 91141922ee | |||
| cc5154e04e | |||
| 77db5ecd12 | |||
| 7ac789c9c7 | |||
| 24dff05f64 | |||
| 64a350364d | |||
| 11b7cfe5cb | |||
| 71cfcad2a1 | |||
| ab4373b26e | |||
| d23ddc96ac | |||
| 147708e779 | |||
| dc969dd7ed | |||
| ef7d1d9327 | |||
| 2e6e9ed925 | |||
| 296dcab4c7 | |||
| f9e1c46c45 | |||
| 94fd5bd7ec | |||
| eb6ca96e85 | |||
| a2bbc7e272 | |||
| f075a991f0 | |||
| edeb817c39 | |||
| 23b4658672 | |||
| 5f95ee987f | |||
| cc73f156a7 | |||
| ee72d10718 | |||
| 831871d37f | |||
| 6072550ec1 | |||
| 112a565bf7 | |||
| 59e5c76286 | |||
| 21620ac6bd | |||
| d05129ec67 | |||
| 0998de4ae6 | |||
| 2bdf1832da | |||
| a846c4b66e | |||
| ee535895a3 | |||
| 1e549dfd43 | |||
| 6ee718a252 | |||
| 557e98c33f | |||
| 7a9eec88e8 | |||
| a7a4f66633 | |||
| a88d0a6ae1 | |||
| db87bc770e | |||
| 7b6b71cd4b | |||
| df98463325 | |||
| f7492db8bd | |||
| 70b46d4a8f | |||
| 411486e1e7 | |||
| 6f81305232 | |||
| 79bc22d8ce | |||
| 1c634a702a | |||
| 909a9e4050 | |||
| b5cc794061 | |||
| 73b8e85976 | |||
| 282b5d6893 | |||
| c6628e7311 | |||
| 6b109d172f | |||
| 6b29972399 | |||
| 0fcd3c09fd | |||
| af503442b8 | |||
| c875971b71 | |||
| d1a65922d7 | |||
| 6ef34f95d5 | |||
| 8b79022179 | |||
| 21aec77e5c | |||
| 74c5259af8 | |||
| a3e7d4414d | |||
| 986d32eb81 | |||
| de0ae14544 | |||
| 6b52276fb6 | |||
| a19ea7489c | |||
| 14229c2f00 | |||
| 6eb20a1f2e | |||
| 8debac2edf | |||
| a68301e4dc | |||
| c6a988bc92 | |||
| fe02ce7b64 | |||
| df012dec90 | |||
| 5969425a6f | |||
| b17b1e6463 | |||
| c99e61c402 | |||
| f4aaec8b3c | |||
| adc3e6118b | |||
| d933493c31 | |||
| f91d591b03 | |||
| af6deb99cd | |||
| c5d285f755 | |||
| b1eb706925 | |||
| 5a01634ca3 | |||
| 487676ce13 | |||
| 0280ca7b1a | |||
| b0ccab41e1 | |||
| ccda3a3325 | |||
| 4b7eeaa6e0 | |||
| 2951f0030d | |||
| acc2df29de | |||
| 431afd618f | |||
| 6d5e5bd692 | |||
| ffd2e8149e | |||
| 2ab92dc13e | |||
| 7f6a8bc87e | |||
| b1ff163a28 | |||
| 440d55ccb8 | |||
| 285532d431 | |||
| f2c47459f8 | |||
| 49703f08e5 | |||
| 1d0aa9573b | |||
| b2014cf88b | |||
| a0e0078bad | |||
| 5ebca21c32 | |||
| 970aea90c9 | |||
| 5f9341ad8e | |||
| 574c0983f5 | |||
| be6c7c7ac8 | |||
| 4fd31f276b | |||
| 224db7da57 | |||
| 1413e1aff4 | |||
| 68b669d3ff | |||
| 29f44c67c8 | |||
| 3332d2288f | |||
| 34702196e1 | |||
| d45c8d1e9b | |||
| bc19825ada | |||
| 72bb640239 | |||
| aacee4a94c | |||
| 3ab37d5c5d | |||
| 3dd3ecf8f1 | |||
| a3831827d0 | |||
| 6aa6c957ee | |||
| 9e12412f5f | |||
| 0f9eb31740 | |||
| 6be8ab581d | |||
| d8425bc9c5 | |||
| 0ddcb9c00a | |||
| 6d43623f45 | |||
| 196cd88010 | |||
| 7f37df4227 | |||
| 985a12a63b | |||
| 9058c0e9fc | |||
| 4b0cd32d12 | |||
| 6cb51bc55d | |||
| 119e3c31c9 | |||
| 56164c25d0 | |||
| c66e5f9fcd | |||
| 12700e1754 | |||
| 50db6f0765 | |||
| 64e8adddfd | |||
| 729a4d64e9 | |||
| 6f12504588 | |||
| 271459f820 | |||
| 5000c95d01 | |||
| f477733483 | |||
| 54e1681c5e | |||
| 2f6d9a156a | |||
| 10dd89ae62 | |||
| d01bfbec96 | |||
| 5eb4aa3a0e | |||
| 0b9933df1e | |||
| 76d12d6062 | |||
| cf10faf61c | |||
| 1cbf9c1cd9 | |||
| 25e361b9f9 | |||
| b88ee33ae4 | |||
| 684964da4f | |||
| 8a3841f638 | |||
| f642e42eea | |||
| bbef854c02 | |||
| e50611666e | |||
| eae4f721e8 | |||
| 12fed34e10 | |||
| 56350b54ee | |||
| 10b7644bb7 | |||
| d79db3bd3f | |||
| 1588461633 | |||
| dd999b60a4 | |||
| 3abee72fee | |||
| b5577b1d37 | |||
| e15ffb5820 | |||
| 4d9a5ed4a1 | |||
| b2bc1debe0 | |||
| 590ff67fcb | |||
| 209e1adf53 | |||
| 53c08484a3 | |||
| c6ca832737 | |||
| 2c399a078e | |||
| 8c519f13da | |||
| 853fdc70a2 | |||
| dc4f811eaa | |||
| d23c8b4a2a | |||
| 00c0dcc81d | |||
| f77feefdb8 | |||
| 2e346e5369 | |||
| 17023f6b55 | |||
| 3bb29abe32 | |||
| ac42d38b7a | |||
| d9c0130b59 | |||
| 4925d5a5e7 | |||
| dd9a7cf5d7 | |||
| 5ee3874b7e | |||
| 17dd77cc96 | |||
| 6c546b5290 | |||
| a853fc2026 | |||
| 92c9ac3826 | |||
| 78c2ced43b | |||
| 72f850f675 | |||
| bc326489ab | |||
| ea5e7d9563 | |||
| 5b5b48fc06 | |||
| 1548ba0b8d | |||
| 26b1c4244f | |||
| 8a4e981931 |
@@ -0,0 +1,36 @@
|
|||||||
|
# 后端规则
|
||||||
|
|
||||||
|
主包:`packages/ui/certd-server`。后端使用 Node.js、ESM、TypeScript、MidwayJS 3、Koa、TypeORM,默认 better-sqlite3,同时支持 PostgreSQL 和 MySQL,并通过 `@certd/midway-flyway-js` 使用类似 Flyway 的 SQL 迁移机制。
|
||||||
|
|
||||||
|
详细入口、模块和验证命令见 `.codex/repo-map.md`。
|
||||||
|
|
||||||
|
## 默认开发配置
|
||||||
|
|
||||||
|
- HTTP 端口:`7001`
|
||||||
|
- HTTPS 端口:`7002`
|
||||||
|
- 默认 SQLite 数据库:`./data/db.sqlite`
|
||||||
|
- 默认文件根目录:`./data/files`
|
||||||
|
|
||||||
|
## 数据与迁移
|
||||||
|
|
||||||
|
- 后端使用 TypeORM 实体加 SQL 迁移。
|
||||||
|
- 重点查看 `packages/ui/certd-server/src/modules/**/entity/*.ts` 和 `packages/ui/certd-server/db/migration/*.sql`。
|
||||||
|
- 默认配置中 `synchronize: false`,涉及表结构变更时应添加或更新迁移脚本,不要依赖 TypeORM 自动同步。
|
||||||
|
|
||||||
|
## 文件上传
|
||||||
|
|
||||||
|
使用 `/basic/file/upload` 上传文件后,接口返回的是临时缓存 key。业务保存表单或设置时,后端必须调用 `FileService.saveFile(userId, key, "public" | "private")` 转成永久文件 key 后再入库/入设置;不要直接保存 `tmpfile_key_...`,否则后续回显或下载会失效。
|
||||||
|
|
||||||
|
## Service 与事务
|
||||||
|
|
||||||
|
- 后端方法参数超过 3 个时,尽量改为对象参数传入。
|
||||||
|
- 需要传入 `manager` / `EntityManager` 做事务传播的方法,必须使用对象参数,不要把 `manager` 作为位置参数藏在参数列表末尾。
|
||||||
|
- 后端 service 层只有存在事务链路传播需求时才定义 `ctx`,不要为了将来可能需要而提前给普通方法加 `ctx`。
|
||||||
|
- 事务链路方法统一采用 `method(ctx, req)` 形式,`ctx` 放第一位并承载 `manager?: EntityManager` 等横切上下文,业务参数放在 `req` 对象里,例如 `settleCommission({ manager }, { tradeId, userId, amount })`。
|
||||||
|
- 无事务链路需求的普通查询、纯函数和简单私有方法继续使用明确参数。
|
||||||
|
- service 内部需要根据事务上下文选择 Repository 时,优先使用 `BaseService.getRepo(ctx, EntityClass)`;不要在业务方法里反复写 `ctx.manager?.getRepository(Entity) || this.xxxRepository`。
|
||||||
|
- 拿到 repo 后 save/update/delete/find 都能做,不需要再包一层 `saveEntity` 之类的单一用途方法。
|
||||||
|
- service 拼接用户与项目范围查询条件时,优先使用 `BaseService.buildUserProjectQuery(userId, projectId)`;不要直接写 `{ userId, projectId }`,否则 `projectId` 为空时可能把 `null`/`undefined` 带入 TypeORM 条件,导致查询或 update 不符合预期。
|
||||||
|
- `ctx` 类型统一从 `BaseService` 导出的 `ServiceContext` 复用,不要在每个 service 里重复定义。
|
||||||
|
- 需要“有事务则复用、无事务则开启”时,使用 `BaseService.transactionWithCtx(ctx, callback)`:`ctx.manager` 存在则直接执行 callback,否则自动 `this.transaction()`。不要在业务代码里手写 `if (ctx.manager) { ... } else { await this.transaction(...) }`。
|
||||||
|
- 新增方法注意不要与 `BaseService` 基类方法签名冲突,例如 `delete(id)` vs `BaseService.delete(ids, where?)`,ts-node 下会直接 TS2416 编译报错。冲突时改用具体名称如 `deleteById`。
|
||||||
@@ -0,0 +1,26 @@
|
|||||||
|
# 代码风格规则
|
||||||
|
|
||||||
|
## 基本原则
|
||||||
|
|
||||||
|
- 中文 README 在部分 PowerShell 环境中可能显示乱码;`README_en.md` 可读性更好,且包含同样的高层项目说明。
|
||||||
|
- 根包管理器是 pnpm,不要引入 npm/yarn lockfile。
|
||||||
|
- 优先沿用现有模块、插件、服务模式,再考虑新增抽象。
|
||||||
|
- 注意本地数据和配置里可能包含凭据、证书材料等敏感信息。
|
||||||
|
|
||||||
|
## 注释
|
||||||
|
|
||||||
|
本仓库代码注释优先使用中文,尤其是解释业务规则、兼容逻辑、协议细节和隐藏风险时;除非文件已有明确英文注释风格或引用外部英文术语,否则不要新增英文说明性注释。
|
||||||
|
|
||||||
|
## 可读性
|
||||||
|
|
||||||
|
代码可读性优先于短写法。遇到包含业务分支的复杂三元表达式、内联对象、链式调用或条件组合时,优先拆成命名清晰的中间变量、独立分支或小函数,让读代码的人能一眼看出业务意图;不要为了少写几行把逻辑压成难读的一坨。
|
||||||
|
|
||||||
|
在对象字面量、查询条件或函数参数里不要内联调用多层 helper,例如 `{ domain, ...this.buildUserProjectQuery(userId, projectId) }`。应先用命名变量承接结果,例如 `const userProjectQuery = this.buildUserProjectQuery(userId, projectId)`,再在对象里展开 `...userProjectQuery`,让条件构造和业务字段都更容易阅读。
|
||||||
|
|
||||||
|
## DRY
|
||||||
|
|
||||||
|
遵守 DRY 原则:同一业务规则、字段转换、权限判断、Repository 选择、事务传播、金额计算等逻辑不要在多个地方复制粘贴。第二次出现时可以先保持清晰,第三次出现前应优先抽成局部 helper、service 方法或已有公共工具;抽象要服务于减少真实重复和降低修改风险,不要为了形式上的“复用”制造过度设计。
|
||||||
|
|
||||||
|
## 单一职责
|
||||||
|
|
||||||
|
遵守单一职责原则:一个方法只负责一个清晰的业务步骤或技术步骤。流程编排方法可以串联多个步骤,但具体的校验、计算、持久化、状态变更、展示数据组装应尽量拆到命名明确的小方法中;不要让一个方法同时承担查询、校验、计算、写库、格式化返回等过多职责。
|
||||||
@@ -0,0 +1,31 @@
|
|||||||
|
# 前端规则
|
||||||
|
|
||||||
|
主包:`packages/ui/certd-client`。前端使用 Vue 3、Vite、TypeScript、Ant Design Vue、Fast Crud、Pinia、vue-router、vue-i18n、Tailwind/Windi 相关样式工具。
|
||||||
|
|
||||||
|
详细入口、路由、状态、API、视图、locale 和验证命令见 `.codex/repo-map.md`。
|
||||||
|
|
||||||
|
## 禁跑命令
|
||||||
|
|
||||||
|
- 不要运行前端 `pnpm tsc` / `vue-tsc`:当前依赖组合中 `vue-tsc@1.8.27` 会直接抛内部错误 `Search string not found: "/supportedTSExtensions = .*(?=;)/"`,不是有效的项目类型检查结果。
|
||||||
|
- 前端暂不跑单元测试;当前 `test:unit` 只是占位脚本。
|
||||||
|
|
||||||
|
## 格式化与校验
|
||||||
|
|
||||||
|
前端 TS/Vue/locale 等文件改动后,优先只对本次改动文件运行项目现有自动格式化/修复:
|
||||||
|
|
||||||
|
- Prettier:`packages\ui\certd-client\node_modules\.bin\prettier.cmd --write <files>`
|
||||||
|
- ESLint:`packages\ui\certd-client\node_modules\.bin\eslint.cmd --fix <files>`
|
||||||
|
|
||||||
|
不要为了格式化无关文件而扩大 diff。项目保留了 `tslint` 依赖,但当前主要使用 ESLint + Prettier。
|
||||||
|
|
||||||
|
## Fast Crud 页面
|
||||||
|
|
||||||
|
- 列表管理、后台管理、记录查询、CRUD 表格类页面,默认优先使用 Fast Crud(`@fast-crud/fast-crud`、`fs-crud`、`useFs`、`createCrudOptions`)实现。
|
||||||
|
- 只有轻量只读展示、强交互自定义界面或已有页面模式明确不适合 Fast Crud 时,才手写 `a-table` / 自定义列表,并在回复中说明原因。
|
||||||
|
- 开发或重构这类页面前,先读取 `.trae/skills/fast-crud-page-dev/SKILL.md`,按仓库内 Fast Crud 页面拆分与验证方式实现。
|
||||||
|
- 页面内嵌 Fast Crud 表格时,要显式给外层容器稳定高度或 `flex: 1; min-height: 0` 的撑满链路;Fast Crud 依赖外部元素高度,不能只依赖表格默认高度。
|
||||||
|
- 后台管理列表里展示或筛选用户字段时,优先参考 `packages/ui/certd-client/src/views/sys/suite/user-suite/crud.tsx` 的 `userId` 字段模式:前端使用 `table-select` + `/sys/authority/user/getSimpleUserByIds` 字典回显和搜索;不要为了展示用户名让后端列表接口额外 `fillSimpleUser` / `userDisplay`,除非该接口本身就是用户端业务列表且已有明确模式。
|
||||||
|
|
||||||
|
## 对话框
|
||||||
|
|
||||||
|
前端对话框里只做纯确认时可以使用 `Modal.confirm`;只要对话框里有字段输入、表单校验或提交字段,统一使用 `useFormDialog` / `openFormDialog`,不要在 `Modal.confirm` 的 `content` 里手写输入框。
|
||||||
@@ -0,0 +1,42 @@
|
|||||||
|
# 流水线与插件规则
|
||||||
|
|
||||||
|
项目最关键的架构概念是证书流水线。核心导出、关键抽象、插件目录和共享 helper 位置见 `.codex/repo-map.md`。
|
||||||
|
|
||||||
|
插件是核心能力,不是边缘功能。新增服务商、DNS 验证、证书部署、通知方式等能力,通常应该放在插件包里,或放在 `packages/ui/certd-server/src/plugins/<plugin-name>/` 下。
|
||||||
|
|
||||||
|
## 改动归属
|
||||||
|
|
||||||
|
修改证书申请、验证、部署或通知行为时,先判断改动属于哪里:
|
||||||
|
|
||||||
|
- ACME client 代码
|
||||||
|
- pipeline 核心抽象
|
||||||
|
- 后端 module/service/entity/controller
|
||||||
|
- 某个具体插件实现
|
||||||
|
- 前端 view/form/schema
|
||||||
|
|
||||||
|
如果只是某个服务商或部署目标的问题,不要轻易修改共享 pipeline/core 行为,除非确实是可复用的公共能力。
|
||||||
|
|
||||||
|
## ACME / EAB
|
||||||
|
|
||||||
|
- 公共 EAB(尤其是 Google EAB)可能只能创建一次 ACME 账号。要跨用户复用公共 EAB,应保存并复用同一个 ACME account private key;`accountUrl` 如果存到 `userContext` 里,只能视为当前用户缓存,因为 `userContext` 跟用户 id 走。
|
||||||
|
- ACME 协议的 `newAccount` 支持 `onlyReturnExisting`。使用同一个 account private key 调用 `newAccount({ onlyReturnExisting: true })` 可以取回已创建账号的 URL,且不会再次消费 EAB。
|
||||||
|
- 修改 EAB 的 `kid` 后,应重新生成绑定该 `kid` 的 account private key;否则应阻止继续申请并提示用户刷新账号私钥。
|
||||||
|
|
||||||
|
## 插件开发技能
|
||||||
|
|
||||||
|
仓库内置了 Certd 插件开发技能,供 Trae 和 Codex 共用:
|
||||||
|
|
||||||
|
- Trae 入口:`.trae/skills`
|
||||||
|
- Codex 入口:`.codex/skills`
|
||||||
|
|
||||||
|
其中 `.codex/skills` 是指向 `.trae/skills` 的目录链接,不要复制出第二份技能内容。更新技能时只维护 `.trae/skills` 下的原始文件,Codex 会通过 `.codex/skills` 读取同一份内容。
|
||||||
|
|
||||||
|
当前技能包括:
|
||||||
|
|
||||||
|
- `access-plugin-dev`:开发 Access 授权插件
|
||||||
|
- `dns-provider-dev`:开发 DNS Provider 插件
|
||||||
|
- `fast-crud-page-dev`:开发或重构前端 Fast Crud 列表管理页面
|
||||||
|
- `task-plugin-dev`:开发 Task 部署任务插件
|
||||||
|
- `plugin-converter`:将插件转换为 YAML 配置
|
||||||
|
|
||||||
|
做插件相关任务时,先读取对应技能目录下的 `SKILL.md`,再进入具体实现。若用户在插件开发中指出更好的做法,应总结并更新对应技能。
|
||||||
@@ -0,0 +1,26 @@
|
|||||||
|
# 测试与验证规则
|
||||||
|
|
||||||
|
实现新功能或修复行为缺陷前,先补对应单元测试,并先运行测试确认它处于失败状态;再实现功能或修复代码,反复运行聚焦单元测试直到通过。若某项改动确实不适合先写单元测试,应在回复中说明原因和替代验证方式。
|
||||||
|
|
||||||
|
后补单元测试时,应先基于对正确行为的实际预期编写测试,而不是为了迎合现有实现改写预期;如果运行后出现红灯,且通过测试需要修改已有实现,应先向用户确认这是确实的 bug,还是原本需求/既有行为就是如此;确认后再修改原始实现,避免把测试补充变成未经确认的行为改动。
|
||||||
|
|
||||||
|
## 后端单测
|
||||||
|
|
||||||
|
- 后端纯单元测试用例放在 `src` 目录内,并尽量与被测文件相邻,例如 `src/utils/random.test.ts`。
|
||||||
|
- 对应 `test:unit` 只跑 `src/**/*.test.ts`,构建/打包配置应排除这些 `*.test.ts` 文件。
|
||||||
|
- 单元测试需要 mock ESM 静态 import 时,优先使用 `esmock`,不要为了测试把业务代码改成构造函数注入或把逻辑挪到调用方。
|
||||||
|
- 各包 `test:unit` 脚本应显式设置 `NODE_ENV=unittest`。
|
||||||
|
|
||||||
|
## 运行方式
|
||||||
|
|
||||||
|
单个 monorepo 包运行单元测试时,优先使用 `corepack pnpm --dir <包目录> test:unit`,例如:
|
||||||
|
|
||||||
|
- `corepack pnpm --dir packages\ui\certd-server test:unit`
|
||||||
|
- `corepack pnpm --dir packages\core\basic test:unit`
|
||||||
|
- `corepack pnpm --dir packages\plugins\plugin-lib test:unit`
|
||||||
|
|
||||||
|
也可以用包名过滤,例如 `corepack pnpm --filter @certd/ui-server test:unit`。
|
||||||
|
|
||||||
|
前端 `packages\ui\certd-client` 暂时不跑单元测试。前端改动优先使用 Prettier/ESLint 做改动文件验证。
|
||||||
|
|
||||||
|
优先对改动包运行聚焦测试;只有跨包影响明显时再考虑全 monorepo 构建。
|
||||||
@@ -0,0 +1,106 @@
|
|||||||
|
# Certd 仓库地图
|
||||||
|
|
||||||
|
本文档由 Codex 子智能体只读探索后整理,用于后续开发时快速定位代码。进入仓库仍应先读取根目录 `AGENTS.md`,本文件只作为导航补充。
|
||||||
|
|
||||||
|
## 顶层结构
|
||||||
|
|
||||||
|
Certd 是 pnpm + lerna-lite monorepo。
|
||||||
|
|
||||||
|
- `package.json`:根脚本与 workspace 元信息
|
||||||
|
- `pnpm-workspace.yaml`:workspace 匹配规则,包含 `packages/**`、`packages/ui/**`
|
||||||
|
- `lerna.json`:lerna-lite 配置
|
||||||
|
- `docs`:VitePress 文档站
|
||||||
|
- `docker`:Docker 安装和运行相关文件
|
||||||
|
- `packages/core/acme-client`:ACME 协议客户端
|
||||||
|
- `packages/core/basic`:共享基础工具
|
||||||
|
- `packages/core/pipeline`:流水线核心抽象、插件模型、执行上下文
|
||||||
|
- `packages/libs`:共享集成库
|
||||||
|
- `packages/plugins/plugin-lib`:证书、DNS Provider、格式转换等插件共享能力
|
||||||
|
- `packages/plugins/plugin-cert`:证书插件包入口
|
||||||
|
- `packages/ui/certd-server`:后端 Midway 服务
|
||||||
|
- `packages/ui/certd-client`:前端 Vue/Vite 管理台
|
||||||
|
- `packages/pro`:商业版独立 Git 工作区,需在该目录内单独检查状态
|
||||||
|
|
||||||
|
运行时或生成产物通常包括根目录 `node_modules`、`logs`、`output`、`lerna-debug.log`、`tmp-certd-client-vite*.log`,以及后端 `packages/ui/certd-server/data`、`packages/ui/certd-server/logs`、各包 `dist`、插件 metadata/yaml 导出结果。
|
||||||
|
|
||||||
|
## 常用验证
|
||||||
|
|
||||||
|
- 根目录启动后端生产模式:`pnpm run start:server`
|
||||||
|
- 后端开发服务:`corepack pnpm --dir packages\ui\certd-server dev`
|
||||||
|
- 后端聚焦单测:`corepack pnpm --dir packages\ui\certd-server test:unit`
|
||||||
|
- 后端完整测试:`corepack pnpm --dir packages\ui\certd-server test`
|
||||||
|
- 后端构建:`corepack pnpm --dir packages\ui\certd-server build`
|
||||||
|
- 前端开发服务:`corepack pnpm --dir packages\ui\certd-client dev`
|
||||||
|
- 前端构建:`corepack pnpm --dir packages\ui\certd-client build`
|
||||||
|
- 前端改动文件格式化:`packages\ui\certd-client\node_modules\.bin\prettier.cmd --write <files>`
|
||||||
|
- 前端改动文件 ESLint 修复:`packages\ui\certd-client\node_modules\.bin\eslint.cmd --fix <files>`
|
||||||
|
|
||||||
|
不要主动运行 `pnpm install`。前端不要运行 `pnpm tsc` / `vue-tsc`,当前依赖组合中 `vue-tsc@1.8.27` 会抛无效内部错误;前端 `test:unit` 也只是占位。
|
||||||
|
|
||||||
|
## 后端地图
|
||||||
|
|
||||||
|
主包:`packages/ui/certd-server`。
|
||||||
|
|
||||||
|
- `bootstrap.js`:Midway 启动入口,使用 `@midwayjs/bootstrap`
|
||||||
|
- `src/configuration.ts`:Midway 主配置,注册组件和全局中间件
|
||||||
|
- `src/config/config.default.ts`:端口、HTTPS、静态文件、cron、TypeORM、Flyway、上传、JWT、Swagger 默认配置
|
||||||
|
- `src/config/loader.ts`:读取 `.env`、`.env.<env>.yaml`,支持 `certd_` 前缀环境变量覆盖嵌套配置
|
||||||
|
- `src/modules`:业务模块根目录,例如 `basic`、`cert`、`cname`、`cron`、`login`、`monitor`、`open`、`pipeline`、`plugin`、`suite`、`sys`
|
||||||
|
- `src/controller`:API 入口,按 `basic`、`user`、`sys`、`openapi` 分组
|
||||||
|
- `db/migration`:SQL 迁移目录,TypeORM `synchronize: false`,表结构变更应配套迁移 SQL
|
||||||
|
|
||||||
|
测试使用 Mocha + Node `assert/strict`,纯单测放在 `src/**/*.test.ts`,尽量与被测文件相邻。可参考 `src/utils/random.test.ts`、`src/controller/basic/app-controller.test.ts`、`src/modules/pipeline/service/pipeline-service.test.ts`。
|
||||||
|
|
||||||
|
## 前端地图
|
||||||
|
|
||||||
|
主包:`packages/ui/certd-client`。
|
||||||
|
|
||||||
|
- `vite.config.ts`:Vite 配置,dev 端口 `3008`,`/api`、`/certd/api` 代理到后端 `127.0.0.1:7001`
|
||||||
|
- `src/main.ts`:Vue 启动入口,注册 AntDV、Vben、router、全局组件、插件和偏好设置
|
||||||
|
- `src/App.vue`:根组件,包含 `AConfigProvider`、`FsFormProvider`、`router-view`
|
||||||
|
- `src/router/index.ts`、`src/router/resolve.ts`:路由入口,使用 `createWebHashHistory`
|
||||||
|
- `src/router/source/modules/certd.ts`:Certd 主业务路由
|
||||||
|
- `src/store`:Pinia store,主要有 `user`、`project`、`settings`、`plugin`
|
||||||
|
- `src/api/service.ts`:Axios 封装
|
||||||
|
- `src/api/tools.ts`:错误与响应工具
|
||||||
|
- `src/views/certd`:核心业务视图,例如 `pipeline`、`cert`、`monitor`、`access`、`notification`、`open`、`project`、`suite`、`wallet`
|
||||||
|
- `src/locales`:国际化入口与语言包
|
||||||
|
|
||||||
|
列表管理、后台管理、记录查询、CRUD 表格页面优先使用 Fast Crud。开发前读取 `.trae/skills/fast-crud-page-dev/SKILL.md`。常见拆分是 `api.ts`、`crud.tsx`、`index.vue`。可参考 `src/views/certd/access`、`src/views/sys/suite/user-suite/crud.tsx`、`src/views/certd/wallet/index.vue`。内嵌 `fs-crud` 时要给外层稳定高度或完整 `flex: 1; min-height: 0` 链路。
|
||||||
|
|
||||||
|
## 流水线与插件地图
|
||||||
|
|
||||||
|
核心入口:`packages/core/pipeline/src/index.ts`,导出 `core`、`dt`、`access`、`registry`、`plugin`、`context`、`decorator`、`service`、`notification`。
|
||||||
|
|
||||||
|
- `packages/core/pipeline/src/plugin`:任务插件抽象,例如 `AbstractTaskPlugin`、`IsTaskPlugin`、`TaskInput`、`pluginRegistry`
|
||||||
|
- `packages/core/pipeline/src/access`:授权插件抽象,例如 `BaseAccess`、`IsAccess`、`AccessInput`、`accessRegistry`
|
||||||
|
- `packages/core/pipeline/src/dt/pipeline.ts`:`Pipeline`、`Stage`、`Task`、`RunStrategy` 等流水线数据结构
|
||||||
|
- `packages/core/pipeline/src/core`:执行器、上下文、运行历史、文件存储等
|
||||||
|
- `packages/core/pipeline/src/service`:CNAME、事件、配置、邮件、URL 等 pipeline service 接口
|
||||||
|
- `packages/ui/certd-server/src/plugins`:后端内置服务商、DNS、部署、通知等插件
|
||||||
|
- `packages/ui/certd-server/src/plugins/plugin-cert`:证书申请核心插件
|
||||||
|
- `packages/ui/certd-server/src/plugins/plugin-lib`:后端插件 helper/access
|
||||||
|
- `packages/plugins/plugin-lib/src/cert`:`CertReader`、`CertConverter`、DNS Provider 公共能力
|
||||||
|
- `packages/plugins/plugin-lib/src/cert/dns-provider`:`AbstractDnsProvider`、`dnsProviderRegistry`、`DomainParser`
|
||||||
|
|
||||||
|
插件开发技能入口:
|
||||||
|
|
||||||
|
- `.trae/skills/dns-provider-dev/SKILL.md`:DNS Provider 插件
|
||||||
|
- `.trae/skills/task-plugin-dev/SKILL.md`:Task 部署任务插件
|
||||||
|
- `.trae/skills/access-plugin-dev/SKILL.md`:Access 授权插件
|
||||||
|
- `.trae/skills/plugin-converter/SKILL.md`:插件转 YAML 配置
|
||||||
|
|
||||||
|
改动归属判断:
|
||||||
|
|
||||||
|
- ACME 协议、EAB、账号、订单、挑战流程:优先看 `packages/core/acme-client` 或 `packages/ui/certd-server/src/plugins/plugin-cert/plugin/cert-plugin/acme.ts`
|
||||||
|
- 流水线执行、任务生命周期、输入输出、注册机制:看 `packages/core/pipeline`
|
||||||
|
- 单个云厂商 DNS 验证、证书部署、API 调用失败:改对应 `packages/ui/certd-server/src/plugins/plugin-xxx`
|
||||||
|
- 通用证书读取、DNS Provider 公共能力、格式转换:改 `packages/plugins/plugin-lib`
|
||||||
|
- 后端业务数据、接口、实体、权限、迁移:改 `packages/ui/certd-server/src/modules` 与 `src/controller`
|
||||||
|
- 表单、列表、插件配置 UI:改 `packages/ui/certd-client/src/views/certd` 及对应 `src/api`
|
||||||
|
|
||||||
|
原则:如果只是单个服务商或部署目标的问题,不动共享 pipeline/core;只有可复用的公共语义或跨插件一致行为,才考虑上移到 `packages/core/pipeline` 或 `packages/plugins/plugin-lib`。
|
||||||
|
|
||||||
|
## Git 注意事项
|
||||||
|
|
||||||
|
子智能体探索时根仓库 `git status --short` 为空。`packages/pro` 也是独立仓库且当时未显示未提交改动,但曾出现无法删除 `packages/pro/.git/index.lock` 的警告;后续操作 pro 仓库前应先检查该锁文件或占用状态。
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
../.trae/skills
|
||||||
@@ -1,36 +1,29 @@
|
|||||||
---
|
---
|
||||||
name: Plugin Apply
|
name: Plugin Apply
|
||||||
about: 部署插件申请支持
|
about: 部署插件申请支持
|
||||||
title: "[Plugin] "
|
title: '[Plugin] '
|
||||||
labels: feature
|
labels: feature
|
||||||
---
|
---
|
||||||
|
|
||||||
> > 感谢您支持certd,请按如下规范提交issue
|
> > 感谢您支持certd,请按如下规范提交issue
|
||||||
> 如果有条件,请尽量在[github上提交](https://github.com/certd/certd/issues)
|
> > 如果有条件,请尽量在[github上提交](https://github.com/certd/certd/issues)
|
||||||
|
|
||||||
# 新部署插件申请支持
|
# 新部署插件申请支持
|
||||||
|
|
||||||
## 1. 需求描述
|
## 1. 需求描述
|
||||||
`请在此处简要描述你的需求`
|
|
||||||
|
|
||||||
|
`请在此处简要描述你的需求`
|
||||||
|
|
||||||
## 2. 要部署证书应用的信息
|
## 2. 要部署证书应用的信息
|
||||||
|
|
||||||
1. 应用名称:
|
1. 应用名称:
|
||||||
|
|
||||||
|
|
||||||
2. 应用网址/项目地址/官方网站:
|
2. 应用网址/项目地址/官方网站:
|
||||||
|
|
||||||
|
|
||||||
3. 管理证书界面截图(或者手动部署证书方式介绍及截图):
|
3. 管理证书界面截图(或者手动部署证书方式介绍及截图):
|
||||||
|
|
||||||
|
|
||||||
4. 是否有API接口,接口地址:
|
4. 是否有API接口,接口地址:
|
||||||
|
|
||||||
|
|
||||||
5. 如果没有API接口,网页登录是否需要验证码:
|
5. 如果没有API接口,网页登录是否需要验证码:
|
||||||
|
|
||||||
|
|
||||||
6. 是否可以提供测试账号?(如果可以请留下联系方式或者加作者好友)
|
6. 是否可以提供测试账号?(如果可以请留下联系方式或者加作者好友)
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -1,36 +1,29 @@
|
|||||||
---
|
---
|
||||||
name: DNS Provider Apply
|
name: DNS Provider Apply
|
||||||
about: 域名提供商申请支持
|
about: 域名提供商申请支持
|
||||||
title: "[DNS] "
|
title: '[DNS] '
|
||||||
labels: feature
|
labels: feature
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
> 感谢您支持certd,请按如下规范提交issue
|
> 感谢您支持certd,请按如下规范提交issue
|
||||||
> 如果有条件,请尽量在[github上提交](https://github.com/certd/certd/issues)
|
> 如果有条件,请尽量在[github上提交](https://github.com/certd/certd/issues)
|
||||||
|
|
||||||
# 新域名提供商支持申请
|
# 新域名提供商支持申请
|
||||||
|
|
||||||
## 1. 基本信息
|
## 1. 基本信息
|
||||||
|
|
||||||
请填写如下内容:
|
请填写如下内容:
|
||||||
|
|
||||||
1. 域名提供商名称:
|
1. 域名提供商名称:
|
||||||
|
|
||||||
|
|
||||||
2. 管理页面地址:
|
2. 管理页面地址:
|
||||||
|
|
||||||
|
|
||||||
3. 是否有API接口,接口地址:
|
3. 是否有API接口,接口地址:
|
||||||
|
|
||||||
|
|
||||||
4. 如果没有API接口,网页登录是否有验证码:
|
4. 如果没有API接口,网页登录是否有验证码:
|
||||||
|
|
||||||
|
|
||||||
5. 是否可以提供测试账号?(如果可以请留下联系方式或者加作者好友)
|
5. 是否可以提供测试账号?(如果可以请留下联系方式或者加作者好友)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## 2. 截图
|
## 2. 截图
|
||||||
|
|
||||||
`域名管理页面截图`
|
`域名管理页面截图`
|
||||||
|
|
||||||
|
|||||||
@@ -1,28 +1,32 @@
|
|||||||
---
|
---
|
||||||
name: Bug Report
|
name: Bug Report
|
||||||
about: 错误或问题报告
|
about: 错误或问题报告
|
||||||
title: "[BUG] "
|
title: '[BUG] '
|
||||||
labels: bug
|
labels: bug
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
||||||
> 感谢您支持certd,请按如下规范提交issue
|
> 感谢您支持certd,请按如下规范提交issue
|
||||||
> 如果有条件,请尽量在[github上提交](https://github.com/certd/certd/issues)
|
> 如果有条件,请尽量在[github上提交](https://github.com/certd/certd/issues)
|
||||||
|
|
||||||
# bug提交
|
# bug提交
|
||||||
|
|
||||||
## 1、问题描述
|
## 1、问题描述
|
||||||
|
|
||||||
`请在此处简要描述你所遇到的问题,必要时请贴出相关截图辅助理解和定位`
|
`请在此处简要描述你所遇到的问题,必要时请贴出相关截图辅助理解和定位`
|
||||||
|
|
||||||
### 2、复现步骤
|
### 2、复现步骤
|
||||||
|
|
||||||
`请描述复现问题的详细步骤`
|
`请描述复现问题的详细步骤`
|
||||||
`如果非示例页面的问题,最好能提供最小复现示例的代码、或者仓库链接`
|
`如果非示例页面的问题,最好能提供最小复现示例的代码、或者仓库链接`
|
||||||
|
|
||||||
|
|
||||||
### 3.报错截图
|
### 3.报错截图
|
||||||
|
|
||||||
`请贴出报错日志截图`
|
`请贴出报错日志截图`
|
||||||
|
|
||||||
### 4、效果截图
|
### 4、效果截图
|
||||||
|
|
||||||
`请贴出效果截图`
|
`请贴出效果截图`
|
||||||
|
|
||||||
#### 4.1. 期望效果
|
#### 4.1. 期望效果
|
||||||
|
|
||||||
#### 4.2. 实际效果
|
#### 4.2. 实际效果
|
||||||
|
|||||||
@@ -1,24 +1,25 @@
|
|||||||
---
|
---
|
||||||
name: Feature Request
|
name: Feature Request
|
||||||
about: 新需求、新特性申请支持
|
about: 新需求、新特性申请支持
|
||||||
title: "[Feature] "
|
title: '[Feature] '
|
||||||
labels: feature
|
labels: feature
|
||||||
---
|
---
|
||||||
|
|
||||||
> > 感谢您支持certd,请按如下规范提交issue
|
> > 感谢您支持certd,请按如下规范提交issue
|
||||||
> 如果有条件,请尽量在[github上提交](https://github.com/certd/certd/issues)
|
> > 如果有条件,请尽量在[github上提交](https://github.com/certd/certd/issues)
|
||||||
|
|
||||||
|
|
||||||
# 新特性申请
|
# 新特性申请
|
||||||
>注意:这里仅供如果是要申请新的部署插件,请提交插件申请
|
|
||||||
|
> 注意:这里仅供如果是要申请新的部署插件,请提交插件申请
|
||||||
|
|
||||||
## 1. 需求描述,需求背景
|
## 1. 需求描述,需求背景
|
||||||
|
|
||||||
`请在此处简要描述你所遇到的问题,必要时请贴出相关截图辅助理解`
|
`请在此处简要描述你所遇到的问题,必要时请贴出相关截图辅助理解`
|
||||||
|
|
||||||
|
|
||||||
## 2. 期望效果
|
## 2. 期望效果
|
||||||
|
|
||||||
`必要时可以截图描述你的期望效果`
|
`必要时可以截图描述你的期望效果`
|
||||||
|
|
||||||
|
|
||||||
## 3. 你的解决方案
|
## 3. 你的解决方案
|
||||||
|
|
||||||
`如果你有解决方案,请描述你的方案`
|
`如果你有解决方案,请描述你的方案`
|
||||||
|
|||||||
@@ -3,8 +3,8 @@ on:
|
|||||||
push:
|
push:
|
||||||
branches: ['v2-dev']
|
branches: ['v2-dev']
|
||||||
paths:
|
paths:
|
||||||
- "trigger/build.trigger"
|
- 'trigger/build.trigger'
|
||||||
|
workflow_dispatch: # 添加手动触发
|
||||||
# schedule:
|
# schedule:
|
||||||
# - # 国际时间 19:17 执行,北京时间3:17 ↙↙↙ 改成你想要每天自动执行的时间
|
# - # 国际时间 19:17 执行,北京时间3:17 ↙↙↙ 改成你想要每天自动执行的时间
|
||||||
# - cron: '17 19 * * *'
|
# - cron: '17 19 * * *'
|
||||||
@@ -21,7 +21,7 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
lfs: true
|
lfs: true
|
||||||
|
ref: 'v2-dev'
|
||||||
- name: get_certd_version
|
- name: get_certd_version
|
||||||
id: get_certd_version
|
id: get_certd_version
|
||||||
uses: actions/github-script@v6
|
uses: actions/github-script@v6
|
||||||
@@ -37,14 +37,14 @@ jobs:
|
|||||||
const pkg = JSON.parse(jsonContent)
|
const pkg = JSON.parse(jsonContent)
|
||||||
console.log("certd_version:",pkg.version);
|
console.log("certd_version:",pkg.version);
|
||||||
return pkg.version
|
return pkg.version
|
||||||
# - name: Use Node.js
|
# - name: Use Node.js
|
||||||
# uses: actions/setup-node@v4
|
# uses: actions/setup-node@v4
|
||||||
# with:
|
# with:
|
||||||
# node-version: 18
|
# node-version: 18
|
||||||
# cache: 'npm'
|
# cache: 'npm'
|
||||||
# working-directory: ./packages/ui/certd-client
|
# working-directory: ./packages/ui/certd-client
|
||||||
- run: |
|
- run: |
|
||||||
npm install -g pnpm
|
npm install -g pnpm@10.33.4
|
||||||
pnpm install
|
pnpm install
|
||||||
npm run build
|
npm run build
|
||||||
working-directory: ./packages/ui/certd-client
|
working-directory: ./packages/ui/certd-client
|
||||||
|
|||||||
@@ -3,12 +3,12 @@ on:
|
|||||||
push:
|
push:
|
||||||
branches: ['v2-dev']
|
branches: ['v2-dev']
|
||||||
paths:
|
paths:
|
||||||
- "trigger/deploy.trigger"
|
- 'trigger/deploy.trigger'
|
||||||
workflow_run:
|
workflow_run:
|
||||||
workflows: [ "build-image" ]
|
workflows: ['build-image']
|
||||||
types:
|
types:
|
||||||
- completed
|
- completed
|
||||||
|
workflow_dispatch: # 添加手动触发
|
||||||
|
|
||||||
# schedule:
|
# schedule:
|
||||||
# - # 国际时间 19:17 执行,北京时间3:17 ↙↙↙ 改成你想要每天自动执行的时间
|
# - # 国际时间 19:17 执行,北京时间3:17 ↙↙↙ 改成你想要每天自动执行的时间
|
||||||
@@ -26,6 +26,7 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
ref: v2-dev
|
ref: v2-dev
|
||||||
|
|
||||||
- name: get_certd_version
|
- name: get_certd_version
|
||||||
id: get_certd_version
|
id: get_certd_version
|
||||||
uses: actions/github-script@v6
|
uses: actions/github-script@v6
|
||||||
@@ -43,7 +44,7 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
time: '10' # for 60 seconds
|
time: '10' # for 60 seconds
|
||||||
- name: deploy-certd-demo
|
- name: deploy-certd-demo
|
||||||
uses: tyrrrz/action-http-request@master
|
uses: tyrrrz/action-http-request@prime
|
||||||
with:
|
with:
|
||||||
# 通过webhook 触发 certd-demo来部署
|
# 通过webhook 触发 certd-demo来部署
|
||||||
url: ${{ secrets.WEBHOOK_CERTD_DEMO }}
|
url: ${{ secrets.WEBHOOK_CERTD_DEMO }}
|
||||||
|
|||||||
@@ -3,12 +3,12 @@ on:
|
|||||||
push:
|
push:
|
||||||
branches: ['v2-dev']
|
branches: ['v2-dev']
|
||||||
paths:
|
paths:
|
||||||
- "trigger/publish.trigger"
|
- 'trigger/publish.trigger'
|
||||||
workflow_run:
|
workflow_run:
|
||||||
workflows: [ "build-image-for-release" ]
|
workflows: ['build-image-for-release']
|
||||||
types:
|
types:
|
||||||
- completed
|
- completed
|
||||||
|
workflow_dispatch: # 添加手动触发
|
||||||
# schedule:
|
# schedule:
|
||||||
# - # 国际时间 19:17 执行,北京时间3:17 ↙↙↙ 改成你想要每天自动执行的时间
|
# - # 国际时间 19:17 执行,北京时间3:17 ↙↙↙ 改成你想要每天自动执行的时间
|
||||||
# - cron: '17 19 * * *'
|
# - cron: '17 19 * * *'
|
||||||
@@ -19,13 +19,17 @@ permissions:
|
|||||||
jobs:
|
jobs:
|
||||||
publish-atomgit:
|
publish-atomgit:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
if: ${{ github.event.workflow_run.conclusion == 'success' }}
|
if: |
|
||||||
|
github.event_name == 'workflow_dispatch' ||
|
||||||
|
(github.event.workflow_run.conclusion == 'success')
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout Code
|
- name: Checkout Code
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v4
|
||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
lfs: true
|
lfs: true
|
||||||
|
ref: 'v2-dev'
|
||||||
|
|
||||||
- name: get_certd_version
|
- name: get_certd_version
|
||||||
id: get_certd_version
|
id: get_certd_version
|
||||||
uses: actions/github-script@v6
|
uses: actions/github-script@v6
|
||||||
@@ -42,7 +46,7 @@ jobs:
|
|||||||
console.log("certd_version:",pkg.version);
|
console.log("certd_version:",pkg.version);
|
||||||
return pkg.version
|
return pkg.version
|
||||||
- run: |
|
- run: |
|
||||||
npm install -g pnpm
|
npm install -g pnpm@10.33.4
|
||||||
pnpm install
|
pnpm install
|
||||||
npm run build
|
npm run build
|
||||||
working-directory: ./packages/ui/certd-client
|
working-directory: ./packages/ui/certd-client
|
||||||
@@ -58,4 +62,3 @@ jobs:
|
|||||||
pnpm install
|
pnpm install
|
||||||
npm run publish_to_atomgit
|
npm run publish_to_atomgit
|
||||||
working-directory: ./
|
working-directory: ./
|
||||||
|
|
||||||
@@ -3,12 +3,12 @@ on:
|
|||||||
push:
|
push:
|
||||||
branches: ['v2-dev']
|
branches: ['v2-dev']
|
||||||
paths:
|
paths:
|
||||||
- "trigger/publish.trigger"
|
- 'trigger/publish.trigger'
|
||||||
workflow_run:
|
workflow_run:
|
||||||
workflows: [ "build-image-for-release" ]
|
workflows: ['build-image-for-release']
|
||||||
types:
|
types:
|
||||||
- completed
|
- completed
|
||||||
|
workflow_dispatch: # 添加手动触发
|
||||||
# schedule:
|
# schedule:
|
||||||
# - # 国际时间 19:17 执行,北京时间3:17 ↙↙↙ 改成你想要每天自动执行的时间
|
# - # 国际时间 19:17 执行,北京时间3:17 ↙↙↙ 改成你想要每天自动执行的时间
|
||||||
# - cron: '17 19 * * *'
|
# - cron: '17 19 * * *'
|
||||||
@@ -19,21 +19,23 @@ permissions:
|
|||||||
jobs:
|
jobs:
|
||||||
publish-gitee:
|
publish-gitee:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
if: ${{ github.event.workflow_run.conclusion == 'success' }}
|
if: |
|
||||||
|
github.event_name == 'workflow_dispatch' ||
|
||||||
|
(github.event.workflow_run.conclusion == 'success')
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout Code
|
- name: Checkout Code
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v4
|
||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
lfs: true
|
lfs: true
|
||||||
|
ref: 'v2-dev'
|
||||||
|
|
||||||
- name: publish_to_gitee
|
- name: publish_to_gitee
|
||||||
id: publish_to_gitee
|
id: publish_to_gitee
|
||||||
run: |
|
run: |
|
||||||
export GITEE_TOKEN=${{ secrets.GITEE_TOKEN }}
|
export GITEE_TOKEN=${{ secrets.GITEE_TOKEN }}
|
||||||
rm -rf ./pnpm*.yaml
|
rm -rf ./pnpm*.yaml
|
||||||
npm install -g pnpm
|
npm install -g pnpm@10.33.4
|
||||||
pnpm install
|
pnpm install
|
||||||
npm run publish_to_gitee
|
npm run publish_to_gitee
|
||||||
working-directory: ./
|
working-directory: ./
|
||||||
|
|
||||||
@@ -3,12 +3,12 @@ on:
|
|||||||
push:
|
push:
|
||||||
branches: ['v2-dev']
|
branches: ['v2-dev']
|
||||||
paths:
|
paths:
|
||||||
- "trigger/publish.trigger"
|
- 'trigger/publish.trigger'
|
||||||
workflow_run:
|
workflow_run:
|
||||||
workflows: [ "build-image-for-release" ]
|
workflows: ['build-image-for-release']
|
||||||
types:
|
types:
|
||||||
- completed
|
- completed
|
||||||
|
workflow_dispatch: # 添加手动触发
|
||||||
# schedule:
|
# schedule:
|
||||||
# - # 国际时间 19:17 执行,北京时间3:17 ↙↙↙ 改成你想要每天自动执行的时间
|
# - # 国际时间 19:17 执行,北京时间3:17 ↙↙↙ 改成你想要每天自动执行的时间
|
||||||
# - cron: '17 19 * * *'
|
# - cron: '17 19 * * *'
|
||||||
@@ -19,21 +19,23 @@ permissions:
|
|||||||
jobs:
|
jobs:
|
||||||
publish-github:
|
publish-github:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
if: ${{ github.event.workflow_run.conclusion == 'success' }}
|
if: |
|
||||||
|
github.event_name == 'workflow_dispatch' ||
|
||||||
|
(github.event.workflow_run.conclusion == 'success')
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout Code
|
- name: Checkout Code
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v4
|
||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
lfs: true
|
lfs: true
|
||||||
|
ref: 'v2-dev'
|
||||||
|
|
||||||
- name: publish_to_github
|
- name: publish_to_github
|
||||||
id: publish_to_github
|
id: publish_to_github
|
||||||
run: |
|
run: |
|
||||||
export GITHUB_TOKEN=${{ secrets.GH_TOKEN }}
|
export GITHUB_TOKEN=${{ secrets.GH_TOKEN }}
|
||||||
rm -rf ./pnpm*.yaml
|
rm -rf ./pnpm*.yaml
|
||||||
npm install -g pnpm
|
npm install -g pnpm@10.33.4
|
||||||
pnpm install
|
pnpm install
|
||||||
npm run publish_to_github
|
npm run publish_to_github
|
||||||
working-directory: ./
|
working-directory: ./
|
||||||
|
|
||||||
@@ -3,7 +3,8 @@ on:
|
|||||||
push:
|
push:
|
||||||
branches: ['v2-dev']
|
branches: ['v2-dev']
|
||||||
paths:
|
paths:
|
||||||
- "trigger/release.trigger"
|
- 'trigger/release.trigger'
|
||||||
|
workflow_dispatch: # 添加手动触发
|
||||||
# workflow_run:
|
# workflow_run:
|
||||||
# workflows: [ "deploy-demo" ]
|
# workflows: [ "deploy-demo" ]
|
||||||
# types:
|
# types:
|
||||||
@@ -25,6 +26,7 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
lfs: true
|
lfs: true
|
||||||
|
ref: 'v2-dev'
|
||||||
|
|
||||||
- name: get_certd_version
|
- name: get_certd_version
|
||||||
id: get_certd_version
|
id: get_certd_version
|
||||||
@@ -41,14 +43,14 @@ jobs:
|
|||||||
const pkg = JSON.parse(jsonContent)
|
const pkg = JSON.parse(jsonContent)
|
||||||
console.log("certd_version:",pkg.version);
|
console.log("certd_version:",pkg.version);
|
||||||
return pkg.version
|
return pkg.version
|
||||||
# - name: Use Node.js
|
# - name: Use Node.js
|
||||||
# uses: actions/setup-node@v4
|
# uses: actions/setup-node@v4
|
||||||
# with:
|
# with:
|
||||||
# node-version: 18
|
# node-version: 18
|
||||||
# cache: 'npm'
|
# cache: 'npm'
|
||||||
# working-directory: ./packages/ui/certd-client
|
# working-directory: ./packages/ui/certd-client
|
||||||
- run: |
|
- run: |
|
||||||
npm install -g pnpm
|
npm install -g pnpm@10.33.4
|
||||||
pnpm install
|
pnpm install
|
||||||
npm run build
|
npm run build
|
||||||
working-directory: ./packages/ui/certd-client
|
working-directory: ./packages/ui/certd-client
|
||||||
@@ -106,19 +108,19 @@ jobs:
|
|||||||
ghcr.io/${{ github.repository }}:armv7
|
ghcr.io/${{ github.repository }}:armv7
|
||||||
ghcr.io/${{ github.repository }}:${{steps.get_certd_version.outputs.result}}-armv7
|
ghcr.io/${{ github.repository }}:${{steps.get_certd_version.outputs.result}}-armv7
|
||||||
|
|
||||||
# - name: Build agent
|
# - name: Build agent
|
||||||
# uses: docker/build-push-action@v6
|
# uses: docker/build-push-action@v6
|
||||||
# with:
|
# with:
|
||||||
# platforms: linux/amd64,linux/arm64
|
# platforms: linux/amd64,linux/arm64
|
||||||
# push: true
|
# push: true
|
||||||
# context: ./packages/ui/agent/
|
# context: ./packages/ui/agent/
|
||||||
# tags: |
|
# tags: |
|
||||||
# registry.cn-shenzhen.aliyuncs.com/handsfree/certd-agent:latest
|
# registry.cn-shenzhen.aliyuncs.com/handsfree/certd-agent:latest
|
||||||
# registry.cn-shenzhen.aliyuncs.com/handsfree/certd-agent:${{steps.get_certd_version.outputs.result}}
|
# registry.cn-shenzhen.aliyuncs.com/handsfree/certd-agent:${{steps.get_certd_version.outputs.result}}
|
||||||
# greper/certd-agent:latest
|
# greper/certd-agent:latest
|
||||||
# greper/certd-agent:${{steps.get_certd_version.outputs.result}}
|
# greper/certd-agent:${{steps.get_certd_version.outputs.result}}
|
||||||
- name: deploy-certd-doc
|
- name: deploy-certd-doc
|
||||||
uses: tyrrrz/action-http-request@master
|
uses: tyrrrz/action-http-request@prime
|
||||||
with:
|
with:
|
||||||
url: ${{ secrets.WEBHOOK_CERTD_DOC }}
|
url: ${{ secrets.WEBHOOK_CERTD_DOC }}
|
||||||
method: POST
|
method: POST
|
||||||
@@ -130,4 +132,3 @@ jobs:
|
|||||||
Content-Type: application/json
|
Content-Type: application/json
|
||||||
retry-count: 3
|
retry-count: 3
|
||||||
retry-delay: 5000
|
retry-delay: 5000
|
||||||
|
|
||||||
@@ -12,23 +12,23 @@ jobs:
|
|||||||
sync:
|
sync:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout work repo # 1. 检出当前仓库(certd-sync-work)
|
- name: Checkout work repo # 1. 检出当前仓库(certd-sync-work)
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v4
|
||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
lfs: true
|
lfs: true
|
||||||
- name: Set git user # 2. 给git命令设置用户名和邮箱,↙↙↙ 改成你的name和email
|
ref: v2-dev
|
||||||
|
- name: Set git user # 2. 给git命令设置用户名和邮箱,↙↙↙ 改成你的name和email
|
||||||
run: |
|
run: |
|
||||||
git config --global user.name "xiaojunnuo"
|
git config --global user.name "xiaojunnuo"
|
||||||
git config --global user.email "xiaojunnuo@qq.com"
|
git config --global user.email "xiaojunnuo@qq.com"
|
||||||
|
|
||||||
- name: Set git token # 3. 给git命令设置token,用于push到目标仓库
|
- name: Set git token # 3. 给git命令设置token,用于push到目标仓库
|
||||||
uses: de-vri-es/setup-git-credentials@v2
|
uses: de-vri-es/setup-git-credentials@v2
|
||||||
with: # token 格式为: username:password
|
with: # token 格式为: username:password
|
||||||
credentials: https://greper:${{secrets.ATOMGIT_TOKEN}}@atomgit.com
|
credentials: https://greper:${{secrets.ATOMGIT_TOKEN}}@atomgit.com
|
||||||
|
|
||||||
- name: push to atomgit # 4. 执行同步
|
- name: push to atomgit # 4. 执行同步
|
||||||
run: |
|
run: |
|
||||||
git remote add upstream https://atomgit.com/certd/certd
|
git remote add upstream https://atomgit.com/certd/certd
|
||||||
git push --set-upstream upstream v2-dev
|
git push --set-upstream upstream v2-dev
|
||||||
|
|
||||||
|
|||||||
@@ -12,23 +12,23 @@ jobs:
|
|||||||
sync:
|
sync:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout work repo # 1. 检出当前仓库(certd-sync-work)
|
- name: Checkout work repo # 1. 检出当前仓库(certd-sync-work)
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v4
|
||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
lfs: true
|
lfs: true
|
||||||
- name: Set git user # 2. 给git命令设置用户名和邮箱,↙↙↙ 改成你的name和email
|
ref: v2
|
||||||
|
- name: Set git user # 2. 给git命令设置用户名和邮箱,↙↙↙ 改成你的name和email
|
||||||
run: |
|
run: |
|
||||||
git config --global user.name "xiaojunnuo"
|
git config --global user.name "xiaojunnuo"
|
||||||
git config --global user.email "xiaojunnuo@qq.com"
|
git config --global user.email "xiaojunnuo@qq.com"
|
||||||
|
|
||||||
- name: Set git token # 3. 给git命令设置token,用于push到目标仓库
|
- name: Set git token # 3. 给git命令设置token,用于push到目标仓库
|
||||||
uses: de-vri-es/setup-git-credentials@v2
|
uses: de-vri-es/setup-git-credentials@v2
|
||||||
with: # token 格式为: username:password
|
with: # token 格式为: username:password
|
||||||
credentials: https://greper:${{secrets.ATOMGIT_TOKEN}}@atomgit.com
|
credentials: https://greper:${{secrets.ATOMGIT_TOKEN}}@atomgit.com
|
||||||
|
|
||||||
- name: push to atomgit # 4. 执行同步
|
- name: push to atomgit # 4. 执行同步
|
||||||
run: |
|
run: |
|
||||||
git remote add upstream https://atomgit.com/certd/certd
|
git remote add upstream https://atomgit.com/certd/certd
|
||||||
git push --set-upstream upstream v2
|
git push --set-upstream upstream v2
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,34 @@
|
|||||||
|
name: sync-to-cnb-dev
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches: ['v2-dev']
|
||||||
|
# schedule:
|
||||||
|
# - # 国际时间 19:17 执行,北京时间3:17 ↙↙↙ 改成你想要每天自动执行的时间
|
||||||
|
# - cron: '17 19 * * *'
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
sync:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Checkout work repo # 1. 检出当前仓库(certd-sync-work)
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
with:
|
||||||
|
fetch-depth: 0
|
||||||
|
lfs: true
|
||||||
|
ref: v2-dev
|
||||||
|
- name: Set git user # 2. 给git命令设置用户名和邮箱,↙↙↙ 改成你的name和email
|
||||||
|
run: |
|
||||||
|
git config --global user.name "xiaojunnuo"
|
||||||
|
git config --global user.email "xiaojunnuo@qq.com"
|
||||||
|
|
||||||
|
- name: Set git token # 3. 给git命令设置token,用于push到目标仓库
|
||||||
|
uses: de-vri-es/setup-git-credentials@v2
|
||||||
|
with: # token 格式为: username:password
|
||||||
|
credentials: https://cnb:${{secrets.CNB_TOKEN}}@cnb.cool
|
||||||
|
|
||||||
|
- name: push to cnb # 4. 执行同步
|
||||||
|
run: |
|
||||||
|
git remote add upstream https://cnb.cool/certd/certd.git
|
||||||
|
git push --set-upstream upstream v2-dev
|
||||||
@@ -0,0 +1,33 @@
|
|||||||
|
name: sync-to-cnb
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches: ['v2']
|
||||||
|
# schedule:
|
||||||
|
# - # 国际时间 19:17 执行,北京时间3:17 ↙↙↙ 改成你想要每天自动执行的时间
|
||||||
|
# - cron: '17 19 * * *'
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
sync:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Checkout work repo # 1. 检出当前仓库(certd-sync-work)
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
with:
|
||||||
|
fetch-depth: 0
|
||||||
|
lfs: true
|
||||||
|
- name: Set git user # 2. 给git命令设置用户名和邮箱,↙↙↙ 改成你的name和email
|
||||||
|
run: |
|
||||||
|
git config --global user.name "xiaojunnuo"
|
||||||
|
git config --global user.email "xiaojunnuo@qq.com"
|
||||||
|
|
||||||
|
- name: Set git token # 3. 给git命令设置token,用于push到目标仓库
|
||||||
|
uses: de-vri-es/setup-git-credentials@v2
|
||||||
|
with: # token 格式为: username:password
|
||||||
|
credentials: https://cnb:${{secrets.CNB_TOKEN}}@cnb.cool
|
||||||
|
|
||||||
|
- name: push to cnb # 4. 执行同步
|
||||||
|
run: |
|
||||||
|
git remote add upstream https://cnb.cool/certd/certd.git
|
||||||
|
git push --set-upstream upstream v2
|
||||||
@@ -12,23 +12,23 @@ jobs:
|
|||||||
sync:
|
sync:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout work repo # 1. 检出当前仓库(certd-sync-work)
|
- name: Checkout work repo # 1. 检出当前仓库(certd-sync-work)
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v4
|
||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
lfs: true
|
lfs: true
|
||||||
- name: Set git user # 2. 给git命令设置用户名和邮箱,↙↙↙ 改成你的name和email
|
ref: v2-dev
|
||||||
|
- name: Set git user # 2. 给git命令设置用户名和邮箱,↙↙↙ 改成你的name和email
|
||||||
run: |
|
run: |
|
||||||
git config --global user.name "xiaojunnuo"
|
git config --global user.name "xiaojunnuo"
|
||||||
git config --global user.email "xiaojunnuo@qq.com"
|
git config --global user.email "xiaojunnuo@qq.com"
|
||||||
|
|
||||||
- name: Set git token # 3. 给git命令设置token,用于push到目标仓库
|
- name: Set git token # 3. 给git命令设置token,用于push到目标仓库
|
||||||
uses: de-vri-es/setup-git-credentials@v2
|
uses: de-vri-es/setup-git-credentials@v2
|
||||||
with: # token 格式为: username:password
|
with: # token 格式为: username:password
|
||||||
credentials: https://${{secrets.PUSH_TOKEN_GITEE}}@gitee.com
|
credentials: https://${{secrets.PUSH_TOKEN_GITEE}}@gitee.com
|
||||||
|
|
||||||
- name: push to gitee # 4. 执行同步
|
- name: push to gitee # 4. 执行同步
|
||||||
run: |
|
run: |
|
||||||
git remote add upstream https://gitee.com/certd/certd
|
git remote add upstream https://gitee.com/certd/certd
|
||||||
git push --set-upstream upstream v2-dev
|
git push --set-upstream upstream v2-dev
|
||||||
|
|
||||||
|
|||||||
@@ -12,23 +12,22 @@ jobs:
|
|||||||
sync:
|
sync:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout work repo # 1. 检出当前仓库(certd-sync-work)
|
- name: Checkout work repo # 1. 检出当前仓库(certd-sync-work)
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v4
|
||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
lfs: true
|
lfs: true
|
||||||
- name: Set git user # 2. 给git命令设置用户名和邮箱,↙↙↙ 改成你的name和email
|
- name: Set git user # 2. 给git命令设置用户名和邮箱,↙↙↙ 改成你的name和email
|
||||||
run: |
|
run: |
|
||||||
git config --global user.name "xiaojunnuo"
|
git config --global user.name "xiaojunnuo"
|
||||||
git config --global user.email "xiaojunnuo@qq.com"
|
git config --global user.email "xiaojunnuo@qq.com"
|
||||||
|
|
||||||
- name: Set git token # 3. 给git命令设置token,用于push到目标仓库
|
- name: Set git token # 3. 给git命令设置token,用于push到目标仓库
|
||||||
uses: de-vri-es/setup-git-credentials@v2
|
uses: de-vri-es/setup-git-credentials@v2
|
||||||
with: # token 格式为: username:password
|
with: # token 格式为: username:password
|
||||||
credentials: https://${{secrets.PUSH_TOKEN_GITEE}}@gitee.com
|
credentials: https://${{secrets.PUSH_TOKEN_GITEE}}@gitee.com
|
||||||
|
|
||||||
- name: push to gitee # 4. 执行同步
|
- name: push to gitee # 4. 执行同步
|
||||||
run: |
|
run: |
|
||||||
git remote add upstream https://gitee.com/certd/certd
|
git remote add upstream https://gitee.com/certd/certd
|
||||||
git push --set-upstream upstream v2
|
git push --set-upstream upstream v2
|
||||||
|
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
./packages/core/lego
|
./packages/core/lego
|
||||||
# IntelliJ project files
|
# IntelliJ project files
|
||||||
node_modules/
|
node_modules/
|
||||||
npm-debug.log
|
npm-debug.log
|
||||||
@@ -32,3 +32,10 @@ test/**/*.js
|
|||||||
test.js
|
test.js
|
||||||
.history
|
.history
|
||||||
/logs
|
/logs
|
||||||
|
.pnpm-lock.yaml
|
||||||
|
pnpm-lock.yaml
|
||||||
|
.studio/
|
||||||
|
|
||||||
|
# Certd 推广报告,仅本地使用
|
||||||
|
/popularize/
|
||||||
|
|
||||||
|
|||||||
@@ -1,163 +1,68 @@
|
|||||||
|
---
|
||||||
|
name: access-plugin-dev
|
||||||
|
description: 用于开发 Certd 系统中的 Access 插件,存储用户第三方应用授权数据并对接实现第三方 API 接口。当用户需要创建授权插件、实现第三方API接口、添加新的授权方式或修改现有 Access 插件时触发。
|
||||||
|
version: 1.0.0
|
||||||
|
---
|
||||||
|
|
||||||
# Access 插件开发技能
|
# Access 插件开发技能
|
||||||
|
|
||||||
## 什么是 Access 插件
|
## 角色定义
|
||||||
|
|
||||||
Access 插件是 Certd 系统中用于存储用户第三方应用授权数据的插件,例如用户名密码、accessSecret 或 accessToken 等。同时,它还负责对接实现第三方的 API 接口,供其他插件调用使用。
|
你是一名 Certd 插件开发专家,擅长创建和实现 Access 类型的插件,熟悉 TypeScript 编程和 Certd 插件开发规范。
|
||||||
|
|
||||||
## 开发步骤
|
## 核心指令
|
||||||
|
|
||||||
### 1. 导入必要的依赖
|
请严格按照以下步骤执行任务:
|
||||||
|
|
||||||
```typescript
|
1. **导入必要的依赖**
|
||||||
import { AccessInput, BaseAccess, IsAccess, Pager, PageRes, PageSearch } from '@certd/pipeline';
|
|
||||||
import { DomainRecord } from '@certd/plugin-lib';
|
|
||||||
```
|
|
||||||
|
|
||||||
### 2. 使用 @IsAccess 注解注册插件
|
- 导入 `AccessInput`, `BaseAccess`, `IsAccess`, `Pager`, `PageRes`, `PageSearch` 等必要的类型和装饰器
|
||||||
|
- 导入 `DomainRecord` 等相关类型
|
||||||
|
|
||||||
```typescript
|
2. **使用 @IsAccess 注解注册插件**
|
||||||
@IsAccess({
|
|
||||||
name: 'demo', // 插件唯一标识
|
|
||||||
title: '授权插件示例', // 插件标题
|
|
||||||
icon: 'clarity:plugin-line', // 插件图标
|
|
||||||
desc: '这是一个示例授权插件,用于演示如何实现一个授权插件', // 插件描述
|
|
||||||
})
|
|
||||||
export class DemoAccess extends BaseAccess {
|
|
||||||
// 插件实现...
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### 3. 定义授权属性
|
- 配置插件的唯一标识、标题、图标和描述
|
||||||
|
- 继承 `BaseAccess` 类
|
||||||
|
|
||||||
使用 `@AccessInput` 注解定义授权属性:
|
3. **定义授权属性**
|
||||||
|
|
||||||
```typescript
|
- 使用 `@AccessInput` 注解定义授权属性
|
||||||
@AccessInput({
|
- 配置属性的标题、默认值、组件类型和验证规则
|
||||||
title: '授权方式',
|
- 对于敏感信息,设置 `encrypt: true` 进行加密
|
||||||
value: 'apiKey', // 默认值
|
|
||||||
component: {
|
|
||||||
name: "a-select", // 基于 antdv 的输入组件
|
|
||||||
vModel: "value", // v-model 绑定的属性名
|
|
||||||
options: [ // 组件参数
|
|
||||||
{ label: "API密钥(推荐)", value: "apiKey" },
|
|
||||||
{ label: "账号密码", value: "account" },
|
|
||||||
],
|
|
||||||
placeholder: 'demoKeyId',
|
|
||||||
},
|
|
||||||
required: true,
|
|
||||||
})
|
|
||||||
apiType = '';
|
|
||||||
|
|
||||||
@AccessInput({
|
4. **实现测试方法**
|
||||||
title: '密钥Id',
|
|
||||||
component: {
|
|
||||||
name:"a-input",
|
|
||||||
allowClear: true,
|
|
||||||
placeholder: 'demoKeyId',
|
|
||||||
},
|
|
||||||
required: true,
|
|
||||||
})
|
|
||||||
demoKeyId = '';
|
|
||||||
|
|
||||||
@AccessInput({
|
- 添加测试按钮配置
|
||||||
title: '密钥',//标题
|
- 实现 `onTestRequest` 方法,用于测试接口调用是否正常
|
||||||
required: true, //text组件可以省略
|
|
||||||
encrypt: true, //该属性是否需要加密
|
|
||||||
})
|
|
||||||
demoKeySecret = '';
|
|
||||||
```
|
|
||||||
|
|
||||||
### 4. 实现测试方法
|
5. **实现 API 方法**
|
||||||
|
|
||||||
```typescript
|
- 实现必要的 API 方法,如 `GetDomainList`
|
||||||
@AccessInput({
|
- 封装统一的 API 请求方法 `doRequest`,处理错误和日志
|
||||||
title: "测试",
|
|
||||||
component: {
|
|
||||||
name: "api-test",
|
|
||||||
action: "TestRequest"
|
|
||||||
},
|
|
||||||
helper: "点击测试接口是否正常"
|
|
||||||
})
|
|
||||||
testRequest = true;
|
|
||||||
|
|
||||||
/**
|
6. **遵循开发最佳实践**
|
||||||
* 会通过上面的testRequest参数在ui界面上生成测试按钮,供用户测试接口调用是否正常
|
- 使用 `this.ctx.logger` 输出日志
|
||||||
*/
|
- 统一处理错误,抛出明确的错误信息
|
||||||
async onTestRequest() {
|
- 实现代码复用,避免重复逻辑
|
||||||
await this.GetDomainList({});
|
|
||||||
return "ok"
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### 5. 实现 API 方法
|
## 输出规范
|
||||||
|
|
||||||
```typescript
|
- 必须包含完整的插件实现代码,包括所有必要的导入语句
|
||||||
/**
|
- 代码必须包含详细的注释说明,解释每个步骤的目的和实现细节
|
||||||
* 获api接口示例 取域名列表,
|
- 提供完整的示例代码,展示插件的使用方法,包括不同类型的授权方式
|
||||||
*/
|
- 代码块必须使用正确的语法高亮,确保代码可读性
|
||||||
async GetDomainList(req: PageSearch): Promise<PageRes<DomainRecord>> {
|
- 包含开发技巧和注意事项,帮助开发者避免常见错误
|
||||||
//输出日志必须使用ctx.logger
|
- 输出内容必须结构清晰,使用适当的标题和列表格式
|
||||||
this.ctx.logger.info(`获取域名列表,req:${JSON.stringify(req)}`);
|
|
||||||
const pager = new Pager(req);
|
|
||||||
const resp = await this.doRequest({
|
|
||||||
action: "ListDomains",
|
|
||||||
data: {
|
|
||||||
domain: req.searchKey,
|
|
||||||
offset: pager.getOffset(),
|
|
||||||
limit: pager.pageSize,
|
|
||||||
}
|
|
||||||
});
|
|
||||||
const total = resp?.TotalCount || 0;
|
|
||||||
let list = resp?.DomainList?.map((item) => {
|
|
||||||
item.domain = item.Domain;
|
|
||||||
item.id = item.DomainId;
|
|
||||||
return item;
|
|
||||||
})
|
|
||||||
return {
|
|
||||||
total,
|
|
||||||
list
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
## 示例
|
||||||
* 通用api调用方法, 具体如何构造请求体,需参考对应应用的API文档
|
|
||||||
*/
|
|
||||||
async doRequest(req: { action: string, data?: any }) {
|
|
||||||
/**
|
|
||||||
this.ctx中包含很多有用的工具类
|
|
||||||
type AccessContext = {
|
|
||||||
http: HttpClient;
|
|
||||||
logger: ILogger;
|
|
||||||
utils: typeof utils;
|
|
||||||
accessService: IAccessService;
|
|
||||||
}
|
|
||||||
*/
|
|
||||||
const res = await this.ctx.http.request({
|
|
||||||
url: "https://api.demo.cn/api/",
|
|
||||||
method: "POST",
|
|
||||||
data: {
|
|
||||||
Action: req.action,
|
|
||||||
Body: req.data
|
|
||||||
}
|
|
||||||
});
|
|
||||||
|
|
||||||
if (res.Code !== 0) {
|
### 示例 1: 基本 Access 插件
|
||||||
//异常处理
|
|
||||||
throw new Error(res.Message || "请求失败");
|
|
||||||
}
|
|
||||||
return res.Resp;
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## 注意事项
|
#### 用户输入
|
||||||
|
|
||||||
1. **插件命名**:插件名称应简洁明了,反映其功能。
|
创建一个 Access 插件,用于存储第三方应用的授权信息并提供 API 接口。
|
||||||
2. **属性加密**:对于敏感信息(如密钥),应设置 `encrypt: true`。
|
|
||||||
3. **日志输出**:必须使用 `this.ctx.logger` 输出日志,而不是 `console`。
|
|
||||||
4. **错误处理**:API 调用失败时应抛出明确的错误信息。
|
|
||||||
5. **测试方法**:实现 `onTestRequest` 方法,以便用户可以测试授权是否正常。
|
|
||||||
|
|
||||||
## 完整示例
|
#### 你的回答
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { AccessInput, BaseAccess, IsAccess, Pager, PageRes, PageSearch } from '@certd/pipeline';
|
import { AccessInput, BaseAccess, IsAccess, Pager, PageRes, PageSearch } from '@certd/pipeline';
|
||||||
@@ -174,24 +79,24 @@ import { DomainRecord } from '@certd/plugin-lib';
|
|||||||
desc: '这是一个示例授权插件,用于演示如何实现一个授权插件',
|
desc: '这是一个示例授权插件,用于演示如何实现一个授权插件',
|
||||||
})
|
})
|
||||||
export class DemoAccess extends BaseAccess {
|
export class DemoAccess extends BaseAccess {
|
||||||
|
/**
|
||||||
/**
|
|
||||||
* 授权属性配置
|
* 授权属性配置
|
||||||
*/
|
*/
|
||||||
@AccessInput({
|
@AccessInput({
|
||||||
title: '授权方式',
|
title: '授权方式',
|
||||||
value: 'apiKey', //默认值
|
value: 'apiKey', //默认值
|
||||||
component: {
|
component: {
|
||||||
name: "a-select", //基于antdv的输入组件
|
name: 'a-select', //基于antdv的输入组件
|
||||||
vModel: "value", // v-model绑定的属性名
|
vModel: 'value', // v-model绑定的属性名
|
||||||
options: [ //组件参数
|
options: [
|
||||||
|
//组件参数
|
||||||
{
|
{
|
||||||
label: "API密钥(推荐)",
|
label: 'API密钥(推荐)',
|
||||||
value: "apiKey"
|
value: 'apiKey',
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
label: "账号密码",
|
label: '账号密码',
|
||||||
value: "account"
|
value: 'account',
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
placeholder: 'demoKeyId',
|
placeholder: 'demoKeyId',
|
||||||
@@ -206,7 +111,7 @@ export class DemoAccess extends BaseAccess {
|
|||||||
@AccessInput({
|
@AccessInput({
|
||||||
title: '密钥Id',
|
title: '密钥Id',
|
||||||
component: {
|
component: {
|
||||||
name:"a-input",
|
name: 'a-input',
|
||||||
allowClear: true,
|
allowClear: true,
|
||||||
placeholder: 'demoKeyId',
|
placeholder: 'demoKeyId',
|
||||||
},
|
},
|
||||||
@@ -215,20 +120,19 @@ export class DemoAccess extends BaseAccess {
|
|||||||
demoKeyId = '';
|
demoKeyId = '';
|
||||||
|
|
||||||
@AccessInput({
|
@AccessInput({
|
||||||
title: '密钥',//标题
|
title: '密钥', //标题
|
||||||
required: true, //text组件可以省略
|
required: true, //text组件可以省略
|
||||||
encrypt: true, //该属性是否需要加密
|
encrypt: true, //该属性是否需要加密
|
||||||
})
|
})
|
||||||
demoKeySecret = '';
|
demoKeySecret = '';
|
||||||
|
|
||||||
|
|
||||||
@AccessInput({
|
@AccessInput({
|
||||||
title: "测试",
|
title: '测试',
|
||||||
component: {
|
component: {
|
||||||
name: "api-test",
|
name: 'api-test',
|
||||||
action: "TestRequest"
|
action: 'TestRequest',
|
||||||
},
|
},
|
||||||
helper: "点击测试接口是否正常"
|
helper: '点击测试接口是否正常',
|
||||||
})
|
})
|
||||||
testRequest = true;
|
testRequest = true;
|
||||||
|
|
||||||
@@ -237,65 +141,278 @@ export class DemoAccess extends BaseAccess {
|
|||||||
*/
|
*/
|
||||||
async onTestRequest() {
|
async onTestRequest() {
|
||||||
await this.GetDomainList({});
|
await this.GetDomainList({});
|
||||||
return "ok"
|
return 'ok';
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 获api接口示例 取域名列表,
|
* api接口示例 获取域名列表
|
||||||
*/
|
*/
|
||||||
async GetDomainList(req: PageSearch): Promise<PageRes<DomainRecord>> {
|
async GetDomainList(req: PageSearch): Promise<PageRes<DomainRecord>> {
|
||||||
//输出日志必须使用ctx.logger
|
//输出日志必须使用ctx.logger
|
||||||
this.ctx.logger.info(`获取域名列表,req:${JSON.stringify(req)}`);
|
this.ctx.logger.info(`获取域名列表,req:${JSON.stringify(req)}`);
|
||||||
const pager = new Pager(req);
|
const pager = new Pager(req);
|
||||||
const resp = await this.doRequest({
|
const resp = await this.doRequest({
|
||||||
action: "ListDomains",
|
action: 'ListDomains',
|
||||||
data: {
|
data: {
|
||||||
domain: req.searchKey,
|
domain: req.searchKey,
|
||||||
offset: pager.getOffset(),
|
offset: pager.getOffset(),
|
||||||
limit: pager.pageSize,
|
limit: pager.pageSize,
|
||||||
}
|
},
|
||||||
});
|
});
|
||||||
const total = resp?.TotalCount || 0;
|
const total = resp?.TotalCount || 0;
|
||||||
let list = resp?.DomainList?.map((item) => {
|
let list = resp?.DomainList?.map(item => {
|
||||||
item.domain = item.Domain;
|
item.domain = item.Domain;
|
||||||
item.id = item.DomainId;
|
item.id = item.DomainId;
|
||||||
return item;
|
return item;
|
||||||
})
|
});
|
||||||
return {
|
return {
|
||||||
total,
|
total,
|
||||||
list
|
list,
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
// 还可以继续编写API
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 通用api调用方法, 具体如何构造请求体,需参考对应应用的API文档
|
* 通用api调用方法, 具体如何构造请求体,需参考对应应用的API文档
|
||||||
*/
|
*/
|
||||||
async doRequest(req: { action: string, data?: any }) {
|
async doRequest(req: { action: string; data?: any }) {
|
||||||
/**
|
|
||||||
this.ctx中包含很多有用的工具类
|
|
||||||
type AccessContext = {
|
|
||||||
http: HttpClient;
|
|
||||||
logger: ILogger;
|
|
||||||
utils: typeof utils;
|
|
||||||
accessService: IAccessService;
|
|
||||||
}
|
|
||||||
*/
|
|
||||||
const res = await this.ctx.http.request({
|
const res = await this.ctx.http.request({
|
||||||
url: "https://api.demo.cn/api/",
|
url: 'https://api.demo.cn/api/',
|
||||||
method: "POST",
|
method: 'POST',
|
||||||
data: {
|
data: {
|
||||||
Action: req.action,
|
Action: req.action,
|
||||||
Body: req.data
|
Body: req.data,
|
||||||
}
|
},
|
||||||
});
|
});
|
||||||
|
|
||||||
if (res.Code !== 0) {
|
if (res.Code !== 0) {
|
||||||
//异常处理
|
//异常处理
|
||||||
throw new Error(res.Message || "请求失败");
|
throw new Error(res.Message || '请求失败');
|
||||||
}
|
}
|
||||||
return res.Resp;
|
return res.Resp;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### 示例 2: 支持 OAuth 授权的 Access 插件
|
||||||
|
|
||||||
|
#### 用户输入
|
||||||
|
|
||||||
|
创建一个支持 OAuth 授权方式的 Access 插件。
|
||||||
|
|
||||||
|
#### 你的回答
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { AccessInput, BaseAccess, IsAccess, Pager, PageRes, PageSearch } from '@certd/pipeline';
|
||||||
|
import { DomainRecord } from '@certd/plugin-lib';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* OAuth 授权插件示例
|
||||||
|
*/
|
||||||
|
@IsAccess({
|
||||||
|
name: 'oauth-demo',
|
||||||
|
title: 'OAuth授权插件示例',
|
||||||
|
icon: 'clarity:plugin-line',
|
||||||
|
desc: '这是一个支持OAuth授权的插件示例',
|
||||||
|
})
|
||||||
|
export class OAuthDemoAccess extends BaseAccess {
|
||||||
|
@AccessInput({
|
||||||
|
title: '授权方式',
|
||||||
|
value: 'oauth',
|
||||||
|
component: {
|
||||||
|
name: 'a-select',
|
||||||
|
vModel: 'value',
|
||||||
|
options: [
|
||||||
|
{
|
||||||
|
label: 'OAuth授权',
|
||||||
|
value: 'oauth',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
label: 'API密钥',
|
||||||
|
value: 'apiKey',
|
||||||
|
},
|
||||||
|
],
|
||||||
|
},
|
||||||
|
required: true,
|
||||||
|
})
|
||||||
|
authType = '';
|
||||||
|
|
||||||
|
@AccessInput({
|
||||||
|
title: '客户端ID',
|
||||||
|
component: {
|
||||||
|
name: 'a-input',
|
||||||
|
placeholder: 'Client ID',
|
||||||
|
},
|
||||||
|
required: true,
|
||||||
|
})
|
||||||
|
clientId = '';
|
||||||
|
|
||||||
|
@AccessInput({
|
||||||
|
title: '客户端密钥',
|
||||||
|
required: true,
|
||||||
|
encrypt: true,
|
||||||
|
})
|
||||||
|
clientSecret = '';
|
||||||
|
|
||||||
|
@AccessInput({
|
||||||
|
title: '授权回调地址',
|
||||||
|
component: {
|
||||||
|
name: 'a-input',
|
||||||
|
placeholder: 'https://your-domain.com/callback',
|
||||||
|
},
|
||||||
|
required: true,
|
||||||
|
})
|
||||||
|
redirectUri = '';
|
||||||
|
|
||||||
|
@AccessInput({
|
||||||
|
title: 'AccessToken',
|
||||||
|
required: true,
|
||||||
|
encrypt: true,
|
||||||
|
})
|
||||||
|
accessToken = '';
|
||||||
|
|
||||||
|
@AccessInput({
|
||||||
|
title: 'RefreshToken',
|
||||||
|
encrypt: true,
|
||||||
|
})
|
||||||
|
refreshToken = '';
|
||||||
|
|
||||||
|
@AccessInput({
|
||||||
|
title: '测试',
|
||||||
|
component: {
|
||||||
|
name: 'api-test',
|
||||||
|
action: 'TestOAuth',
|
||||||
|
},
|
||||||
|
helper: '点击测试OAuth授权是否正常',
|
||||||
|
})
|
||||||
|
testOAuth = true;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 测试OAuth授权
|
||||||
|
*/
|
||||||
|
async onTestOAuth() {
|
||||||
|
try {
|
||||||
|
// 测试AccessToken是否有效
|
||||||
|
const result = await this.doOAuthRequest('GET', '/api/user/profile');
|
||||||
|
this.ctx.logger.info('OAuth测试成功:', result);
|
||||||
|
return 'OAuth授权测试成功';
|
||||||
|
} catch (error) {
|
||||||
|
this.ctx.logger.error('OAuth测试失败:', error);
|
||||||
|
throw new Error('OAuth授权测试失败');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* OAuth API请求方法
|
||||||
|
*/
|
||||||
|
async doOAuthRequest(method: string, endpoint: string, data?: any) {
|
||||||
|
const res = await this.ctx.http.request({
|
||||||
|
url: `https://api.oauth-demo.com${endpoint}`,
|
||||||
|
method,
|
||||||
|
headers: {
|
||||||
|
Authorization: `Bearer ${this.accessToken}`,
|
||||||
|
'Content-Type': 'application/json',
|
||||||
|
},
|
||||||
|
data,
|
||||||
|
});
|
||||||
|
|
||||||
|
if (res.status !== 200) {
|
||||||
|
throw new Error(`API请求失败: ${res.status} ${res.statusText}`);
|
||||||
|
}
|
||||||
|
return res.data;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 刷新AccessToken
|
||||||
|
*/
|
||||||
|
async refreshAccessToken() {
|
||||||
|
if (!this.refreshToken) {
|
||||||
|
throw new Error('没有提供RefreshToken');
|
||||||
|
}
|
||||||
|
|
||||||
|
const res = await this.ctx.http.request({
|
||||||
|
url: 'https://api.oauth-demo.com/oauth/token',
|
||||||
|
method: 'POST',
|
||||||
|
data: {
|
||||||
|
grant_type: 'refresh_token',
|
||||||
|
refresh_token: this.refreshToken,
|
||||||
|
client_id: this.clientId,
|
||||||
|
client_secret: this.clientSecret,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
if (res.status === 200 && res.data.access_token) {
|
||||||
|
this.accessToken = res.data.access_token;
|
||||||
|
if (res.data.refresh_token) {
|
||||||
|
this.refreshToken = res.data.refresh_token;
|
||||||
|
}
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
throw new Error('刷新AccessToken失败');
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 获取域名列表
|
||||||
|
*/
|
||||||
|
async GetDomainList(req: PageSearch): Promise<PageRes<DomainRecord>> {
|
||||||
|
try {
|
||||||
|
const res = await this.doOAuthRequest('GET', '/api/domains', {
|
||||||
|
search: req.searchKey,
|
||||||
|
page: req.page,
|
||||||
|
pageSize: req.pageSize,
|
||||||
|
});
|
||||||
|
|
||||||
|
return {
|
||||||
|
total: res.total,
|
||||||
|
list: res.items.map((item: any) => ({
|
||||||
|
id: item.id,
|
||||||
|
domain: item.domain,
|
||||||
|
})),
|
||||||
|
};
|
||||||
|
} catch (error) {
|
||||||
|
// 尝试刷新AccessToken并重试
|
||||||
|
if (error.message.includes('401')) {
|
||||||
|
await this.refreshAccessToken();
|
||||||
|
const res = await this.doOAuthRequest('GET', '/api/domains', {
|
||||||
|
search: req.searchKey,
|
||||||
|
page: req.page,
|
||||||
|
pageSize: req.pageSize,
|
||||||
|
});
|
||||||
|
|
||||||
|
return {
|
||||||
|
total: res.total,
|
||||||
|
list: res.items.map((item: any) => ({
|
||||||
|
id: item.id,
|
||||||
|
domain: item.domain,
|
||||||
|
})),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
throw error;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## 注意事项
|
||||||
|
|
||||||
|
1. **插件命名**:插件名称应简洁明了,反映其功能。
|
||||||
|
2. **属性加密**:对于敏感信息(如密钥),应设置 `encrypt: true`。
|
||||||
|
3. **日志输出**:必须使用 `this.ctx.logger` 输出日志,而不是 `console`,参数文本化,不要传对象,否则会输出`[object Object]}`。
|
||||||
|
4. **错误处理**:API 调用失败时应抛出明确的错误信息。
|
||||||
|
5. **测试方法**:实现 `onTestRequest` 方法,以便用户可以测试授权是否正常。
|
||||||
|
6. **统一接口调用**:封装统一的 API 请求方法,避免重复编写错误处理逻辑。
|
||||||
|
|
||||||
|
## 开发技巧
|
||||||
|
|
||||||
|
### 实现统一的 API 请求封装
|
||||||
|
|
||||||
|
**好处:**
|
||||||
|
|
||||||
|
- **代码复用**:避免在每个 API 方法中重复编写相同的 header 设置和错误处理逻辑
|
||||||
|
- **错误处理一致**:统一捕获和处理各种错误情况,确保错误信息格式统一
|
||||||
|
- **日志记录完善**:集中记录详细的错误信息,便于调试和问题排查
|
||||||
|
- **接口调用简化**:调用方只需关注业务逻辑,无需关心底层请求细节
|
||||||
|
- **易于维护**:统一修改 API 调用方式时,只需修改一处代码
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
```
|
||||||
|
|||||||
@@ -0,0 +1,13 @@
|
|||||||
|
你是一名资深nodejs工程师,擅长开发Certd开源系统的任务插件。
|
||||||
|
certd是一款全自动证书申请部署管理工具,基于流水线的方式,通过里面申请证书插件申请证书,然后将证书传递给下一个部署任务插件,不同的部署任务插件将证书部署到用户的各个应用系统当中。
|
||||||
|
|
||||||
|
certd插件分成以下几种类型:
|
||||||
|
Access:存储用户的第三放应用的授权数据,比如用户名密码,accessSecret 或 accessToken等。同时它里面的方法还负责对接第三方的api接口
|
||||||
|
Task: 部署任务插件,它继承AbstractTaskPlugin类,被流水线调用execute方法,将证书部署到对应的应用上
|
||||||
|
DnsProvider: DNS提供商插件,它用于在ACME申请证书时给域名添加txt解析记录。
|
||||||
|
|
||||||
|
注意事项:
|
||||||
|
1、使用技能:在开始工作前,请阅读并加载.trae/skills下面的技能,根据skills进行相应的插件开发
|
||||||
|
2、迭代技能:当开发过程用户提醒你更好的做法时,你需要总结经验,更新相应的skills,让skills越来越完善,能够在以后得新插件开发中具备指导意义。
|
||||||
|
3、一般调用的api接口文档会比较复杂,你不知道接口是什么时,请务必询问用户,让用户提供API接口文档
|
||||||
|
4、完成开发后无需测试,通知用户自己去测试
|
||||||
@@ -1,139 +1,93 @@
|
|||||||
|
---
|
||||||
|
name: dns-provider-dev
|
||||||
|
description: 用于开发 Certd 系统中的 DNS Provider 插件,在 ACME 申请证书时给域名添加 TXT 解析记录以验证域名所有权。当用户需要创建DNS提供商插件、实现DNS解析、ACME证书验证或修改现有 DNS Provider 插件时触发。
|
||||||
|
version: 1.0.0
|
||||||
|
---
|
||||||
|
|
||||||
# DNS Provider 插件开发技能
|
# DNS Provider 插件开发技能
|
||||||
|
|
||||||
## 什么是 DNS Provider 插件
|
## 角色定义
|
||||||
|
|
||||||
DNS Provider 插件是 Certd 系统中的 DNS 提供商插件,它用于在 ACME 申请证书时给域名添加 TXT 解析记录,以验证域名所有权。
|
你是一名 Certd 插件开发专家,擅长创建和实现 DNS Provider 类型的插件,熟悉 TypeScript 编程和 Certd 插件开发规范。
|
||||||
|
|
||||||
## 开发步骤
|
## 核心指令
|
||||||
|
|
||||||
### 1. 导入必要的依赖
|
请严格按照以下步骤执行任务:
|
||||||
|
|
||||||
|
1. **导入必要的依赖**
|
||||||
|
|
||||||
|
- 导入 `AbstractDnsProvider`, `CreateRecordOptions`, `IsDnsProvider`, `RemoveRecordOptions` 等必要的类型和装饰器
|
||||||
|
- 导入对应的 Access 插件类型
|
||||||
|
|
||||||
|
2. **定义记录数据结构**
|
||||||
|
|
||||||
|
- 定义适合对应云平台的记录数据结构
|
||||||
|
- 至少包含 id 字段,用于后续删除记录
|
||||||
|
|
||||||
|
3. **使用 @IsDnsProvider 注解注册插件**
|
||||||
|
|
||||||
|
- 配置插件的唯一标识、标题、描述、图标
|
||||||
|
- 指定对应的云平台的 access 类型名称
|
||||||
|
- 设置排序值(可选)
|
||||||
|
- 继承 `AbstractDnsProvider` 类
|
||||||
|
|
||||||
|
4. **实现 onInstance 方法**
|
||||||
|
|
||||||
|
- 获取并保存对应的 Access 实例
|
||||||
|
- 执行初始化操作
|
||||||
|
|
||||||
|
5. **实现 createRecord 方法**
|
||||||
|
|
||||||
|
- 解析传入的参数(fullRecord, value, type, domain)
|
||||||
|
- 记录操作开始日志
|
||||||
|
- 调用云平台 API 创建 TXT 类型的 DNS 解析记录
|
||||||
|
- 处理可能的错误:网络错误、API调用失败、授权失败等
|
||||||
|
- 记录操作结果日志
|
||||||
|
- 返回创建的记录信息,用于后续删除操作
|
||||||
|
|
||||||
|
6. **实现 removeRecord 方法**
|
||||||
|
|
||||||
|
- 解析传入的参数和之前创建的记录信息
|
||||||
|
- 记录操作开始日志
|
||||||
|
- 调用云平台 API 删除 TXT 类型的 DNS 解析记录
|
||||||
|
- 处理可能的错误:网络错误、API调用失败、记录不存在等
|
||||||
|
- 记录操作结果日志
|
||||||
|
|
||||||
|
7. **实现 getDomainListPage 方法**
|
||||||
|
|
||||||
|
- 实现获取域名列表的方法
|
||||||
|
- 支持分页查询
|
||||||
|
- 处理可能的错误:网络错误、API调用失败、授权失败等
|
||||||
|
- 返回标准化的域名列表格式
|
||||||
|
|
||||||
|
8. **实例化插件**
|
||||||
|
- 实例化插件,确保插件被注册
|
||||||
|
|
||||||
|
## 输出规范
|
||||||
|
|
||||||
|
- 必须包含完整的插件实现代码
|
||||||
|
- 代码必须包含详细的注释说明
|
||||||
|
- 提供完整的示例代码,展示插件的使用方法
|
||||||
|
- 包含开发注意事项
|
||||||
|
|
||||||
|
## 示例
|
||||||
|
|
||||||
|
### 示例 1: 基本 DNS Provider 插件
|
||||||
|
|
||||||
|
#### 用户输入
|
||||||
|
|
||||||
|
创建一个 DNS Provider 插件,用于在 ACME 申请证书时添加和删除 TXT 解析记录。
|
||||||
|
|
||||||
|
#### 你的回答
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { AbstractDnsProvider, CreateRecordOptions, IsDnsProvider, RemoveRecordOptions } from '@certd/plugin-cert';
|
import { Pager, PageRes, PageSearch } from '@certd/pipeline';
|
||||||
|
import { AbstractDnsProvider, CreateRecordOptions, IsDnsProvider, RemoveRecordOptions, DomainRecord } from '@certd/plugin-cert';
|
||||||
import { DemoAccess } from './access.js';
|
import { DemoAccess } from './access.js';
|
||||||
import { isDev } from '../../utils/env.js';
|
|
||||||
```
|
|
||||||
|
|
||||||
### 2. 定义记录数据结构
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
type DemoRecord = {
|
|
||||||
// 这里定义 Record 记录的数据结构,跟对应云平台接口返回值一样即可,一般是拿到 id 就行,用于删除 txt 解析记录,清理申请痕迹
|
|
||||||
// id:string
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
### 3. 使用 @IsDnsProvider 注解注册插件
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
// 这里通过 IsDnsProvider 注册一个 dnsProvider
|
|
||||||
@IsDnsProvider({
|
|
||||||
name: 'demo', // 插件唯一标识
|
|
||||||
title: 'Dns提供商Demo', // 插件标题
|
|
||||||
desc: 'dns provider示例', // 插件描述
|
|
||||||
icon: 'clarity:plugin-line', // 插件图标
|
|
||||||
// 这里是对应的云平台的 access 类型名称
|
|
||||||
accessType: 'demo',
|
|
||||||
order: 99, // 排序
|
|
||||||
})
|
|
||||||
export class DemoDnsProvider extends AbstractDnsProvider<DemoRecord> {
|
|
||||||
access!: DemoAccess;
|
|
||||||
|
|
||||||
async onInstance() {
|
|
||||||
this.access = this.ctx.access as DemoAccess;
|
|
||||||
// 也可以通过 ctx 成员变量传递 context
|
|
||||||
this.logger.debug('access', this.access);
|
|
||||||
// 初始化的操作
|
|
||||||
// ...
|
|
||||||
}
|
|
||||||
|
|
||||||
// 插件实现...
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### 4. 实现 createRecord 方法
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
/**
|
|
||||||
* 创建 dns 解析记录,用于验证域名所有权
|
|
||||||
*/
|
|
||||||
async createRecord(options: CreateRecordOptions): Promise<any> {
|
|
||||||
/**
|
|
||||||
* options 参数说明
|
|
||||||
* fullRecord: '_acme-challenge.example.com',
|
|
||||||
* value: 一串 uuid
|
|
||||||
* type: 'TXT',
|
|
||||||
* domain: 'example.com'
|
|
||||||
*/
|
|
||||||
const { fullRecord, value, type, domain } = options;
|
|
||||||
this.logger.info('添加域名解析:', fullRecord, value, type, domain);
|
|
||||||
|
|
||||||
// 调用创建 dns 解析记录的对应的云端接口,创建 txt 类型的 dns 解析记录
|
|
||||||
// 请根据实际接口情况调用,例如:
|
|
||||||
// const createDnsRecordUrl = "xxx"
|
|
||||||
// const record = this.http.post(createDnsRecordUrl,{
|
|
||||||
// // 授权参数
|
|
||||||
// // 创建 dns 解析记录的参数
|
|
||||||
// })
|
|
||||||
// // 返回本次创建的 dns 解析记录,这个记录会在删除的时候用到
|
|
||||||
// return record
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### 5. 实现 removeRecord 方法
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
/**
|
|
||||||
* 删除 dns 解析记录,清理申请痕迹
|
|
||||||
* @param options
|
|
||||||
*/
|
|
||||||
async removeRecord(options: RemoveRecordOptions<DemoRecord>): Promise<void> {
|
|
||||||
const { fullRecord, value, domain } = options.recordReq;
|
|
||||||
const record = options.recordRes;
|
|
||||||
this.logger.info('删除域名解析:', domain, fullRecord, value, record);
|
|
||||||
// 这里调用删除 txt dns 解析记录接口
|
|
||||||
// 请根据实际接口情况调用,例如:
|
|
||||||
|
|
||||||
// const deleteDnsRecordUrl = "xxx"
|
|
||||||
// const res = this.http.delete(deleteDnsRecordUrl,{
|
|
||||||
// // 授权参数
|
|
||||||
// // 删除 dns 解析记录的参数
|
|
||||||
// })
|
|
||||||
|
|
||||||
|
|
||||||
this.logger.info('删除域名解析成功:', fullRecord, value);
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### 6. 实例化插件
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
// 实例化这个 provider,将其自动注册到系统中
|
|
||||||
if (isDev()) {
|
|
||||||
// 你的实现 要去掉这个 if,不然生产环境将不会显示
|
|
||||||
new DemoDnsProvider();
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## 注意事项
|
|
||||||
|
|
||||||
1. **插件命名**:插件名称应简洁明了,反映其功能。
|
|
||||||
2. **accessType**:必须指定对应的云平台的 access 类型名称。
|
|
||||||
3. **记录结构**:定义适合对应云平台的记录数据结构,至少包含 id 字段用于删除记录。
|
|
||||||
4. **日志输出**:使用 `this.logger` 输出日志,而不是 `console`。
|
|
||||||
5. **错误处理**:API 调用失败时应抛出明确的错误信息。
|
|
||||||
6. **实例化**:生产环境中应移除 `if (isDev())` 条件,确保插件在生产环境中也能被注册。
|
|
||||||
|
|
||||||
## 完整示例
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { AbstractDnsProvider, CreateRecordOptions, IsDnsProvider, RemoveRecordOptions } from '@certd/plugin-cert';
|
|
||||||
import { DemoAccess } from './access.js';
|
|
||||||
import { isDev } from '../../utils/env.js';
|
|
||||||
|
|
||||||
type DemoRecord = {
|
type DemoRecord = {
|
||||||
// 这里定义 Record 记录的数据结构,跟对应云平台接口返回值一样即可,一般是拿到 id 就行,用于删除 txt 解析记录,清理申请痕迹
|
// 这里定义 Record 记录的数据结构,跟对应云平台接口返回值一样即可
|
||||||
// id:string
|
id: string;
|
||||||
};
|
};
|
||||||
|
|
||||||
// 这里通过 IsDnsProvider 注册一个 dnsProvider
|
// 这里通过 IsDnsProvider 注册一个 dnsProvider
|
||||||
@@ -171,15 +125,23 @@ export class DemoDnsProvider extends AbstractDnsProvider<DemoRecord> {
|
|||||||
const { fullRecord, value, type, domain } = options;
|
const { fullRecord, value, type, domain } = options;
|
||||||
this.logger.info('添加域名解析:', fullRecord, value, type, domain);
|
this.logger.info('添加域名解析:', fullRecord, value, type, domain);
|
||||||
|
|
||||||
// 调用创建 dns 解析记录的对应的云端接口,创建 txt 类型的 dns 解析记录
|
try {
|
||||||
// 请根据实际接口情况调用,例如:
|
// 调用创建 dns 解析记录的对应的云端接口,创建 txt 类型的 dns 解析记录
|
||||||
// const createDnsRecordUrl = "xxx"
|
// 请根据实际接口情况调用,例如:
|
||||||
// const record = this.http.post(createDnsRecordUrl,{
|
// const createDnsRecordUrl = "xxx"
|
||||||
// // 授权参数
|
// const record = this.http.post(createDnsRecordUrl,{
|
||||||
// // 创建 dns 解析记录的参数
|
// // 授权参数
|
||||||
// })
|
// // 创建 dns 解析记录的参数
|
||||||
// // 返回本次创建的 dns 解析记录,这个记录会在删除的时候用到
|
// })
|
||||||
// return record
|
// // 返回本次创建的 dns 解析记录,这个记录会在删除的时候用到
|
||||||
|
// return record
|
||||||
|
|
||||||
|
// 模拟返回
|
||||||
|
return { id: 'demo-record-id' };
|
||||||
|
} catch (error) {
|
||||||
|
this.logger.error('创建DNS记录失败:', error);
|
||||||
|
throw new Error(`创建DNS记录失败: ${error.message}`);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -190,23 +152,305 @@ export class DemoDnsProvider extends AbstractDnsProvider<DemoRecord> {
|
|||||||
const { fullRecord, value, domain } = options.recordReq;
|
const { fullRecord, value, domain } = options.recordReq;
|
||||||
const record = options.recordRes;
|
const record = options.recordRes;
|
||||||
this.logger.info('删除域名解析:', domain, fullRecord, value, record);
|
this.logger.info('删除域名解析:', domain, fullRecord, value, record);
|
||||||
// 这里调用删除 txt dns 解析记录接口
|
|
||||||
// 请根据实际接口情况调用,例如:
|
|
||||||
|
|
||||||
// const deleteDnsRecordUrl = "xxx"
|
try {
|
||||||
// const res = this.http.delete(deleteDnsRecordUrl,{
|
// 这里调用删除 txt dns 解析记录接口
|
||||||
// // 授权参数
|
// 请根据实际接口情况调用,例如:
|
||||||
// // 删除 dns 解析记录的参数
|
// const deleteDnsRecordUrl = "xxx"
|
||||||
// })
|
// const res = this.http.delete(deleteDnsRecordUrl,{
|
||||||
|
// // 授权参数
|
||||||
|
// // 删除 dns 解析记录的参数
|
||||||
|
// })
|
||||||
|
|
||||||
|
this.logger.info('删除域名解析成功:', fullRecord, value);
|
||||||
|
} catch (error) {
|
||||||
|
this.logger.error('删除DNS记录失败:', error);
|
||||||
|
// 即使删除失败也不抛出异常,避免影响整个证书申请流程
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
this.logger.info('删除域名解析成功:', fullRecord, value);
|
/**
|
||||||
|
* 实现获取域名列表
|
||||||
|
*/
|
||||||
|
async getDomainListPage(req: PageSearch): Promise<PageRes<DomainRecord>> {
|
||||||
|
try {
|
||||||
|
const pager = new Pager(req);
|
||||||
|
const res = await this.http.request({
|
||||||
|
// 请求接口获取域名列表
|
||||||
|
});
|
||||||
|
const list =
|
||||||
|
res.Domains?.map(item => ({
|
||||||
|
id: item.Id,
|
||||||
|
domain: item.DomainName,
|
||||||
|
})) || [];
|
||||||
|
|
||||||
|
return {
|
||||||
|
list,
|
||||||
|
total: res.Total,
|
||||||
|
};
|
||||||
|
} catch (error) {
|
||||||
|
this.logger.error('获取域名列表失败:', error);
|
||||||
|
return { list: [], total: 0 };
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// 实例化这个 provider,将其自动注册到系统中
|
// 实例化这个 provider,将其自动注册到系统中
|
||||||
if (isDev()) {
|
new DemoDnsProvider();
|
||||||
// 你的实现 要去掉这个 if,不然生产环境将不会显示
|
|
||||||
new DemoDnsProvider();
|
|
||||||
}
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### 示例 2: 阿里云 DNS Provider 插件
|
||||||
|
|
||||||
|
#### 用户输入
|
||||||
|
|
||||||
|
创建一个阿里云 DNS Provider 插件,用于在 ACME 申请证书时添加和删除 TXT 解析记录。
|
||||||
|
|
||||||
|
#### 你的回答
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { AbstractDnsProvider, CreateRecordOptions, IsDnsProvider, RemoveRecordOptions, PageSearch, PageRes, DomainRecord } from '@certd/plugin-cert';
|
||||||
|
import { AliyunAccess } from './aliyun-access.js';
|
||||||
|
import { Pager } from '@certd/pipeline';
|
||||||
|
|
||||||
|
type AliyunRecord = {
|
||||||
|
RecordId: string;
|
||||||
|
};
|
||||||
|
|
||||||
|
// 阿里云 DNS Provider 插件
|
||||||
|
@IsDnsProvider({
|
||||||
|
name: 'aliyun',
|
||||||
|
title: '阿里云DNS',
|
||||||
|
desc: '阿里云DNS提供商插件',
|
||||||
|
icon: 'clarity:plugin-line',
|
||||||
|
accessType: 'aliyun',
|
||||||
|
order: 10,
|
||||||
|
})
|
||||||
|
export class AliyunDnsProvider extends AbstractDnsProvider<AliyunRecord> {
|
||||||
|
access!: AliyunAccess;
|
||||||
|
|
||||||
|
async onInstance() {
|
||||||
|
this.access = this.ctx.access as AliyunAccess;
|
||||||
|
this.logger.debug('阿里云Access实例初始化成功');
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 创建 DNS 解析记录
|
||||||
|
*/
|
||||||
|
async createRecord(options: CreateRecordOptions): Promise<AliyunRecord> {
|
||||||
|
const { fullRecord, value, type, domain } = options;
|
||||||
|
this.logger.info('阿里云DNS: 添加解析记录', { fullRecord, value, type, domain });
|
||||||
|
|
||||||
|
try {
|
||||||
|
// 提取主机记录
|
||||||
|
const hostRecord = fullRecord.replace(`.${domain}`, '');
|
||||||
|
|
||||||
|
// 调用阿里云 API 创建解析记录
|
||||||
|
const response = await this.access.doRequest({
|
||||||
|
action: 'AddDomainRecord',
|
||||||
|
data: {
|
||||||
|
DomainName: domain,
|
||||||
|
RR: hostRecord,
|
||||||
|
Type: type,
|
||||||
|
Value: value,
|
||||||
|
TTL: 600, // 10分钟
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
this.logger.info('阿里云DNS: 解析记录创建成功', { RecordId: response.RecordId });
|
||||||
|
return { RecordId: response.RecordId };
|
||||||
|
} catch (error) {
|
||||||
|
this.logger.error('阿里云DNS: 创建解析记录失败', error);
|
||||||
|
throw new Error(`阿里云DNS创建解析记录失败: ${error.message}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 删除 DNS 解析记录
|
||||||
|
*/
|
||||||
|
async removeRecord(options: RemoveRecordOptions<AliyunRecord>): Promise<void> {
|
||||||
|
const { fullRecord, value, domain } = options.recordReq;
|
||||||
|
const record = options.recordRes;
|
||||||
|
this.logger.info('阿里云DNS: 删除解析记录', { fullRecord, value, domain, RecordId: record.RecordId });
|
||||||
|
|
||||||
|
try {
|
||||||
|
// 调用阿里云 API 删除解析记录
|
||||||
|
await this.access.doRequest({
|
||||||
|
action: 'DeleteDomainRecord',
|
||||||
|
data: {
|
||||||
|
RecordId: record.RecordId,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
this.logger.info('阿里云DNS: 解析记录删除成功', { RecordId: record.RecordId });
|
||||||
|
} catch (error) {
|
||||||
|
this.logger.error('阿里云DNS: 删除解析记录失败', error);
|
||||||
|
// 即使删除失败也不抛出异常,避免影响整个证书申请流程
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 获取域名列表
|
||||||
|
*/
|
||||||
|
async getDomainListPage(req: PageSearch): Promise<PageRes<DomainRecord>> {
|
||||||
|
try {
|
||||||
|
const pager = new Pager(req);
|
||||||
|
const response = await this.access.doRequest({
|
||||||
|
action: 'DescribeDomains',
|
||||||
|
data: {
|
||||||
|
PageNumber: pager.page,
|
||||||
|
PageSize: pager.pageSize,
|
||||||
|
KeyWord: req.searchKey,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const list = response.Domains.Domain.map((domain: any) => ({
|
||||||
|
id: domain.DomainId,
|
||||||
|
domain: domain.DomainName,
|
||||||
|
}));
|
||||||
|
|
||||||
|
return {
|
||||||
|
list,
|
||||||
|
total: response.TotalCount,
|
||||||
|
};
|
||||||
|
} catch (error) {
|
||||||
|
this.logger.error('阿里云DNS: 获取域名列表失败', error);
|
||||||
|
return { list: [], total: 0 };
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 实例化插件
|
||||||
|
new AliyunDnsProvider();
|
||||||
|
```
|
||||||
|
|
||||||
|
### 示例 3: 腾讯云 DNS Provider 插件
|
||||||
|
|
||||||
|
#### 用户输入
|
||||||
|
|
||||||
|
创建一个腾讯云 DNS Provider 插件,用于在 ACME 申请证书时添加和删除 TXT 解析记录。
|
||||||
|
|
||||||
|
#### 你的回答
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { AbstractDnsProvider, CreateRecordOptions, IsDnsProvider, RemoveRecordOptions, PageSearch, PageRes, DomainRecord } from '@certd/plugin-cert';
|
||||||
|
import { TencentAccess } from './tencent-access.js';
|
||||||
|
import { Pager } from '@certd/pipeline';
|
||||||
|
|
||||||
|
type TencentRecord = {
|
||||||
|
RecordId: string;
|
||||||
|
};
|
||||||
|
|
||||||
|
// 腾讯云 DNS Provider 插件
|
||||||
|
@IsDnsProvider({
|
||||||
|
name: 'tencent',
|
||||||
|
title: '腾讯云DNS',
|
||||||
|
desc: '腾讯云DNS提供商插件',
|
||||||
|
icon: 'clarity:plugin-line',
|
||||||
|
accessType: 'tencent',
|
||||||
|
order: 20,
|
||||||
|
})
|
||||||
|
export class TencentDnsProvider extends AbstractDnsProvider<TencentRecord> {
|
||||||
|
access!: TencentAccess;
|
||||||
|
|
||||||
|
async onInstance() {
|
||||||
|
this.access = this.ctx.access as TencentAccess;
|
||||||
|
this.logger.debug('腾讯云Access实例初始化成功');
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 创建 DNS 解析记录
|
||||||
|
*/
|
||||||
|
async createRecord(options: CreateRecordOptions): Promise<TencentRecord> {
|
||||||
|
const { fullRecord, value, type, domain } = options;
|
||||||
|
this.logger.info('腾讯云DNS: 添加解析记录', { fullRecord, value, type, domain });
|
||||||
|
|
||||||
|
try {
|
||||||
|
// 提取主机记录
|
||||||
|
const hostRecord = fullRecord.replace(`.${domain}`, '');
|
||||||
|
|
||||||
|
// 调用腾讯云 API 创建解析记录
|
||||||
|
const response = await this.access.doRequest({
|
||||||
|
action: 'CreateRecord',
|
||||||
|
data: {
|
||||||
|
Domain: domain,
|
||||||
|
SubDomain: hostRecord,
|
||||||
|
RecordType: type,
|
||||||
|
RecordValue: value,
|
||||||
|
TTL: 600, // 10分钟
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
this.logger.info('腾讯云DNS: 解析记录创建成功', { RecordId: response.RecordId });
|
||||||
|
return { RecordId: response.RecordId };
|
||||||
|
} catch (error) {
|
||||||
|
this.logger.error('腾讯云DNS: 创建解析记录失败', error);
|
||||||
|
throw new Error(`腾讯云DNS创建解析记录失败: ${error.message}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 删除 DNS 解析记录
|
||||||
|
*/
|
||||||
|
async removeRecord(options: RemoveRecordOptions<TencentRecord>): Promise<void> {
|
||||||
|
const { fullRecord, value, domain } = options.recordReq;
|
||||||
|
const record = options.recordRes;
|
||||||
|
this.logger.info('腾讯云DNS: 删除解析记录', { fullRecord, value, domain, RecordId: record.RecordId });
|
||||||
|
|
||||||
|
try {
|
||||||
|
// 调用腾讯云 API 删除解析记录
|
||||||
|
await this.access.doRequest({
|
||||||
|
action: 'DeleteRecord',
|
||||||
|
data: {
|
||||||
|
RecordId: record.RecordId,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
this.logger.info('腾讯云DNS: 解析记录删除成功', { RecordId: record.RecordId });
|
||||||
|
} catch (error) {
|
||||||
|
this.logger.error('腾讯云DNS: 删除解析记录失败', error);
|
||||||
|
// 即使删除失败也不抛出异常,避免影响整个证书申请流程
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 获取域名列表
|
||||||
|
*/
|
||||||
|
async getDomainListPage(req: PageSearch): Promise<PageRes<DomainRecord>> {
|
||||||
|
try {
|
||||||
|
const pager = new Pager(req);
|
||||||
|
const response = await this.access.doRequest({
|
||||||
|
action: 'DescribeDomains',
|
||||||
|
data: {
|
||||||
|
Offset: (pager.page - 1) * pager.pageSize,
|
||||||
|
Limit: pager.pageSize,
|
||||||
|
Keyword: req.searchKey,
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
const list = response.Domains.map((domain: any) => ({
|
||||||
|
id: domain.DomainId,
|
||||||
|
domain: domain.DomainName,
|
||||||
|
}));
|
||||||
|
|
||||||
|
return {
|
||||||
|
list,
|
||||||
|
total: response.TotalCount,
|
||||||
|
};
|
||||||
|
} catch (error) {
|
||||||
|
this.logger.error('腾讯云DNS: 获取域名列表失败', error);
|
||||||
|
return { list: [], total: 0 };
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 实例化插件
|
||||||
|
new TencentDnsProvider();
|
||||||
|
```
|
||||||
|
|
||||||
|
## 注意事项
|
||||||
|
|
||||||
|
1. **插件命名**:插件名称应简洁明了,反映其功能。
|
||||||
|
2. **accessType**:必须指定对应的云平台的 access 类型名称。
|
||||||
|
3. **记录结构**:定义适合对应云平台的记录数据结构,至少包含 id 字段用于删除记录。
|
||||||
|
4. **日志输出**:使用 `this.logger` 输出日志,而不是 `console`,参数文本化,不要传对象,否则会输出`[object Object]}`。
|
||||||
|
5. **错误处理**:API 调用失败时应抛出明确的错误信息。
|
||||||
|
|||||||
@@ -0,0 +1,222 @@
|
|||||||
|
---
|
||||||
|
name: fast-crud-page-dev
|
||||||
|
description: 用于开发或重构 Certd 前端列表管理、后台管理、记录查询、CRUD 表格页面,优先使用 Fast Crud(@fast-crud/fast-crud、fs-crud、useFs、createCrudOptions)实现。当用户要求列表页、管理页、审核页、记录页或表格 CRUD 页面时触发。
|
||||||
|
version: 1.0.0
|
||||||
|
---
|
||||||
|
|
||||||
|
# Fast Crud 页面开发技能
|
||||||
|
|
||||||
|
## 角色定义
|
||||||
|
|
||||||
|
你是一名 Certd 前端列表管理页面开发专家,熟悉 Vue 3、Ant Design Vue、Fast Crud 和本仓库现有页面拆分方式。你的目标是让管理页面保持统一的表格、搜索、分页、操作列和弹窗体验。
|
||||||
|
|
||||||
|
## 核心规则
|
||||||
|
|
||||||
|
- 列表管理、后台管理、记录查询、审核记录、CRUD 表格类页面,默认优先使用 Fast Crud 实现。
|
||||||
|
- 只有轻量只读展示、强交互自定义界面、复杂可视化或已有页面模式明确不适合 Fast Crud 时,才手写 `a-table` / 自定义列表,并在回复中说明原因。
|
||||||
|
- 设置表单、概览卡片、向导流程等非列表主体可以保留自定义 Vue;如果同一功能同时包含设置和列表,优先拆成独立页面,或把设置放入对话框。
|
||||||
|
|
||||||
|
## 推荐文件拆分
|
||||||
|
|
||||||
|
- `api.ts`:封装接口请求,保持页面和 CRUD 配置里不直接散落 URL。
|
||||||
|
- `crud.tsx` / `crud-*.tsx`:导出 `createCrudOptions`,集中定义请求映射、搜索项、列、表单、操作列、工具栏和字典。
|
||||||
|
- `index.vue`:承载 `fs-page`、`fs-crud`、页面头部、弹窗和生命周期,使用 `useFs({ createCrudOptions, context })` 创建绑定。
|
||||||
|
|
||||||
|
## 实现流程
|
||||||
|
|
||||||
|
1. 先在 `packages/ui/certd-client/src/views` 下找 1-2 个相近 Fast Crud 页面,沿用它们的导入、布局、命名和权限写法。
|
||||||
|
2. 在 `index.vue` 中使用 `fs-crud ref="crudRef" v-bind="crudBinding"`,并在 `onMounted` 或 `onActivated` 时调用 `crudExpose.doRefresh()`;两个生命周期同时存在时只保留一个刷新入口,避免首次进入页面请求两次。
|
||||||
|
3. 在 `crud.tsx` 中配置 `request.pageRequest`、`columns`、`search`、`form`、`rowHandle`、`actionbar`、`toolbar` 等,接口分页参数和返回值按现有页面适配。
|
||||||
|
4. 操作按钮优先放在 Fast Crud 的 `rowHandle.buttons` 或 `actionbar.buttons` 中;审核、保存设置、批量操作等复杂交互可通过 `context` 调用 `index.vue` 中的方法。
|
||||||
|
5. 金额、状态、时间、枚举等字段优先复用项目已有组件、字典和格式化工具;避免在模板里重复堆格式化逻辑。
|
||||||
|
6. 表格查询条件使用 Fast Crud 的 `search` 配置;新增/编辑表单使用 Fast Crud 的 `form` 配置,复杂设置项可以用 Ant Design Vue 对话框承载。
|
||||||
|
7. 删除、审核通过、拒绝等危险操作必须保留确认弹窗和错误提示,成功后刷新当前 CRUD 列表。
|
||||||
|
8. 对话框里只做纯确认时可以使用 `Modal.confirm`;只要需要字段输入、表单校验或提交字段,统一使用 `useFormDialog` / `openFormDialog`,不要在 `Modal.confirm` 的 `content` 里手写输入框。
|
||||||
|
|
||||||
|
## crud 配置
|
||||||
|
|
||||||
|
const crudOptions ={
|
||||||
|
id: string, //表格唯一标识,同一个页面的多个表格的列设置和字段设置会根据id进行区分保存
|
||||||
|
request:{}, //http请求
|
||||||
|
columns:{ //字段配置
|
||||||
|
key:{ //字段key
|
||||||
|
column:{}, //对应table-column配置
|
||||||
|
form:{}, //表单中该字段的公共配置,viewForm、addForm、editForm、search会集成此配置,支持对应ui的form-item配置
|
||||||
|
viewForm:{}, //查看表单中该字段的配置,支持对应ui的form-item配置
|
||||||
|
addForm:{}, // 添加表单中该字段的配置,支持对应ui的form-item配置
|
||||||
|
editForm:{}, //编辑表单中该字段的配置,支持对应ui的form-item配置
|
||||||
|
search:{} //对应查询表单的form-item配置
|
||||||
|
}
|
||||||
|
},
|
||||||
|
search:{ //查询框配置 ,对应fs-search组件
|
||||||
|
options:{} //查询表单配置 ,对应el-from, a-form配置
|
||||||
|
},
|
||||||
|
actionbar:{}, //动作条,添加按钮,对应fs-actionbar组件
|
||||||
|
toolbar:{}, //工具条 ,对应fs-toolbar组件
|
||||||
|
table:{ //表格配置,对应fs-table
|
||||||
|
// 对应 el-table / a-table的配置
|
||||||
|
slots:{} // 对应el-table ,a-table的插槽
|
||||||
|
},
|
||||||
|
data:{}, //列表数据,无需配置,自动从pageRequest中获取
|
||||||
|
// 如果你要手动改变表格数据,可以通过crudBinding.value.data直接赋值修改表格数据
|
||||||
|
rowHandle:{}, //操作列配置,对应fs-row-handle
|
||||||
|
form:{ //表单的公共配置,对应el-form,a-form配置
|
||||||
|
wrapper:{} //表单外部容器(对话框)的配置,对应el-dialog,el-drawer,a-model,a-drawer的配置
|
||||||
|
},
|
||||||
|
viewForm:{}, //查看表单的独立配置
|
||||||
|
editForm:{}, //编辑表单的独立配置
|
||||||
|
addForm:{}, //添加表单的独立配置
|
||||||
|
pagination:{}, //分页配置 ,对应el-pagination / a-pagination
|
||||||
|
container:{}, //容器配置 ,对应fs-container
|
||||||
|
}
|
||||||
|
|
||||||
|
## 布局高度
|
||||||
|
|
||||||
|
- Fast Crud 表格依赖外部容器高度计算。虽然表格本身有默认约 200px 高度,但页面内嵌 `fs-crud` 时,为了获得稳定可用的列表区域,必须让外层容器提供明确高度或剩余高度。
|
||||||
|
- 独立列表页通常可直接让 `fs-page` / 页面内容区撑满;如果表格嵌在 tabs、详情页、上下分区或弹窗里,要从页面根容器到 `fs-crud` 建立完整的 flex 高度链路:父容器 `display: flex; flex-direction: column; min-height: 0`,中间内容区和 tab pane 使用 `flex: 1; min-height: 0`,`fs-crud` 本身也使用 `flex: 1; min-height: 0`。
|
||||||
|
- 有固定操作栏、统计区、说明区时,这些区域应 `flex: none`,把剩余空间交给表格区域。
|
||||||
|
- 修改嵌入式 Fast Crud 页面后,要检查空数据、少量数据和多页数据时表格高度、分页器和空状态是否仍在预期区域内。
|
||||||
|
|
||||||
|
## 列表导出
|
||||||
|
|
||||||
|
- 列表需要导出时,优先使用 Fast Crud 工具栏导出能力,不要另写一套导出按钮或后端接口,除非数据必须跨权限、跨分页或异步生成文件。
|
||||||
|
- 导出当前搜索条件下的数据时,在 `toolbar.export` 中设置 `dataFrom: "search"`,并显式打开导出按钮。
|
||||||
|
- 导出列必须输出 Excel 可读的纯文本或数字;不要直接导出对象、数组、VNode、进度条组件、开关组件、时间戳毫秒值等。
|
||||||
|
- 有隐藏但业务上需要导出的字段时,把字段定义为普通列并设置 `column.show: false`,再在 `columnFilter` 中对该字段返回 `true`。例如证书域名这类只用于导出的辅助列。
|
||||||
|
- 嵌套字段可以使用 `lastVars.certDomains` 这类 key;导出格式化时用安全取值函数读取嵌套值。
|
||||||
|
- `dataFormatter` 中统一格式化特殊字段:时间字段转 `YYYY-MM-DD HH:mm:ss`,日期类有效期转业务文案或 `YYYY-MM-DD`,枚举/开关转字典 label,数组转逗号分隔字符串,对象转明确的业务摘要。
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { ColumnProps, DataFormatterContext } from "@fast-crud/fast-crud";
|
||||||
|
import dayjs from "dayjs";
|
||||||
|
|
||||||
|
function getRecordValue(row: any, key: string) {
|
||||||
|
return key.split(".").reduce((target, item) => target?.[item], row);
|
||||||
|
}
|
||||||
|
|
||||||
|
function formatListValue(value: any) {
|
||||||
|
if (Array.isArray(value)) {
|
||||||
|
return value.join(",");
|
||||||
|
}
|
||||||
|
return value ?? "";
|
||||||
|
}
|
||||||
|
|
||||||
|
function exportColumnFilter(col: ColumnProps) {
|
||||||
|
if (!col.key || ["_index", "_selection", "rowHandle"].includes(col.key)) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
if (col.key === "lastVars.certDomains") {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
return col.show !== false;
|
||||||
|
}
|
||||||
|
|
||||||
|
function exportDataFormatter(opts: DataFormatterContext) {
|
||||||
|
const { row, originalRow, col, exportCol } = opts;
|
||||||
|
const key = col.key;
|
||||||
|
const value = getRecordValue(originalRow, key);
|
||||||
|
|
||||||
|
if (key === "lastVars.certDomains") {
|
||||||
|
row[key] = formatListValue(value);
|
||||||
|
} else if (key.includes("Time") && value) {
|
||||||
|
row[key] = dayjs(value).format("YYYY-MM-DD HH:mm:ss");
|
||||||
|
}
|
||||||
|
|
||||||
|
if (col.width) {
|
||||||
|
exportCol.width = col.width / 10;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
crudOptions: {
|
||||||
|
toolbar: {
|
||||||
|
buttons: {
|
||||||
|
export: { show: true },
|
||||||
|
},
|
||||||
|
export: {
|
||||||
|
dataFrom: "search",
|
||||||
|
columnFilter: exportColumnFilter,
|
||||||
|
dataFormatter: exportDataFormatter,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
columns: {
|
||||||
|
"lastVars.certDomains": {
|
||||||
|
title: "证书域名",
|
||||||
|
type: "text",
|
||||||
|
column: {
|
||||||
|
show: false,
|
||||||
|
width: 260,
|
||||||
|
ellipsis: true,
|
||||||
|
},
|
||||||
|
form: { show: false },
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## 内置 CRUD 按钮
|
||||||
|
|
||||||
|
只要在 `request` 中配置了 `addRequest`、`editRequest`、`delRequest`,Fast Crud 会自动在 `rowHandle` 渲染新增、编辑、删除按钮并完成对应操作,**不需要手写 `openDeleteConfirm`、`openEditDialog` 等方法**。
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// crud.tsx
|
||||||
|
const addRequest = async ({ form }: AddReq) => await api.AddObj(form);
|
||||||
|
const editRequest = async ({ form, row }: EditReq) => {
|
||||||
|
form.id = row.id;
|
||||||
|
return await api.UpdateObj(form);
|
||||||
|
};
|
||||||
|
const delRequest = async ({ row }: DelReq) => await api.DelObj(row.id);
|
||||||
|
|
||||||
|
return {
|
||||||
|
crudOptions: {
|
||||||
|
request: { pageRequest, addRequest, editRequest, delRequest },
|
||||||
|
rowHandle: {
|
||||||
|
buttons: {
|
||||||
|
view: { show: false }, // 不需要查看就隐藏
|
||||||
|
edit: {}, // 自动调用 editRequest
|
||||||
|
remove: {}, // 自动调用 delRequest,自带确认弹窗和错误提示
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
- 删除按钮自带确认弹窗,不需要额外包装 `Modal.confirm`。
|
||||||
|
- 只有**自定义操作**(如禁用、审核、生成激活码)才需要在 `rowHandle.buttons` 中手写 `click` 处理方法。
|
||||||
|
- 如果不需要某列操作,直接把对应 key 去掉或设 `show: false`。
|
||||||
|
|
||||||
|
## compute 动态计算
|
||||||
|
|
||||||
|
当 `rowHandle.buttons` 的 `show`、`disabled` 等属性需要根据行数据动态决定时,**必须使用 `compute` 包裹**,不能直接传函数。
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { compute } from "@fast-crud/fast-crud";
|
||||||
|
|
||||||
|
// WRONG: 直接传函数
|
||||||
|
show: ({ row }) => row.status === "unused"
|
||||||
|
|
||||||
|
// CORRECT: 用 compute 包裹
|
||||||
|
show: compute(({ row }) => row.status === "unused")
|
||||||
|
```
|
||||||
|
|
||||||
|
`compute` 基于 Vue 的 `computed`,但额外支持上下文参数。适用位置:
|
||||||
|
- `rowHandle.buttons` 的 `show`、`disabled` 等属性
|
||||||
|
- `columns.key.column` 的 `show`、`cellRender` 等
|
||||||
|
- `columns.key.form` / `search` 的表单字段属性
|
||||||
|
|
||||||
|
参考文档:http://fast-crud.docmirror.cn/guide/advance/compute.html
|
||||||
|
|
||||||
|
## 代码习惯
|
||||||
|
|
||||||
|
- 页面命名、API 命名、权限标识和路由结构要贴近同目录已有页面。
|
||||||
|
- CRUD 配置中不要写大段业务流程;复杂逻辑放回 `index.vue` 方法或 `api.ts`。
|
||||||
|
- 能用 `dict`、`compute`、`valueBuilder`、`valueResolve`、`component` 配置表达的表格/表单行为,不要改成手写模板。
|
||||||
|
- 保持列表页密度和操作入口克制,不要做营销式布局、嵌套卡片或大块说明文字。
|
||||||
|
- 如果页面有“设置 + 列表”,管理端优先拆成两个路由页面;用户端提现设置这类低频配置优先使用对话框保存。
|
||||||
|
|
||||||
|
## 验证方式
|
||||||
|
|
||||||
|
- 前端改动后,只对本次改动的 Vue / TS / TSX / locale 文件运行项目现有 Prettier / ESLint。
|
||||||
|
- 不运行 `vue-tsc` / `pnpm tsc`,因为当前依赖组合下 `vue-tsc` 已知会抛内部错误。
|
||||||
|
- 若只是新增或修改本 skill / 文档,不需要运行前端格式化和测试。
|
||||||
@@ -1,125 +1,100 @@
|
|||||||
|
---
|
||||||
|
name: plugin-converter
|
||||||
|
description: 用于将 Certd 插件转换为 YAML 配置文件的命令行工具,支持分析单个插件文件、识别插件类型并生成对应的 YAML 配置。当用户需要生成插件配置、转换插件格式、批量处理插件或修改现有插件配置时触发。
|
||||||
|
version: 1.0.0
|
||||||
|
---
|
||||||
|
|
||||||
# 插件转换工具技能
|
# 插件转换工具技能
|
||||||
|
|
||||||
## 什么是插件转换工具
|
## 角色定义
|
||||||
|
|
||||||
插件转换工具是一个用于将 Certd 插件转换为 YAML 配置文件的命令行工具。它可以分析单个插件文件,识别插件类型,并生成对应的 YAML 配置,方便插件的注册和管理。
|
你是一名 Certd 插件开发专家,擅长使用插件转换工具将 Certd 插件转换为 YAML 配置文件,熟悉命令行工具的使用和 Certd 插件开发规范。
|
||||||
|
|
||||||
## 工具位置
|
## 核心指令
|
||||||
|
|
||||||
`trae/skills/convert-plugin-to-yaml.js`
|
请严格按照以下步骤执行任务:
|
||||||
|
|
||||||
## 功能特性
|
1. **定位工具位置**
|
||||||
|
|
||||||
- **单个插件转换**:支持指定单个插件文件进行转换,而不是扫描整个目录
|
- 工具位于 `trae/skills/convert-plugin-to-yaml.js`
|
||||||
- **自动类型识别**:自动识别插件类型(Access、Task、DNS Provider、Notification、Addon)
|
|
||||||
- **详细日志输出**:提供详细的转换过程日志,便于调试
|
|
||||||
- **YAML 配置生成**:生成标准的 YAML 配置文件
|
|
||||||
- **配置文件保存**:自动将生成的配置保存到 `./metadata` 目录
|
|
||||||
- **可复用函数**:导出了可复用的函数,便于其他模块调用
|
|
||||||
|
|
||||||
## 使用方法
|
2. **了解功能特性**
|
||||||
|
|
||||||
### 基本用法
|
- 单个插件转换:支持指定单个插件文件进行转换
|
||||||
|
- 批量插件转换:支持指定目录批量转换多个插件
|
||||||
|
- 自动类型识别:自动识别插件类型(Access、Task、DNS Provider、Notification、Addon)
|
||||||
|
- 详细日志输出:提供详细的转换过程日志
|
||||||
|
- YAML 配置生成:生成标准的 YAML 配置文件
|
||||||
|
- 配置文件保存:自动将生成的配置保存到 `./metadata` 目录
|
||||||
|
- 自定义输出目录:支持指定自定义输出目录
|
||||||
|
- 格式化输出:支持格式化 YAML 输出
|
||||||
|
- 可复用函数:导出了可复用的函数,便于其他模块调用
|
||||||
|
|
||||||
```bash
|
3. **使用工具**
|
||||||
node trae/skills/convert-plugin-to-yaml.js <插件文件路径>
|
|
||||||
```
|
|
||||||
|
|
||||||
### 示例
|
- 基本用法:`node trae/skills/convert-plugin-to-yaml.js <插件文件路径>`
|
||||||
|
- 批量转换:`node trae/skills/convert-plugin-to-yaml.js <目录路径>`
|
||||||
|
- 自定义输出目录:`node trae/skills/convert-plugin-to-yaml.js <插件文件路径> --output <输出目录>`
|
||||||
|
- 格式化输出:`node trae/skills/convert-plugin-to-yaml.js <插件文件路径> --format`
|
||||||
|
- 示例:
|
||||||
|
- 转换 Access 插件:`node trae/skills/convert-plugin-to-yaml.js packages/ui/certd-server/src/plugins/plugin-demo/access.js`
|
||||||
|
- 转换 Task 插件:`node trae/skills/convert-plugin-to-yaml.js packages/ui/certd-server/src/plugins/plugin-demo/plugins/plugin-test.js`
|
||||||
|
- 转换 DNS Provider 插件:`node trae/skills/convert-plugin-to-yaml.js packages/ui/certd-server/src/plugins/plugin-demo/dns-provider.js`
|
||||||
|
- 批量转换插件:`node trae/skills/convert-plugin-to-yaml.js packages/ui/certd-server/src/plugins/`
|
||||||
|
- 自定义输出目录:`node trae/skills/convert-plugin-to-yaml.js packages/ui/certd-server/src/plugins/plugin-demo/access.js --output ./configs`
|
||||||
|
|
||||||
|
4. **理解转换过程**
|
||||||
|
|
||||||
|
- 加载插件模块:使用 `import()` 动态加载指定的插件文件
|
||||||
|
- 分析插件定义:检查模块导出的对象,寻找带有 `define` 属性的插件
|
||||||
|
- 识别插件类型:根据插件的继承关系或属性识别插件类型
|
||||||
|
- 生成 YAML 配置:基于插件定义生成标准的 YAML 配置
|
||||||
|
- 保存配置文件:将生成的配置保存到 `./metadata` 目录
|
||||||
|
|
||||||
|
5. **了解输出说明**
|
||||||
|
|
||||||
|
- 命令行输出:插件加载状态、插件导出的对象列表、插件类型识别结果、生成的 YAML 配置内容、配置文件保存路径
|
||||||
|
- 配置文件命名规则:`<插件类型>[_<子类型>]_<插件名称>.yaml`
|
||||||
|
|
||||||
|
6. **理解插件类型识别逻辑**
|
||||||
|
|
||||||
|
- DNS Provider:如果插件定义中包含 `accessType` 属性
|
||||||
|
- Task:如果插件继承自 `AbstractTaskPlugin`
|
||||||
|
- Notification:如果插件继承自 `BaseNotification`
|
||||||
|
- Access:如果插件继承自 `BaseAccess`
|
||||||
|
- Addon:如果插件继承自 `BaseAddon`
|
||||||
|
|
||||||
|
7. **遵循注意事项**
|
||||||
|
- 文件路径:插件文件路径可以是相对路径或绝对路径
|
||||||
|
- 文件格式:仅支持 `.js` 文件,不支持 `.ts` 文件(需要先编译)
|
||||||
|
- 依赖安装:执行前确保已安装所有必要的依赖
|
||||||
|
- 配置目录:如果 `./metadata` 目录不存在,工具会自动创建
|
||||||
|
- 错误处理:如果插件加载失败或识别失败,工具会输出错误信息但不会终止执行
|
||||||
|
|
||||||
|
## 输出规范
|
||||||
|
|
||||||
|
- 必须包含工具的使用方法和示例
|
||||||
|
- 必须包含转换过程的详细说明
|
||||||
|
- 必须包含输出说明和配置文件命名规则
|
||||||
|
- 必须包含插件类型识别逻辑
|
||||||
|
- 必须包含注意事项和故障排除建议
|
||||||
|
|
||||||
|
## 示例
|
||||||
|
|
||||||
|
### 示例 1: 转换单个 Access 插件
|
||||||
|
|
||||||
|
#### 用户输入
|
||||||
|
|
||||||
|
将 Access 插件转换为 YAML 配置文件。
|
||||||
|
|
||||||
|
#### 你的回答
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# 转换 Access 插件
|
# 转换 Access 插件
|
||||||
node trae/skills/convert-plugin-to-yaml.js packages/ui/certd-server/src/plugins/plugin-demo/access.js
|
node trae/skills/convert-plugin-to-yaml.js packages/ui/certd-server/src/plugins/plugin-demo/access.js
|
||||||
|
|
||||||
# 转换 Task 插件
|
|
||||||
node trae/skills/convert-plugin-to-yaml.js packages/ui/certd-server/src/plugins/plugin-demo/plugins/plugin-test.js
|
|
||||||
|
|
||||||
# 转换 DNS Provider 插件
|
|
||||||
node trae/skills/convert-plugin-to-yaml.js packages/ui/certd-server/src/plugins/plugin-demo/dns-provider.js
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## 转换过程
|
#### 输出
|
||||||
|
|
||||||
1. **加载插件模块**:使用 `import()` 动态加载指定的插件文件
|
|
||||||
2. **分析插件定义**:检查模块导出的对象,寻找带有 `define` 属性的插件
|
|
||||||
3. **识别插件类型**:根据插件的继承关系或属性识别插件类型
|
|
||||||
4. **生成 YAML 配置**:基于插件定义生成标准的 YAML 配置
|
|
||||||
5. **保存配置文件**:将生成的配置保存到 `./metadata` 目录
|
|
||||||
|
|
||||||
## 输出说明
|
|
||||||
|
|
||||||
### 命令行输出
|
|
||||||
|
|
||||||
执行转换命令后,工具会输出以下信息:
|
|
||||||
|
|
||||||
- 插件加载状态
|
|
||||||
- 插件导出的对象列表
|
|
||||||
- 插件类型识别结果
|
|
||||||
- 生成的 YAML 配置内容
|
|
||||||
- 配置文件保存路径
|
|
||||||
|
|
||||||
### 配置文件命名规则
|
|
||||||
|
|
||||||
生成的配置文件命名规则为:
|
|
||||||
|
|
||||||
```
|
|
||||||
<插件类型>[_<子类型>]_<插件名称>.yaml
|
|
||||||
```
|
|
||||||
|
|
||||||
例如:
|
|
||||||
- `access_demo.yaml`(Access 插件)
|
|
||||||
- `deploy_DemoTest.yaml`(Task 插件)
|
|
||||||
- `dnsProvider_demo.yaml`(DNS Provider 插件)
|
|
||||||
|
|
||||||
## 插件类型识别逻辑
|
|
||||||
|
|
||||||
工具通过以下逻辑识别插件类型:
|
|
||||||
|
|
||||||
1. **DNS Provider**:如果插件定义中包含 `accessType` 属性
|
|
||||||
2. **Task**:如果插件继承自 `AbstractTaskPlugin`
|
|
||||||
3. **Notification**:如果插件继承自 `BaseNotification`
|
|
||||||
4. **Access**:如果插件继承自 `BaseAccess`
|
|
||||||
5. **Addon**:如果插件继承自 `BaseAddon`
|
|
||||||
|
|
||||||
## 注意事项
|
|
||||||
|
|
||||||
1. **文件路径**:插件文件路径可以是相对路径或绝对路径
|
|
||||||
2. **文件格式**:仅支持 `.js` 文件,不支持 `.ts` 文件(需要先编译)
|
|
||||||
3. **依赖安装**:执行前确保已安装所有必要的依赖
|
|
||||||
4. **配置目录**:如果 `./metadata` 目录不存在,工具会自动创建
|
|
||||||
5. **错误处理**:如果插件加载失败或识别失败,工具会输出错误信息但不会终止执行
|
|
||||||
|
|
||||||
## 代码结构
|
|
||||||
|
|
||||||
### 主要函数
|
|
||||||
|
|
||||||
1. **isPrototypeOf(value, cls)**:检查对象是否是指定类的原型
|
|
||||||
2. **loadSingleModule(filePath)**:加载单个插件模块
|
|
||||||
3. **convertSinglePlugin(pluginPath)**:分析单个插件并生成 YAML 配置
|
|
||||||
4. **main()**:主函数,处理命令行参数并执行转换
|
|
||||||
|
|
||||||
### 导出函数
|
|
||||||
|
|
||||||
工具导出了以下函数,便于其他模块调用:
|
|
||||||
|
|
||||||
```javascript
|
|
||||||
export {
|
|
||||||
convertSinglePlugin, // 转换单个插件
|
|
||||||
loadSingleModule, // 加载单个模块
|
|
||||||
isPrototypeOf // 检查原型关系
|
|
||||||
};
|
|
||||||
```
|
|
||||||
|
|
||||||
## 应用场景
|
|
||||||
|
|
||||||
1. **插件开发**:在开发新插件时,快速生成配置文件
|
|
||||||
2. **插件调试**:查看插件的内部定义和配置
|
|
||||||
3. **插件管理**:批量转换现有插件为标准配置格式
|
|
||||||
4. **自动化构建**:集成到构建流程中,自动生成插件配置
|
|
||||||
|
|
||||||
## 示例输出
|
|
||||||
|
|
||||||
### 转换 Access 插件示例
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
$ node trae/skills/convert-plugin-to-yaml.js packages/ui/certd-server/src/plugins/plugin-demo/access.js
|
$ node trae/skills/convert-plugin-to-yaml.js packages/ui/certd-server/src/plugins/plugin-demo/access.js
|
||||||
@@ -142,30 +117,121 @@ YAML 配置已保存到: ./metadata/access_demo.yaml
|
|||||||
插件转换完成!
|
插件转换完成!
|
||||||
```
|
```
|
||||||
|
|
||||||
### 转换 Task 插件示例
|
### 示例 2: 批量转换插件
|
||||||
|
|
||||||
|
#### 用户输入
|
||||||
|
|
||||||
|
批量转换目录中的所有插件为 YAML 配置文件。
|
||||||
|
|
||||||
|
#### 你的回答
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
$ node trae/skills/convert-plugin-to-yaml.js packages/ui/certd-server/src/plugins/plugin-demo/plugins/plugin-test.js
|
# 批量转换插件
|
||||||
|
node trae/skills/convert-plugin-to-yaml.js packages/ui/certd-server/src/plugins/
|
||||||
|
```
|
||||||
|
|
||||||
|
#### 输出
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ node trae/skills/convert-plugin-to-yaml.js packages/ui/certd-server/src/plugins/
|
||||||
|
开始转换目录: packages/ui/certd-server/src/plugins/
|
||||||
|
|
||||||
|
正在处理文件: packages/ui/certd-server/src/plugins/plugin-demo/access.js
|
||||||
|
开始转换插件: packages/ui/certd-server/src/plugins/plugin-demo/access.js
|
||||||
|
插件模块导出了 1 个对象: DemoAccess
|
||||||
|
处理插件: DemoAccess
|
||||||
|
插件类型: access
|
||||||
|
脚本路径: packages/ui/certd-server/src/plugins/plugin-demo/access.js
|
||||||
|
|
||||||
|
生成的 YAML 配置:
|
||||||
|
name: demo
|
||||||
|
title: 授权插件示例
|
||||||
|
desc: 这是一个示例授权插件,用于演示如何实现一个授权插件
|
||||||
|
icon: clarity:plugin-line
|
||||||
|
pluginType: access
|
||||||
|
type: builtIn
|
||||||
|
scriptFilePath: packages/ui/certd-server/src/plugins/plugin-demo/access.js
|
||||||
|
|
||||||
|
YAML 配置已保存到: ./metadata/access_demo.yaml
|
||||||
|
插件转换完成!
|
||||||
|
|
||||||
|
正在处理文件: packages/ui/certd-server/src/plugins/plugin-demo/plugins/plugin-test.js
|
||||||
开始转换插件: packages/ui/certd-server/src/plugins/plugin-demo/plugins/plugin-test.js
|
开始转换插件: packages/ui/certd-server/src/plugins/plugin-demo/plugins/plugin-test.js
|
||||||
插件模块导出了 1 个对象: DemoTest
|
插件模块导出了 1 个对象: DemoTest
|
||||||
处理插件: DemoTest
|
处理插件: DemoTest
|
||||||
插件类型: deploy
|
插件类型: task
|
||||||
脚本路径: packages/ui/certd-server/src/plugins/plugin-demo/plugins/plugin-test.js
|
脚本路径: packages/ui/certd-server/src/plugins/plugin-demo/plugins/plugin-test.js
|
||||||
|
|
||||||
生成的 YAML 配置:
|
生成的 YAML 配置:
|
||||||
name: DemoTest
|
name: DemoTest
|
||||||
title: Demo-测试插件
|
title: Demo-测试插件
|
||||||
desc: ""
|
desc: 这是一个示例任务插件,用于演示如何实现一个任务插件
|
||||||
icon: clarity:plugin-line
|
icon: clarity:plugin-line
|
||||||
|
pluginType: task
|
||||||
group: other
|
group: other
|
||||||
default:
|
|
||||||
strategy:
|
|
||||||
runStrategy: SkipWhenSucceed
|
|
||||||
pluginType: deploy
|
|
||||||
type: builtIn
|
type: builtIn
|
||||||
scriptFilePath: packages/ui/certd-server/src/plugins/plugin-demo/plugins/plugin-test.js
|
scriptFilePath: packages/ui/certd-server/src/plugins/plugin-demo/plugins/plugin-test.js
|
||||||
|
|
||||||
YAML 配置已保存到: ./metadata/deploy_DemoTest.yaml
|
YAML 配置已保存到: ./metadata/task_DemoTest.yaml
|
||||||
|
插件转换完成!
|
||||||
|
|
||||||
|
正在处理文件: packages/ui/certd-server/src/plugins/plugin-demo/dns-provider.js
|
||||||
|
开始转换插件: packages/ui/certd-server/src/plugins/plugin-demo/dns-provider.js
|
||||||
|
插件模块导出了 1 个对象: DemoDnsProvider
|
||||||
|
处理插件: DemoDnsProvider
|
||||||
|
插件类型: dns-provider
|
||||||
|
脚本路径: packages/ui/certd-server/src/plugins/plugin-demo/dns-provider.js
|
||||||
|
|
||||||
|
生成的 YAML 配置:
|
||||||
|
name: demo
|
||||||
|
title: Dns提供商Demo
|
||||||
|
desc: dns provider示例
|
||||||
|
icon: clarity:plugin-line
|
||||||
|
pluginType: dns-provider
|
||||||
|
accessType: demo
|
||||||
|
order: 99
|
||||||
|
type: builtIn
|
||||||
|
scriptFilePath: packages/ui/certd-server/src/plugins/plugin-demo/dns-provider.js
|
||||||
|
|
||||||
|
YAML 配置已保存到: ./metadata/dns-provider_demo.yaml
|
||||||
|
插件转换完成!
|
||||||
|
|
||||||
|
批量转换完成,共处理 3 个插件文件
|
||||||
|
```
|
||||||
|
|
||||||
|
### 示例 3: 自定义输出目录
|
||||||
|
|
||||||
|
#### 用户输入
|
||||||
|
|
||||||
|
将插件转换为 YAML 配置文件,并保存到自定义目录。
|
||||||
|
|
||||||
|
#### 你的回答
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# 自定义输出目录
|
||||||
|
node trae/skills/convert-plugin-to-yaml.js packages/ui/certd-server/src/plugins/plugin-demo/access.js --output ./configs
|
||||||
|
```
|
||||||
|
|
||||||
|
#### 输出
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ node trae/skills/convert-plugin-to-yaml.js packages/ui/certd-server/src/plugins/plugin-demo/access.js --output ./configs
|
||||||
|
开始转换插件: packages/ui/certd-server/src/plugins/plugin-demo/access.js
|
||||||
|
插件模块导出了 1 个对象: DemoAccess
|
||||||
|
处理插件: DemoAccess
|
||||||
|
插件类型: access
|
||||||
|
脚本路径: packages/ui/certd-server/src/plugins/plugin-demo/access.js
|
||||||
|
|
||||||
|
生成的 YAML 配置:
|
||||||
|
name: demo
|
||||||
|
title: 授权插件示例
|
||||||
|
desc: 这是一个示例授权插件,用于演示如何实现一个授权插件
|
||||||
|
icon: clarity:plugin-line
|
||||||
|
pluginType: access
|
||||||
|
type: builtIn
|
||||||
|
scriptFilePath: packages/ui/certd-server/src/plugins/plugin-demo/access.js
|
||||||
|
|
||||||
|
YAML 配置已保存到: ./configs/access_demo.yaml
|
||||||
插件转换完成!
|
插件转换完成!
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -174,14 +240,17 @@ YAML 配置已保存到: ./metadata/deploy_DemoTest.yaml
|
|||||||
### 常见问题
|
### 常见问题
|
||||||
|
|
||||||
1. **模块加载失败**
|
1. **模块加载失败**
|
||||||
|
|
||||||
- 原因:插件文件依赖未安装或路径错误
|
- 原因:插件文件依赖未安装或路径错误
|
||||||
- 解决:确保已安装所有依赖,检查文件路径是否正确
|
- 解决:确保已安装所有依赖,检查文件路径是否正确
|
||||||
|
|
||||||
2. **插件类型识别失败**
|
2. **插件类型识别失败**
|
||||||
|
|
||||||
- 原因:插件未正确继承基类或缺少必要的属性
|
- 原因:插件未正确继承基类或缺少必要的属性
|
||||||
- 解决:检查插件代码,确保正确继承对应的基类
|
- 解决:检查插件代码,确保正确继承对应的基类
|
||||||
|
|
||||||
3. **YAML 配置生成失败**
|
3. **YAML 配置生成失败**
|
||||||
|
|
||||||
- 原因:插件定义格式不正确
|
- 原因:插件定义格式不正确
|
||||||
- 解决:检查插件的 `define` 属性格式是否正确
|
- 解决:检查插件的 `define` 属性格式是否正确
|
||||||
|
|
||||||
@@ -196,6 +265,30 @@ YAML 配置已保存到: ./metadata/deploy_DemoTest.yaml
|
|||||||
- **尝试简化插件**:如果转换失败,尝试创建一个最小化的插件示例进行测试
|
- **尝试简化插件**:如果转换失败,尝试创建一个最小化的插件示例进行测试
|
||||||
- **检查依赖版本**:确保使用的依赖版本与 Certd 兼容
|
- **检查依赖版本**:确保使用的依赖版本与 Certd 兼容
|
||||||
|
|
||||||
## 总结
|
## 代码结构
|
||||||
|
|
||||||
插件转换工具是一个方便实用的工具,它可以帮助开发者快速生成插件的 YAML 配置文件,简化插件的注册和管理过程。通过命令行参数指定单个插件文件,工具会自动完成类型识别、配置生成和保存等操作,大大提高了插件开发和管理的效率。
|
### 主要函数
|
||||||
|
|
||||||
|
1. **isPrototypeOf(value, cls)**:检查对象是否是指定类的原型
|
||||||
|
2. **loadSingleModule(filePath)**:加载单个插件模块
|
||||||
|
3. **convertSinglePlugin(pluginPath)**:分析单个插件并生成 YAML 配置
|
||||||
|
4. **main()**:主函数,处理命令行参数并执行转换
|
||||||
|
|
||||||
|
### 导出函数
|
||||||
|
|
||||||
|
工具导出了以下函数,便于其他模块调用:
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
export {
|
||||||
|
convertSinglePlugin, // 转换单个插件
|
||||||
|
loadSingleModule, // 加载单个模块
|
||||||
|
isPrototypeOf, // 检查原型关系
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
|
## 应用场景
|
||||||
|
|
||||||
|
1. **插件开发**:在开发新插件时,快速生成配置文件
|
||||||
|
2. **插件调试**:查看插件的内部定义和配置
|
||||||
|
3. **插件管理**:批量转换现有插件为标准配置格式
|
||||||
|
4. **自动化构建**:集成到构建流程中,自动生成插件配置
|
||||||
|
|||||||
@@ -65,6 +65,7 @@ node .trae/skills/plugin-converter/resources/convert-plugin-to-yaml.js packages/
|
|||||||
```
|
```
|
||||||
|
|
||||||
例如:
|
例如:
|
||||||
|
|
||||||
- `access_demo.yaml`(Access 插件)
|
- `access_demo.yaml`(Access 插件)
|
||||||
- `deploy_DemoTest.yaml`(Task 插件)
|
- `deploy_DemoTest.yaml`(Task 插件)
|
||||||
- `dnsProvider_demo.yaml`(DNS Provider 插件)
|
- `dnsProvider_demo.yaml`(DNS Provider 插件)
|
||||||
|
|||||||
@@ -1,11 +1,11 @@
|
|||||||
// 转换单个插件为 YAML 配置的技能脚本
|
// 转换单个插件为 YAML 配置的技能脚本
|
||||||
|
|
||||||
import path from "path";
|
import path from 'path';
|
||||||
import fs from "fs";
|
import fs from 'fs';
|
||||||
import { pathToFileURL } from "node:url";
|
import { pathToFileURL } from 'node:url';
|
||||||
import * as yaml from "js-yaml";
|
import * as yaml from 'js-yaml';
|
||||||
import { AbstractTaskPlugin, BaseAccess, BaseNotification} from "@certd/pipeline";
|
import { AbstractTaskPlugin, BaseAccess, BaseNotification } from '@certd/pipeline';
|
||||||
import { BaseAddon} from "@certd/lib-server";
|
import { BaseAddon } from '@certd/lib-server';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* 检查对象是否是指定类的原型
|
* 检查对象是否是指定类的原型
|
||||||
@@ -38,18 +38,18 @@ async function convertSinglePlugin(pluginPath) {
|
|||||||
// 加载插件模块
|
// 加载插件模块
|
||||||
const module = await loadSingleModule(pluginPath);
|
const module = await loadSingleModule(pluginPath);
|
||||||
if (!module) {
|
if (!module) {
|
||||||
console.error("加载插件失败,退出");
|
console.error('加载插件失败,退出');
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
// 处理模块中的所有导出
|
// 处理模块中的所有导出
|
||||||
const entry = Object.entries(module);
|
const entry = Object.entries(module);
|
||||||
if (entry.length === 0) {
|
if (entry.length === 0) {
|
||||||
console.error("插件模块没有导出任何内容");
|
console.error('插件模块没有导出任何内容');
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
console.log(`插件模块导出了 ${entry.length} 个对象: ${entry.map(([name]) => name).join(", ")}`);
|
console.log(`插件模块导出了 ${entry.length} 个对象: ${entry.map(([name]) => name).join(', ')}`);
|
||||||
|
|
||||||
// 处理每个导出的对象
|
// 处理每个导出的对象
|
||||||
for (const [name, value] of entry) {
|
for (const [name, value] of entry) {
|
||||||
@@ -63,33 +63,33 @@ async function convertSinglePlugin(pluginPath) {
|
|||||||
|
|
||||||
// 构建插件定义
|
// 构建插件定义
|
||||||
const pluginDefine = {
|
const pluginDefine = {
|
||||||
...value.define
|
...value.define,
|
||||||
};
|
};
|
||||||
|
|
||||||
let subType = "";
|
let subType = '';
|
||||||
|
|
||||||
// 确定插件类型
|
// 确定插件类型
|
||||||
if (pluginDefine.accessType) {
|
if (pluginDefine.accessType) {
|
||||||
pluginDefine.pluginType = "dnsProvider";
|
pluginDefine.pluginType = 'dnsProvider';
|
||||||
} else if (isPrototypeOf(value, AbstractTaskPlugin)) {
|
} else if (isPrototypeOf(value, AbstractTaskPlugin)) {
|
||||||
pluginDefine.pluginType = "deploy";
|
pluginDefine.pluginType = 'deploy';
|
||||||
} else if (isPrototypeOf(value, BaseNotification)) {
|
} else if (isPrototypeOf(value, BaseNotification)) {
|
||||||
pluginDefine.pluginType = "notification";
|
pluginDefine.pluginType = 'notification';
|
||||||
} else if (isPrototypeOf(value, BaseAccess)) {
|
} else if (isPrototypeOf(value, BaseAccess)) {
|
||||||
pluginDefine.pluginType = "access";
|
pluginDefine.pluginType = 'access';
|
||||||
} else if (isPrototypeOf(value, BaseAddon)) {
|
} else if (isPrototypeOf(value, BaseAddon)) {
|
||||||
pluginDefine.pluginType = "addon";
|
pluginDefine.pluginType = 'addon';
|
||||||
subType = "_" + (pluginDefine.addonType || "");
|
subType = '_' + (pluginDefine.addonType || '');
|
||||||
} else {
|
} else {
|
||||||
console.log(`[warning] 未知的插件类型:${pluginDefine.name}`);
|
console.log(`[warning] 未知的插件类型:${pluginDefine.name}`);
|
||||||
continue;
|
continue;
|
||||||
}
|
}
|
||||||
|
|
||||||
pluginDefine.type = "builtIn";
|
pluginDefine.type = 'builtIn';
|
||||||
|
|
||||||
// 计算脚本文件路径
|
// 计算脚本文件路径
|
||||||
const relativePath = path.relative(process.cwd(), pluginPath);
|
const relativePath = path.relative(process.cwd(), pluginPath);
|
||||||
const scriptFilePath = relativePath.replace(/\\/g, "/").replace(/\.js$/, ".js");
|
const scriptFilePath = relativePath.replace(/\\/g, '/').replace(/\.js$/, '.js');
|
||||||
pluginDefine.scriptFilePath = scriptFilePath;
|
pluginDefine.scriptFilePath = scriptFilePath;
|
||||||
|
|
||||||
console.log(`插件类型: ${pluginDefine.pluginType}`);
|
console.log(`插件类型: ${pluginDefine.pluginType}`);
|
||||||
@@ -97,11 +97,11 @@ async function convertSinglePlugin(pluginPath) {
|
|||||||
|
|
||||||
// 生成 YAML 配置
|
// 生成 YAML 配置
|
||||||
const yamlContent = yaml.dump(pluginDefine);
|
const yamlContent = yaml.dump(pluginDefine);
|
||||||
console.log("\n生成的 YAML 配置:");
|
console.log('\n生成的 YAML 配置:');
|
||||||
console.log(yamlContent);
|
console.log(yamlContent);
|
||||||
|
|
||||||
// 可选:保存到文件
|
// 可选:保存到文件
|
||||||
const outputDir = "./metadata";
|
const outputDir = './metadata';
|
||||||
if (!fs.existsSync(outputDir)) {
|
if (!fs.existsSync(outputDir)) {
|
||||||
fs.mkdirSync(outputDir, { recursive: true });
|
fs.mkdirSync(outputDir, { recursive: true });
|
||||||
}
|
}
|
||||||
@@ -115,7 +115,7 @@ async function convertSinglePlugin(pluginPath) {
|
|||||||
return pluginDefine;
|
return pluginDefine;
|
||||||
}
|
}
|
||||||
|
|
||||||
console.error("未找到有效的插件定义");
|
console.error('未找到有效的插件定义');
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -125,8 +125,8 @@ async function main() {
|
|||||||
const args = process.argv.slice(2);
|
const args = process.argv.slice(2);
|
||||||
|
|
||||||
if (args.length === 0) {
|
if (args.length === 0) {
|
||||||
console.error("请指定插件文件路径");
|
console.error('请指定插件文件路径');
|
||||||
console.log("用法: node convert-plugin-to-yaml.js <插件文件路径>");
|
console.log('用法: node convert-plugin-to-yaml.js <插件文件路径>');
|
||||||
process.exit(1);
|
process.exit(1);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -139,9 +139,9 @@ async function main() {
|
|||||||
|
|
||||||
try {
|
try {
|
||||||
await convertSinglePlugin(pluginPath);
|
await convertSinglePlugin(pluginPath);
|
||||||
console.log("\n插件转换完成!");
|
console.log('\n插件转换完成!');
|
||||||
} catch (error) {
|
} catch (error) {
|
||||||
console.error("转换过程中出错:", error);
|
console.error('转换过程中出错:', error);
|
||||||
process.exit(1);
|
process.exit(1);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -152,9 +152,4 @@ if (import.meta.url === pathToFileURL(process.argv[1]).href) {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// 导出函数,以便其他模块使用
|
// 导出函数,以便其他模块使用
|
||||||
export {
|
export { convertSinglePlugin, loadSingleModule, isPrototypeOf };
|
||||||
convertSinglePlugin,
|
|
||||||
loadSingleModule,
|
|
||||||
isPrototypeOf
|
|
||||||
};
|
|
||||||
|
|
||||||
|
|||||||
@@ -1,197 +1,92 @@
|
|||||||
|
---
|
||||||
|
name: task-plugin-dev
|
||||||
|
description: 用于开发 Certd 系统中的 Task 插件,继承自 AbstractTaskPlugin 类,被流水线调用 execute 方法将证书部署到对应的应用上。当用户需要创建任务插件、部署证书、自动化任务或修改现有 Task 插件时触发。
|
||||||
|
version: 1.0.0
|
||||||
|
---
|
||||||
|
|
||||||
# Task 插件开发技能
|
# Task 插件开发技能
|
||||||
|
|
||||||
## 什么是 Task 插件
|
## 角色定义
|
||||||
|
|
||||||
Task 插件是 Certd 系统中的部署任务插件,它继承自 `AbstractTaskPlugin` 类,被流水线调用 `execute` 方法,将证书部署到对应的应用上。
|
你是一名 Certd 插件开发专家,擅长创建和实现 Task 类型的插件,熟悉 TypeScript 编程和 Certd 插件开发规范。
|
||||||
|
|
||||||
## 开发步骤
|
## 核心指令
|
||||||
|
|
||||||
### 1. 导入必要的依赖
|
请严格按照以下步骤执行任务:
|
||||||
|
|
||||||
|
1. **导入必要的依赖**
|
||||||
|
|
||||||
|
- 导入 `AbstractTaskPlugin`, `IsTaskPlugin`, `PageSearch`, `pluginGroups`, `RunStrategy`, `TaskInput` 等必要的类型和装饰器
|
||||||
|
- 导入 `CertInfo`, `CertReader` 等证书相关类型
|
||||||
|
- 导入 `createCertDomainGetterInputDefine`, `createRemoteSelectInputDefine` 等工具函数
|
||||||
|
- 导入 `optionsUtils` 等辅助工具
|
||||||
|
- 导入 `CertApplyPluginNames` 等常量
|
||||||
|
|
||||||
|
2. **使用 @IsTaskPlugin 注解注册插件**
|
||||||
|
|
||||||
|
- 配置插件的唯一标识、标题、图标
|
||||||
|
- 设置插件分组
|
||||||
|
- 配置默认策略(如 `SkipWhenSucceed`)
|
||||||
|
- 确保类名与插件名称一致
|
||||||
|
|
||||||
|
3. **定义任务输入参数**
|
||||||
|
|
||||||
|
- 使用 `@TaskInput` 注解定义各种输入参数
|
||||||
|
- 必须包含证书选择参数,用于获取前置任务输出的域名证书
|
||||||
|
- 可以添加授权选择框、文本输入、选择框等参数
|
||||||
|
- 使用 `createCertDomainGetterInputDefine` 获取证书域名列表
|
||||||
|
|
||||||
|
4. **实现动态显隐配置**
|
||||||
|
|
||||||
|
- 使用 `mergeScript` 实现根据其他输入值动态控制输入项的显隐状态
|
||||||
|
- 利用 `ctx.compute` 函数访问表单中的其他字段值
|
||||||
|
|
||||||
|
5. **实现插件方法**
|
||||||
|
|
||||||
|
- **onInstance 方法**:插件实例化时执行的初始化操作
|
||||||
|
- **execute 方法**:插件的核心执行逻辑
|
||||||
|
- 获取授权信息
|
||||||
|
- 读取证书信息
|
||||||
|
- 执行具体的部署逻辑
|
||||||
|
- 处理错误并记录日志
|
||||||
|
- 实现幂等性:确保重复执行不会导致问题
|
||||||
|
- 实现超时处理:设置合理的超时时间
|
||||||
|
- 实现回滚机制:在部署失败时能够回滚到之前的状态
|
||||||
|
- **后端获取选项方法**:用于前端从后端获取选项的方法
|
||||||
|
|
||||||
|
6. **遵循开发最佳实践**
|
||||||
|
- 插件命名:遵循命名规范,大写字母开头,驼峰命名
|
||||||
|
- 类名规范:类名应与插件名称一致
|
||||||
|
- 日志输出:使用 `this.logger` 输出日志
|
||||||
|
- 错误处理:捕获并记录执行过程中的错误
|
||||||
|
- 授权获取:使用 `this.getAccess(accessId)` 获取授权信息
|
||||||
|
|
||||||
|
## 输出规范
|
||||||
|
|
||||||
|
- 必须包含完整的插件实现代码
|
||||||
|
- 代码必须包含详细的注释说明
|
||||||
|
- 提供完整的示例代码,展示插件的使用方法
|
||||||
|
- 包含开发注意事项和最佳实践
|
||||||
|
|
||||||
|
## 示例
|
||||||
|
|
||||||
|
### 示例 1: 基本 Task 插件
|
||||||
|
|
||||||
|
#### 用户输入
|
||||||
|
|
||||||
|
创建一个 Task 插件,用于将证书部署到对应的应用上。
|
||||||
|
|
||||||
|
#### 你的回答
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { AbstractTaskPlugin, IsTaskPlugin, PageSearch, pluginGroups, RunStrategy, TaskInput } from '@certd/pipeline';
|
import { AbstractTaskPlugin, IsTaskPlugin, PageSearch, pluginGroups, RunStrategy, TaskInput } from '@certd/pipeline';
|
||||||
import { CertInfo, CertReader } from '@certd/plugin-cert';
|
import { CertInfo, CertReader } from '@certd/plugin-cert';
|
||||||
import { createCertDomainGetterInputDefine, createRemoteSelectInputDefine } from '@certd/plugin-lib';
|
import { createCertDomainGetterInputDefine, createRemoteSelectInputDefine } from '@certd/plugin-lib';
|
||||||
import { optionsUtils } from '@certd/basic';
|
import { optionsUtils } from '@certd/basic';
|
||||||
import { CertApplyPluginNames} from '@certd/plugin-cert';
|
import { CertApplyPluginNames } from '@certd/plugin-cert';
|
||||||
```
|
|
||||||
|
|
||||||
### 2. 使用 @IsTaskPlugin 注解注册插件
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
@IsTaskPlugin({
|
@IsTaskPlugin({
|
||||||
// 命名规范,插件类型+功能,大写字母开头,驼峰命名
|
//命名规范,插件类型+功能,大写字母开头,驼峰命名
|
||||||
name: 'DemoTest',
|
|
||||||
title: 'Demo-测试插件', // 插件标题
|
|
||||||
icon: 'clarity:plugin-line', // 插件图标
|
|
||||||
// 插件分组
|
|
||||||
group: pluginGroups.other.key,
|
|
||||||
default: {
|
|
||||||
// 默认值配置照抄即可
|
|
||||||
strategy: {
|
|
||||||
runStrategy: RunStrategy.SkipWhenSucceed,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
})
|
|
||||||
// 类名规范,跟上面插件名称(name)一致
|
|
||||||
export class DemoTest extends AbstractTaskPlugin {
|
|
||||||
// 插件实现...
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### 3. 定义任务输入参数
|
|
||||||
|
|
||||||
使用 `@TaskInput` 注解定义任务输入参数:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
// 测试参数
|
|
||||||
@TaskInput({
|
|
||||||
title: '属性示例',
|
|
||||||
value: '默认值',
|
|
||||||
component: {
|
|
||||||
// 前端组件配置,具体配置见组件文档 https://www.antdv.com/components/input-cn
|
|
||||||
name: 'a-input',
|
|
||||||
vModel: 'value', // 双向绑定组件的 props 名称
|
|
||||||
},
|
|
||||||
helper: '帮助说明,[链接](https://certd.docmirror.cn)',
|
|
||||||
required: false, // 是否必填
|
|
||||||
})
|
|
||||||
text!: string;
|
|
||||||
|
|
||||||
// 证书选择,此项必须要有
|
|
||||||
@TaskInput({
|
|
||||||
title: '域名证书',
|
|
||||||
helper: '请选择前置任务输出的域名证书',
|
|
||||||
component: {
|
|
||||||
name: 'output-selector',
|
|
||||||
from: [...CertApplyPluginNames],
|
|
||||||
},
|
|
||||||
// required: true, // 必填
|
|
||||||
})
|
|
||||||
cert!: CertInfo;
|
|
||||||
|
|
||||||
@TaskInput(createCertDomainGetterInputDefine({ props: { required: false } }))
|
|
||||||
// 前端可以展示,当前申请的证书域名列表
|
|
||||||
certDomains!: string[];
|
|
||||||
|
|
||||||
// 授权选择框
|
|
||||||
@TaskInput({
|
|
||||||
title: 'demo授权',
|
|
||||||
helper: 'demoAccess授权',
|
|
||||||
component: {
|
|
||||||
name: 'access-selector',
|
|
||||||
type: 'demo', // 固定授权类型
|
|
||||||
},
|
|
||||||
// rules: [{ required: true, message: '此项必填' }],
|
|
||||||
// required: true, // 必填
|
|
||||||
})
|
|
||||||
accessId!: string;
|
|
||||||
```
|
|
||||||
|
|
||||||
### 4. 实现插件方法
|
|
||||||
|
|
||||||
#### 4.1 插件实例化时执行的方法
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
// 插件实例化时执行的方法
|
|
||||||
async onInstance() {}
|
|
||||||
```
|
|
||||||
|
|
||||||
#### 4.2 插件执行方法
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
// 插件执行方法
|
|
||||||
async execute(): Promise<void> {
|
|
||||||
const { select, text, cert, accessId } = this;
|
|
||||||
|
|
||||||
try {
|
|
||||||
const access = await this.getAccess(accessId);
|
|
||||||
this.logger.debug('access', access);
|
|
||||||
} catch (e) {
|
|
||||||
this.logger.error('获取授权失败', e);
|
|
||||||
}
|
|
||||||
|
|
||||||
try {
|
|
||||||
const certReader = new CertReader(cert);
|
|
||||||
this.logger.debug('certReader', certReader);
|
|
||||||
} catch (e) {
|
|
||||||
this.logger.error('读取crt失败', e);
|
|
||||||
}
|
|
||||||
|
|
||||||
this.logger.info('DemoTestPlugin execute');
|
|
||||||
this.logger.info('text:', text);
|
|
||||||
this.logger.info('select:', select);
|
|
||||||
this.logger.info('switch:', this.switch);
|
|
||||||
this.logger.info('授权id:', accessId);
|
|
||||||
|
|
||||||
// 具体的部署逻辑
|
|
||||||
// ...
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
#### 4.3 后端获取选项方法
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
@TaskInput(
|
|
||||||
createRemoteSelectInputDefine({
|
|
||||||
title: '从后端获取选项',
|
|
||||||
helper: '选择时可以从后端获取选项',
|
|
||||||
action: DemoTest.prototype.onGetSiteList.name,
|
|
||||||
// 当以下参数变化时,触发获取选项
|
|
||||||
watches: ['certDomains', 'accessId'],
|
|
||||||
required: true,
|
|
||||||
})
|
|
||||||
)
|
|
||||||
siteName!: string | string[];
|
|
||||||
|
|
||||||
// 从后端获取选项的方法
|
|
||||||
async onGetSiteList(req: PageSearch) {
|
|
||||||
if (!this.accessId) {
|
|
||||||
throw new Error('请选择Access授权');
|
|
||||||
}
|
|
||||||
|
|
||||||
// @ts-ignore
|
|
||||||
const access = await this.getAccess(this.accessId);
|
|
||||||
|
|
||||||
// const siteRes = await access.GetDomainList(req);
|
|
||||||
// 以下是模拟数据
|
|
||||||
const siteRes = [
|
|
||||||
{ id: 1, siteName: 'site1.com' },
|
|
||||||
{ id: 2, siteName: 'site2.com' },
|
|
||||||
{ id: 3, siteName: 'site2.com' },
|
|
||||||
];
|
|
||||||
// 转换为前端所需要的格式
|
|
||||||
const options = siteRes.map((item: any) => {
|
|
||||||
return {
|
|
||||||
value: item.siteName,
|
|
||||||
label: item.siteName,
|
|
||||||
domain: item.siteName,
|
|
||||||
};
|
|
||||||
});
|
|
||||||
// 将站点域名名称根据证书域名进行匹配分组,分成匹配的和不匹配的两组选项,返回给前端,供用户选择
|
|
||||||
return optionsUtils.buildGroupOptions(options, this.certDomains);
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## 注意事项
|
|
||||||
|
|
||||||
1. **插件命名**:插件名称应遵循命名规范,大写字母开头,驼峰命名。
|
|
||||||
2. **类名规范**:类名应与插件名称(name)一致。
|
|
||||||
3. **证书选择**:必须包含证书选择参数,用于获取前置任务输出的域名证书。
|
|
||||||
4. **日志输出**:使用 `this.logger` 输出日志,而不是 `console`。
|
|
||||||
5. **错误处理**:执行过程中的错误应被捕获并记录。
|
|
||||||
6. **授权获取**:使用 `this.getAccess(accessId)` 获取授权信息。
|
|
||||||
|
|
||||||
## 完整示例
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
import { AbstractTaskPlugin, IsTaskPlugin, PageSearch, pluginGroups, RunStrategy, TaskInput } from '@certd/pipeline';
|
|
||||||
import { CertInfo, CertReader } from '@certd/plugin-cert';
|
|
||||||
import { createCertDomainGetterInputDefine, createRemoteSelectInputDefine } from '@certd/plugin-lib';
|
|
||||||
import { optionsUtils } from '@certd/basic';
|
|
||||||
import { CertApplyPluginNames} from '@certd/plugin-cert';
|
|
||||||
@IsTaskPlugin({
|
|
||||||
//命名规范,插件类型+功能(就是目录plugin-demo中的demo),大写字母开头,驼峰命名
|
|
||||||
name: 'DemoTest',
|
name: 'DemoTest',
|
||||||
title: 'Demo-测试插件',
|
title: 'Demo-测试插件',
|
||||||
icon: 'clarity:plugin-line',
|
icon: 'clarity:plugin-line',
|
||||||
@@ -240,7 +135,7 @@ export class DemoTest extends AbstractTaskPlugin {
|
|||||||
title: '动态显隐',
|
title: '动态显隐',
|
||||||
helper: '我会根据选择框的值进行显隐',
|
helper: '我会根据选择框的值进行显隐',
|
||||||
show: true, //动态计算的值会覆盖它
|
show: true, //动态计算的值会覆盖它
|
||||||
//动态计算脚本, mergeScript返回的对象会合并当前配置,此处演示 show的值会被动态计算结果覆盖,show的值根据用户选择的select的值决定
|
//动态计算脚本, mergeScript返回的对象会合并当前配置
|
||||||
mergeScript: `
|
mergeScript: `
|
||||||
return {
|
return {
|
||||||
show: ctx.compute(({form})=>{
|
show: ctx.compute(({form})=>{
|
||||||
@@ -278,6 +173,7 @@ export class DemoTest extends AbstractTaskPlugin {
|
|||||||
},
|
},
|
||||||
})
|
})
|
||||||
switch!: boolean;
|
switch!: boolean;
|
||||||
|
|
||||||
//证书选择,此项必须要有
|
//证书选择,此项必须要有
|
||||||
@TaskInput({
|
@TaskInput({
|
||||||
title: '域名证书',
|
title: '域名证书',
|
||||||
@@ -346,6 +242,7 @@ export class DemoTest extends AbstractTaskPlugin {
|
|||||||
this.logger.info('switch:', this.switch);
|
this.logger.info('switch:', this.switch);
|
||||||
this.logger.info('授权id:', accessId);
|
this.logger.info('授权id:', accessId);
|
||||||
|
|
||||||
|
// 具体的部署逻辑
|
||||||
// const res = await this.http.request({
|
// const res = await this.http.request({
|
||||||
// url: 'https://api.demo.com',
|
// url: 'https://api.demo.com',
|
||||||
// method: 'GET',
|
// method: 'GET',
|
||||||
@@ -382,7 +279,384 @@ export class DemoTest extends AbstractTaskPlugin {
|
|||||||
};
|
};
|
||||||
});
|
});
|
||||||
//将站点域名名称根据证书域名进行匹配分组,分成匹配的和不匹配的两组选项,返回给前端,供用户选择
|
//将站点域名名称根据证书域名进行匹配分组,分成匹配的和不匹配的两组选项,返回给前端,供用户选择
|
||||||
return optionsUtils.buildGroupOptions(options, this.certDomains);
|
return {
|
||||||
|
list: optionsUtils.buildGroupOptions(options, this.certDomains),
|
||||||
|
total: siteRes.length,
|
||||||
|
};
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### 示例 2: Nginx 部署 Task 插件
|
||||||
|
|
||||||
|
#### 用户输入
|
||||||
|
|
||||||
|
创建一个 Task 插件,用于将证书部署到 Nginx 服务器上。
|
||||||
|
|
||||||
|
#### 你的回答
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { AbstractTaskPlugin, CertInfo, IsTaskPlugin, TaskInput, pluginGroups, RunStrategy } from '@certd/pipeline';
|
||||||
|
import { CertReader } from '@certd/plugin-lib';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Nginx 证书部署插件
|
||||||
|
*/
|
||||||
|
@IsTaskPlugin({
|
||||||
|
name: 'NginxDeploy',
|
||||||
|
title: 'Nginx 部署',
|
||||||
|
desc: '将证书部署到 Nginx 服务器上',
|
||||||
|
icon: 'clarity:server-line',
|
||||||
|
group: pluginGroups.deploy.key,
|
||||||
|
default: {
|
||||||
|
strategy: {
|
||||||
|
runStrategy: RunStrategy.SkipWhenSucceed,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
})
|
||||||
|
export class NginxDeploy extends AbstractTaskPlugin {
|
||||||
|
/**
|
||||||
|
* 服务器授权
|
||||||
|
*/
|
||||||
|
@TaskInput({
|
||||||
|
title: '服务器授权',
|
||||||
|
component: {
|
||||||
|
name: 'access-selector',
|
||||||
|
vModel: 'accessId',
|
||||||
|
accessTypes: ['ssh'],
|
||||||
|
placeholder: '请选择服务器授权',
|
||||||
|
},
|
||||||
|
required: true,
|
||||||
|
})
|
||||||
|
accessId = '';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 域名证书
|
||||||
|
*/
|
||||||
|
@TaskInput({
|
||||||
|
title: '域名证书',
|
||||||
|
component: {
|
||||||
|
name: 'output-selector',
|
||||||
|
from: ['CertApply', 'CertApplyCloudflare'],
|
||||||
|
field: 'cert',
|
||||||
|
},
|
||||||
|
required: true,
|
||||||
|
})
|
||||||
|
cert!: CertInfo;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 证书路径
|
||||||
|
*/
|
||||||
|
@TaskInput({
|
||||||
|
title: '证书路径',
|
||||||
|
value: '/etc/nginx/ssl',
|
||||||
|
component: {
|
||||||
|
name: 'a-input',
|
||||||
|
placeholder: '请输入证书存储路径',
|
||||||
|
},
|
||||||
|
required: true,
|
||||||
|
})
|
||||||
|
certPath = '';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Nginx 配置文件路径
|
||||||
|
*/
|
||||||
|
@TaskInput({
|
||||||
|
title: 'Nginx 配置文件',
|
||||||
|
value: '/etc/nginx/conf.d',
|
||||||
|
component: {
|
||||||
|
name: 'a-input',
|
||||||
|
placeholder: '请输入 Nginx 配置文件路径',
|
||||||
|
},
|
||||||
|
required: true,
|
||||||
|
})
|
||||||
|
nginxConfPath = '';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 服务名称
|
||||||
|
*/
|
||||||
|
@TaskInput({
|
||||||
|
title: '服务名称',
|
||||||
|
component: {
|
||||||
|
name: 'a-input',
|
||||||
|
placeholder: '请输入服务名称(用于生成配置文件)',
|
||||||
|
},
|
||||||
|
required: true,
|
||||||
|
})
|
||||||
|
serviceName = '';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 执行部署
|
||||||
|
*/
|
||||||
|
async execute(): Promise<void> {
|
||||||
|
this.logger.info('开始部署证书到 Nginx');
|
||||||
|
|
||||||
|
try {
|
||||||
|
// 1. 获取服务器授权
|
||||||
|
const sshAccess = await this.getAccess(this.accessId);
|
||||||
|
this.logger.info('获取服务器授权成功');
|
||||||
|
|
||||||
|
// 2. 读取证书信息
|
||||||
|
const certReader = new CertReader(this.cert);
|
||||||
|
const cert = certReader.getCert();
|
||||||
|
const key = certReader.getKey();
|
||||||
|
const fullchain = certReader.getFullChain();
|
||||||
|
this.logger.info('读取证书信息成功');
|
||||||
|
|
||||||
|
// 3. 准备部署路径
|
||||||
|
const certFile = `${this.certPath}/${this.serviceName}.pem`;
|
||||||
|
const keyFile = `${this.certPath}/${this.serviceName}.key`;
|
||||||
|
const confFile = `${this.nginxConfPath}/${this.serviceName}.conf`;
|
||||||
|
|
||||||
|
// 4. 创建证书目录
|
||||||
|
await sshAccess.exec(`mkdir -p ${this.certPath}`);
|
||||||
|
this.logger.info('创建证书目录成功');
|
||||||
|
|
||||||
|
// 5. 上传证书文件
|
||||||
|
await sshAccess.uploadContent(cert, certFile);
|
||||||
|
await sshAccess.uploadContent(key, keyFile);
|
||||||
|
await sshAccess.uploadContent(fullchain, `${this.certPath}/${this.serviceName}-fullchain.pem`);
|
||||||
|
this.logger.info('上传证书文件成功');
|
||||||
|
|
||||||
|
// 6. 生成 Nginx 配置
|
||||||
|
const nginxConf = `server {
|
||||||
|
listen 443 ssl;
|
||||||
|
server_name ${this.cert.domains.join(' ')};
|
||||||
|
|
||||||
|
ssl_certificate ${certFile};
|
||||||
|
ssl_certificate_key ${keyFile};
|
||||||
|
ssl_protocols TLSv1.2 TLSv1.3;
|
||||||
|
ssl_ciphers ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384;
|
||||||
|
ssl_prefer_server_ciphers on;
|
||||||
|
|
||||||
|
location / {
|
||||||
|
proxy_pass http://localhost:80;
|
||||||
|
proxy_set_header Host $host;
|
||||||
|
proxy_set_header X-Real-IP $remote_addr;
|
||||||
|
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
`;
|
||||||
|
|
||||||
|
// 7. 上传 Nginx 配置
|
||||||
|
await sshAccess.uploadContent(nginxConf, confFile);
|
||||||
|
this.logger.info('上传 Nginx 配置成功');
|
||||||
|
|
||||||
|
// 8. 测试 Nginx 配置
|
||||||
|
const testResult = await sshAccess.exec('nginx -t');
|
||||||
|
if (testResult.includes('test is successful')) {
|
||||||
|
this.logger.info('Nginx 配置测试成功');
|
||||||
|
} else {
|
||||||
|
throw new Error(`Nginx 配置测试失败: ${testResult}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
// 9. 重启 Nginx 服务
|
||||||
|
await sshAccess.exec('systemctl reload nginx');
|
||||||
|
this.logger.info('重启 Nginx 服务成功');
|
||||||
|
|
||||||
|
this.logger.info('证书部署到 Nginx 成功');
|
||||||
|
} catch (error) {
|
||||||
|
this.logger.error('部署失败:', error);
|
||||||
|
throw new Error(`部署到 Nginx 失败: ${error.message}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 实例化插件
|
||||||
|
new NginxDeploy();
|
||||||
|
```
|
||||||
|
|
||||||
|
### 示例 3: 阿里云 OSS 部署 Task 插件
|
||||||
|
|
||||||
|
#### 用户输入
|
||||||
|
|
||||||
|
创建一个 Task 插件,用于将证书部署到阿里云 OSS 上。
|
||||||
|
|
||||||
|
#### 你的回答
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
import { AbstractTaskPlugin, CertInfo, IsTaskPlugin, TaskInput, pluginGroups, RunStrategy } from '@certd/pipeline';
|
||||||
|
import { CertReader } from '@certd/plugin-lib';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 阿里云 OSS 证书部署插件
|
||||||
|
*/
|
||||||
|
@IsTaskPlugin({
|
||||||
|
name: 'AliyunOSSDeploy',
|
||||||
|
title: '阿里云 OSS 部署',
|
||||||
|
desc: '将证书部署到阿里云 OSS 存储上',
|
||||||
|
icon: 'clarity:cloud-line',
|
||||||
|
group: pluginGroups.deploy.key,
|
||||||
|
default: {
|
||||||
|
strategy: {
|
||||||
|
runStrategy: RunStrategy.SkipWhenSucceed,
|
||||||
|
},
|
||||||
|
},
|
||||||
|
})
|
||||||
|
export class AliyunOSSDeploy extends AbstractTaskPlugin {
|
||||||
|
/**
|
||||||
|
* 阿里云授权
|
||||||
|
*/
|
||||||
|
@TaskInput({
|
||||||
|
title: '阿里云授权',
|
||||||
|
component: {
|
||||||
|
name: 'access-selector',
|
||||||
|
vModel: 'accessId',
|
||||||
|
accessTypes: ['aliyun'],
|
||||||
|
placeholder: '请选择阿里云授权',
|
||||||
|
},
|
||||||
|
required: true,
|
||||||
|
})
|
||||||
|
accessId = '';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 域名证书
|
||||||
|
*/
|
||||||
|
@TaskInput({
|
||||||
|
title: '域名证书',
|
||||||
|
component: {
|
||||||
|
name: 'output-selector',
|
||||||
|
from: ['CertApply', 'CertApplyCloudflare'],
|
||||||
|
field: 'cert',
|
||||||
|
},
|
||||||
|
required: true,
|
||||||
|
})
|
||||||
|
cert!: CertInfo;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* OSS 存储桶
|
||||||
|
*/
|
||||||
|
@TaskInput({
|
||||||
|
title: 'OSS 存储桶',
|
||||||
|
component: {
|
||||||
|
name: 'a-input',
|
||||||
|
placeholder: '请输入 OSS 存储桶名称',
|
||||||
|
},
|
||||||
|
required: true,
|
||||||
|
})
|
||||||
|
bucketName = '';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 存储路径
|
||||||
|
*/
|
||||||
|
@TaskInput({
|
||||||
|
title: '存储路径',
|
||||||
|
value: 'ssl/',
|
||||||
|
component: {
|
||||||
|
name: 'a-input',
|
||||||
|
placeholder: '请输入证书存储路径',
|
||||||
|
},
|
||||||
|
})
|
||||||
|
storagePath = '';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 执行部署
|
||||||
|
*/
|
||||||
|
async execute(): Promise<void> {
|
||||||
|
this.logger.info('开始部署证书到阿里云 OSS');
|
||||||
|
|
||||||
|
try {
|
||||||
|
// 1. 获取阿里云授权
|
||||||
|
const aliyunAccess = await this.getAccess(this.accessId);
|
||||||
|
this.logger.info('获取阿里云授权成功');
|
||||||
|
|
||||||
|
// 2. 读取证书信息
|
||||||
|
const certReader = new CertReader(this.cert);
|
||||||
|
const cert = certReader.getCert();
|
||||||
|
const key = certReader.getKey();
|
||||||
|
const fullchain = certReader.getFullChain();
|
||||||
|
this.logger.info('读取证书信息成功');
|
||||||
|
|
||||||
|
// 3. 准备存储路径
|
||||||
|
const basePath = this.storagePath.endsWith('/') ? this.storagePath : `${this.storagePath}/`;
|
||||||
|
const certFileName = `${basePath}${this.cert.domains[0]}.pem`;
|
||||||
|
const keyFileName = `${basePath}${this.cert.domains[0]}.key`;
|
||||||
|
const fullchainFileName = `${basePath}${this.cert.domains[0]}-fullchain.pem`;
|
||||||
|
|
||||||
|
// 4. 上传证书到 OSS
|
||||||
|
await aliyunAccess.uploadToOSS({
|
||||||
|
bucket: this.bucketName,
|
||||||
|
key: certFileName,
|
||||||
|
content: cert,
|
||||||
|
});
|
||||||
|
this.logger.info('上传证书文件成功');
|
||||||
|
|
||||||
|
await aliyunAccess.uploadToOSS({
|
||||||
|
bucket: this.bucketName,
|
||||||
|
key: keyFileName,
|
||||||
|
content: key,
|
||||||
|
});
|
||||||
|
this.logger.info('上传私钥文件成功');
|
||||||
|
|
||||||
|
await aliyunAccess.uploadToOSS({
|
||||||
|
bucket: this.bucketName,
|
||||||
|
key: fullchainFileName,
|
||||||
|
content: fullchain,
|
||||||
|
});
|
||||||
|
this.logger.info('上传完整证书链成功');
|
||||||
|
|
||||||
|
// 5. 设置文件访问权限(可选)
|
||||||
|
await aliyunAccess.setOSSObjectAcl({
|
||||||
|
bucket: this.bucketName,
|
||||||
|
key: certFileName,
|
||||||
|
acl: 'private',
|
||||||
|
});
|
||||||
|
|
||||||
|
await aliyunAccess.setOSSObjectAcl({
|
||||||
|
bucket: this.bucketName,
|
||||||
|
key: keyFileName,
|
||||||
|
acl: 'private',
|
||||||
|
});
|
||||||
|
|
||||||
|
await aliyunAccess.setOSSObjectAcl({
|
||||||
|
bucket: this.bucketName,
|
||||||
|
key: fullchainFileName,
|
||||||
|
acl: 'private',
|
||||||
|
});
|
||||||
|
this.logger.info('设置文件访问权限成功');
|
||||||
|
|
||||||
|
this.logger.info('证书部署到阿里云 OSS 成功');
|
||||||
|
} catch (error) {
|
||||||
|
this.logger.error('部署失败:', error);
|
||||||
|
throw new Error(`部署到阿里云 OSS 失败: ${error.message}`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// 实例化插件
|
||||||
|
new AliyunOSSDeploy();
|
||||||
|
```
|
||||||
|
|
||||||
|
## 注意事项
|
||||||
|
|
||||||
|
1. **插件命名**:插件名称应遵循命名规范,大写字母开头,驼峰命名。
|
||||||
|
2. **类名规范**:类名应与插件名称(name)一致。
|
||||||
|
3. **证书选择**:必须包含证书选择参数,用于获取前置任务输出的域名证书。
|
||||||
|
4. **日志输出**:使用 `this.logger` 输出日志,而不是 `console`,参数文本化,不要传对象,否则会输出`[object Object]}`。
|
||||||
|
5. **错误处理**:执行过程中的错误应被捕获并记录。
|
||||||
|
6. **授权获取**:使用 `this.getAccess(accessId)` 获取授权信息。
|
||||||
|
|
||||||
|
## 部署逻辑注意事项
|
||||||
|
|
||||||
|
1. **部署接口逻辑**:
|
||||||
|
|
||||||
|
- 研究应用的部署接口逻辑,一般有两种:
|
||||||
|
a. 用户选择网站ID,给网站部署新证书
|
||||||
|
b. 用户选择证书ID,只需要更新证书即可
|
||||||
|
- 保证多次执行都能针对同一个对象部署证书
|
||||||
|
- 确保出错后重新运行能够回归到正常状态
|
||||||
|
|
||||||
|
2. **前置证书选择**:
|
||||||
|
|
||||||
|
- 前置证书可以是原始的 `certInfo` 类型,也可能是上传到平台之后返回的证书id
|
||||||
|
- 根据接口要求选择合适的证书类型:
|
||||||
|
a. 如果接口需要上传后的证书id,那么部署时要先将证书上传,再部署
|
||||||
|
b. 如果接口需要原始的 `certInfo` 类型,那么直接使用 `certInfo` 部署证书
|
||||||
|
c. 当两者都支持时,判断用户选择的证书类型,再考虑优先上传再部署
|
||||||
|
|
||||||
|
3. **证书清理**:
|
||||||
|
- 如果是先上传再部署的,那么在部署完成后,可能需要考虑清理证书
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
```
|
||||||
|
|||||||
@@ -9,7 +9,7 @@ import { AbstractTaskPlugin, IsTaskPlugin, PageSearch, pluginGroups, RunStrategy
|
|||||||
import { CertInfo, CertReader } from '@certd/plugin-cert';
|
import { CertInfo, CertReader } from '@certd/plugin-cert';
|
||||||
import { createCertDomainGetterInputDefine, createRemoteSelectInputDefine } from '@certd/plugin-lib';
|
import { createCertDomainGetterInputDefine, createRemoteSelectInputDefine } from '@certd/plugin-lib';
|
||||||
import { optionsUtils } from '@certd/basic';
|
import { optionsUtils } from '@certd/basic';
|
||||||
import { CertApplyPluginNames} from '@certd/plugin-cert';
|
import { CertApplyPluginNames } from '@certd/plugin-cert';
|
||||||
```
|
```
|
||||||
|
|
||||||
### 2. 使用 @IsTaskPlugin 注解注册插件
|
### 2. 使用 @IsTaskPlugin 注解注册插件
|
||||||
|
|||||||
@@ -1,83 +1,99 @@
|
|||||||
{
|
{
|
||||||
// 使用 IntelliSense 了解相关属性。
|
// 使用 IntelliSense 了解相关属性。
|
||||||
// 悬停以查看现有属性的描述。
|
// 悬停以查看现有属性的描述。
|
||||||
// 欲了解更多信息,请访问: https://go.microsoft.com/fwlink/?linkid=830387
|
// 欲了解更多信息,请访问: https://go.microsoft.com/fwlink/?linkid=830387
|
||||||
"version": "0.2.0",
|
"version": "0.2.0",
|
||||||
"configurations": [
|
"configurations": [
|
||||||
|
{
|
||||||
{
|
"name": "client",
|
||||||
"name": "client",
|
"type": "node",
|
||||||
"type": "node",
|
"request": "launch",
|
||||||
"request": "launch",
|
"cwd": "${workspaceFolder}/packages/ui/certd-client",
|
||||||
"cwd": "${workspaceFolder}/packages/ui/certd-client",
|
"runtimeExecutable": "pnpm",
|
||||||
"runtimeExecutable": "pnpm",
|
"runtimeArgs": ["dev"],
|
||||||
"runtimeArgs": ["dev"],
|
"console": "integratedTerminal",
|
||||||
"console": "integratedTerminal",
|
"internalConsoleOptions": "neverOpen"
|
||||||
"internalConsoleOptions": "neverOpen"
|
},
|
||||||
},
|
{
|
||||||
{
|
"name": "server",
|
||||||
"name": "server",
|
"type": "node",
|
||||||
"type": "node",
|
"request": "launch",
|
||||||
"request": "launch",
|
"cwd": "${workspaceFolder}/packages/ui/certd-server",
|
||||||
"cwd": "${workspaceFolder}/packages/ui/certd-server",
|
"runtimeExecutable": "pnpm",
|
||||||
"runtimeExecutable": "pnpm",
|
"runtimeArgs": ["dev"],
|
||||||
"runtimeArgs": ["dev"],
|
"console": "integratedTerminal",
|
||||||
"console": "integratedTerminal",
|
"internalConsoleOptions": "neverOpen"
|
||||||
"internalConsoleOptions": "neverOpen"
|
},
|
||||||
},
|
{
|
||||||
{
|
"name": "server-mysql",
|
||||||
"name": "server-mysql",
|
"type": "node",
|
||||||
"type": "node",
|
"request": "launch",
|
||||||
"request": "launch",
|
"cwd": "${workspaceFolder}/packages/ui/certd-server",
|
||||||
"cwd": "${workspaceFolder}/packages/ui/certd-server",
|
"runtimeExecutable": "pnpm",
|
||||||
"runtimeExecutable": "pnpm",
|
"runtimeArgs": ["dev-mysql"],
|
||||||
"runtimeArgs": ["dev-mysql"],
|
"console": "integratedTerminal",
|
||||||
"console": "integratedTerminal",
|
"internalConsoleOptions": "neverOpen"
|
||||||
"internalConsoleOptions": "neverOpen"
|
},
|
||||||
},
|
{
|
||||||
{
|
"name": "server-pg",
|
||||||
"name": "server-pg",
|
"type": "node",
|
||||||
"type": "node",
|
"request": "launch",
|
||||||
"request": "launch",
|
"cwd": "${workspaceFolder}/packages/ui/certd-server",
|
||||||
"cwd": "${workspaceFolder}/packages/ui/certd-server",
|
"runtimeExecutable": "pnpm",
|
||||||
"runtimeExecutable": "pnpm",
|
"runtimeArgs": ["dev-pg"],
|
||||||
"runtimeArgs": ["dev-pg"],
|
"console": "integratedTerminal",
|
||||||
"console": "integratedTerminal",
|
"internalConsoleOptions": "neverOpen"
|
||||||
"internalConsoleOptions": "neverOpen"
|
},
|
||||||
},
|
{
|
||||||
{
|
"name": "server-pgpl",
|
||||||
"name": "server-pgpl",
|
"type": "node",
|
||||||
"type": "node",
|
"request": "launch",
|
||||||
"request": "launch",
|
"cwd": "${workspaceFolder}/packages/ui/certd-server",
|
||||||
"cwd": "${workspaceFolder}/packages/ui/certd-server",
|
"runtimeExecutable": "pnpm",
|
||||||
"runtimeExecutable": "pnpm",
|
"runtimeArgs": ["dev-pgpl"],
|
||||||
"runtimeArgs": ["dev-pgpl"],
|
"console": "integratedTerminal",
|
||||||
"console": "integratedTerminal",
|
"internalConsoleOptions": "neverOpen"
|
||||||
"internalConsoleOptions": "neverOpen"
|
},
|
||||||
},
|
{
|
||||||
{
|
"name": "server-common",
|
||||||
"name": "server-common",
|
"type": "node",
|
||||||
"type": "node",
|
"request": "launch",
|
||||||
"request": "launch",
|
"cwd": "${workspaceFolder}/packages/ui/certd-server",
|
||||||
"cwd": "${workspaceFolder}/packages/ui/certd-server",
|
"runtimeExecutable": "pnpm",
|
||||||
"runtimeExecutable": "pnpm",
|
"runtimeArgs": ["dev-commpro"],
|
||||||
"runtimeArgs": ["dev-commpro"],
|
"console": "integratedTerminal",
|
||||||
"console": "integratedTerminal",
|
"internalConsoleOptions": "neverOpen"
|
||||||
"internalConsoleOptions": "neverOpen"
|
},
|
||||||
},
|
{
|
||||||
{
|
"name": "server-new",
|
||||||
"name": "server-local-plus",
|
"type": "node",
|
||||||
"type": "node",
|
"request": "launch",
|
||||||
"request": "launch",
|
"cwd": "${workspaceFolder}/packages/ui/certd-server",
|
||||||
"cwd": "${workspaceFolder}/packages/ui/certd-server",
|
"runtimeExecutable": "pnpm",
|
||||||
"runtimeExecutable": "npm",
|
"runtimeArgs": ["dev-new"],
|
||||||
"runtimeArgs": ["run", "dev-localplus"],
|
"console": "integratedTerminal",
|
||||||
"console": "integratedTerminal",
|
"internalConsoleOptions": "neverOpen"
|
||||||
"internalConsoleOptions": "neverOpen",
|
},
|
||||||
"env": {
|
{
|
||||||
"plus_use_prod": "false",
|
"name": "server-local-plus",
|
||||||
"PLUS_SERVER_BASE_URL": "http://127.0.0.1:11007"
|
"type": "node",
|
||||||
}
|
"request": "launch",
|
||||||
}
|
"cwd": "${workspaceFolder}/packages/ui/certd-server",
|
||||||
]
|
"runtimeExecutable": "npm",
|
||||||
|
"runtimeArgs": ["run", "dev-localplus"],
|
||||||
|
"console": "integratedTerminal",
|
||||||
|
"internalConsoleOptions": "neverOpen",
|
||||||
|
"env": {
|
||||||
|
"plus_use_prod": "false",
|
||||||
|
"PLUS_SERVER_BASE_URL": "http://127.0.0.1:11007"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"compounds": [
|
||||||
|
{
|
||||||
|
"name": "all",
|
||||||
|
"configurations": ["server", "client"],
|
||||||
|
"stopAll": false
|
||||||
|
}
|
||||||
|
]
|
||||||
}
|
}
|
||||||
@@ -1,24 +1,23 @@
|
|||||||
{
|
{
|
||||||
"eslint.debug": false,
|
"eslint.debug": false,
|
||||||
"eslint.format.enable": true,
|
"eslint.format.enable": true,
|
||||||
"typescript.tsc.autoDetect": "watch",
|
"typescript.tsc.autoDetect": "watch",
|
||||||
"git.scanRepositories": [
|
"git.scanRepositories": ["./packages/pro"],
|
||||||
"./packages/pro"
|
"editor.defaultFormatter": "dbaeumer.vscode-eslint",
|
||||||
],
|
"[typescript]": {
|
||||||
"editor.defaultFormatter": "dbaeumer.vscode-eslint",
|
"editor.defaultFormatter": "vscode.typescript-language-features"
|
||||||
"[typescript]": {
|
},
|
||||||
"editor.defaultFormatter": "vscode.typescript-language-features"
|
"editor.tabSize": 2,
|
||||||
},
|
"explorer.autoReveal": false,
|
||||||
"editor.tabSize": 2,
|
"[javascript]": {
|
||||||
"explorer.autoReveal": false,
|
"editor.defaultFormatter": "vscode.typescript-language-features"
|
||||||
"[javascript]": {
|
},
|
||||||
"editor.defaultFormatter": "vscode.typescript-language-features"
|
"[less]": {
|
||||||
},
|
"editor.defaultFormatter": "vscode.css-language-features"
|
||||||
"[less]": {
|
},
|
||||||
"editor.defaultFormatter": "vscode.css-language-features"
|
"scm.repositories.visible": 9,
|
||||||
},
|
"scm.repositories.explorer": false,
|
||||||
"scm.repositories.visible": 9,
|
"scm.repositories.selectionMode": "multiple",
|
||||||
"scm.repositories.explorer": false,
|
"scm.repositories.sortOrder": "discovery time",
|
||||||
"scm.repositories.selectionMode": "multiple",
|
"git.ignoreLimitWarning": true
|
||||||
"scm.repositories.sortOrder": "discovery time"
|
|
||||||
}
|
}
|
||||||
@@ -1,52 +1,52 @@
|
|||||||
{
|
{
|
||||||
"version": "2.0.0",
|
"version": "2.0.0",
|
||||||
"tasks": [
|
"tasks": [
|
||||||
{
|
{
|
||||||
"label": "启动Client",
|
"label": "启动Client",
|
||||||
"type": "shell",
|
"type": "shell",
|
||||||
"command": "npm",
|
"command": "npm",
|
||||||
"args": ["run", "dev"],
|
"args": ["run", "dev"],
|
||||||
"options": {
|
"options": {
|
||||||
"cwd": "${workspaceFolder}/packages/ui/certd-client"
|
"cwd": "${workspaceFolder}/packages/ui/certd-client"
|
||||||
},
|
},
|
||||||
"group": {
|
"group": {
|
||||||
"kind": "build",
|
"kind": "build",
|
||||||
"isDefault": true
|
"isDefault": true
|
||||||
},
|
},
|
||||||
"presentation": {
|
"presentation": {
|
||||||
"echo": true,
|
"echo": true,
|
||||||
"reveal": "always",
|
"reveal": "always",
|
||||||
"focus": false,
|
"focus": false,
|
||||||
"panel": "shared"
|
"panel": "shared"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"label": "启动Server",
|
"label": "启动Server",
|
||||||
"type": "shell",
|
"type": "shell",
|
||||||
"command": "npm",
|
"command": "npm",
|
||||||
"args": ["run", "dev"],
|
"args": ["run", "dev"],
|
||||||
"options": {
|
"options": {
|
||||||
"cwd": "${workspaceFolder}/packages/ui/certd-server"
|
"cwd": "${workspaceFolder}/packages/ui/certd-server"
|
||||||
},
|
},
|
||||||
"group": {
|
"group": {
|
||||||
"kind": "build",
|
"kind": "build",
|
||||||
"isDefault": true
|
"isDefault": true
|
||||||
},
|
},
|
||||||
"presentation": {
|
"presentation": {
|
||||||
"echo": true,
|
"echo": true,
|
||||||
"reveal": "always",
|
"reveal": "always",
|
||||||
"focus": false,
|
"focus": false,
|
||||||
"panel": "shared"
|
"panel": "shared"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"label": "同时启动Client和Server",
|
"label": "同时启动Client和Server",
|
||||||
"dependsOn": ["启动Client", "启动Server"],
|
"dependsOn": ["启动Client", "启动Server"],
|
||||||
"group": {
|
"group": {
|
||||||
"kind": "build",
|
"kind": "build",
|
||||||
"isDefault": true
|
"isDefault": true
|
||||||
},
|
},
|
||||||
"problemMatcher": []
|
"problemMatcher": []
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
@@ -0,0 +1,71 @@
|
|||||||
|
# Certd 开发 Agent 上下文
|
||||||
|
|
||||||
|
这个文件是给在本仓库工作的开发 agent 看的常驻项目说明。进入仓库后先读本文,再按任务读取对应导航或规则文件,避免每次重新全量扫描项目。
|
||||||
|
|
||||||
|
仓库代码导航、目录地图、常用入口和参考文件见 `.codex/repo-map.md`。更细的开发规则拆在 `.codex/agent-rules/` 下;本文只保留最高优先级的规则、架构边界和工作方式。
|
||||||
|
|
||||||
|
## 项目定位
|
||||||
|
|
||||||
|
Certd 是支持私有化部署的 SSL/TLS 证书自动化管理平台,提供 Web 管理台和后端服务,用于证书申请、续期、部署、监控、通知和开放 API 集成。
|
||||||
|
|
||||||
|
核心产品模型是“证书流水线”:
|
||||||
|
|
||||||
|
- 通过 ACME 申请证书
|
||||||
|
- 使用 DNS-01、HTTP-01、CNAME 代理或服务商集成完成域名验证
|
||||||
|
- 将证书转换或导出为 pem、pfx、der、jks、p7b 等格式
|
||||||
|
- 部署证书到主机、Nginx、Kubernetes、CDN、云厂商、面板等目标
|
||||||
|
- 通知用户,并监控站点证书过期时间
|
||||||
|
|
||||||
|
系统会保存证书、云厂商凭据、SSH 信息、API Key 等敏感数据,始终按私有化/本地部署产品处理,避免泄露本地数据和配置。
|
||||||
|
|
||||||
|
## 必读索引
|
||||||
|
|
||||||
|
- `.codex/repo-map.md`:仓库结构、后端/前端入口、流水线与插件地图、验证命令
|
||||||
|
- `.codex/agent-rules/backend.md`:后端、数据库迁移、文件上传、service/事务约定
|
||||||
|
- `.codex/agent-rules/frontend.md`:前端、Fast Crud、弹窗表单、格式化和禁跑命令
|
||||||
|
- `.codex/agent-rules/plugins.md`:流水线、插件归属、ACME/EAB、插件开发技能
|
||||||
|
- `.codex/agent-rules/testing.md`:测试优先策略、单测位置、ESM mock、聚焦验证
|
||||||
|
- `.codex/agent-rules/coding-style.md`:注释、可读性、DRY、单一职责等通用代码风格
|
||||||
|
|
||||||
|
## 仓库边界
|
||||||
|
|
||||||
|
这是一个 pnpm + lerna 的 monorepo。核心定位:
|
||||||
|
|
||||||
|
- `packages/ui/certd-server`:后端服务
|
||||||
|
- `packages/ui/certd-client`:前端 Web 管理台
|
||||||
|
- `packages/core/pipeline`:流水线核心
|
||||||
|
- `packages/core/acme-client`:ACME 协议客户端
|
||||||
|
- `packages/plugins/plugin-lib`:通用插件辅助能力和证书相关共享代码
|
||||||
|
|
||||||
|
`packages/pro/` 是独立 Git 工作区,使用 `packages/pro/.git` 管理。根仓库的 `git status` / `git diff` 默认看不到这里的实际改动;修改商业版代码后,要在 `packages/pro` 目录内单独执行 `git status` / `git diff` 检查。
|
||||||
|
|
||||||
|
## 硬性规则
|
||||||
|
|
||||||
|
- 根包管理器是 pnpm,不要引入 npm/yarn lockfile。
|
||||||
|
- 不要主动运行 `pnpm install`;用户会事先准备好 `node_modules`。如果 `pnpm install` 或测试因缺少依赖、TTY、网络问题失败,停止尝试并告知用户环境问题。
|
||||||
|
- 前端不要运行 `pnpm tsc` / `vue-tsc`;当前依赖组合中 `vue-tsc@1.8.27` 会抛无效内部错误。前端 `test:unit` 只是占位脚本。
|
||||||
|
- 不要把 `packages/ui/certd-server/data/`、`logs/`、生成的 metadata/dist 等运行时或构建产物纳入改动,除非任务明确要求。
|
||||||
|
- 做数据库结构变更时,添加或更新迁移脚本,不要依赖 TypeORM 自动同步。
|
||||||
|
- 做插件相关任务时,先读取对应 `.trae/skills/<skill>/SKILL.md`,再进入具体实现。
|
||||||
|
- 后端 service 拼接可选 `projectId` 查询条件时,不要直接写 `{ userId, projectId }`;应使用 `BaseService.buildUserProjectQuery(userId, projectId)`,只有 `projectId != null` 时才加入查询条件。
|
||||||
|
|
||||||
|
## 工作方式
|
||||||
|
|
||||||
|
- 先读本文;需要代码导航、目录入口、参考文件或验证命令时读 `.codex/repo-map.md`。
|
||||||
|
- 任务涉及后端、前端、插件、测试或代码风格时,先读取 `.codex/agent-rules/` 下对应规则文件,再查看具体代码。
|
||||||
|
- 在 PowerShell 中读取中文、Markdown、locale、文档类文件时,显式使用 `Get-Content -Encoding utf8`;如果仍乱码,再执行 `[Console]::OutputEncoding = [System.Text.UTF8Encoding]::new()` 后重试。
|
||||||
|
- 做后端任务时,先定位 `packages/ui/certd-server/src/modules` 下的模块,以及相关 entity/service/controller。
|
||||||
|
- 做前端任务时,先定位 `packages/ui/certd-client/src/views/certd` 下的页面,再找对应 `src/api`。
|
||||||
|
- 做服务商、DNS、部署、通知相关任务时,先看 `packages/ui/certd-server/src/plugins`,再看 `packages/plugins/plugin-lib` 里的共享辅助能力。
|
||||||
|
- 优先沿用现有模块、插件、服务模式,再考虑新增抽象;避免为了形式上的“复用”制造过度设计。
|
||||||
|
- 实现新功能或修复行为缺陷前,优先补对应单元测试并确认红灯,再实现代码并跑聚焦验证。确实不适合先写测试时,在回复中说明原因和替代验证方式。
|
||||||
|
- 后补单元测试时,先按正确行为写预期;如果红灯需要修改既有实现,先向用户确认这是 bug 还是既有需求,避免未经确认改变行为。
|
||||||
|
- 优先对改动包运行聚焦测试或格式化/ESLint;只有跨包影响明显时再考虑更大范围构建。
|
||||||
|
|
||||||
|
## 架构边界
|
||||||
|
|
||||||
|
插件是核心能力,不是边缘功能。新增服务商、DNS 验证、证书部署、通知方式等能力,通常应该放在插件包里,或放在 `packages/ui/certd-server/src/plugins/<plugin-name>/` 下。
|
||||||
|
|
||||||
|
修改证书申请、验证、部署或通知行为时,先判断改动属于 ACME client、pipeline 核心抽象、后端 module/service/entity/controller、具体插件实现,还是前端 view/form/schema。
|
||||||
|
|
||||||
|
如果只是某个服务商或部署目标的问题,不要轻易修改共享 pipeline/core 行为,除非确实是可复用的公共能力。
|
||||||
@@ -3,6 +3,363 @@
|
|||||||
All notable changes to this project will be documented in this file.
|
All notable changes to this project will be documented in this file.
|
||||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||||
|
|
||||||
|
## [1.41.1](https://github.com/certd/certd/compare/v1.41.0...v1.41.1) (2026-06-05)
|
||||||
|
|
||||||
|
### Performance Improvements
|
||||||
|
|
||||||
|
* 流水线、监控站点支持导出 ([99fd308](https://github.com/certd/certd/commit/99fd3083f259cdb96fd656f04858dd708d1251c7))
|
||||||
|
* 优化列表页面请求两次的问题 ([5546af5](https://github.com/certd/certd/commit/5546af518e92c765513787ccaf8e856be789bcf9))
|
||||||
|
* 优化邀请注册流程 ([7a71e45](https://github.com/certd/certd/commit/7a71e45799d782d0691606fb42b4236f1d3009b0))
|
||||||
|
* **settings:** 新增NO_PROXY代理排除配置 ([c0df8be](https://github.com/certd/certd/commit/c0df8be83237e323c2c9a5bd02507430a86a00cc))
|
||||||
|
* **volcengine-vke:** 火山VKE集群证书支持两种类型的证书保密字典 ([77b8024](https://github.com/certd/certd/commit/77b802445322d576d54d194f7c505da49e0e824c))
|
||||||
|
|
||||||
|
# [1.41.0](https://github.com/certd/certd/compare/v1.40.5...v1.41.0) (2026-06-04)
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* 修复阿里云证书订单orderid 选择出错的问题 ([41254d1](https://github.com/certd/certd/commit/41254d10b748a2d3e6ba43c7e11411650c748d1b))
|
||||||
|
* **monitor:** 修复开放接口自动创建证书流水线重复触发和等待时间不足的问题 ([91d5c90](https://github.com/certd/certd/commit/91d5c90eb0eaf65c81dddbd2d4d4b404cb8b4d07))
|
||||||
|
* **pipeline:** 修复批量随机修改定时没有生效的bug ([2e19dda](https://github.com/certd/certd/commit/2e19dda72e70b525a7c269e18e963a5ee602f59f))
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
* 商业版支持邀请返佣功能 ([f9a310b](https://github.com/certd/certd/commit/f9a310b6c3bbf30f221482a0c59e9c30080bdfc8))
|
||||||
|
* 商业版支持邀请推广功能 ([f1d2a10](https://github.com/certd/certd/commit/f1d2a1033a0f8d3dbd91fc9793e07bd0b858b539))
|
||||||
|
* 新增管理员针对用户流水线和证书监控管理功能 ([0211552](https://github.com/certd/certd/commit/021155278e7375f8487b0531ed1b5ad52512f007))
|
||||||
|
* 新增套餐激活码功能,通过CDK兑换套餐 ([81d6289](https://github.com/certd/certd/commit/81d6289a8631b073b49f24dee4b14bb1c8f31071))
|
||||||
|
* 新增推广等级激励功能 ([5096df5](https://github.com/certd/certd/commit/5096df5cc0d8f0ad8aa327b8e2a900ba23714bd8))
|
||||||
|
* 新增证书申请参数模版管理,开放接口支持使用证书参数模版和指定证书申请参数 ([f8b71a0](https://github.com/certd/certd/commit/f8b71a0e612fad527cf49136335e0b46f0f379cd))
|
||||||
|
* 支持dns-persist-01持久化验证方式申请证书,优化Acme账号的存储方式 ([67b05e2](https://github.com/certd/certd/commit/67b05e2d75e96b9f855e1ca0b3d0d8d03b92d8e6))
|
||||||
|
|
||||||
|
### Performance Improvements
|
||||||
|
|
||||||
|
* 插件全局配置支持下拉选项自定义映射功能 ([c637985](https://github.com/certd/certd/commit/c637985575b09196b04cce37ac14fbe68c029bde))
|
||||||
|
* 商业版提现增加收款二维码上传 ([83a5a21](https://github.com/certd/certd/commit/83a5a21f956e50942541f1532f3a8dcaa5821d34))
|
||||||
|
* **aliyun-apig:** 优化阿里云API网关部署插件的查询及翻页 ([3e4b7f3](https://github.com/certd/certd/commit/3e4b7f30ac6f3c976c8274bdf256c69b8a2c46db))
|
||||||
|
* **trade:** 优化商品购买页面的规格展示和折扣计算,支持订单取消 ([6624769](https://github.com/certd/certd/commit/66247690326ce2789900fc9110c08b3502cea655))
|
||||||
|
|
||||||
|
## [1.40.5](https://github.com/certd/certd/compare/v1.40.4...v1.40.5) (2026-05-26)
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* 安装glibc,增加Alpine镜像下 dns解析结果的兼容性 ([1a08bd3](https://github.com/certd/certd/commit/1a08bd340e1e7d3f9acf5d40f7bba7998459b8fb))
|
||||||
|
* 修复阿里云证书订单orderid 选择出错的问题 ([af9047b](https://github.com/certd/certd/commit/af9047bf3c54ce71b11727ccc6220288ed1f57be))
|
||||||
|
* 修复查询阿里云cdn Dcdn 域名太多无法选择的bug ([346fb73](https://github.com/certd/certd/commit/346fb730a37e035576f5d9ea5c0d74c052b34aeb))
|
||||||
|
|
||||||
|
## [1.40.4](https://github.com/certd/certd/compare/v1.40.3...v1.40.4) (2026-05-24)
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* **pipeline-service:** 修复流水线运行时超过套餐部署次数仍然能够正常运行的bug ([5e59651](https://github.com/certd/certd/commit/5e59651d45bc91919629e35995ff1b3cff6b87ea))
|
||||||
|
|
||||||
|
### Performance Improvements
|
||||||
|
|
||||||
|
* 商业版套餐只支持设置为可叠加 ([5e72f75](https://github.com/certd/certd/commit/5e72f75395fb632a30e80c07d35d8ba40ef631fa))
|
||||||
|
* 新增阿里云直播证书部署插件 ([8edb6f8](https://github.com/certd/certd/commit/8edb6f8727bd148f106801bef25567880fd35e9e))
|
||||||
|
|
||||||
|
## [1.40.3](https://github.com/certd/certd/compare/v1.40.2...v1.40.3) (2026-05-21)
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* 修复暗黑模式下注册页面验证码看不清的问题 ([5ba33be](https://github.com/certd/certd/commit/5ba33be30f765f06cafbfcc04f5e25320db01449))
|
||||||
|
|
||||||
|
### Performance Improvements
|
||||||
|
|
||||||
|
* 修复商业版套餐添加和修改时的字段显示 ([fb5b00d](https://github.com/certd/certd/commit/fb5b00d73f925036a65ce5003c57c1199578c34d))
|
||||||
|
|
||||||
|
## [1.40.2](https://github.com/certd/certd/compare/v1.40.1...v1.40.2) (2026-05-19)
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* **certd-server:** 调整首页缓存控制头的判断逻辑 ([0499347](https://github.com/certd/certd/commit/0499347588ee544862420ab9a5afd2546d61bc6c))
|
||||||
|
|
||||||
|
### Performance Improvements
|
||||||
|
|
||||||
|
* **controller:** 更换版本获取源并添加版本标准化处理 ([cb08e06](https://github.com/certd/certd/commit/cb08e061d257ba23a0fefdbfb046a8c759def828))
|
||||||
|
|
||||||
|
## [1.40.1](https://github.com/certd/certd/compare/v1.40.0...v1.40.1) (2026-05-18)
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* 固化华为云sdk版本,避免华为云调用报错 ([59b9ffa](https://github.com/certd/certd/commit/59b9ffadd05faf3982151c48f8d83cbd97419865))
|
||||||
|
* **email-service:** 优化商业版测试邮件内容中带的url链接 ([667e7b1](https://github.com/certd/certd/commit/667e7b185bf26558972be01720872f48352b5876))
|
||||||
|
|
||||||
|
### Performance Improvements
|
||||||
|
|
||||||
|
* 商业版支持限制泛域名数量 ([c63745d](https://github.com/certd/certd/commit/c63745d1ba30904428ba6b13ab0785298baa5cae))
|
||||||
|
* **suite:** 商业版用户已购套餐支持修改 ([bdb3d09](https://github.com/certd/certd/commit/bdb3d09c09fc73e7e5e3401f6ef5588bf8ad5088))
|
||||||
|
|
||||||
|
# [1.40.0](https://github.com/certd/certd/compare/v1.39.16...v1.40.0) (2026-05-14)
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* 修复第三方登录丢失state时无法在用户信息页面绑定第三方账号的bug ([45dedf5](https://github.com/certd/certd/commit/45dedf5bc779fea852e1f33dda4f31db2765633c))
|
||||||
|
* 修复群晖授权没有显示设备id输入框的bug ([2f172b5](https://github.com/certd/certd/commit/2f172b56e9411303ca15138d827bdb9bafdae4d1))
|
||||||
|
* 修复自动注册后没有跳转到控制台的bug ([4681ec9](https://github.com/certd/certd/commit/4681ec90088a3eb665427b2ac4047ec5ccefd7b3))
|
||||||
|
* 修复clogin登录丢失state问题 ([22f5cfc](https://github.com/certd/certd/commit/22f5cfcfd8462ca74128329eefb3f48b3ee0b7ea))
|
||||||
|
* 修复clogin多选类型登录失败的bug ([9f878a3](https://github.com/certd/certd/commit/9f878a353cd49b7b10bb0a95610ad236bc920dd2))
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
* 彩虹登录支持选择多种登录方式 ([7aa0c7e](https://github.com/certd/certd/commit/7aa0c7e491fe660abb62e68792ff5474f19bd5b8))
|
||||||
|
|
||||||
|
### Performance Improvements
|
||||||
|
|
||||||
|
* 第三方登录自动注册的用户支持设置初始化密码 ([a815d02](https://github.com/certd/certd/commit/a815d0245b97efbb948b33d6fc9d49862ce06889))
|
||||||
|
* 头像增加缓存时间 ([7015b1b](https://github.com/certd/certd/commit/7015b1b232602e5168a3eb8bee6d7f1776ae1e74))
|
||||||
|
|
||||||
|
## [1.39.16](https://github.com/certd/certd/compare/v1.39.15...v1.39.16) (2026-05-13)
|
||||||
|
|
||||||
|
**Note:** Version bump only for package root
|
||||||
|
|
||||||
|
## [1.39.15](https://github.com/certd/certd/compare/v1.39.14...v1.39.15) (2026-05-13)
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* 修复第三方登录彩虹登录不上的bug ([bae4f8e](https://github.com/certd/certd/commit/bae4f8e3209d9f9869ecbd7c01655383bac2fe21))
|
||||||
|
|
||||||
|
### Performance Improvements
|
||||||
|
|
||||||
|
* 优化申请时报错日志增加对应域名打印 ([d6e9e59](https://github.com/certd/certd/commit/d6e9e5987bd52ea12ee18745615486eadd4c87ff))
|
||||||
|
* icon选择器增加一套logo集 ([fdd5848](https://github.com/certd/certd/commit/fdd5848df4055a6ee07dc5eabaaf6b718672882d))
|
||||||
|
* **monitor/site:** 新增站点监控页面禁用启用、检查状态两个筛选条件 ([118c15d](https://github.com/certd/certd/commit/118c15d04633a6ef06f2d9e7a7849d20f596e02c))
|
||||||
|
* **network:** 新增全局公共http请求 headers设置 ([aad9045](https://github.com/certd/certd/commit/aad9045de55e76cb2ad09cac74a7bd60a4b47124))
|
||||||
|
|
||||||
|
## [1.39.14](https://github.com/certd/certd/compare/v1.39.13...v1.39.14) (2026-05-11)
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* 修复阿里云订阅流水线创建对话框无法获取阿里订单列表的bug ([a362860](https://github.com/certd/certd/commit/a362860137bfb7072893c844fe775edc46070ee1))
|
||||||
|
* 修复启动时报密钥备份不存在的问题 ([c966896](https://github.com/certd/certd/commit/c9668965226af6b54e0e576931dcba8b3d188ef3))
|
||||||
|
|
||||||
|
## [1.39.13](https://github.com/certd/certd/compare/v1.39.12...v1.39.13) (2026-05-10)
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* **aliyun-access:** 添加阿里云密钥校验失败的错误处理 ([b75c625](https://github.com/certd/certd/commit/b75c625ddcc0b3110699d8e6175681ef157b25df))
|
||||||
|
* cnameProvider域名支持设置子域名托管 ([7266af1](https://github.com/certd/certd/commit/7266af17491a98338022cfb18cfedfb93ca6ef8f))
|
||||||
|
* **plugin-aliyun:** 过滤非CAS证书并优化日志信息 ([c4b01da](https://github.com/certd/certd/commit/c4b01da384bc40a241a673ea8bc01ca733c04d83))
|
||||||
|
|
||||||
|
### Performance Improvements
|
||||||
|
|
||||||
|
* **设置:** 添加首页启用开关配置 ([25ad1e6](https://github.com/certd/certd/commit/25ad1e6f861e43288cc8bd90d4903628e6faec29))
|
||||||
|
* 新增agents.md ([aa176b0](https://github.com/certd/certd/commit/aa176b081a92837d2d6809d16546a8dfc2e5dd36))
|
||||||
|
* **用户资料:** 新增手机号邮箱绑定功能 ([e0eb0e2](https://github.com/certd/certd/commit/e0eb0e21f6dae24b639c944f9aba2c90496ab1c0))
|
||||||
|
* 域名注册过期时间获取再次优化 ([91a1b97](https://github.com/certd/certd/commit/91a1b9755066bf280e194dabf7c3a9f936e2643f))
|
||||||
|
* **证书流水线:** 添加批量更新证书申请参数功能 ([63be1c1](https://github.com/certd/certd/commit/63be1c1cbd9b09a3b48f26130c296b1cedcca1ac))
|
||||||
|
* 支持火山云vke ([bb46cb0](https://github.com/certd/certd/commit/bb46cb08f71f6ae921543f7e4a6c5f4e0190556e))
|
||||||
|
* 重构自动加载模块并优化EAB授权处理 ([4755216](https://github.com/certd/certd/commit/4755216505ad18555a50da9d8008c2207c48df86))
|
||||||
|
* **domain:** 添加域名过期时间同步进度显示功能 ([9d2937d](https://github.com/certd/certd/commit/9d2937dd4b14ffab73e9b096edd2aa8539811182))
|
||||||
|
* **plugin-volcengine:** 支持火山引擎VKE部署插件 ([b8a64a6](https://github.com/certd/certd/commit/b8a64a6b5bf3691a47177de42bc49b798e795feb))
|
||||||
|
|
||||||
|
## [1.39.12](https://github.com/certd/certd/compare/v1.39.11...v1.39.12) (2026-04-29)
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* 调整手机版首页标题被挤开的bug ([eab66e2](https://github.com/certd/certd/commit/eab66e2d1988635985745f2d1b227b958969ee00))
|
||||||
|
* 修复腾讯云clb部署报缺少sslmode参数的bug ([2f1ad72](https://github.com/certd/certd/commit/2f1ad7201f5ed9e00368a28b9e40907d4b415852))
|
||||||
|
|
||||||
|
### Performance Improvements
|
||||||
|
|
||||||
|
* 524错误时重试3次 ([00e6d58](https://github.com/certd/certd/commit/00e6d580c2f54af70fe96a214aff87c4b96426c2))
|
||||||
|
* 阿里云证书订单支持获取2.0的订单 ([64b3184](https://github.com/certd/certd/commit/64b3184b286fee996002d857b0de588452abdadd))
|
||||||
|
* 优化流水线执行时的状态保存性能 ([e00830b](https://github.com/certd/certd/commit/e00830bebcfe6344499e490bc174de96f9fb22d6))
|
||||||
|
* 增加权威NS检查开关,某些用户服务器禁止向黑名单NS服务器发请求 ([1aa50cf](https://github.com/certd/certd/commit/1aa50cf53a0deab752f35ec973912e41ab8161b6))
|
||||||
|
* 支持页脚自定义 ([c985a13](https://github.com/certd/certd/commit/c985a13544aa31b0eb0783f9a3193a7e8bdc6ed6))
|
||||||
|
|
||||||
|
## [1.39.11](https://github.com/certd/certd/compare/v1.39.10...v1.39.11) (2026-04-26)
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* 修复列表页面底部滚动条与表格之间有空白间隙的bug ([71cfcad](https://github.com/certd/certd/commit/71cfcad2a15aac0badd85a10c4012a1e713654d1))
|
||||||
|
* 修复流水线未编辑模式下也提示未保存的bug ([64a3503](https://github.com/certd/certd/commit/64a350364d820725b5e69d22ac2416809092f97d))
|
||||||
|
* 修复商业版设置了公共eab,创建流水线仍然会显示需要配置eab的bug ([24dff05](https://github.com/certd/certd/commit/24dff05f6427dadec1e40350214c0167e1d6a73d))
|
||||||
|
* 修复站点监控某些情况下获取不到证书的bug ([a2bbc7e](https://github.com/certd/certd/commit/a2bbc7e27298821d75a36abac6ec05d86dcf51f4))
|
||||||
|
|
||||||
|
### Performance Improvements
|
||||||
|
|
||||||
|
* 支持google dns插件 ([edc7bfc](https://github.com/certd/certd/commit/edc7bfc23043c2c6ef5f3564392f8aac6661c4bf))
|
||||||
|
* 阿里云waf支持云产品接入方式应用的证书部署 ([2f7514a](https://github.com/certd/certd/commit/2f7514a2e7d89a34f833401a983149e667da911b))
|
||||||
|
* 模版创建流水线支持随机时间 ([575415b](https://github.com/certd/certd/commit/575415b93a3e10e1c6e5644f71ddc711ea6f8adc))
|
||||||
|
* 商业版支持配置证书申请插件参数 ([7ac789c](https://github.com/certd/certd/commit/7ac789c9c7e91cdf08dfdae1bb49186552e370e3))
|
||||||
|
* 添加全新的未登录首页和路由配置 ([d1988dc](https://github.com/certd/certd/commit/d1988dc982440472ecf61847ccad76e4c96a80fb))
|
||||||
|
* 添加Azure DNS插件支持及文档 ([1f1d687](https://github.com/certd/certd/commit/1f1d6873172d71fadaa5a0005e1d6f3f528096fc))
|
||||||
|
* 添加HiPMDnsmgr DNS提供商的支持 @WUHINS ([296dcab](https://github.com/certd/certd/commit/296dcab4c7c26cb3f9da1ff748cc6a6b7d83edda))
|
||||||
|
* 为DNS解析器添加超时配置,避免查询时间过长 ([cc5154e](https://github.com/certd/certd/commit/cc5154e04e87f648111119b4eeb4e3cb4dd6cc41))
|
||||||
|
* 优化权威域名服务器查询超时时长 ([77db5ec](https://github.com/certd/certd/commit/77db5ecd12c51293e4de178e43ca0067bc70b46d))
|
||||||
|
* 支持部署到nginx-proxy-manager ([2e6e9ed](https://github.com/certd/certd/commit/2e6e9ed9255bcf178edb0eb00d93a7f13c214430))
|
||||||
|
* 支持一键安装脚本 ([dc969dd](https://github.com/certd/certd/commit/dc969dd7edb6934a29d6657afefe6f8af056741c))
|
||||||
|
* 支持主动修改绑定url地址 ([11b7cfe](https://github.com/certd/certd/commit/11b7cfe5cb7e88e6ebd68d53acb4e5b556550ca9))
|
||||||
|
* apisix支持v2 ([23b4658](https://github.com/certd/certd/commit/23b465867244b199bab9b61863a5ca43644834a9))
|
||||||
|
* **technitium:** 添加Technitium DNS Server插件支持 ([edeb817](https://github.com/certd/certd/commit/edeb817c39597e4fa73a17ff4ca3f712f0320fec))
|
||||||
|
|
||||||
|
## [1.39.10](https://github.com/certd/certd/compare/v1.39.9...v1.39.10) (2026-04-11)
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* 修复创建流水线无法选择通知的bug ([a88d0a6](https://github.com/certd/certd/commit/a88d0a6ae15cb6170d0b36e21daf89f0dbd5f681))
|
||||||
|
* 修复流水线任务编辑页面复制粘贴按钮在夜间模式显示问题 ([1e549df](https://github.com/certd/certd/commit/1e549dfd431ed74e2bcdfce63e5f640c51603af3))
|
||||||
|
* 修复用户管理添加用户无法上传头像的bug ([557e98c](https://github.com/certd/certd/commit/557e98c33f5462167d8f6289f70dad68bb114a97))
|
||||||
|
* 修复自定义插件删除后没有反注册的bug ([df98463](https://github.com/certd/certd/commit/df9846332596d2afaba53e66d2897aa1c598f9c4))
|
||||||
|
* 修复spaceship创建record报错的bug ([70b46d4](https://github.com/certd/certd/commit/70b46d4a8f89cf8eded21ebb237e8c8ce6c40d30))
|
||||||
|
|
||||||
|
### Performance Improvements
|
||||||
|
|
||||||
|
* 1panel支持先上传证书再选择证书 ([7a9eec8](https://github.com/certd/certd/commit/7a9eec88e8eddf40dba055c072b5b2b0f67c1407))
|
||||||
|
* 部署到1panel面板支持mux模式 ([d05129e](https://github.com/certd/certd/commit/d05129ec67893b0b639003a4bca6878d128f56ad))
|
||||||
|
* 流水线修改编辑之后,增加未保存提示 ([21620ac](https://github.com/certd/certd/commit/21620ac6bdeb57e43509156a77037fc07c44282a))
|
||||||
|
* 修复检查全部某些情况下无效的bug,优化公共触发站点证书检查定时逻辑 ([ee53589](https://github.com/certd/certd/commit/ee535895a3166c6f9046963e28fa8f22f018b574))
|
||||||
|
* 增加域名管理 子域名检查提醒 ([2bdf183](https://github.com/certd/certd/commit/2bdf1832da73a3728f3ac415837bc26e70531cd6))
|
||||||
|
* 站点监控域名气泡增加端口显示 ([6ee718a](https://github.com/certd/certd/commit/6ee718a25265a9db2115343af9a1a01958f34b81))
|
||||||
|
|
||||||
|
## [1.39.9](https://github.com/certd/certd/compare/v1.39.8...v1.39.9) (2026-04-05)
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* 修复cn域名获取不到到期时间的问题 ([73b8e85](https://github.com/certd/certd/commit/73b8e859766097b5251fc4e5051593d686669eb2))
|
||||||
|
* 修复某些情况下报无法修改通知的问题 ([d1a6592](https://github.com/certd/certd/commit/d1a65922d7e152d6edcf6c53b70079f16b54a0d3))
|
||||||
|
|
||||||
|
### Performance Improvements
|
||||||
|
|
||||||
|
* 腾讯云CLB大区增加台北 ([6b109d1](https://github.com/certd/certd/commit/6b109d172f0c7b6ce6ec164dc196d646a65f529f))
|
||||||
|
* 优化腾讯云CLB插件支持选择证书id ([c875971](https://github.com/certd/certd/commit/c875971b71dc6d392e56f0a7605281c40d9bb405))
|
||||||
|
* 支持域名到期时间监控通知 ([c6628e7](https://github.com/certd/certd/commit/c6628e7311d6c43c2a784581fb25ec37b29c168d))
|
||||||
|
* **monitor:** 支持查看监控执行记录 ([b5cc794](https://github.com/certd/certd/commit/b5cc794061c11b7200b669473c25c4bbfc944b61))
|
||||||
|
* **plugin-dnsmgr:** 添加彩虹DNS插件支持 ([af50344](https://github.com/certd/certd/commit/af503442b8298c5b89d11cf2ea351d62e66a609e))
|
||||||
|
* **spaceship:** 新增Spaceship DNS插件和授权模块 ([21aec77](https://github.com/certd/certd/commit/21aec77e5c3307b5973d4185baba33edcb28926f))
|
||||||
|
|
||||||
|
## [1.39.8](https://github.com/certd/certd/compare/v1.39.7...v1.39.8) (2026-03-31)
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* 修复某些情况下报没有匹配到任何校验方式的bug ([fe02ce7](https://github.com/certd/certd/commit/fe02ce7b64cf23c4dc4c30daccd5330059a35e9a))
|
||||||
|
* 修复上传头像退出登录的bug ([6eb20a1](https://github.com/certd/certd/commit/6eb20a1f2e31d984d9135edbf39c97cdd15621f9))
|
||||||
|
|
||||||
|
### Performance Improvements
|
||||||
|
|
||||||
|
* 阿里云CDN部署支持根据证书域名自动匹配部署 ([a68301e](https://github.com/certd/certd/commit/a68301e4dcea8b7391ad751aa57555d566297ad9))
|
||||||
|
* 阿里云dcdn支持根据证书域名匹配模式 ([df012de](https://github.com/certd/certd/commit/df012dec90590ecba85a69ed6355cfa8382c1da3))
|
||||||
|
* 支持部署证书到百度CCE ([a19ea74](https://github.com/certd/certd/commit/a19ea7489c01cdbf795fb51f804bd6d00389f604))
|
||||||
|
* dcdn自动匹配部署,支持新增域名感知 ([c6a988b](https://github.com/certd/certd/commit/c6a988bc925886bd7163c1270f2b7a10a57b1c5b))
|
||||||
|
|
||||||
|
## [1.39.7](https://github.com/certd/certd/compare/v1.39.6...v1.39.7) (2026-03-25)
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* 修复cname校验报该授权无权限的bug ([b1eb706](https://github.com/certd/certd/commit/b1eb7069258d6ff2b128091911fa448eaffc5f33))
|
||||||
|
|
||||||
|
### Performance Improvements
|
||||||
|
|
||||||
|
* 支持部署到火山云tos自定义域名证书 ([af6deb9](https://github.com/certd/certd/commit/af6deb99cd24a69a189b1fdd1df51c8f7816dcda))
|
||||||
|
* 支持部署证书到火山引擎vod ([f91d591](https://github.com/certd/certd/commit/f91d591b03c50166d9fa352ba11c62d963869aa5))
|
||||||
|
|
||||||
|
## [1.39.6](https://github.com/certd/certd/compare/v1.39.5...v1.39.6) (2026-03-22)
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* 修复模版id不正确导致修改到错误的模版流水线bug ([b1ff163](https://github.com/certd/certd/commit/b1ff163a2828b205297408d5aed21cf1eff335e8))
|
||||||
|
* 修复批量执行按钮无效的bug ([49703f0](https://github.com/certd/certd/commit/49703f08e55b303851086d9f36aca562d7999be6))
|
||||||
|
* remote-select默认pageSize设置为50,阿里云WAF不支持pageSize100 ([285532d](https://github.com/certd/certd/commit/285532d4318b90d0d7f8154f070274c0a0ec0269))
|
||||||
|
|
||||||
|
### Performance Improvements
|
||||||
|
|
||||||
|
* 火山引擎部署alb证书插件支持部署扩展证书以及删除已过期扩展证书 ([ffd2e81](https://github.com/certd/certd/commit/ffd2e8149e3a06bf3eec456ff85dbed793af9e90))
|
||||||
|
* 企业模式下面增加个人数据迁移的引导 ([431afd6](https://github.com/certd/certd/commit/431afd618f547cecf9a29433f46d4367619e2ecf))
|
||||||
|
* 新增阿里云证书清理插件 ([4b7eeaa](https://github.com/certd/certd/commit/4b7eeaa6e0a14d2e461c7c473a920a0966b1fe8e))
|
||||||
|
* 优化远程数据选择框,选择数据时不刷新闪烁 ([7f6a8bc](https://github.com/certd/certd/commit/7f6a8bc87e364685defe7f039264b2de064806c5))
|
||||||
|
* 支持复制粘贴任务步骤 ([acc2df2](https://github.com/certd/certd/commit/acc2df29def017fb8165f931b41ef95414966afc))
|
||||||
|
|
||||||
|
## [1.39.5](https://github.com/certd/certd/compare/v1.39.4...v1.39.5) (2026-03-18)
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* 修复修改分组报错的bug ([224db7d](https://github.com/certd/certd/commit/224db7da57dbdddf25bcac7faa0a29eb228c5a33))
|
||||||
|
|
||||||
|
### Performance Improvements
|
||||||
|
|
||||||
|
* 移除passkey的counter递增校验 ([68b669d](https://github.com/certd/certd/commit/68b669d3ff3e13b931939093320ce7237bb02b1b))
|
||||||
|
* passkey 支持Bitwarden ([29f44c6](https://github.com/certd/certd/commit/29f44c67c808bed9ff1c9d4884d39a1a62d043a7))
|
||||||
|
* passkey登录放到下方其他登录位置 ([1413e1a](https://github.com/certd/certd/commit/1413e1aff4aabcfd471716338c210fbcfd76c8f9))
|
||||||
|
|
||||||
|
## [1.39.4](https://github.com/certd/certd/compare/v1.39.3...v1.39.4) (2026-03-17)
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* 修复阿里云证书订单翻页问题 ([6d43623](https://github.com/certd/certd/commit/6d43623f459a7594599e50a7ed89d67fcc775518))
|
||||||
|
* 修复查看证书详情页面错位的bug ([7f37df4](https://github.com/certd/certd/commit/7f37df42274e657892d92e868ceac67e139f3bf2))
|
||||||
|
* 修复选择插件页面无法滚动的bug ([d8425bc](https://github.com/certd/certd/commit/d8425bc9c5ee81bb669706c6de6bad69d7c38d8e))
|
||||||
|
|
||||||
|
### Performance Improvements
|
||||||
|
|
||||||
|
* 优化passkey ([9e12412](https://github.com/certd/certd/commit/9e12412f5fa7800df1d7efaf62cd8fd5d79bb569))
|
||||||
|
|
||||||
|
## [1.39.3](https://github.com/certd/certd/compare/v1.39.2...v1.39.3) (2026-03-17)
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* 修复多选框只能单选的bug ([12700e1](https://github.com/certd/certd/commit/12700e1754319513ac02822ff1588d63420b964e))
|
||||||
|
* 修复旧版1panel插件 报sslIds is not iterable的错误 ([50db6f0](https://github.com/certd/certd/commit/50db6f0765e7ec9a5698cd99540d90e188634fb1))
|
||||||
|
|
||||||
|
## [1.39.2](https://github.com/certd/certd/compare/v1.39.1...v1.39.2) (2026-03-16)
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* 修复当证书更新后第一次站点检查会报与主站证书过期时间不一致错误的bug ([dd999b6](https://github.com/certd/certd/commit/dd999b60a4fe3507ff5e0109d637b4e891b28bdd))
|
||||||
|
* 修复京东云报错不准确的bug ([10dd89a](https://github.com/certd/certd/commit/10dd89ae62e438a211a15e729559af823a096583))
|
||||||
|
* 修复群晖测试时报addSecret undefine错误 ([5eb4aa3](https://github.com/certd/certd/commit/5eb4aa3a0eab9ffa729c8e813cbf973d9683cc13))
|
||||||
|
* 修复提示支付失败的bug ([12fed34](https://github.com/certd/certd/commit/12fed34e109f3254de664813954081a52513bd38))
|
||||||
|
* 修复修改项目名称后,没有同步刷新的bug ([3abee72](https://github.com/certd/certd/commit/3abee72fee286864b665033b23b172ef0ea92d83))
|
||||||
|
* cname provider授权修改为sys级别 ([d01bfbe](https://github.com/certd/certd/commit/d01bfbec96a3a2109ec864953b0c9e8c1f95b97b))
|
||||||
|
|
||||||
|
### Performance Improvements
|
||||||
|
|
||||||
|
* 查看证书增加证书详情显示,包括域名,过期时间,颁发机构,指纹等 ([0b9933d](https://github.com/certd/certd/commit/0b9933df1e8d1685d14271435a8a7488974cc47b))
|
||||||
|
* 获取阿里证书订单id组件增加翻页功能,突破50的上限 ([d79db3b](https://github.com/certd/certd/commit/d79db3bd3f0d5ad39664bb47ec3814d43ad93304))
|
||||||
|
* 优化阿里云连接超时时长为10秒,支持配置环境变量 ([1588461](https://github.com/certd/certd/commit/1588461633bd275765daa96fc68320abb58d616d))
|
||||||
|
* 优化个人账户页面 ([e506116](https://github.com/certd/certd/commit/e50611666ef731a903d7bdd8eb62333b97e2cc5b))
|
||||||
|
* 支持批量转移流水线到其他项目 ([8a3841f](https://github.com/certd/certd/commit/8a3841f6382b53ce2343307fb035e74fa5383fef))
|
||||||
|
* 支持passkey登录 ([10b7644](https://github.com/certd/certd/commit/10b7644bb7ba5f82776537bc0c4f5eb95d5f8e4e))
|
||||||
|
* dns-provider 支持bind9 ,support bind9 ([76d12d6](https://github.com/certd/certd/commit/76d12d60624c0672fd3717a80a2cfef6845b14b8))
|
||||||
|
|
||||||
|
## [1.39.1](https://github.com/certd/certd/compare/v1.39.0...v1.39.1) (2026-03-09)
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* 修复企业管理模式下,切换用户登录后,丢失项目列表的bug ([d23c8b4](https://github.com/certd/certd/commit/d23c8b4a2a5f5ab17822c6ee1d4108ac7280b9d1))
|
||||||
|
|
||||||
|
### Performance Improvements
|
||||||
|
|
||||||
|
* 支持迁移个人数据到企业项目中 ([c6ca832](https://github.com/certd/certd/commit/c6ca83273779ed84de1b23b5e477063af043d015))
|
||||||
|
* install tip ([853fdc7](https://github.com/certd/certd/commit/853fdc70a263b62d75c9ff3970607e6bf1c1593b))
|
||||||
|
|
||||||
|
# [1.39.0](https://github.com/certd/certd/compare/v1.38.12...v1.39.0) (2026-03-07)
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* 修复部署到openwrt错误的bug ([2e3d0cc](https://github.com/certd/certd/commit/2e3d0cc57c16c48ad435bc8fde729bacaedde9f5))
|
||||||
|
* 修复发件邮箱无法输入的bug ([27b0348](https://github.com/certd/certd/commit/27b0348e1d3d752f418f851965d6afbc26c0160c))
|
||||||
|
* 修复复制流水线保存后丢失分组和排序号的问题 ([bc32648](https://github.com/certd/certd/commit/bc326489abc1d50a0930b4f47aa2d62d3a486798))
|
||||||
|
* 修复获取群辉deviceid报错的bug ([79be392](https://github.com/certd/certd/commit/79be392775a2c91848dd5a66a2618adc4e4b48f6))
|
||||||
|
* 修复京东云域名申请证书报错的bug ([d9c0130](https://github.com/certd/certd/commit/d9c0130b59997144a3c274d456635b800135e43f))
|
||||||
|
* 修复偶尔下载证书报未授权的错误 ([316537e](https://github.com/certd/certd/commit/316537eb4dcbe5ec57784e8bf95ee3cdfd21dce7))
|
||||||
|
* 修复dcdn多个域名同时部署时 可能会出现证书名称重复的bug ([78c2ced](https://github.com/certd/certd/commit/78c2ced43b1a73d142b0ed783b162b97f545ab06))
|
||||||
|
* 优化dcdn部署上传多次证书 偶尔报 The CertName already exists的问题 ([72f850f](https://github.com/certd/certd/commit/72f850f675b500d12ebff2338d1b99d6fab476e1))
|
||||||
|
* **cert-plugin:** 优化又拍云客户端错误处理逻辑,当域名已绑定证书时不再抛出异常。 ([92c9ac3](https://github.com/certd/certd/commit/92c9ac382692e6c84140ff787759ab6d39ccbe96))
|
||||||
|
* esxi部署失败的bug ([1e44115](https://github.com/certd/certd/commit/1e441154617e6516a9a3610412bf597128c62696))
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
* 支持企业级管理模式,项目管理,细分权限 ([3734083](https://github.com/certd/certd/commit/37340838b6a61a94b86bfa13cf5da88b26f1315a))
|
||||||
|
|
||||||
|
### Performance Improvements
|
||||||
|
|
||||||
|
* 【破坏性更新】错误返回信息msg字段名统一改成message,与成功的返回结构一致 ([51ab6d6](https://github.com/certd/certd/commit/51ab6d6da1bb551b55b3a6a4a9a945c8d6ace806))
|
||||||
|
* 当域名管理中没有域名时,创建流水线时不展开域名选择框 ([bb0afe1](https://github.com/certd/certd/commit/bb0afe1fa7b0fc52fde051d24fbe6be69d52f4cc))
|
||||||
|
* 任务步骤页面增加串行执行提示说明 ([787f6ef](https://github.com/certd/certd/commit/787f6ef52893d8dc912ee2a7a5b8ce2b73c108c9))
|
||||||
|
* 站点监控支持指定ip地址检查 ([83d81b6](https://github.com/certd/certd/commit/83d81b64b3adb375366039e07c87d1ad79121c13))
|
||||||
|
* AI开发插件 skills 定义初步 ([1f68fad](https://github.com/certd/certd/commit/1f68faddb97a978c5a5e731a8895b4bb0587ad83))
|
||||||
|
* http请求增加建立连接超时配置 ([3c85602](https://github.com/certd/certd/commit/3c85602ab1fc1953cdc06a6cd75a971d14119179))
|
||||||
|
|
||||||
## [1.38.12](https://github.com/certd/certd/compare/v1.38.11...v1.38.12) (2026-02-18)
|
## [1.38.12](https://github.com/certd/certd/compare/v1.38.11...v1.38.12) (2026-02-18)
|
||||||
|
|
||||||
### Bug Fixes
|
### Bug Fixes
|
||||||
|
|||||||
@@ -5,41 +5,40 @@
|
|||||||
Certd® 是一个免费的全自动证书管理系统,让你的网站证书永不过期。
|
Certd® 是一个免费的全自动证书管理系统,让你的网站证书永不过期。
|
||||||
后缀d取自linux守护进程的命名风格,意为证书守护进程
|
后缀d取自linux守护进程的命名风格,意为证书守护进程
|
||||||
|
|
||||||
|
> 首创流水线申请部署证书模式,已被多个项目“借鉴”,被抄也是一种成功。
|
||||||
>首创流水线申请部署证书模式,已被多个项目“借鉴”,被抄也是一种成功。
|
|
||||||
|
|
||||||
> 关于证书续期:
|
> 关于证书续期:
|
||||||
>* 实际上没有办法不改变证书文件本身情况下直接续期或者续签。
|
>
|
||||||
>* 我们所说的续期,其实就是按照全套流程重新申请一份新证书,然后重新部署上去。
|
> - 实际上没有办法不改变证书文件本身情况下直接续期或者续签。
|
||||||
>* 免费证书过期时间90天,以后可能还会缩短,所以自动化部署必不可少
|
> - 我们所说的续期,其实就是按照全套流程重新申请一份新证书,然后重新部署上去。
|
||||||
|
> - 免费证书过期时间90天,以后可能还会缩短,所以自动化部署必不可少
|
||||||
|
|
||||||
> 流水线数量现已调整为无限制,欢迎大家使用
|
> 流水线数量现已调整为无限制,欢迎大家使用
|
||||||
|
|
||||||
|
| 官方开源地址: | |
|
||||||
|官方开源地址: | |
|
| ------------------------------------------ | ---------------------------------------------------------------- |
|
||||||
| ---- | ---- |
|
| [Github](https://github.com/certd/certd) |  |
|
||||||
| [Github](https://github.com/certd/certd)|  |
|
| [Gitee](https://gitee.com/certd/certd) |  |
|
||||||
| [Gitee](https://gitee.com/certd/certd) |  |
|
| [AtomGit](https://atomgit.com/certd/certd) |  |
|
||||||
| [AtomGit](https://atomgit.com/certd/certd) | |
|
|
||||||
|
|
||||||
|
|
||||||
## 一、特性
|
## 一、特性
|
||||||
|
|
||||||
本项目不仅支持证书申请过程自动化,还可以自动化部署更新证书,让你的证书永不过期。
|
本项目不仅支持证书申请过程自动化,还可以自动化部署更新证书,让你的证书永不过期。
|
||||||
|
|
||||||
* **全自动申请证书**: 支持所有注册商注册的域名,支持DNS-01、HTTP-01、CNAME代理等多种域名验证方式
|
- **全自动申请证书**: 支持所有注册商注册的域名,支持DNS-01、HTTP-01、CNAME代理等多种域名验证方式
|
||||||
* **全自动部署更新证书**: 目前支持部署到主机、阿里云、腾讯云等110+部署插件
|
- **全自动部署更新证书**: 目前支持部署到主机、阿里云、腾讯云等110+部署插件
|
||||||
* **多种证书格式**: 支持pem、pfx、der、jks、p7b
|
- **多种证书格式**: 支持pem、pfx、der、jks、p7b
|
||||||
* **免费通配符域名/泛域名证书**: 支持多个域名打到一个证书上
|
- **免费通配符域名/泛域名证书**: 支持多个域名打到一个证书上
|
||||||
* **多种通知方式**: 邮件通知、webhook通知、企微、钉钉、飞书、anpush等多种通知方式
|
- **多种通知方式**: 邮件通知、webhook通知、企微、钉钉、飞书、anpush等多种通知方式
|
||||||
* **私有化部署**: 数据保存本地,安装简单快捷,镜像由Github Actions构建,过程公开透明
|
- **私有化部署**: 数据保存本地,安装简单快捷,镜像由Github Actions构建,过程公开透明
|
||||||
* **多重安全保障**: 授权加密,站点隐藏,2FA,密码防爆破等多重安全保障
|
- **多重安全保障**: 授权加密,站点隐藏,2FA,密码防爆破等多重安全保障
|
||||||
* **多数据库支持**:支持SQLite、PostgreSQL、MySQL
|
- **多数据库支持**:支持SQLite、PostgreSQL、MySQL、MariaDB
|
||||||
* **开放接口支持**: 提供RESTful API接口,方便集成到其他系统
|
- **开放接口支持**: 提供RESTful API接口,方便集成到其他系统
|
||||||
* **站点证书监控**: 定时监控网站证书的过期时间
|
- **站点证书监控**: 定时监控网站证书的过期时间
|
||||||
* **多用户管理**: 用户可以管理自己的证书流水线
|
- **多用户管理**: 用户可以管理自己的证书流水线
|
||||||
* **多语言支持**: 中英双语切换
|
- **项目管理**: 企业级项目管理模式
|
||||||
* **无忧升级**: 版本向下兼容
|
- **多语言支持**: 中英双语切换
|
||||||
|
- **无忧升级**: 版本向下兼容
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
@@ -59,11 +58,13 @@ https://certd.handfree.work/
|
|||||||
仅需3步,让你的证书永不过期
|
仅需3步,让你的证书永不过期
|
||||||
|
|
||||||
### 1. 创建证书流水线
|
### 1. 创建证书流水线
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
> 添加成功后,就可以直接运行流水线申请证书了
|
> 添加成功后,就可以直接运行流水线申请证书了
|
||||||
|
|
||||||
### 2. 添加部署任务
|
### 2. 添加部署任务
|
||||||
|
|
||||||
当然我们一般需要把证书部署到应用上,certd支持海量的部署插件,您可以根据自身实际情况进行选择,比如部署到Nginx、阿里云、腾讯云、K8S、CDN、宝塔、1Panel等等
|
当然我们一般需要把证书部署到应用上,certd支持海量的部署插件,您可以根据自身实际情况进行选择,比如部署到Nginx、阿里云、腾讯云、K8S、CDN、宝塔、1Panel等等
|
||||||
|
|
||||||
此处演示部署证书到主机的nginx上
|
此处演示部署证书到主机的nginx上
|
||||||
@@ -73,17 +74,15 @@ https://certd.handfree.work/
|
|||||||

|

|
||||||
|
|
||||||
### 3. 定时运行
|
### 3. 定时运行
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
|
||||||
↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓
|
↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓
|
||||||
-------> [点我查看详细使用步骤演示](./step.md) <--------
|
-------> [点我查看详细使用步骤演示](./step.md) <--------
|
||||||
↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑
|
↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑
|
||||||
|
|
||||||
更多教程请访问官方文档 [certd.docmirror.cn](https://certd.docmirror.cn/guide/)
|
更多教程请访问官方文档 [certd.docmirror.cn](https://certd.docmirror.cn/guide/)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## 四、私有化部署
|
## 四、私有化部署
|
||||||
|
|
||||||
由于证书、授权信息等属于高度敏感数据,请务必私有化部署,保障数据安全
|
由于证书、授权信息等属于高度敏感数据,请务必私有化部署,保障数据安全
|
||||||
@@ -94,96 +93,111 @@ https://certd.handfree.work/
|
|||||||
2. 【推荐】[宝塔面板方式部署 ](https://certd.docmirror.cn/guide/install/docker/)
|
2. 【推荐】[宝塔面板方式部署 ](https://certd.docmirror.cn/guide/install/docker/)
|
||||||
3. 【推荐】[1Panel面板方式部署](https://certd.docmirror.cn/guide/install/1panel/)
|
3. 【推荐】[1Panel面板方式部署](https://certd.docmirror.cn/guide/install/1panel/)
|
||||||
4. 【推荐】[雨云一键部署](https://app.rainyun.com/apps/rca/store/6646/?ref=NzExMDQ2) : 首充翻倍,每月仅需2.2元
|
4. 【推荐】[雨云一键部署](https://app.rainyun.com/apps/rca/store/6646/?ref=NzExMDQ2) : 首充翻倍,每月仅需2.2元
|
||||||
[<img src="https://rainyun-apps.cn-nb1.rains3.com/materials/deploy-on-rainyun-cn.svg">](https://app.rainyun.com/apps/rca/store/6646/?ref=NzExMDQ2)
|
[<img src="https://rainyun-apps.cn-nb1.rains3.com/materials/deploy-on-rainyun-cn.svg">](https://app.rainyun.com/apps/rca/store/6646/?ref=NzExMDQ2)
|
||||||
5. 【不推荐】[源码方式部署 ](https://certd.docmirror.cn/guide/install/source/)
|
|
||||||
|
5. 【推荐】[一键安装脚本](https://certd.docmirror.cn/guide/install/docker/)(自动安装 Docker,Certd):
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -fsSL https://gitee.com/certd/certd/raw/v2/docker/run/install.sh | bash
|
||||||
|
```
|
||||||
|
|
||||||
|
6. 【不推荐】[源码方式部署 ](https://certd.docmirror.cn/guide/install/source/)
|
||||||
|
|
||||||
#### Docker镜像说明:
|
#### Docker镜像说明:
|
||||||
* 国内镜像地址:
|
|
||||||
* `registry.cn-shenzhen.aliyuncs.com/handsfree/certd:latest`
|
|
||||||
* `registry.cn-shenzhen.aliyuncs.com/handsfree/certd:armv7`、`[version]-armv7`
|
|
||||||
* DockerHub地址:
|
|
||||||
* `https://hub.docker.com/r/greper/certd`
|
|
||||||
* `greper/certd:latest`
|
|
||||||
* `greper/certd:armv7`、`greper/certd:[version]-armv7`
|
|
||||||
* GitHub Packages地址:
|
|
||||||
* `ghcr.io/certd/certd:latest`
|
|
||||||
* `ghcr.io/certd/certd:armv7`、`ghcr.io/certd/certd:[version]-armv7`
|
|
||||||
|
|
||||||
* 镜像构建通过`Actions`自动执行,过程公开透明,请放心使用
|
- 国内镜像地址:
|
||||||
* [点我查看镜像构建日志](https://github.com/certd/certd/actions/workflows/build-image.yml)
|
- `registry.cn-shenzhen.aliyuncs.com/handsfree/certd:latest`
|
||||||
|
- `registry.cn-shenzhen.aliyuncs.com/handsfree/certd:armv7`、`[version]-armv7`
|
||||||
|
- DockerHub地址:
|
||||||
|
- `https://hub.docker.com/r/greper/certd`
|
||||||
|
- `greper/certd:latest`
|
||||||
|
- `greper/certd:armv7`、`greper/certd:[version]-armv7`
|
||||||
|
- GitHub Packages地址:
|
||||||
|
|
||||||
|
- `ghcr.io/certd/certd:latest`
|
||||||
|
- `ghcr.io/certd/certd:armv7`、`ghcr.io/certd/certd:[version]-armv7`
|
||||||
|
|
||||||
|
- 镜像构建通过`Actions`自动执行,过程公开透明,请放心使用
|
||||||
|
- [点我查看镜像构建日志](https://github.com/certd/certd/actions/workflows/build-image.yml)
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
> 注意:
|
> 注意:
|
||||||
> * 本应用存储的证书、授权信息等属于高度敏感数据,请做好安全防护
|
>
|
||||||
> * 请务必使用HTTPS协议访问本应用,避免被中间人攻击
|
> - 本应用存储的证书、授权信息等属于高度敏感数据,请做好安全防护
|
||||||
> * 请务必使用web应用防火墙防护本应用,防止XSS、SQL注入等攻击
|
> - 请务必使用HTTPS协议访问本应用,避免被中间人攻击
|
||||||
> * 请务必做好服务器本身的安全防护,防止数据库泄露
|
> - 请务必使用web应用防火墙防护本应用,防止XSS、SQL注入等攻击
|
||||||
> * 请务必做好数据备份,避免数据丢失
|
> - 请务必做好服务器本身的安全防护,防止数据库泄露
|
||||||
> * [更多安全生产建议点我](https://certd.docmirror.cn/guide/feature/safe/)
|
> - 请务必做好数据备份,避免数据丢失
|
||||||
|
> - [更多安全生产建议点我](https://certd.docmirror.cn/guide/feature/safe/)
|
||||||
|
|
||||||
## 五、生态
|
## 五、生态
|
||||||
|
|
||||||
### 1. 客户端工具 SSL-Assistant
|
### 1. 客户端工具 SSL-Assistant
|
||||||
|
|
||||||
`SSL Assistant` 是一个运行于主机上的证书部署管理助手客户端。
|
`SSL Assistant` 是一个运行于主机上的证书部署管理助手客户端。
|
||||||
支持自动扫描主机`Nginx`配置,然后从`Certd`拉取证书并部署。
|
支持自动扫描主机`Nginx`配置,然后从`Certd`拉取证书并部署。
|
||||||
在不想暴露ssh主机密码情况下,该工具非常好用。
|
在不想暴露ssh主机密码情况下,该工具非常好用。
|
||||||
|
|
||||||
开源地址: https://github.com/Youngxj/SSL-Assistant
|
开源地址: https://github.com/Youngxj/SSL-Assistant
|
||||||
|
|
||||||
|
|
||||||
## 六、更多帮助
|
## 六、更多帮助
|
||||||
|
|
||||||
请访问官方文档:[https://certd.docmirror.cn/](https://certd.docmirror.cn/guide/)
|
请访问官方文档:[https://certd.docmirror.cn/](https://certd.docmirror.cn/guide/)
|
||||||
|
|
||||||
* 升级方法:[升级方法](https://certd.docmirror.cn/guide/install/upgrade/)
|
- 升级方法:[升级方法](https://certd.docmirror.cn/guide/install/upgrade/)
|
||||||
* 常见问题:[忘记密码](https://certd.docmirror.cn/guide/use/forgotpasswd/)
|
- 常见问题:[忘记密码](https://certd.docmirror.cn/guide/use/forgotpasswd/)
|
||||||
* 多数据库:[多数据库配置](https://certd.docmirror.cn/guide/install/database/)
|
- 多数据库:[多数据库配置](https://certd.docmirror.cn/guide/install/database/)
|
||||||
* 站点安全:[站点安全特性](https://certd.docmirror.cn/guide/feature/safe/)
|
- 站点安全:[站点安全特性](https://certd.docmirror.cn/guide/feature/safe/)
|
||||||
* 更新日志:[CHANGELOG](./CHANGELOG.md)
|
- 更新日志:[CHANGELOG](./CHANGELOG.md)
|
||||||
|
|
||||||
|
|
||||||
## 七、联系作者
|
## 七、联系作者
|
||||||
|
|
||||||
如有疑问,欢迎加入群聊(请备注certd)
|
如有疑问,欢迎加入群聊(请备注certd)
|
||||||
|
|
||||||
| 加群 | 微信群 | QQ群 |
|
| 加群 | 微信群 | QQ群 |
|
||||||
|---------|-------|-------|
|
| ------ | ----------------------------------------------------------- | ----------------------------------------------------------- |
|
||||||
| 二维码 | <img height="230" src="./docs/guide/contact/images/wx.png"> | <img height="230" src="./docs/guide/contact/images/qq.png"> |
|
| 二维码 | <img height="230" src="./docs/guide/contact/images/wx.png"> | <img height="230" src="./docs/guide/contact/images/qq.png"> |
|
||||||
|
|
||||||
也可以加作者好友
|
也可以加作者好友
|
||||||
|
|
||||||
| 加作者好友 | 微信 QQ |
|
| 加作者好友 | 微信 QQ |
|
||||||
|---------|-------------------------------------------------------------|
|
| ---------- | ----------------------------------------------------------- |
|
||||||
| 二维码 | <img height="230" src="./docs/guide/contact/images/me.png"> |
|
| 二维码 | <img height="230" src="./docs/guide/contact/images/me.png"> |
|
||||||
|
|
||||||
|
|
||||||
## 八、赞助捐赠
|
## 八、赞助捐赠
|
||||||
|
|
||||||
开源为什么要做专业版收费?
|
开源为什么要做专业版收费?
|
||||||
|
|
||||||
1. 纯靠为爱发电不可持续(比如:我的[dev-sidecar项目](https://github.com/docmirror/dev-sidecar)即便是拥有20K+star,也差点凉凉,幸亏有另外大佬接手用爱发电)
|
1. 纯靠为爱发电不可持续(比如:我的[dev-sidecar项目](https://github.com/docmirror/dev-sidecar)即便是拥有20K+star,也差点凉凉,幸亏有另外大佬接手用爱发电)
|
||||||
2. 没有赞助的项目,作者会比较任性,不会用心倾听用户的心声,不顾用户体验(比如:下意识拒绝需求、频繁破坏性变更升级、全盘推倒重来之类的)
|
2. 没有赞助的项目,作者会比较任性,不会用心倾听用户的心声,不顾用户体验(比如:下意识拒绝需求、频繁破坏性变更升级、全盘推倒重来之类的)
|
||||||
3. 没有赞助的项目,交流群的戾气有时候比较重,容易起冲突
|
3. 没有赞助的项目,交流群的戾气有时候比较重,容易起冲突
|
||||||
|
|
||||||
赞助权益:
|
赞助权益:
|
||||||
|
|
||||||
1. 可加入专属VIP群,可以获得作者一对一技术支持,必要时可以远程协助
|
1. 可加入专属VIP群,可以获得作者一对一技术支持,必要时可以远程协助
|
||||||
2. 您的需求我们将优先实现,并且可能将作为专业版功能提供
|
2. 您的需求我们将优先实现,并且可能将作为专业版功能提供
|
||||||
3. 获得专业版功能
|
3. 获得专业版功能
|
||||||
|
|
||||||
[50元专业版优惠券限时领取](https://app.handfree.work/subject/#/app/certd/product)
|
[50元专业版优惠券限时领取](https://app.handfree.work/subject/#/app/certd/product)
|
||||||
|
|
||||||
专业版特权对比
|
专业版、商业版特权对比
|
||||||
|
|
||||||
| 功能 | 免费版 | 专业版 |
|
|
||||||
|---------|---------------------------------------|--------------------------------|
|
|
||||||
| 免费证书申请 | 免费无限制 | 免费无限制 |
|
|
||||||
| 证书域名数量 | 无限制 | 无限制 |
|
|
||||||
| 证书流水线条数 | 无限制 | 无限制 |
|
|
||||||
| 自动部署插件 | 阿里云CDN、腾讯云、七牛CDN、主机部署、宝塔、1Panel等大部分插件 | 群晖、威联通、proxmox等 |
|
|
||||||
| 通知 | 邮件通知、自定义webhook | 邮件免配置、企微、钉钉、飞书、anpush、server酱等 |
|
|
||||||
| 站点监控 | 限制1条 | 无限制 |
|
|
||||||
| 批量操作 | 无 | 流水线模版,流水线复制,批量运行,批量设置通知、定时等 |
|
|
||||||
| VIP群 | 无 | 可加,一对一技术支持,必要时可申请远程协助 |
|
|
||||||
|
|
||||||
|
| 功能 | 免费版 | 专业版 | 商业版 |
|
||||||
|
| ---------------------------------------- | -------------------------------------------------------------- | ------------------------------------------------------ | --------------------------------------------------- |
|
||||||
|
| 证书申请 | 无限制 | 无限制 | 无限制 |
|
||||||
|
| 证书域名数量 | 无限制 | 无限制 | 无限制 |
|
||||||
|
| 证书流水线条数 | 无限制 | 无限制 | 无限制 |
|
||||||
|
| 自动部署插件 | 阿里云CDN、腾讯云、七牛CDN、主机部署、宝塔、1Panel等大部分插件 | 群晖、威联通、proxmox等 | 同专业版 |
|
||||||
|
| 通知 | 邮件通知、自定义webhook | 邮件免配置、企微、钉钉、飞书、anpush、server酱等 | 同专业版 |
|
||||||
|
| 站点监控 | 限制1条 | 无限制 | 无限制 |
|
||||||
|
| 批量操作 | 无 | 流水线模版,流水线复制,批量运行,批量设置通知、定时等 | 同专业版 |
|
||||||
|
| VIP群 | 无 | 可加,一对一技术支持,必要时可申请远程协助 | 商业版技术支持 |
|
||||||
|
| 站点个性化 | 无 | 无 | 可自定义站点名称、Logo等,移除Certd元素,首页警告等 |
|
||||||
|
| 套餐功能 | 无 | 无 | 支持配置套餐供用户购买 |
|
||||||
|
| 数据统计 | 无 | 无 | 支持站点各类统计数据 |
|
||||||
|
| 插件管理 | 无 | 无 | 支持公共EAB设置,插件选项配置 |
|
||||||
|
| 是否可商用 | 不允许 | 不允许 | 可对外运营 |
|
||||||
|
|
||||||
## 九、贡献代码
|
## 九、贡献代码
|
||||||
|
|
||||||
@@ -199,15 +213,16 @@ https://certd.handfree.work/
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
## 十、 开源许可
|
## 十、 开源许可
|
||||||
* 本项目遵循 GNU Affero General Public License(AGPL)开源协议。
|
|
||||||
* 允许个人和公司内部自由使用、复制、修改和分发本项目,未获得商业授权情况下禁止任何形式的商业用途
|
|
||||||
* 未获得商业授权情况下,禁止任何对logo、版权信息及授权许可相关代码的修改。
|
|
||||||
* 如需商业授权,请联系作者。
|
|
||||||
|
|
||||||
|
- 本项目遵循 GNU Affero General Public License(AGPL)开源协议。
|
||||||
|
- 允许个人和公司内部自由使用、复制、修改和分发本项目,未获得商业授权情况下禁止任何形式的商业用途
|
||||||
|
- 未获得商业授权情况下,禁止任何对logo、版权信息及授权许可相关代码的修改。
|
||||||
|
- 如需商业授权,请联系作者。
|
||||||
|
|
||||||
## 十一、我的其他项目(求Star)
|
## 十一、我的其他项目(求Star)
|
||||||
|
|
||||||
| 项目名称 | stars | 项目描述 |
|
| 项目名称 | stars | 项目描述 |
|
||||||
| --------- |--------- |----------- |
|
| ----------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ---------------------------------------------------- |
|
||||||
| [fast-crud](https://gitee.com/fast-crud/fast-crud/) | <img alt="GitHub stars" src="https://img.shields.io/github/stars/fast-crud/fast-crud?logo=github"/> | 基于vue3的crud快速开发框架 |
|
| [fast-crud](https://gitee.com/fast-crud/fast-crud/) | <img alt="GitHub stars" src="https://img.shields.io/github/stars/fast-crud/fast-crud?logo=github"/> | 基于vue3的crud快速开发框架 |
|
||||||
| [dev-sidecar](https://github.com/docmirror/dev-sidecar/) | <img alt="GitHub stars" src="https://img.shields.io/github/stars/docmirror/dev-sidecar?logo=github"/> | 直连访问github工具,无需FQ,解决github无法访问的问题 |
|
| [dev-sidecar](https://github.com/docmirror/dev-sidecar/) | <img alt="GitHub stars" src="https://img.shields.io/github/stars/docmirror/dev-sidecar?logo=github"/> | 直连访问github工具,无需FQ,解决github无法访问的问题 |
|
||||||
|
| [winsvc-manager](https://github.com/greper/winsvc-manager/) | <img alt="GitHub stars" src="https://img.shields.io/github/stars/greper/winsvc-manager?logo=github"/> | 可视化包装应用成为一个Windows服务,使其后台运行 |
|
||||||
|
|||||||
@@ -7,40 +7,40 @@ Certd® is a free, fully automated certificate management system that ensures yo
|
|||||||
> We pioneered the pipeline-based certificate application and deployment model, which has been "referenced" by multiple projects. Being copied is also a form of success.
|
> We pioneered the pipeline-based certificate application and deployment model, which has been "referenced" by multiple projects. Being copied is also a form of success.
|
||||||
|
|
||||||
> Regarding certificate renewal:
|
> Regarding certificate renewal:
|
||||||
>* In fact, it's impossible to renew or reissue a certificate without modifying the certificate file itself.
|
>
|
||||||
>* What we refer to as renewal is essentially applying for a new certificate following the full process and redeploying it.
|
> - In fact, it's impossible to renew or reissue a certificate without modifying the certificate file itself.
|
||||||
>* Free certificates expire in 90 days, which may be shortened in the future. Therefore, automated deployment is essential.
|
> - What we refer to as renewal is essentially applying for a new certificate following the full process and redeploying it.
|
||||||
|
> - Free certificates expire in 90 days, which may be shortened in the future. Therefore, automated deployment is essential.
|
||||||
|
|
||||||
> The number of pipelines is now unlimited. Welcome to use it.
|
> The number of pipelines is now unlimited. Welcome to use it.
|
||||||
|
|
||||||
|
|
||||||
Official Open Source Address:
|
Official Open Source Address:
|
||||||
|
|
||||||
[Github](https://github.com/certd/certd) 
|
[Github](https://github.com/certd/certd) 
|
||||||
[Gitee](https://gitee.com/certd/certd) 
|
[Gitee](https://gitee.com/certd/certd) 
|
||||||
[AtomGit](https://atomgit.com/certd/certd) 
|
[AtomGit](https://atomgit.com/certd/certd) 
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## 1. Features
|
## 1. Features
|
||||||
|
|
||||||
This project not only supports automated certificate application but also automated certificate deployment and updates, ensuring your certificates never expire.
|
This project not only supports automated certificate application but also automated certificate deployment and updates, ensuring your certificates never expire.
|
||||||
|
|
||||||
* Fully automated certificate application (supports domains registered with all registrars and multiple domain verification methods such as DNS-01, HTTP-01, and CNAME proxy).
|
- Fully automated certificate application (supports domains registered with all registrars and multiple domain verification methods such as DNS-01, HTTP-01, and CNAME proxy).
|
||||||
* Fully automated certificate deployment and updates (currently supports deployment to over 70 plugins, including hosts, Alibaba Cloud, Tencent Cloud, etc.).
|
- Fully automated certificate deployment and updates (currently supports deployment to over 70 plugins, including hosts, Alibaba Cloud, Tencent Cloud, etc.).
|
||||||
* Supports wildcard domains/pan-domains, allows multiple domains in a single certificate, and supports various certificate formats such as pem, pfx, der, and jks.
|
- Supports wildcard domains/pan-domains, allows multiple domains in a single certificate, and supports various certificate formats such as pem, pfx, der, and jks.
|
||||||
* Multiple notification methods, including email, webhook, WeChat Work, DingTalk, Lark, and anpush.
|
- Multiple notification methods, including email, webhook, WeChat Work, DingTalk, Lark, and anpush.
|
||||||
* On-premises deployment, local data storage, simple and quick installation. Images are built by Github Actions, with a transparent process.
|
- On-premises deployment, local data storage, simple and quick installation. Images are built by Github Actions, with a transparent process.
|
||||||
* Multiple security measures, including authorization encryption, site hiding, 2FA, and password brute-force protection.
|
- Multiple security measures, including authorization encryption, site hiding, 2FA, and password brute-force protection.
|
||||||
* Supports multiple databases such as SQLite, PostgreSQL, and MySQL.
|
- Supports multiple databases such as SQLite, PostgreSQL, MySQL, and MariaDB.
|
||||||
* Open API support.
|
- Open API support.
|
||||||
* Site certificate monitoring.
|
- Site certificate monitoring.
|
||||||
* Multi-user management.
|
- Multi-user management.
|
||||||
* Multi-language support (Chinese and English switching).
|
- Multi-language support (Chinese and English switching).
|
||||||
* Downward compatibility across all versions, with one-click worry-free upgrades.
|
- Downward compatibility across all versions, with one-click worry-free upgrades.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
## 2. Online Experience
|
## 2. Online Experience
|
||||||
|
|
||||||
Visit the official demo site and register to experience it.
|
Visit the official demo site and register to experience it.
|
||||||
|
|
||||||
https://certd.handfree.work/
|
https://certd.handfree.work/
|
||||||
@@ -51,14 +51,17 @@ https://certd.handfree.work/
|
|||||||

|

|
||||||
|
|
||||||
## 3. Usage Tutorial
|
## 3. Usage Tutorial
|
||||||
|
|
||||||
Just 3 steps to ensure your certificates never expire.
|
Just 3 steps to ensure your certificates never expire.
|
||||||
|
|
||||||
### 1. Create a Certificate Pipeline
|
### 1. Create a Certificate Pipeline
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
> After successful addition, you can directly run the pipeline to apply for a certificate.
|
> After successful addition, you can directly run the pipeline to apply for a certificate.
|
||||||
|
|
||||||
### 2. Add a Deployment Task
|
### 2. Add a Deployment Task
|
||||||
|
|
||||||
Normally, we need to deploy certificates to applications. Certd supports a wide range of deployment plugins. You can choose based on your needs, such as deploying to Nginx, Alibaba Cloud, Tencent Cloud, K8S, CDN, Baota, 1Panel, etc.
|
Normally, we need to deploy certificates to applications. Certd supports a wide range of deployment plugins. You can choose based on your needs, such as deploying to Nginx, Alibaba Cloud, Tencent Cloud, K8S, CDN, Baota, 1Panel, etc.
|
||||||
|
|
||||||
Here's a demonstration of deploying certificates to a host's Nginx:
|
Here's a demonstration of deploying certificates to a host's Nginx:
|
||||||
@@ -68,6 +71,7 @@ If the current deployment plugins don't meet your needs, you can also download t
|
|||||||

|

|
||||||
|
|
||||||
### 3. Run Scheduled Tasks
|
### 3. Run Scheduled Tasks
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓
|
↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓↓
|
||||||
@@ -77,6 +81,7 @@ If the current deployment plugins don't meet your needs, you can also download t
|
|||||||
For more tutorials, please visit the official documentation [certd.docmirror.cn](https://certd.docmirror.cn/guide/).
|
For more tutorials, please visit the official documentation [certd.docmirror.cn](https://certd.docmirror.cn/guide/).
|
||||||
|
|
||||||
## 4. On-Premises Deployment
|
## 4. On-Premises Deployment
|
||||||
|
|
||||||
Since certificates, authorization information, and other data are highly sensitive, please make sure to deploy them on-premises to ensure data security.
|
Since certificates, authorization information, and other data are highly sensitive, please make sure to deploy them on-premises to ensure data security.
|
||||||
|
|
||||||
You can choose one of the following deployment methods based on your needs:
|
You can choose one of the following deployment methods based on your needs:
|
||||||
@@ -85,87 +90,98 @@ You can choose one of the following deployment methods based on your needs:
|
|||||||
2. 【Recommended】[BT Panel Deployment](https://certd.docmirror.cn/guide/install/docker/)
|
2. 【Recommended】[BT Panel Deployment](https://certd.docmirror.cn/guide/install/docker/)
|
||||||
3. 【Recommended】[1Panel Deployment](https://certd.docmirror.cn/guide/install/1panel/)
|
3. 【Recommended】[1Panel Deployment](https://certd.docmirror.cn/guide/install/1panel/)
|
||||||
4. 【Recommended】[Rainyun One-Click Deployment](https://app.rainyun.com/apps/rca/store/6646/?ref=NzExMDQ2_): Double your first recharge, only $2.2 per month.
|
4. 【Recommended】[Rainyun One-Click Deployment](https://app.rainyun.com/apps/rca/store/6646/?ref=NzExMDQ2_): Double your first recharge, only $2.2 per month.
|
||||||
[<img src="https://rainyun-apps.cn-nb1.rains3.com/materials/deploy-on-rainyun-cn.svg">](https://app.rainyun.com/apps/rca/store/6646/?ref=NzExMDQ2_)
|
[<img src="https://rainyun-apps.cn-nb1.rains3.com/materials/deploy-on-rainyun-cn.svg">](https://app.rainyun.com/apps/rca/store/6646/?ref=NzExMDQ2_)
|
||||||
5. 【Not Recommended】[Source Code Deployment](https://certd.docmirror.cn/guide/install/source/)
|
5. 【Not Recommended】[Source Code Deployment](https://certd.docmirror.cn/guide/install/source/)
|
||||||
|
|
||||||
#### Docker Image Information:
|
#### Docker Image Information:
|
||||||
* Domestic Image Addresses:
|
|
||||||
* `registry.cn-shenzhen.aliyuncs.com/handsfree/certd:latest`
|
|
||||||
* `registry.cn-shenzhen.aliyuncs.com/handsfree/certd:armv7`, `[version]-armv7`
|
|
||||||
* DockerHub Addresses:
|
|
||||||
* `https://hub.docker.com/r/greper/certd`
|
|
||||||
* `greper/certd:latest`
|
|
||||||
* `greper/certd:armv7`, `greper/certd:[version]-armv7`
|
|
||||||
* GitHub Packages Addresses:
|
|
||||||
* `ghcr.io/certd/certd:latest`
|
|
||||||
* `ghcr.io/certd/certd:armv7`, `ghcr.io/certd/certd:[version]-armv7`
|
|
||||||
|
|
||||||
* Images are built automatically by `Actions`, with a transparent process. Please use them with confidence.
|
- Domestic Image Addresses:
|
||||||
* [Click here to view image build logs](https://github.com/certd/certd/actions/workflows/build-image.yml)
|
- `registry.cn-shenzhen.aliyuncs.com/handsfree/certd:latest`
|
||||||
|
- `registry.cn-shenzhen.aliyuncs.com/handsfree/certd:armv7`, `[version]-armv7`
|
||||||
|
- DockerHub Addresses:
|
||||||
|
- `https://hub.docker.com/r/greper/certd`
|
||||||
|
- `greper/certd:latest`
|
||||||
|
- `greper/certd:armv7`, `greper/certd:[version]-armv7`
|
||||||
|
- GitHub Packages Addresses:
|
||||||
|
|
||||||
|
- `ghcr.io/certd/certd:latest`
|
||||||
|
- `ghcr.io/certd/certd:armv7`, `ghcr.io/certd/certd:[version]-armv7`
|
||||||
|
|
||||||
|
- Images are built automatically by `Actions`, with a transparent process. Please use them with confidence.
|
||||||
|
- [Click here to view image build logs](https://github.com/certd/certd/actions/workflows/build-image.yml)
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
> Note:
|
> Note:
|
||||||
> * The certificates, authorization information, and other data stored in this application are highly sensitive. Please take appropriate security measures.
|
>
|
||||||
> * Make sure to use the HTTPS protocol to access this application to avoid man-in-the-middle attacks.
|
> - The certificates, authorization information, and other data stored in this application are highly sensitive. Please take appropriate security measures.
|
||||||
> * Make sure to use a web application firewall to protect this application from attacks such as XSS and SQL injection.
|
> - Make sure to use the HTTPS protocol to access this application to avoid man-in-the-middle attacks.
|
||||||
> * Make sure to secure the server itself to prevent database leakage.
|
> - Make sure to use a web application firewall to protect this application from attacks such as XSS and SQL injection.
|
||||||
> * Make sure to back up your data to avoid data loss.
|
> - Make sure to secure the server itself to prevent database leakage.
|
||||||
> * [Click here for more production safety suggestions](https://certd.docmirror.cn/guide/feature/safe/)
|
> - Make sure to back up your data to avoid data loss.
|
||||||
|
> - [Click here for more production safety suggestions](https://certd.docmirror.cn/guide/feature/safe/)
|
||||||
|
|
||||||
## 5. Ecosystem
|
## 5. Ecosystem
|
||||||
|
|
||||||
### 1. Client Tool: SSL-Assistant
|
### 1. Client Tool: SSL-Assistant
|
||||||
|
|
||||||
`SSL Assistant` is a certificate deployment and management assistant client that runs on hosts. It supports automatic scanning of the host's `Nginx` configuration and pulling certificates from `Certd` for deployment. This tool is very useful when you don't want to expose your SSH host password.
|
`SSL Assistant` is a certificate deployment and management assistant client that runs on hosts. It supports automatic scanning of the host's `Nginx` configuration and pulling certificates from `Certd` for deployment. This tool is very useful when you don't want to expose your SSH host password.
|
||||||
|
|
||||||
Open-source Address: https://github.com/Youngxj/SSL-Assistant
|
Open-source Address: https://github.com/Youngxj/SSL-Assistant
|
||||||
|
|
||||||
## 6. More Help
|
## 6. More Help
|
||||||
|
|
||||||
Please visit the official documentation: [https://certd.docmirror.cn/](https://certd.docmirror.cn/guide/).
|
Please visit the official documentation: [https://certd.docmirror.cn/](https://certd.docmirror.cn/guide/).
|
||||||
|
|
||||||
* Upgrade Method: [Upgrade Guide](https://certd.docmirror.cn/guide/install/upgrade/)
|
- Upgrade Method: [Upgrade Guide](https://certd.docmirror.cn/guide/install/upgrade/)
|
||||||
* Common Issues: [Forgot Password](https://certd.docmirror.cn/guide/use/forgotpasswd/)
|
- Common Issues: [Forgot Password](https://certd.docmirror.cn/guide/use/forgotpasswd/)
|
||||||
* Multi-Database: [Multi-Database Configuration](https://certd.docmirror.cn/guide/install/database/)
|
- Multi-Database: [Multi-Database Configuration](https://certd.docmirror.cn/guide/install/database/)
|
||||||
* Site Security: [Site Security Features](https://certd.docmirror.cn/guide/feature/safe/)
|
- Site Security: [Site Security Features](https://certd.docmirror.cn/guide/feature/safe/)
|
||||||
* Changelog: [CHANGELOG](./CHANGELOG.md)
|
- Changelog: [CHANGELOG](./CHANGELOG.md)
|
||||||
|
|
||||||
## 7. Contact the Author
|
## 7. Contact the Author
|
||||||
|
|
||||||
If you have any questions, feel free to join the group chat (please mention 'certd' in your message).
|
If you have any questions, feel free to join the group chat (please mention 'certd' in your message).
|
||||||
|
|
||||||
| Join Group | WeChat Group | QQ Group |
|
| Join Group | WeChat Group | QQ Group |
|
||||||
|---------|-------|-------|
|
| ---------- | ----------------------------------------------------------- | ----------------------------------------------------------- |
|
||||||
| QR Code | <img height="230" src="./docs/guide/contact/images/wx.png"> | <img height="230" src="./docs/guide/contact/images/qq.png"> |
|
| QR Code | <img height="230" src="./docs/guide/contact/images/wx.png"> | <img height="230" src="./docs/guide/contact/images/qq.png"> |
|
||||||
|
|
||||||
You can also add the author as a friend.
|
You can also add the author as a friend.
|
||||||
|
|
||||||
| Add Author as Friend | WeChat QQ |
|
| Add Author as Friend | WeChat QQ |
|
||||||
|---------|-------|-------|
|
| -------------------- | ----------------------------------------------------------- |
|
||||||
| QR Code | <img height="230" src="./docs/guide/contact/images/me.png"> |
|
| QR Code | <img height="230" src="./docs/guide/contact/images/me.png"> |
|
||||||
|
|
||||||
## 8. Donation
|
## 8. Donation
|
||||||
************************
|
|
||||||
[](https://github.com/sponsors/greper)
|
---
|
||||||
************************
|
|
||||||
|
[](https://github.com/sponsors/greper)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
Support open-source projects and contribute with love. I've joined Afdian.
|
Support open-source projects and contribute with love. I've joined Afdian.
|
||||||
https://afdian.com/a/greper
|
https://afdian.com/a/greper
|
||||||
|
|
||||||
Benefits of Contribution:
|
Benefits of Contribution:
|
||||||
|
|
||||||
1. Join the exclusive contributor group and get one-on-one technical support from the author.
|
1. Join the exclusive contributor group and get one-on-one technical support from the author.
|
||||||
2. Your requests will be prioritized and implemented as professional edition features.
|
2. Your requests will be prioritized and implemented as professional edition features.
|
||||||
3. Receive a one-year professional edition activation code.
|
3. Receive a one-year professional edition activation code.
|
||||||
|
|
||||||
Comparison of Professional Edition Privileges:
|
Comparison of Professional Edition Privileges:
|
||||||
|
|
||||||
| Feature | Free Edition | Professional Edition |
|
| Feature | Free Edition | Professional Edition |
|
||||||
|---------|---------------------------------------|--------------------------------|
|
| ------------------------------- | ------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------- |
|
||||||
| Free Certificate Application | Unlimited for free | Unlimited for free |
|
| Free Certificate Application | Unlimited for free | Unlimited for free |
|
||||||
| Number of Domains | Unlimited | Unlimited |
|
| Number of Domains | Unlimited | Unlimited |
|
||||||
| Number of Certificate Pipelines | Unlimited | Unlimited |
|
| Number of Certificate Pipelines | Unlimited | Unlimited |
|
||||||
| Site Certificate Monitoring | Limited to 1 | Unlimited |
|
| Site Certificate Monitoring | Limited to 1 | Unlimited |
|
||||||
| Automatic Deployment Plugins | Most plugins such as Alibaba Cloud CDN, Tencent Cloud, QiNiu CDN, Host Deployment, Baota, 1Panel | Synology |
|
| Automatic Deployment Plugins | Most plugins such as Alibaba Cloud CDN, Tencent Cloud, QiNiu CDN, Host Deployment, Baota, 1Panel | Synology |
|
||||||
| Notifications | Email, Custom Webhook | Email without configuration, WeChat Work, DingTalk, Lark, anpush, ServerChan, etc. |
|
| Notifications | Email, Custom Webhook | Email without configuration, WeChat Work, DingTalk, Lark, anpush, ServerChan, etc. |
|
||||||
|
|
||||||
************************
|
---
|
||||||
|
|
||||||
## 9. Contribute Code
|
## 9. Contribute Code
|
||||||
|
|
||||||
@@ -181,14 +197,15 @@ Thank you to the following contributors.
|
|||||||
</a>
|
</a>
|
||||||
|
|
||||||
## 10. Open-Source License
|
## 10. Open-Source License
|
||||||
* This project follows the GNU Affero General Public License (AGPL).
|
|
||||||
* Individuals and companies are allowed to use, copy, modify, and distribute this project freely for internal use. Any form of commercial use is prohibited without obtaining commercial authorization.
|
- This project follows the GNU Affero General Public License (AGPL).
|
||||||
* Without commercial authorization, any modification of the logo, copyright information, and license-related code is prohibited.
|
- Individuals and companies are allowed to use, copy, modify, and distribute this project freely for internal use. Any form of commercial use is prohibited without obtaining commercial authorization.
|
||||||
* For commercial authorization, please contact the author.
|
- Without commercial authorization, any modification of the logo, copyright information, and license-related code is prohibited.
|
||||||
|
- For commercial authorization, please contact the author.
|
||||||
|
|
||||||
## 11. My Other Projects (Please Star)
|
## 11. My Other Projects (Please Star)
|
||||||
|
|
||||||
| Project Name | Stars | Project Description |
|
| Project Name | Stars | Project Description |
|
||||||
|----------------|---------------|--------------|
|
| -------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
|
||||||
| [fast-crud](https://gitee.com/fast-crud/fast-crud/) | <img alt="GitHub stars" src="https://img.shields.io/github/stars/fast-crud/fast-crud?logo=github"/> | A fast CRUD development framework based on Vue3. |
|
| [fast-crud](https://gitee.com/fast-crud/fast-crud/) | <img alt="GitHub stars" src="https://img.shields.io/github/stars/fast-crud/fast-crud?logo=github"/> | A fast CRUD development framework based on Vue3. |
|
||||||
| [dev-sidecar](https://github.com/docmirror/dev-sidecar/) | <img alt="GitHub stars" src="https://img.shields.io/github/stars/docmirror/dev-sidecar?logo=github"/> | A tool to access GitHub directly without a VPN, solving the problem of inaccessible GitHub. |
|
| [dev-sidecar](https://github.com/docmirror/dev-sidecar/) | <img alt="GitHub stars" src="https://img.shields.io/github/stars/docmirror/dev-sidecar?logo=github"/> | A tool to access GitHub directly without a VPN, solving the problem of inaccessible GitHub. |
|
||||||
|
|||||||
@@ -0,0 +1,95 @@
|
|||||||
|
version: '3.3' # 兼容旧版docker-compose
|
||||||
|
services:
|
||||||
|
certd:
|
||||||
|
# 镜像 # ↓↓↓↓↓ ---- 镜像版本号,建议改成固定版本号,例如:certd:1.29.0
|
||||||
|
image: registry.cn-shenzhen.aliyuncs.com/handsfree/certd:latest
|
||||||
|
# image: ghcr.io/certd/certd:latest # --------- 如果 报镜像not found,可以尝试其他镜像源
|
||||||
|
# image: greper/certd:latest
|
||||||
|
container_name: certd # 容器名
|
||||||
|
restart: unless-stopped # 自动重启
|
||||||
|
volumes:
|
||||||
|
# ↓↓↓↓↓ -------------------------------------------------------- 数据库以及证书存储路径,默认存在宿主机的/data/certd/目录下,【您需要定时备份此目录,以保障数据容灾】
|
||||||
|
- /data/certd:/app/data # 只要修改冒号前面的,冒号后面的/app/data切记切记不要动
|
||||||
|
#- /volume1/docker/certd:/app/data:delegated #群晖使用这个配置
|
||||||
|
# ↓↓↓↓↓ -------------------------------------------------------- 如果走时不准,考虑挂载localtime文件
|
||||||
|
#- /etc/localtime:/etc/localtime
|
||||||
|
#- /etc/timezone:/etc/timezone
|
||||||
|
ports: # 端口映射
|
||||||
|
# ↓↓↓↓ ---------------------------------------------------------- 如果端口有冲突,可以修改第一个7001为其他不冲突的端口号,第二个7001不要动
|
||||||
|
- "7001:7001"
|
||||||
|
# ↓↓↓↓ ---------------------------------------------------------- https端口,可以根据实际情况,是否暴露该端口
|
||||||
|
- "7002:7002"
|
||||||
|
#↓↓↓↓ -------------------------------------------------------------- 如果出现getaddrinfo EAI_AGAIN 或 getaddrinfo ENOTFOUND 错误,可以尝试设置dns
|
||||||
|
# dns:
|
||||||
|
# - 223.5.5.5 # 阿里云公共dns
|
||||||
|
# - 223.6.6.6
|
||||||
|
# # ↓↓↓↓ --------------------------------------------------------- 如果你服务器在腾讯云,可以用这个替换上面阿里云的公共dns
|
||||||
|
# - 119.29.29.29 # 腾讯云公共dns
|
||||||
|
# - 182.254.116.116
|
||||||
|
# # ↓↓↓↓ --------------------------------------------------------- 如果你服务器部署在国外,可以用这个替换上面阿里云的公共dns
|
||||||
|
# - 8.8.8.8 # 谷歌公共dns
|
||||||
|
# - 8.8.4.4
|
||||||
|
# extra_hosts:
|
||||||
|
# # ↓↓↓↓ -------------------------------------------------------- 这里可以配置自定义hosts,外网域名可以指向本地局域网ip地址
|
||||||
|
# - "localdomain.com:192.168.1.3"
|
||||||
|
# # ↓↓↓↓ ------------------------------------------------ 直接使用主机的网络,如果网络问题实在找不到原因,可以尝试打开此参数
|
||||||
|
# network_mode: host
|
||||||
|
labels:
|
||||||
|
com.centurylinklabs.watchtower.enable: "true"
|
||||||
|
# ↓↓↓↓ -------------------------------------------------------------- 启用ipv6网络,还需要把下面networks的注释放开
|
||||||
|
# networks:
|
||||||
|
# - ip6net
|
||||||
|
environment:
|
||||||
|
# ↓↓↓↓ ----------------------------------------------------- 使用上海东八时区
|
||||||
|
- TZ=Asia/Shanghai
|
||||||
|
# 设置环境变量即可自定义certd配置
|
||||||
|
# 配置项见: packages/ui/certd-server/src/config/config.default.ts
|
||||||
|
# 配置规则: certd_ + 配置项, 点号用_代替
|
||||||
|
# #↓↓↓↓ ----------------------------- 如果忘记管理员密码,可以设置为true,docker compose up -d 重建容器之后,管理员密码将改成123456,然后请及时修改回false
|
||||||
|
- certd_system_resetAdminPasswd=false
|
||||||
|
# ↓↓↓ 要使用ipv6,将此配置修改为::
|
||||||
|
- certd_koa_hostname=0.0.0.0
|
||||||
|
|
||||||
|
# 默认使用sqlite文件数据库,如果需要使用其他数据库,请设置以下环境变量
|
||||||
|
# 注意: 选定使用一种数据库之后,不支持更换数据库。
|
||||||
|
# 数据库迁移方法:1、使用新数据库重新部署一套,然后将旧数据同步过去,注意flyway_history表的数据不要同步
|
||||||
|
# #↓↓↓↓ ----------------------------- 使用postgresql数据库,需要提前创建数据库
|
||||||
|
# - certd_flyway_scriptDir=./db/migration-pg # 升级脚本目录
|
||||||
|
# - certd_typeorm_dataSource_default_type=postgres # 数据库类型
|
||||||
|
# - certd_typeorm_dataSource_default_host=localhost # 数据库地址
|
||||||
|
# - certd_typeorm_dataSource_default_port=5433 # 数据库端口
|
||||||
|
# - certd_typeorm_dataSource_default_username=postgres # 用户名
|
||||||
|
# - certd_typeorm_dataSource_default_password=yourpasswd # 密码
|
||||||
|
# - certd_typeorm_dataSource_default_database=certd # 数据库名
|
||||||
|
|
||||||
|
# #↓↓↓↓ ----------------------------- 使用mysql8数据库,需要提前创建数据库 charset=utf8mb4, collation=utf8mb4_bin
|
||||||
|
# - certd_flyway_scriptDir=./db/migration-mysql # 升级脚本目录
|
||||||
|
# - certd_typeorm_dataSource_default_type=mysql # 数据库类型, 或者 mariadb
|
||||||
|
# - certd_typeorm_dataSource_default_host=localhost # 数据库地址
|
||||||
|
# - certd_typeorm_dataSource_default_port=3306 # 数据库端口
|
||||||
|
# - certd_typeorm_dataSource_default_username=root # 用户名
|
||||||
|
# - certd_typeorm_dataSource_default_password=yourpasswd # 密码
|
||||||
|
# - certd_typeorm_dataSource_default_database=certd # 数据库名
|
||||||
|
|
||||||
|
# ↓↓↓↓ --------------------------------------------------------- 自动升级,上面certd的版本号要保持为latest
|
||||||
|
certd-updater: # 添加 Watchtower 服务
|
||||||
|
image: containrrr/watchtower:latest
|
||||||
|
container_name: certd-updater
|
||||||
|
restart: unless-stopped
|
||||||
|
volumes:
|
||||||
|
- /var/run/docker.sock:/var/run/docker.sock
|
||||||
|
# 配置 自动更新
|
||||||
|
environment:
|
||||||
|
- WATCHTOWER_CLEANUP=true # 自动清理旧版本容器
|
||||||
|
- WATCHTOWER_INCLUDE_STOPPED=false # 不更新已停止的容器
|
||||||
|
- WATCHTOWER_LABEL_ENABLE=true # 根据容器标签进行更新
|
||||||
|
- WATCHTOWER_POLL_INTERVAL=600 # 每 10 分钟检查一次更新
|
||||||
|
|
||||||
|
|
||||||
|
# ↓↓↓↓ -------------------------------------------------------------- 启用ipv6网络,还需要把上面networks的注释放开
|
||||||
|
#networks:
|
||||||
|
# ip6net:
|
||||||
|
# enable_ipv6: true
|
||||||
|
# ipam:
|
||||||
|
# config:
|
||||||
|
# - subnet: 2001:db8::/64
|
||||||
@@ -0,0 +1,340 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
set -e
|
||||||
|
|
||||||
|
CERTD_VERSION="${CERTD_VERSION:-latest}"
|
||||||
|
INSTALL_DIR="${INSTALL_DIR:-/opt/certd}"
|
||||||
|
COMPOSE_FILE_URL="https://gitee.com/certd/certd/raw/v2/docker/run/docker-compose.yaml"
|
||||||
|
COMPOSE_FILE="$INSTALL_DIR/docker-compose.yaml"
|
||||||
|
|
||||||
|
DOCKER_MIRROR="https://mirrors.aliyun.com"
|
||||||
|
|
||||||
|
RED='\033[0;31m'
|
||||||
|
GREEN='\033[0;32m'
|
||||||
|
YELLOW='\033[1;33m'
|
||||||
|
NC='\033[0m'
|
||||||
|
|
||||||
|
log_info() {
|
||||||
|
echo -e "${GREEN}[INFO]${NC} $1"
|
||||||
|
}
|
||||||
|
|
||||||
|
log_warn() {
|
||||||
|
echo -e "${YELLOW}[WARN]${NC} $1"
|
||||||
|
}
|
||||||
|
|
||||||
|
log_error() {
|
||||||
|
echo -e "${RED}[ERROR]${NC} $1"
|
||||||
|
}
|
||||||
|
|
||||||
|
check_command() {
|
||||||
|
command -v "$1" >/dev/null 2>&1
|
||||||
|
}
|
||||||
|
|
||||||
|
get_local_ip() {
|
||||||
|
LOCAL_IP=$(ip route get 1.1.1.1 2>/dev/null | grep -oP 'src \K[^ ]+' | head -1)
|
||||||
|
if [ -z "$LOCAL_IP" ]; then
|
||||||
|
LOCAL_IP=$(hostname -I 2>/dev/null | awk '{print $1}')
|
||||||
|
fi
|
||||||
|
if [ -z "$LOCAL_IP" ]; then
|
||||||
|
LOCAL_IP="127.0.0.1"
|
||||||
|
fi
|
||||||
|
echo "$LOCAL_IP"
|
||||||
|
}
|
||||||
|
|
||||||
|
get_public_ip() {
|
||||||
|
PUBLIC_IP=$(curl -s --max-time 5 https://api.ipify.org 2>/dev/null)
|
||||||
|
if [ -z "$PUBLIC_IP" ]; then
|
||||||
|
PUBLIC_IP=$(curl -s --max-time 5 https://checkip.amazonaws.com 2>/dev/null)
|
||||||
|
fi
|
||||||
|
if [ -z "$PUBLIC_IP" ]; then
|
||||||
|
PUBLIC_IP=""
|
||||||
|
fi
|
||||||
|
echo "$PUBLIC_IP"
|
||||||
|
}
|
||||||
|
|
||||||
|
show_access_urls() {
|
||||||
|
LOCAL_IP=$(get_local_ip)
|
||||||
|
PUBLIC_IP=$(get_public_ip)
|
||||||
|
|
||||||
|
echo ""
|
||||||
|
echo "=========================================="
|
||||||
|
log_info "安装完成!"
|
||||||
|
echo "=========================================="
|
||||||
|
echo ""
|
||||||
|
echo "访问地址:"
|
||||||
|
if [ -n "$PUBLIC_IP" ]; then
|
||||||
|
echo -e " ${GREEN}外网访问:${NC} http://$PUBLIC_IP:7001"
|
||||||
|
fi
|
||||||
|
echo -e " ${GREEN}局域网:${NC} http://$LOCAL_IP:7001"
|
||||||
|
echo ""
|
||||||
|
echo "配置文件: $COMPOSE_FILE"
|
||||||
|
echo ""
|
||||||
|
echo "常用命令:"
|
||||||
|
echo " cd $INSTALL_DIR"
|
||||||
|
echo " docker compose logs -f # 查看日志"
|
||||||
|
echo " docker compose restart # 重启服务"
|
||||||
|
echo " docker compose down # 停止服务"
|
||||||
|
echo ""
|
||||||
|
}
|
||||||
|
|
||||||
|
detect_os() {
|
||||||
|
if [ -f /etc/os-release ]; then
|
||||||
|
. /etc/os-release
|
||||||
|
OS=$ID
|
||||||
|
VER=$VERSION_ID
|
||||||
|
elif [ -f /etc/centos-release ]; then
|
||||||
|
OS="centos"
|
||||||
|
elif [ -f /etc/redhat-release ]; then
|
||||||
|
OS="rhel"
|
||||||
|
else
|
||||||
|
OS="unknown"
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
check_docker() {
|
||||||
|
if check_command docker; then
|
||||||
|
DOCKER_VERSION=$(docker --version 2>/dev/null | awk '{print $3}' | tr -d ',')
|
||||||
|
log_info "Docker 已安装: $DOCKER_VERSION"
|
||||||
|
return 0
|
||||||
|
else
|
||||||
|
log_warn "Docker 未安装"
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
check_docker_compose() {
|
||||||
|
if check_command docker-compose; then
|
||||||
|
COMPOSE_VERSION=$(docker-compose --version 2>/dev/null | awk '{print $3}' | tr -d ',')
|
||||||
|
log_info "Docker Compose 已安装: $COMPOSE_VERSION"
|
||||||
|
return 0
|
||||||
|
elif docker compose version >/dev/null 2>&1; then
|
||||||
|
log_info "Docker Compose (插件版) 已安装"
|
||||||
|
return 0
|
||||||
|
else
|
||||||
|
log_warn "Docker Compose 未安装"
|
||||||
|
return 1
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
install_docker_ubuntu() {
|
||||||
|
log_info "正在安装 Docker (Ubuntu/Debian)..."
|
||||||
|
apt-get update
|
||||||
|
apt-get install -y ca-certificates curl gnupg lsb-release
|
||||||
|
|
||||||
|
mkdir -p /etc/apt/keyrings
|
||||||
|
curl -fsSL https://mirrors.aliyun.com/docker-ce/linux/${OS}/gpg | gpg --dearmor -o /etc/apt/keyrings/docker.gpg 2>/dev/null || \
|
||||||
|
curl -fsSL https://download.docker.com/linux/${OS}/gpg | gpg --dearmor -o /etc/apt/keyrings/docker.gpg
|
||||||
|
|
||||||
|
echo "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.gpg] https://mirrors.aliyun.com/docker-ce/linux/${OS} $(lsb_release -cs) stable" | tee /etc/apt/sources.list.d/docker.list > /dev/null
|
||||||
|
|
||||||
|
apt-get update
|
||||||
|
apt-get install -y docker-ce docker-ce-cli containerd.io docker-compose-plugin
|
||||||
|
systemctl enable docker
|
||||||
|
systemctl start docker
|
||||||
|
|
||||||
|
log_info "Docker 安装完成"
|
||||||
|
}
|
||||||
|
|
||||||
|
install_docker_centos() {
|
||||||
|
log_info "正在安装 Docker (CentOS/RHEL)..."
|
||||||
|
yum install -y yum-utils
|
||||||
|
yum-config-manager --add-repo https://mirrors.aliyun.com/docker-ce/linux/centos/docker-ce.repo
|
||||||
|
yum install -y docker-ce docker-ce-cli containerd.io docker-compose-plugin
|
||||||
|
systemctl enable docker
|
||||||
|
systemctl start docker
|
||||||
|
|
||||||
|
log_info "Docker 安装完成"
|
||||||
|
}
|
||||||
|
|
||||||
|
install_dockerrocky() {
|
||||||
|
log_info "正在安装 Docker (Rocky Linux/AlmaLinux)..."
|
||||||
|
dnf install -y yum-utils
|
||||||
|
dnf config-manager --add-repo https://mirrors.aliyun.com/docker-ce/linux/centos/docker-ce.repo
|
||||||
|
dnf install -y docker-ce docker-ce-cli containerd.io docker-compose-plugin
|
||||||
|
systemctl enable docker
|
||||||
|
systemctl start docker
|
||||||
|
|
||||||
|
log_info "Docker 安装完成"
|
||||||
|
}
|
||||||
|
|
||||||
|
install_docker_debian() {
|
||||||
|
log_info "正在安装 Docker (Debian)..."
|
||||||
|
apt-get update
|
||||||
|
apt-get install -y ca-certificates curl gnupg2
|
||||||
|
|
||||||
|
mkdir -p /etc/apt/keyrings
|
||||||
|
curl -fsSL https://mirrors.aliyun.com/docker-ce/linux/debian/gpg | gpg --armor -o /etc/apt/keyrings/docker.gpg 2>/dev/null || \
|
||||||
|
curl -fsSL https://download.docker.com/linux/debian/gpg | gpg --armor -o /etc/apt/keyrings/docker.gpg
|
||||||
|
|
||||||
|
echo "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.gpg] https://mirrors.aliyun.com/docker-ce/linux/debian $(lsb_release -cs) stable" | tee /etc/apt/sources.list.d/docker.list
|
||||||
|
|
||||||
|
apt-get update
|
||||||
|
apt-get install -y docker-ce docker-ce-cli containerd.io docker-compose-plugin
|
||||||
|
systemctl enable docker
|
||||||
|
systemctl start docker
|
||||||
|
|
||||||
|
log_info "Docker 安装完成"
|
||||||
|
}
|
||||||
|
|
||||||
|
install_docker() {
|
||||||
|
detect_os
|
||||||
|
log_info "检测到操作系统: $OS"
|
||||||
|
|
||||||
|
case $OS in
|
||||||
|
ubuntu)
|
||||||
|
install_docker_ubuntu
|
||||||
|
;;
|
||||||
|
debian)
|
||||||
|
install_docker_debian
|
||||||
|
;;
|
||||||
|
centos)
|
||||||
|
install_docker_centos
|
||||||
|
;;
|
||||||
|
rhel|rocky|almalinux)
|
||||||
|
install_dockerrocky
|
||||||
|
;;
|
||||||
|
*)
|
||||||
|
log_error "不支持的操作系统: $OS"
|
||||||
|
log_info "请手动安装 Docker"
|
||||||
|
exit 1
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
}
|
||||||
|
|
||||||
|
install_docker_compose_standalone() {
|
||||||
|
log_info "正在安装 Docker Compose (独立版本)..."
|
||||||
|
|
||||||
|
COMPOSE_URLS=(
|
||||||
|
"https://get.daocloud.io/docker/compose/releases/download/v2.12.2/docker-compose-$(uname -s)-$(uname -m)"
|
||||||
|
"https://mirror.sjtu.edu.cn/github/docker/compose/releases/download/v2.12.2/docker-compose-$(uname -s)-$(uname -m)"
|
||||||
|
"https://github.com/docker/compose/releases/download/v2.12.2/docker-compose-$(uname -s)-$(uname -m)"
|
||||||
|
)
|
||||||
|
|
||||||
|
for url in "${COMPOSE_URLS[@]}"; do
|
||||||
|
log_info "尝试从: $url"
|
||||||
|
if curl -L "$url" -o /usr/local/bin/docker-compose 2>/dev/null; then
|
||||||
|
chmod +x /usr/local/bin/docker-compose
|
||||||
|
log_info "Docker Compose 安装完成"
|
||||||
|
return 0
|
||||||
|
fi
|
||||||
|
log_warn "下载失败,尝试下一个源..."
|
||||||
|
done
|
||||||
|
|
||||||
|
log_error "Docker Compose 安装失败"
|
||||||
|
return 1
|
||||||
|
}
|
||||||
|
|
||||||
|
install_docker_compose() {
|
||||||
|
if check_command docker && docker compose version >/dev/null 2>&1; then
|
||||||
|
log_info "Docker Compose 插件已可用"
|
||||||
|
return 0
|
||||||
|
fi
|
||||||
|
|
||||||
|
if check_command docker-compose; then
|
||||||
|
log_info "Docker Compose 独立版本已安装"
|
||||||
|
return 0
|
||||||
|
fi
|
||||||
|
|
||||||
|
install_docker_compose_standalone
|
||||||
|
}
|
||||||
|
|
||||||
|
download_compose_file() {
|
||||||
|
log_info "正在下载 docker-compose.yaml..."
|
||||||
|
mkdir -p "$INSTALL_DIR"
|
||||||
|
|
||||||
|
if curl -fsSL "$COMPOSE_FILE_URL" -o "$COMPOSE_FILE.tmp"; then
|
||||||
|
mv "$COMPOSE_FILE.tmp" "$COMPOSE_FILE"
|
||||||
|
log_info "docker-compose.yaml 已下载到 $COMPOSE_FILE"
|
||||||
|
|
||||||
|
if [ "$CERTD_VERSION" != "latest" ]; then
|
||||||
|
sed -i "s|certd:latest|certd:$CERTD_VERSION|g" "$COMPOSE_FILE"
|
||||||
|
log_info "已修改镜像版本为: $CERTD_VERSION"
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
log_error "下载失败,请检查网络连接"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
start_certd() {
|
||||||
|
log_info "正在启动 Certd 容器..."
|
||||||
|
cd "$INSTALL_DIR"
|
||||||
|
|
||||||
|
if docker compose -f "$COMPOSE_FILE" up -d 2>/dev/null; then
|
||||||
|
log_info "Certd 启动成功!"
|
||||||
|
elif docker-compose -f "$COMPOSE_FILE" up -d; then
|
||||||
|
log_info "Certd 启动成功!"
|
||||||
|
fi
|
||||||
|
|
||||||
|
sleep 2
|
||||||
|
docker ps --filter "name=certd" --format "table {{.Names}}\t{{.Status}}\t{{.Ports}}"
|
||||||
|
}
|
||||||
|
|
||||||
|
show_usage() {
|
||||||
|
echo "用法: $0 [选项]"
|
||||||
|
echo ""
|
||||||
|
echo "选项:"
|
||||||
|
echo " -v, --version VERSION 指定 Certd 版本 (默认: latest)"
|
||||||
|
echo " -p, --path PATH 指定安装路径 (默认: /opt/certd)"
|
||||||
|
echo " -h, --help 显示帮助信息"
|
||||||
|
echo ""
|
||||||
|
echo "示例:"
|
||||||
|
echo " $0 # 使用默认配置安装"
|
||||||
|
echo " $0 -v 1.29.0 # 安装指定版本"
|
||||||
|
echo " $0 -p /data/certd # 安装到指定目录"
|
||||||
|
}
|
||||||
|
|
||||||
|
main() {
|
||||||
|
echo "=========================================="
|
||||||
|
echo " Certd 一键安装脚本"
|
||||||
|
echo "=========================================="
|
||||||
|
echo ""
|
||||||
|
|
||||||
|
while [[ $# -gt 0 ]]; do
|
||||||
|
case $1 in
|
||||||
|
-v|--version)
|
||||||
|
CERTD_VERSION="$2"
|
||||||
|
shift 2
|
||||||
|
;;
|
||||||
|
-p|--path)
|
||||||
|
INSTALL_DIR="$2"
|
||||||
|
COMPOSE_FILE="$INSTALL_DIR/docker-compose.yaml"
|
||||||
|
shift 2
|
||||||
|
;;
|
||||||
|
-h|--help)
|
||||||
|
show_usage
|
||||||
|
exit 0
|
||||||
|
;;
|
||||||
|
*)
|
||||||
|
log_error "未知选项: $1"
|
||||||
|
show_usage
|
||||||
|
exit 1
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
done
|
||||||
|
|
||||||
|
log_info "Certd 版本: $CERTD_VERSION"
|
||||||
|
log_info "安装路径: $INSTALL_DIR"
|
||||||
|
echo ""
|
||||||
|
|
||||||
|
DOCKER_INSTALLED=true
|
||||||
|
COMPOSE_INSTALLED=true
|
||||||
|
|
||||||
|
if ! check_docker; then
|
||||||
|
echo ""
|
||||||
|
log_info "正在安装 Docker..."
|
||||||
|
install_docker
|
||||||
|
fi
|
||||||
|
|
||||||
|
if ! check_docker_compose; then
|
||||||
|
echo ""
|
||||||
|
log_info "正在安装 Docker Compose..."
|
||||||
|
install_docker_compose
|
||||||
|
fi
|
||||||
|
|
||||||
|
download_compose_file
|
||||||
|
start_certd
|
||||||
|
|
||||||
|
show_access_urls
|
||||||
|
}
|
||||||
|
|
||||||
|
main "$@"
|
||||||
@@ -114,16 +114,19 @@ export default defineConfig({
|
|||||||
{text: "连接windows主机", link: "/guide/use/host/windows.md"},
|
{text: "连接windows主机", link: "/guide/use/host/windows.md"},
|
||||||
{text: "Google EAB获取", link: "/guide/use/google/"},
|
{text: "Google EAB获取", link: "/guide/use/google/"},
|
||||||
{text: "阿里云相关", link: "/guide/use/aliyun/"},
|
{text: "阿里云相关", link: "/guide/use/aliyun/"},
|
||||||
|
{text: "Azure相关", link: "/guide/use/azure/dns.md"},
|
||||||
{text: "数据备份", link: "/guide/use/backup/"},
|
{text: "数据备份", link: "/guide/use/backup/"},
|
||||||
{text: "Certd本身的证书更新", link: "/guide/use/https/index.md"},
|
{text: "Certd本身的证书更新", link: "/guide/use/https/index.md"},
|
||||||
{text: "js脚本插件使用", link: "/guide/use/custom-script/index.md"},
|
{text: "js脚本插件使用", link: "/guide/use/custom-script/index.md"},
|
||||||
{text: "邮箱配置", link: "/guide/use/email/index.md"},
|
{text: "邮箱配置", link: "/guide/use/email/index.md"},
|
||||||
|
{text: "证书复用", link: "/guide/use/pretask/"},
|
||||||
{text: "IPv6支持", link: "/guide/use/setting/ipv6.md"},
|
{text: "IPv6支持", link: "/guide/use/setting/ipv6.md"},
|
||||||
{text: "ESXi", link: "/guide/use/ESXi/index.md"},
|
{text: "ESXi", link: "/guide/use/ESXi/index.md"},
|
||||||
{text: "宝塔动态IP白名单", link: "/guide/use/baota/white_list.md"},
|
{text: "宝塔动态IP白名单", link: "/guide/use/baota/white_list.md"},
|
||||||
{text: "子域名托管", link: "/guide/use/cert/subdomain.md"},
|
{text: "子域名托管", link: "/guide/use/cert/subdomain.md"},
|
||||||
{text: "流水线有效期", link: "/guide/use/pipeline/valid.md"},
|
{text: "流水线有效期", link: "/guide/use/pipeline/valid.md"},
|
||||||
{text: "IP证书申请", link: "/guide/use/cert/ip.md"},
|
{text: "IP证书申请", link: "/guide/use/cert/ip.md"},
|
||||||
|
{text: "企业模式", link: "/guide/use/mode/enterprise.md"},
|
||||||
{text: "插件开发", link: "/guide/use/dev/plugin.md"},
|
{text: "插件开发", link: "/guide/use/dev/plugin.md"},
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
@@ -132,6 +135,7 @@ export default defineConfig({
|
|||||||
{text: "支付宝配置", link: "/guide/use/comm/payments/alipay.md"},
|
{text: "支付宝配置", link: "/guide/use/comm/payments/alipay.md"},
|
||||||
{text: "微信支付配置", link: "/guide/use/comm/payments/wxpay.md"},
|
{text: "微信支付配置", link: "/guide/use/comm/payments/wxpay.md"},
|
||||||
{text: "彩虹易支付配置", link: "/guide/use/comm/payments/yizhifu.md"},
|
{text: "彩虹易支付配置", link: "/guide/use/comm/payments/yizhifu.md"},
|
||||||
|
{text: "插件选项映射", link: "/guide/use/comm/plugin/"},
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -3,6 +3,363 @@
|
|||||||
All notable changes to this project will be documented in this file.
|
All notable changes to this project will be documented in this file.
|
||||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||||
|
|
||||||
|
## [1.41.1](https://github.com/certd/certd/compare/v1.41.0...v1.41.1) (2026-06-05)
|
||||||
|
|
||||||
|
### Performance Improvements
|
||||||
|
|
||||||
|
* 流水线、监控站点支持导出 ([99fd308](https://github.com/certd/certd/commit/99fd3083f259cdb96fd656f04858dd708d1251c7))
|
||||||
|
* 优化列表页面请求两次的问题 ([5546af5](https://github.com/certd/certd/commit/5546af518e92c765513787ccaf8e856be789bcf9))
|
||||||
|
* 优化邀请注册流程 ([7a71e45](https://github.com/certd/certd/commit/7a71e45799d782d0691606fb42b4236f1d3009b0))
|
||||||
|
* **settings:** 新增NO_PROXY代理排除配置 ([c0df8be](https://github.com/certd/certd/commit/c0df8be83237e323c2c9a5bd02507430a86a00cc))
|
||||||
|
* **volcengine-vke:** 火山VKE集群证书支持两种类型的证书保密字典 ([77b8024](https://github.com/certd/certd/commit/77b802445322d576d54d194f7c505da49e0e824c))
|
||||||
|
|
||||||
|
# [1.41.0](https://github.com/certd/certd/compare/v1.40.5...v1.41.0) (2026-06-04)
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* 修复阿里云证书订单orderid 选择出错的问题 ([41254d1](https://github.com/certd/certd/commit/41254d10b748a2d3e6ba43c7e11411650c748d1b))
|
||||||
|
* **monitor:** 修复开放接口自动创建证书流水线重复触发和等待时间不足的问题 ([91d5c90](https://github.com/certd/certd/commit/91d5c90eb0eaf65c81dddbd2d4d4b404cb8b4d07))
|
||||||
|
* **pipeline:** 修复批量随机修改定时没有生效的bug ([2e19dda](https://github.com/certd/certd/commit/2e19dda72e70b525a7c269e18e963a5ee602f59f))
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
* 商业版支持邀请返佣功能 ([f9a310b](https://github.com/certd/certd/commit/f9a310b6c3bbf30f221482a0c59e9c30080bdfc8))
|
||||||
|
* 商业版支持邀请推广功能 ([f1d2a10](https://github.com/certd/certd/commit/f1d2a1033a0f8d3dbd91fc9793e07bd0b858b539))
|
||||||
|
* 新增管理员针对用户流水线和证书监控管理功能 ([0211552](https://github.com/certd/certd/commit/021155278e7375f8487b0531ed1b5ad52512f007))
|
||||||
|
* 新增套餐激活码功能,通过CDK兑换套餐 ([81d6289](https://github.com/certd/certd/commit/81d6289a8631b073b49f24dee4b14bb1c8f31071))
|
||||||
|
* 新增推广等级激励功能 ([5096df5](https://github.com/certd/certd/commit/5096df5cc0d8f0ad8aa327b8e2a900ba23714bd8))
|
||||||
|
* 新增证书申请参数模版管理,开放接口支持使用证书参数模版和指定证书申请参数 ([f8b71a0](https://github.com/certd/certd/commit/f8b71a0e612fad527cf49136335e0b46f0f379cd))
|
||||||
|
* 支持dns-persist-01持久化验证方式申请证书,优化Acme账号的存储方式 ([67b05e2](https://github.com/certd/certd/commit/67b05e2d75e96b9f855e1ca0b3d0d8d03b92d8e6))
|
||||||
|
|
||||||
|
### Performance Improvements
|
||||||
|
|
||||||
|
* 插件全局配置支持下拉选项自定义映射功能 ([c637985](https://github.com/certd/certd/commit/c637985575b09196b04cce37ac14fbe68c029bde))
|
||||||
|
* 商业版提现增加收款二维码上传 ([83a5a21](https://github.com/certd/certd/commit/83a5a21f956e50942541f1532f3a8dcaa5821d34))
|
||||||
|
* **aliyun-apig:** 优化阿里云API网关部署插件的查询及翻页 ([3e4b7f3](https://github.com/certd/certd/commit/3e4b7f30ac6f3c976c8274bdf256c69b8a2c46db))
|
||||||
|
* **trade:** 优化商品购买页面的规格展示和折扣计算,支持订单取消 ([6624769](https://github.com/certd/certd/commit/66247690326ce2789900fc9110c08b3502cea655))
|
||||||
|
|
||||||
|
## [1.40.5](https://github.com/certd/certd/compare/v1.40.4...v1.40.5) (2026-05-26)
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* 安装glibc,增加Alpine镜像下 dns解析结果的兼容性 ([1a08bd3](https://github.com/certd/certd/commit/1a08bd340e1e7d3f9acf5d40f7bba7998459b8fb))
|
||||||
|
* 修复阿里云证书订单orderid 选择出错的问题 ([af9047b](https://github.com/certd/certd/commit/af9047bf3c54ce71b11727ccc6220288ed1f57be))
|
||||||
|
* 修复查询阿里云cdn Dcdn 域名太多无法选择的bug ([346fb73](https://github.com/certd/certd/commit/346fb730a37e035576f5d9ea5c0d74c052b34aeb))
|
||||||
|
|
||||||
|
## [1.40.4](https://github.com/certd/certd/compare/v1.40.3...v1.40.4) (2026-05-24)
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* **pipeline-service:** 修复流水线运行时超过套餐部署次数仍然能够正常运行的bug ([5e59651](https://github.com/certd/certd/commit/5e59651d45bc91919629e35995ff1b3cff6b87ea))
|
||||||
|
|
||||||
|
### Performance Improvements
|
||||||
|
|
||||||
|
* 商业版套餐只支持设置为可叠加 ([5e72f75](https://github.com/certd/certd/commit/5e72f75395fb632a30e80c07d35d8ba40ef631fa))
|
||||||
|
* 新增阿里云直播证书部署插件 ([8edb6f8](https://github.com/certd/certd/commit/8edb6f8727bd148f106801bef25567880fd35e9e))
|
||||||
|
|
||||||
|
## [1.40.3](https://github.com/certd/certd/compare/v1.40.2...v1.40.3) (2026-05-21)
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* 修复暗黑模式下注册页面验证码看不清的问题 ([5ba33be](https://github.com/certd/certd/commit/5ba33be30f765f06cafbfcc04f5e25320db01449))
|
||||||
|
|
||||||
|
### Performance Improvements
|
||||||
|
|
||||||
|
* 修复商业版套餐添加和修改时的字段显示 ([fb5b00d](https://github.com/certd/certd/commit/fb5b00d73f925036a65ce5003c57c1199578c34d))
|
||||||
|
|
||||||
|
## [1.40.2](https://github.com/certd/certd/compare/v1.40.1...v1.40.2) (2026-05-19)
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* **certd-server:** 调整首页缓存控制头的判断逻辑 ([0499347](https://github.com/certd/certd/commit/0499347588ee544862420ab9a5afd2546d61bc6c))
|
||||||
|
|
||||||
|
### Performance Improvements
|
||||||
|
|
||||||
|
* **controller:** 更换版本获取源并添加版本标准化处理 ([cb08e06](https://github.com/certd/certd/commit/cb08e061d257ba23a0fefdbfb046a8c759def828))
|
||||||
|
|
||||||
|
## [1.40.1](https://github.com/certd/certd/compare/v1.40.0...v1.40.1) (2026-05-18)
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* 固化华为云sdk版本,避免华为云调用报错 ([59b9ffa](https://github.com/certd/certd/commit/59b9ffadd05faf3982151c48f8d83cbd97419865))
|
||||||
|
* **email-service:** 优化商业版测试邮件内容中带的url链接 ([667e7b1](https://github.com/certd/certd/commit/667e7b185bf26558972be01720872f48352b5876))
|
||||||
|
|
||||||
|
### Performance Improvements
|
||||||
|
|
||||||
|
* 商业版支持限制泛域名数量 ([c63745d](https://github.com/certd/certd/commit/c63745d1ba30904428ba6b13ab0785298baa5cae))
|
||||||
|
* **suite:** 商业版用户已购套餐支持修改 ([bdb3d09](https://github.com/certd/certd/commit/bdb3d09c09fc73e7e5e3401f6ef5588bf8ad5088))
|
||||||
|
|
||||||
|
# [1.40.0](https://github.com/certd/certd/compare/v1.39.16...v1.40.0) (2026-05-14)
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* 修复第三方登录丢失state时无法在用户信息页面绑定第三方账号的bug ([45dedf5](https://github.com/certd/certd/commit/45dedf5bc779fea852e1f33dda4f31db2765633c))
|
||||||
|
* 修复群晖授权没有显示设备id输入框的bug ([2f172b5](https://github.com/certd/certd/commit/2f172b56e9411303ca15138d827bdb9bafdae4d1))
|
||||||
|
* 修复自动注册后没有跳转到控制台的bug ([4681ec9](https://github.com/certd/certd/commit/4681ec90088a3eb665427b2ac4047ec5ccefd7b3))
|
||||||
|
* 修复clogin登录丢失state问题 ([22f5cfc](https://github.com/certd/certd/commit/22f5cfcfd8462ca74128329eefb3f48b3ee0b7ea))
|
||||||
|
* 修复clogin多选类型登录失败的bug ([9f878a3](https://github.com/certd/certd/commit/9f878a353cd49b7b10bb0a95610ad236bc920dd2))
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
* 彩虹登录支持选择多种登录方式 ([7aa0c7e](https://github.com/certd/certd/commit/7aa0c7e491fe660abb62e68792ff5474f19bd5b8))
|
||||||
|
|
||||||
|
### Performance Improvements
|
||||||
|
|
||||||
|
* 第三方登录自动注册的用户支持设置初始化密码 ([a815d02](https://github.com/certd/certd/commit/a815d0245b97efbb948b33d6fc9d49862ce06889))
|
||||||
|
* 头像增加缓存时间 ([7015b1b](https://github.com/certd/certd/commit/7015b1b232602e5168a3eb8bee6d7f1776ae1e74))
|
||||||
|
|
||||||
|
## [1.39.16](https://github.com/certd/certd/compare/v1.39.15...v1.39.16) (2026-05-13)
|
||||||
|
|
||||||
|
**Note:** Version bump only for package root
|
||||||
|
|
||||||
|
## [1.39.15](https://github.com/certd/certd/compare/v1.39.14...v1.39.15) (2026-05-13)
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* 修复第三方登录彩虹登录不上的bug ([bae4f8e](https://github.com/certd/certd/commit/bae4f8e3209d9f9869ecbd7c01655383bac2fe21))
|
||||||
|
|
||||||
|
### Performance Improvements
|
||||||
|
|
||||||
|
* 优化申请时报错日志增加对应域名打印 ([d6e9e59](https://github.com/certd/certd/commit/d6e9e5987bd52ea12ee18745615486eadd4c87ff))
|
||||||
|
* icon选择器增加一套logo集 ([fdd5848](https://github.com/certd/certd/commit/fdd5848df4055a6ee07dc5eabaaf6b718672882d))
|
||||||
|
* **monitor/site:** 新增站点监控页面禁用启用、检查状态两个筛选条件 ([118c15d](https://github.com/certd/certd/commit/118c15d04633a6ef06f2d9e7a7849d20f596e02c))
|
||||||
|
* **network:** 新增全局公共http请求 headers设置 ([aad9045](https://github.com/certd/certd/commit/aad9045de55e76cb2ad09cac74a7bd60a4b47124))
|
||||||
|
|
||||||
|
## [1.39.14](https://github.com/certd/certd/compare/v1.39.13...v1.39.14) (2026-05-11)
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* 修复阿里云订阅流水线创建对话框无法获取阿里订单列表的bug ([a362860](https://github.com/certd/certd/commit/a362860137bfb7072893c844fe775edc46070ee1))
|
||||||
|
* 修复启动时报密钥备份不存在的问题 ([c966896](https://github.com/certd/certd/commit/c9668965226af6b54e0e576931dcba8b3d188ef3))
|
||||||
|
|
||||||
|
## [1.39.13](https://github.com/certd/certd/compare/v1.39.12...v1.39.13) (2026-05-10)
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* **aliyun-access:** 添加阿里云密钥校验失败的错误处理 ([b75c625](https://github.com/certd/certd/commit/b75c625ddcc0b3110699d8e6175681ef157b25df))
|
||||||
|
* cnameProvider域名支持设置子域名托管 ([7266af1](https://github.com/certd/certd/commit/7266af17491a98338022cfb18cfedfb93ca6ef8f))
|
||||||
|
* **plugin-aliyun:** 过滤非CAS证书并优化日志信息 ([c4b01da](https://github.com/certd/certd/commit/c4b01da384bc40a241a673ea8bc01ca733c04d83))
|
||||||
|
|
||||||
|
### Performance Improvements
|
||||||
|
|
||||||
|
* **设置:** 添加首页启用开关配置 ([25ad1e6](https://github.com/certd/certd/commit/25ad1e6f861e43288cc8bd90d4903628e6faec29))
|
||||||
|
* 新增agents.md ([aa176b0](https://github.com/certd/certd/commit/aa176b081a92837d2d6809d16546a8dfc2e5dd36))
|
||||||
|
* **用户资料:** 新增手机号邮箱绑定功能 ([e0eb0e2](https://github.com/certd/certd/commit/e0eb0e21f6dae24b639c944f9aba2c90496ab1c0))
|
||||||
|
* 域名注册过期时间获取再次优化 ([91a1b97](https://github.com/certd/certd/commit/91a1b9755066bf280e194dabf7c3a9f936e2643f))
|
||||||
|
* **证书流水线:** 添加批量更新证书申请参数功能 ([63be1c1](https://github.com/certd/certd/commit/63be1c1cbd9b09a3b48f26130c296b1cedcca1ac))
|
||||||
|
* 支持火山云vke ([bb46cb0](https://github.com/certd/certd/commit/bb46cb08f71f6ae921543f7e4a6c5f4e0190556e))
|
||||||
|
* 重构自动加载模块并优化EAB授权处理 ([4755216](https://github.com/certd/certd/commit/4755216505ad18555a50da9d8008c2207c48df86))
|
||||||
|
* **domain:** 添加域名过期时间同步进度显示功能 ([9d2937d](https://github.com/certd/certd/commit/9d2937dd4b14ffab73e9b096edd2aa8539811182))
|
||||||
|
* **plugin-volcengine:** 支持火山引擎VKE部署插件 ([b8a64a6](https://github.com/certd/certd/commit/b8a64a6b5bf3691a47177de42bc49b798e795feb))
|
||||||
|
|
||||||
|
## [1.39.12](https://github.com/certd/certd/compare/v1.39.11...v1.39.12) (2026-04-29)
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* 调整手机版首页标题被挤开的bug ([eab66e2](https://github.com/certd/certd/commit/eab66e2d1988635985745f2d1b227b958969ee00))
|
||||||
|
* 修复腾讯云clb部署报缺少sslmode参数的bug ([2f1ad72](https://github.com/certd/certd/commit/2f1ad7201f5ed9e00368a28b9e40907d4b415852))
|
||||||
|
|
||||||
|
### Performance Improvements
|
||||||
|
|
||||||
|
* 524错误时重试3次 ([00e6d58](https://github.com/certd/certd/commit/00e6d580c2f54af70fe96a214aff87c4b96426c2))
|
||||||
|
* 阿里云证书订单支持获取2.0的订单 ([64b3184](https://github.com/certd/certd/commit/64b3184b286fee996002d857b0de588452abdadd))
|
||||||
|
* 优化流水线执行时的状态保存性能 ([e00830b](https://github.com/certd/certd/commit/e00830bebcfe6344499e490bc174de96f9fb22d6))
|
||||||
|
* 增加权威NS检查开关,某些用户服务器禁止向黑名单NS服务器发请求 ([1aa50cf](https://github.com/certd/certd/commit/1aa50cf53a0deab752f35ec973912e41ab8161b6))
|
||||||
|
* 支持页脚自定义 ([c985a13](https://github.com/certd/certd/commit/c985a13544aa31b0eb0783f9a3193a7e8bdc6ed6))
|
||||||
|
|
||||||
|
## [1.39.11](https://github.com/certd/certd/compare/v1.39.10...v1.39.11) (2026-04-26)
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* 修复列表页面底部滚动条与表格之间有空白间隙的bug ([71cfcad](https://github.com/certd/certd/commit/71cfcad2a15aac0badd85a10c4012a1e713654d1))
|
||||||
|
* 修复流水线未编辑模式下也提示未保存的bug ([64a3503](https://github.com/certd/certd/commit/64a350364d820725b5e69d22ac2416809092f97d))
|
||||||
|
* 修复商业版设置了公共eab,创建流水线仍然会显示需要配置eab的bug ([24dff05](https://github.com/certd/certd/commit/24dff05f6427dadec1e40350214c0167e1d6a73d))
|
||||||
|
* 修复站点监控某些情况下获取不到证书的bug ([a2bbc7e](https://github.com/certd/certd/commit/a2bbc7e27298821d75a36abac6ec05d86dcf51f4))
|
||||||
|
|
||||||
|
### Performance Improvements
|
||||||
|
|
||||||
|
* 支持google dns插件 ([edc7bfc](https://github.com/certd/certd/commit/edc7bfc23043c2c6ef5f3564392f8aac6661c4bf))
|
||||||
|
* 阿里云waf支持云产品接入方式应用的证书部署 ([2f7514a](https://github.com/certd/certd/commit/2f7514a2e7d89a34f833401a983149e667da911b))
|
||||||
|
* 模版创建流水线支持随机时间 ([575415b](https://github.com/certd/certd/commit/575415b93a3e10e1c6e5644f71ddc711ea6f8adc))
|
||||||
|
* 商业版支持配置证书申请插件参数 ([7ac789c](https://github.com/certd/certd/commit/7ac789c9c7e91cdf08dfdae1bb49186552e370e3))
|
||||||
|
* 添加全新的未登录首页和路由配置 ([d1988dc](https://github.com/certd/certd/commit/d1988dc982440472ecf61847ccad76e4c96a80fb))
|
||||||
|
* 添加Azure DNS插件支持及文档 ([1f1d687](https://github.com/certd/certd/commit/1f1d6873172d71fadaa5a0005e1d6f3f528096fc))
|
||||||
|
* 添加HiPMDnsmgr DNS提供商的支持 @WUHINS ([296dcab](https://github.com/certd/certd/commit/296dcab4c7c26cb3f9da1ff748cc6a6b7d83edda))
|
||||||
|
* 为DNS解析器添加超时配置,避免查询时间过长 ([cc5154e](https://github.com/certd/certd/commit/cc5154e04e87f648111119b4eeb4e3cb4dd6cc41))
|
||||||
|
* 优化权威域名服务器查询超时时长 ([77db5ec](https://github.com/certd/certd/commit/77db5ecd12c51293e4de178e43ca0067bc70b46d))
|
||||||
|
* 支持部署到nginx-proxy-manager ([2e6e9ed](https://github.com/certd/certd/commit/2e6e9ed9255bcf178edb0eb00d93a7f13c214430))
|
||||||
|
* 支持一键安装脚本 ([dc969dd](https://github.com/certd/certd/commit/dc969dd7edb6934a29d6657afefe6f8af056741c))
|
||||||
|
* 支持主动修改绑定url地址 ([11b7cfe](https://github.com/certd/certd/commit/11b7cfe5cb7e88e6ebd68d53acb4e5b556550ca9))
|
||||||
|
* apisix支持v2 ([23b4658](https://github.com/certd/certd/commit/23b465867244b199bab9b61863a5ca43644834a9))
|
||||||
|
* **technitium:** 添加Technitium DNS Server插件支持 ([edeb817](https://github.com/certd/certd/commit/edeb817c39597e4fa73a17ff4ca3f712f0320fec))
|
||||||
|
|
||||||
|
## [1.39.10](https://github.com/certd/certd/compare/v1.39.9...v1.39.10) (2026-04-11)
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* 修复创建流水线无法选择通知的bug ([a88d0a6](https://github.com/certd/certd/commit/a88d0a6ae15cb6170d0b36e21daf89f0dbd5f681))
|
||||||
|
* 修复流水线任务编辑页面复制粘贴按钮在夜间模式显示问题 ([1e549df](https://github.com/certd/certd/commit/1e549dfd431ed74e2bcdfce63e5f640c51603af3))
|
||||||
|
* 修复用户管理添加用户无法上传头像的bug ([557e98c](https://github.com/certd/certd/commit/557e98c33f5462167d8f6289f70dad68bb114a97))
|
||||||
|
* 修复自定义插件删除后没有反注册的bug ([df98463](https://github.com/certd/certd/commit/df9846332596d2afaba53e66d2897aa1c598f9c4))
|
||||||
|
* 修复spaceship创建record报错的bug ([70b46d4](https://github.com/certd/certd/commit/70b46d4a8f89cf8eded21ebb237e8c8ce6c40d30))
|
||||||
|
|
||||||
|
### Performance Improvements
|
||||||
|
|
||||||
|
* 1panel支持先上传证书再选择证书 ([7a9eec8](https://github.com/certd/certd/commit/7a9eec88e8eddf40dba055c072b5b2b0f67c1407))
|
||||||
|
* 部署到1panel面板支持mux模式 ([d05129e](https://github.com/certd/certd/commit/d05129ec67893b0b639003a4bca6878d128f56ad))
|
||||||
|
* 流水线修改编辑之后,增加未保存提示 ([21620ac](https://github.com/certd/certd/commit/21620ac6bdeb57e43509156a77037fc07c44282a))
|
||||||
|
* 修复检查全部某些情况下无效的bug,优化公共触发站点证书检查定时逻辑 ([ee53589](https://github.com/certd/certd/commit/ee535895a3166c6f9046963e28fa8f22f018b574))
|
||||||
|
* 增加域名管理 子域名检查提醒 ([2bdf183](https://github.com/certd/certd/commit/2bdf1832da73a3728f3ac415837bc26e70531cd6))
|
||||||
|
* 站点监控域名气泡增加端口显示 ([6ee718a](https://github.com/certd/certd/commit/6ee718a25265a9db2115343af9a1a01958f34b81))
|
||||||
|
|
||||||
|
## [1.39.9](https://github.com/certd/certd/compare/v1.39.8...v1.39.9) (2026-04-05)
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* 修复cn域名获取不到到期时间的问题 ([73b8e85](https://github.com/certd/certd/commit/73b8e859766097b5251fc4e5051593d686669eb2))
|
||||||
|
* 修复某些情况下报无法修改通知的问题 ([d1a6592](https://github.com/certd/certd/commit/d1a65922d7e152d6edcf6c53b70079f16b54a0d3))
|
||||||
|
|
||||||
|
### Performance Improvements
|
||||||
|
|
||||||
|
* 腾讯云CLB大区增加台北 ([6b109d1](https://github.com/certd/certd/commit/6b109d172f0c7b6ce6ec164dc196d646a65f529f))
|
||||||
|
* 优化腾讯云CLB插件支持选择证书id ([c875971](https://github.com/certd/certd/commit/c875971b71dc6d392e56f0a7605281c40d9bb405))
|
||||||
|
* 支持域名到期时间监控通知 ([c6628e7](https://github.com/certd/certd/commit/c6628e7311d6c43c2a784581fb25ec37b29c168d))
|
||||||
|
* **monitor:** 支持查看监控执行记录 ([b5cc794](https://github.com/certd/certd/commit/b5cc794061c11b7200b669473c25c4bbfc944b61))
|
||||||
|
* **plugin-dnsmgr:** 添加彩虹DNS插件支持 ([af50344](https://github.com/certd/certd/commit/af503442b8298c5b89d11cf2ea351d62e66a609e))
|
||||||
|
* **spaceship:** 新增Spaceship DNS插件和授权模块 ([21aec77](https://github.com/certd/certd/commit/21aec77e5c3307b5973d4185baba33edcb28926f))
|
||||||
|
|
||||||
|
## [1.39.8](https://github.com/certd/certd/compare/v1.39.7...v1.39.8) (2026-03-31)
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* 修复某些情况下报没有匹配到任何校验方式的bug ([fe02ce7](https://github.com/certd/certd/commit/fe02ce7b64cf23c4dc4c30daccd5330059a35e9a))
|
||||||
|
* 修复上传头像退出登录的bug ([6eb20a1](https://github.com/certd/certd/commit/6eb20a1f2e31d984d9135edbf39c97cdd15621f9))
|
||||||
|
|
||||||
|
### Performance Improvements
|
||||||
|
|
||||||
|
* 阿里云CDN部署支持根据证书域名自动匹配部署 ([a68301e](https://github.com/certd/certd/commit/a68301e4dcea8b7391ad751aa57555d566297ad9))
|
||||||
|
* 阿里云dcdn支持根据证书域名匹配模式 ([df012de](https://github.com/certd/certd/commit/df012dec90590ecba85a69ed6355cfa8382c1da3))
|
||||||
|
* 支持部署证书到百度CCE ([a19ea74](https://github.com/certd/certd/commit/a19ea7489c01cdbf795fb51f804bd6d00389f604))
|
||||||
|
* dcdn自动匹配部署,支持新增域名感知 ([c6a988b](https://github.com/certd/certd/commit/c6a988bc925886bd7163c1270f2b7a10a57b1c5b))
|
||||||
|
|
||||||
|
## [1.39.7](https://github.com/certd/certd/compare/v1.39.6...v1.39.7) (2026-03-25)
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* 修复cname校验报该授权无权限的bug ([b1eb706](https://github.com/certd/certd/commit/b1eb7069258d6ff2b128091911fa448eaffc5f33))
|
||||||
|
|
||||||
|
### Performance Improvements
|
||||||
|
|
||||||
|
* 支持部署到火山云tos自定义域名证书 ([af6deb9](https://github.com/certd/certd/commit/af6deb99cd24a69a189b1fdd1df51c8f7816dcda))
|
||||||
|
* 支持部署证书到火山引擎vod ([f91d591](https://github.com/certd/certd/commit/f91d591b03c50166d9fa352ba11c62d963869aa5))
|
||||||
|
|
||||||
|
## [1.39.6](https://github.com/certd/certd/compare/v1.39.5...v1.39.6) (2026-03-22)
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* 修复模版id不正确导致修改到错误的模版流水线bug ([b1ff163](https://github.com/certd/certd/commit/b1ff163a2828b205297408d5aed21cf1eff335e8))
|
||||||
|
* 修复批量执行按钮无效的bug ([49703f0](https://github.com/certd/certd/commit/49703f08e55b303851086d9f36aca562d7999be6))
|
||||||
|
* remote-select默认pageSize设置为50,阿里云WAF不支持pageSize100 ([285532d](https://github.com/certd/certd/commit/285532d4318b90d0d7f8154f070274c0a0ec0269))
|
||||||
|
|
||||||
|
### Performance Improvements
|
||||||
|
|
||||||
|
* 火山引擎部署alb证书插件支持部署扩展证书以及删除已过期扩展证书 ([ffd2e81](https://github.com/certd/certd/commit/ffd2e8149e3a06bf3eec456ff85dbed793af9e90))
|
||||||
|
* 企业模式下面增加个人数据迁移的引导 ([431afd6](https://github.com/certd/certd/commit/431afd618f547cecf9a29433f46d4367619e2ecf))
|
||||||
|
* 新增阿里云证书清理插件 ([4b7eeaa](https://github.com/certd/certd/commit/4b7eeaa6e0a14d2e461c7c473a920a0966b1fe8e))
|
||||||
|
* 优化远程数据选择框,选择数据时不刷新闪烁 ([7f6a8bc](https://github.com/certd/certd/commit/7f6a8bc87e364685defe7f039264b2de064806c5))
|
||||||
|
* 支持复制粘贴任务步骤 ([acc2df2](https://github.com/certd/certd/commit/acc2df29def017fb8165f931b41ef95414966afc))
|
||||||
|
|
||||||
|
## [1.39.5](https://github.com/certd/certd/compare/v1.39.4...v1.39.5) (2026-03-18)
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* 修复修改分组报错的bug ([224db7d](https://github.com/certd/certd/commit/224db7da57dbdddf25bcac7faa0a29eb228c5a33))
|
||||||
|
|
||||||
|
### Performance Improvements
|
||||||
|
|
||||||
|
* 移除passkey的counter递增校验 ([68b669d](https://github.com/certd/certd/commit/68b669d3ff3e13b931939093320ce7237bb02b1b))
|
||||||
|
* passkey 支持Bitwarden ([29f44c6](https://github.com/certd/certd/commit/29f44c67c808bed9ff1c9d4884d39a1a62d043a7))
|
||||||
|
* passkey登录放到下方其他登录位置 ([1413e1a](https://github.com/certd/certd/commit/1413e1aff4aabcfd471716338c210fbcfd76c8f9))
|
||||||
|
|
||||||
|
## [1.39.4](https://github.com/certd/certd/compare/v1.39.3...v1.39.4) (2026-03-17)
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* 修复阿里云证书订单翻页问题 ([6d43623](https://github.com/certd/certd/commit/6d43623f459a7594599e50a7ed89d67fcc775518))
|
||||||
|
* 修复查看证书详情页面错位的bug ([7f37df4](https://github.com/certd/certd/commit/7f37df42274e657892d92e868ceac67e139f3bf2))
|
||||||
|
* 修复选择插件页面无法滚动的bug ([d8425bc](https://github.com/certd/certd/commit/d8425bc9c5ee81bb669706c6de6bad69d7c38d8e))
|
||||||
|
|
||||||
|
### Performance Improvements
|
||||||
|
|
||||||
|
* 优化passkey ([9e12412](https://github.com/certd/certd/commit/9e12412f5fa7800df1d7efaf62cd8fd5d79bb569))
|
||||||
|
|
||||||
|
## [1.39.3](https://github.com/certd/certd/compare/v1.39.2...v1.39.3) (2026-03-17)
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* 修复多选框只能单选的bug ([12700e1](https://github.com/certd/certd/commit/12700e1754319513ac02822ff1588d63420b964e))
|
||||||
|
* 修复旧版1panel插件 报sslIds is not iterable的错误 ([50db6f0](https://github.com/certd/certd/commit/50db6f0765e7ec9a5698cd99540d90e188634fb1))
|
||||||
|
|
||||||
|
## [1.39.2](https://github.com/certd/certd/compare/v1.39.1...v1.39.2) (2026-03-16)
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* 修复当证书更新后第一次站点检查会报与主站证书过期时间不一致错误的bug ([dd999b6](https://github.com/certd/certd/commit/dd999b60a4fe3507ff5e0109d637b4e891b28bdd))
|
||||||
|
* 修复京东云报错不准确的bug ([10dd89a](https://github.com/certd/certd/commit/10dd89ae62e438a211a15e729559af823a096583))
|
||||||
|
* 修复群晖测试时报addSecret undefine错误 ([5eb4aa3](https://github.com/certd/certd/commit/5eb4aa3a0eab9ffa729c8e813cbf973d9683cc13))
|
||||||
|
* 修复提示支付失败的bug ([12fed34](https://github.com/certd/certd/commit/12fed34e109f3254de664813954081a52513bd38))
|
||||||
|
* 修复修改项目名称后,没有同步刷新的bug ([3abee72](https://github.com/certd/certd/commit/3abee72fee286864b665033b23b172ef0ea92d83))
|
||||||
|
* cname provider授权修改为sys级别 ([d01bfbe](https://github.com/certd/certd/commit/d01bfbec96a3a2109ec864953b0c9e8c1f95b97b))
|
||||||
|
|
||||||
|
### Performance Improvements
|
||||||
|
|
||||||
|
* 查看证书增加证书详情显示,包括域名,过期时间,颁发机构,指纹等 ([0b9933d](https://github.com/certd/certd/commit/0b9933df1e8d1685d14271435a8a7488974cc47b))
|
||||||
|
* 获取阿里证书订单id组件增加翻页功能,突破50的上限 ([d79db3b](https://github.com/certd/certd/commit/d79db3bd3f0d5ad39664bb47ec3814d43ad93304))
|
||||||
|
* 优化阿里云连接超时时长为10秒,支持配置环境变量 ([1588461](https://github.com/certd/certd/commit/1588461633bd275765daa96fc68320abb58d616d))
|
||||||
|
* 优化个人账户页面 ([e506116](https://github.com/certd/certd/commit/e50611666ef731a903d7bdd8eb62333b97e2cc5b))
|
||||||
|
* 支持批量转移流水线到其他项目 ([8a3841f](https://github.com/certd/certd/commit/8a3841f6382b53ce2343307fb035e74fa5383fef))
|
||||||
|
* 支持passkey登录 ([10b7644](https://github.com/certd/certd/commit/10b7644bb7ba5f82776537bc0c4f5eb95d5f8e4e))
|
||||||
|
* dns-provider 支持bind9 ,support bind9 ([76d12d6](https://github.com/certd/certd/commit/76d12d60624c0672fd3717a80a2cfef6845b14b8))
|
||||||
|
|
||||||
|
## [1.39.1](https://github.com/certd/certd/compare/v1.39.0...v1.39.1) (2026-03-09)
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* 修复企业管理模式下,切换用户登录后,丢失项目列表的bug ([d23c8b4](https://github.com/certd/certd/commit/d23c8b4a2a5f5ab17822c6ee1d4108ac7280b9d1))
|
||||||
|
|
||||||
|
### Performance Improvements
|
||||||
|
|
||||||
|
* 支持迁移个人数据到企业项目中 ([c6ca832](https://github.com/certd/certd/commit/c6ca83273779ed84de1b23b5e477063af043d015))
|
||||||
|
* install tip ([853fdc7](https://github.com/certd/certd/commit/853fdc70a263b62d75c9ff3970607e6bf1c1593b))
|
||||||
|
|
||||||
|
# [1.39.0](https://github.com/certd/certd/compare/v1.38.12...v1.39.0) (2026-03-07)
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* 修复部署到openwrt错误的bug ([2e3d0cc](https://github.com/certd/certd/commit/2e3d0cc57c16c48ad435bc8fde729bacaedde9f5))
|
||||||
|
* 修复发件邮箱无法输入的bug ([27b0348](https://github.com/certd/certd/commit/27b0348e1d3d752f418f851965d6afbc26c0160c))
|
||||||
|
* 修复复制流水线保存后丢失分组和排序号的问题 ([bc32648](https://github.com/certd/certd/commit/bc326489abc1d50a0930b4f47aa2d62d3a486798))
|
||||||
|
* 修复获取群辉deviceid报错的bug ([79be392](https://github.com/certd/certd/commit/79be392775a2c91848dd5a66a2618adc4e4b48f6))
|
||||||
|
* 修复京东云域名申请证书报错的bug ([d9c0130](https://github.com/certd/certd/commit/d9c0130b59997144a3c274d456635b800135e43f))
|
||||||
|
* 修复偶尔下载证书报未授权的错误 ([316537e](https://github.com/certd/certd/commit/316537eb4dcbe5ec57784e8bf95ee3cdfd21dce7))
|
||||||
|
* 修复dcdn多个域名同时部署时 可能会出现证书名称重复的bug ([78c2ced](https://github.com/certd/certd/commit/78c2ced43b1a73d142b0ed783b162b97f545ab06))
|
||||||
|
* 优化dcdn部署上传多次证书 偶尔报 The CertName already exists的问题 ([72f850f](https://github.com/certd/certd/commit/72f850f675b500d12ebff2338d1b99d6fab476e1))
|
||||||
|
* **cert-plugin:** 优化又拍云客户端错误处理逻辑,当域名已绑定证书时不再抛出异常。 ([92c9ac3](https://github.com/certd/certd/commit/92c9ac382692e6c84140ff787759ab6d39ccbe96))
|
||||||
|
* esxi部署失败的bug ([1e44115](https://github.com/certd/certd/commit/1e441154617e6516a9a3610412bf597128c62696))
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
* 支持企业级管理模式,项目管理,细分权限 ([3734083](https://github.com/certd/certd/commit/37340838b6a61a94b86bfa13cf5da88b26f1315a))
|
||||||
|
|
||||||
|
### Performance Improvements
|
||||||
|
|
||||||
|
* 【破坏性更新】错误返回信息msg字段名统一改成message,与成功的返回结构一致 ([51ab6d6](https://github.com/certd/certd/commit/51ab6d6da1bb551b55b3a6a4a9a945c8d6ace806))
|
||||||
|
* 当域名管理中没有域名时,创建流水线时不展开域名选择框 ([bb0afe1](https://github.com/certd/certd/commit/bb0afe1fa7b0fc52fde051d24fbe6be69d52f4cc))
|
||||||
|
* 任务步骤页面增加串行执行提示说明 ([787f6ef](https://github.com/certd/certd/commit/787f6ef52893d8dc912ee2a7a5b8ce2b73c108c9))
|
||||||
|
* 站点监控支持指定ip地址检查 ([83d81b6](https://github.com/certd/certd/commit/83d81b64b3adb375366039e07c87d1ad79121c13))
|
||||||
|
* AI开发插件 skills 定义初步 ([1f68fad](https://github.com/certd/certd/commit/1f68faddb97a978c5a5e731a8895b4bb0587ad83))
|
||||||
|
* http请求增加建立连接超时配置 ([3c85602](https://github.com/certd/certd/commit/3c85602ab1fc1953cdc06a6cd75a971d14119179))
|
||||||
|
|
||||||
## [1.38.12](https://github.com/certd/certd/compare/v1.38.11...v1.38.12) (2026-02-18)
|
## [1.38.12](https://github.com/certd/certd/compare/v1.38.11...v1.38.12) (2026-02-18)
|
||||||
|
|
||||||
### Bug Fixes
|
### Bug Fixes
|
||||||
|
|||||||
@@ -39,13 +39,21 @@ pnpm install
|
|||||||
pnpm init
|
pnpm init
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### lib包编译:
|
||||||
|
将packages下面依赖的包都编译一遍,并监听改动。
|
||||||
|
```shell
|
||||||
|
pnpm dev
|
||||||
|
```
|
||||||
|
|
||||||
### 启动 server:
|
### 启动 server:
|
||||||
|
启动server
|
||||||
```shell
|
```shell
|
||||||
cd packages/ui/certd-server
|
cd packages/ui/certd-server
|
||||||
pnpm dev
|
pnpm dev
|
||||||
```
|
```
|
||||||
|
|
||||||
### 启动 client:
|
### 启动 client:
|
||||||
|
启动前端
|
||||||
```shell
|
```shell
|
||||||
cd packages/ui/certd-client
|
cd packages/ui/certd-client
|
||||||
pnpm dev
|
pnpm dev
|
||||||
|
|||||||
@@ -16,16 +16,22 @@
|
|||||||
****------------------****
|
****------------------****
|
||||||
## 专业版特权对比
|
## 专业版特权对比
|
||||||
|
|
||||||
| 功能 | 免费版 | 专业版 |
|
| 功能 | 免费版 | 专业版 | 商业版 |
|
||||||
|---------|---------------------------------------|--------------------------------|
|
|---------|---------------------------------------|--------------------------------|---------------------------------|
|
||||||
| 证书申请 | 无限制 | 无限制 |
|
| 证书申请 | 无限制 | 无限制 | 无限制 |
|
||||||
| 证书域名数量 | 无限制 | 无限制 |
|
| 证书域名数量 | 无限制 | 无限制 | 无限制 |
|
||||||
| 证书流水线条数 | 无限制 | 无限制 |
|
| 证书流水线条数 | 无限制 | 无限制 | 无限制 |
|
||||||
| 自动部署插件 | 阿里云CDN、腾讯云、七牛CDN、主机部署、宝塔、1Panel等大部分插件 | 群晖、威联通、proxmox等 |
|
| 自动部署插件 | 阿里云CDN、腾讯云、七牛CDN、主机部署、宝塔、1Panel等大部分插件 | 群晖、威联通、proxmox等 | 同专业版 |
|
||||||
| 通知 | 邮件通知、自定义webhook | 邮件免配置、企微、钉钉、飞书、anpush、server酱等 |
|
| 通知 | 邮件通知、自定义webhook | 企微、钉钉、飞书、anpush、server酱等 | 同专业版 |
|
||||||
| 站点监控 | 限制1条 | 无限制 |
|
| 站点监控 | 限制1条 | 无限制 | 无限制 |
|
||||||
| 批量操作 | 无 | 流水线模版,流水线复制,批量运行,批量设置通知、定时等 |
|
| 批量操作 | 无 | 流水线模版,流水线复制,批量运行,批量设置通知、定时等 | 同专业版 |
|
||||||
| VIP群 | 无 | 可加,一对一技术支持,必要时可申请远程协助 |
|
| VIP群 | 无 | 可加,一对一技术支持,必要时可申请远程协助 | 商业版技术支持 |
|
||||||
|
| 站点个性化 | 无 | 无 | 可自定义站点名称、Logo等,移除Certd元素,首页警告等 |
|
||||||
|
| 套餐功能 | 无 | 无 | 支持配置套餐供用户购买 |
|
||||||
|
| 数据统计 | 无 | 无 | 支持站点各类统计数据 |
|
||||||
|
| 插件管理 | 无 | 无 | 支持公共EAB设置,插件选项配置 |
|
||||||
|
| 是否可商用 | 不允许 | 不允许 | 可对外运营 |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## 专业版激活方式
|
## 专业版激活方式
|
||||||
|
|||||||
@@ -16,7 +16,6 @@ https://1panel.cn/docs/installation/online_installation/
|
|||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
#### 1.2 访问测试:
|
#### 1.2 访问测试:
|
||||||
@@ -40,6 +39,9 @@ admin/123456
|
|||||||
1. 打开`docker-compose.yaml`,整个内容复制下来
|
1. 打开`docker-compose.yaml`,整个内容复制下来
|
||||||
https://gitee.com/certd/certd/raw/v2/docker/run/docker-compose.yaml
|
https://gitee.com/certd/certd/raw/v2/docker/run/docker-compose.yaml
|
||||||
|
|
||||||
|
::: tip
|
||||||
|
默认使用SQLite数据库,如果需要使用MySQL、PostgreSQL数据库,请参考[多数据库支持](../database.md)
|
||||||
|
:::
|
||||||
|
|
||||||
2. 然后到 `1Panel->容器->编排->新建编排`
|
2. 然后到 `1Panel->容器->编排->新建编排`
|
||||||
输入名称,粘贴`docker-compose.yaml`原文内容
|
输入名称,粘贴`docker-compose.yaml`原文内容
|
||||||
@@ -49,7 +51,10 @@ admin/123456
|
|||||||

|

|
||||||
|
|
||||||
> 默认使用sqlite数据库,数据保存在`/data/certd`目录下,您可以手动备份该目录
|
> 默认使用sqlite数据库,数据保存在`/data/certd`目录下,您可以手动备份该目录
|
||||||
> certd还支持`mysql`和`postgresql`数据库,[点我了解如何切换其他数据库](../database)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### 2.2 访问测试
|
#### 2.2 访问测试
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,60 @@
|
|||||||
|
|
||||||
|
## 自动升级配置
|
||||||
|
|
||||||
|
### 1. 方法一:使用watchtower监控自动升级【推荐】
|
||||||
|
|
||||||
|
1. 修改docker-compose.yaml文件增加如下配置
|
||||||
|
或 [下载完整的自动升级docker-compose.yaml配置](https://gitee.com/certd/certd/raw/v2/docker/auto/docker-compose.yaml)
|
||||||
|
```yaml
|
||||||
|
services:
|
||||||
|
certd:
|
||||||
|
# 镜像 # ↓↓↓↓↓ ---- 镜像版本号 这里要保持为latest
|
||||||
|
image: registry.cn-shenzhen.aliyuncs.com/handsfree/certd:latest
|
||||||
|
... # 这里是你原来的docker-compose.yaml配置
|
||||||
|
|
||||||
|
# ↓↓↓↓ --------------------------------------------------------- 增加一个标签,表示certd需要自动升级
|
||||||
|
labels:
|
||||||
|
com.centurylinklabs.watchtower.enable: "true"
|
||||||
|
|
||||||
|
# ↓↓↓↓ --------------------------------------------------------- 自动升级watchtower配置,注意:上面certd的版本号要保持为latest
|
||||||
|
certd-updater: # 添加 Watchtower 服务
|
||||||
|
image: containrrr/watchtower:latest
|
||||||
|
container_name: certd-updater
|
||||||
|
restart: unless-stopped
|
||||||
|
volumes:
|
||||||
|
- /var/run/docker.sock:/var/run/docker.sock
|
||||||
|
# 配置 自动更新
|
||||||
|
environment:
|
||||||
|
- WATCHTOWER_CLEANUP=true # 自动清理旧版本容器
|
||||||
|
- WATCHTOWER_INCLUDE_STOPPED=false # 不更新已停止的容器
|
||||||
|
- WATCHTOWER_LABEL_ENABLE=true # 根据容器标签进行更新
|
||||||
|
- WATCHTOWER_POLL_INTERVAL=600 # 每 10 分钟检查一次更新
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
2. 重启certd容器
|
||||||
|
```shell
|
||||||
|
cd certd
|
||||||
|
docker compose down
|
||||||
|
docker compose up -d
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
### 2. 方法二:使用Certd版本监控功能【不太稳定】
|
||||||
|
|
||||||
|
1. 选择Github-检查Release版本插件
|
||||||
|

|
||||||
|
按如下图填写配置
|
||||||
|

|
||||||
|
|
||||||
|
|
||||||
|
2. 检测到新版本后执行宿主机升级命令:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
# 拉取最新镜像
|
||||||
|
docker pull registry.cn-shenzhen.aliyuncs.com/handsfree/certd:latest
|
||||||
|
# 升级容器命令, 替换成你自己的certd更新命令
|
||||||
|
export RESTART_CERT='sleep 10; cd ~/deploy/certd/ ; docker compose down; docker compose up -d'
|
||||||
|
# 构造一个脚本10s后在后台执行,避免容器销毁时执行太快,导致流水线任务无法结束
|
||||||
|
nohup sh -c '$RESTART_CERT' >/dev/null 2>&1 & echo '10秒后重启' && exit
|
||||||
|
```
|
||||||
@@ -30,7 +30,9 @@
|
|||||||
点击确定,等待启动完成
|
点击确定,等待启动完成
|
||||||

|

|
||||||
|
|
||||||
> certd默认使用sqlite数据库,另外支持`mysql`和`postgresql`数据库,[点我了解如何切换其他数据库](../database)
|
::: tip
|
||||||
|
默认安装使用SQLite数据库,如果需要使用MySQL、PostgreSQL数据库,请参考[多数据库支持](../database.md)
|
||||||
|
:::
|
||||||
|
|
||||||
|
|
||||||
## 二、访问应用
|
## 二、访问应用
|
||||||
|
|||||||
@@ -2,7 +2,23 @@
|
|||||||
|
|
||||||
## 一、安装
|
## 一、安装
|
||||||
|
|
||||||
### 1. 环境准备
|
### 一键脚本安装(推荐)
|
||||||
|
|
||||||
|
如果您的服务器未安装 Docker,该脚本会自动为您安装 Docker 和 Docker Compose,并启动 Certd 容器。
|
||||||
|
|
||||||
|
```bash
|
||||||
|
curl -fsSL https://gitee.com/certd/certd/raw/v2/docker/run/install.sh | bash
|
||||||
|
```
|
||||||
|
|
||||||
|
> 支持 Ubuntu、Debian、CentOS、Rocky Linux、AlmaLinux 等主流发行版。
|
||||||
|
> docker-compose文件目录:`/opt/certd` ,升级时需要先进入此目录
|
||||||
|
> 运行时数据默认保存路径:`/data/certd` ,可使用参数指定:`-p /data/certd`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### 手动安装
|
||||||
|
|
||||||
|
#### 1. 环境准备
|
||||||
|
|
||||||
1.1 准备一台云服务器
|
1.1 准备一台云服务器
|
||||||
|
|
||||||
@@ -19,9 +35,9 @@ https://docs.docker.com/engine/install/
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
# 随便创建一个目录
|
# 随便创建一个目录
|
||||||
mkdir certd
|
mkdir /opt/certd
|
||||||
# 进入目录
|
# 进入目录
|
||||||
cd certd
|
cd /opt/certd
|
||||||
# 下载docker-compose.yaml文件,或者手动下载放到certd目录下
|
# 下载docker-compose.yaml文件,或者手动下载放到certd目录下
|
||||||
wget https://gitee.com/certd/certd/raw/v2/docker/run/docker-compose.yaml
|
wget https://gitee.com/certd/certd/raw/v2/docker/run/docker-compose.yaml
|
||||||
|
|
||||||
@@ -42,8 +58,9 @@ docker compose up -d
|
|||||||
> 如果提示 没有docker compose命令,请安装docker-compose
|
> 如果提示 没有docker compose命令,请安装docker-compose
|
||||||
> https://docs.docker.com/compose/install/linux/
|
> https://docs.docker.com/compose/install/linux/
|
||||||
|
|
||||||
> certd默认使用sqlite数据库,另外还支持`mysql`和`postgresql`数据库,[点我了解如何切换其他数据库](../database)
|
::: tip
|
||||||
|
默认安装使用SQLite数据库,如果需要使用MySQL、PostgreSQL数据库,请参考[多数据库支持](../database.md)
|
||||||
|
:::
|
||||||
|
|
||||||
### 3. 访问测试
|
### 3. 访问测试
|
||||||
|
|
||||||
@@ -53,12 +70,12 @@ https://your_server_ip:7002
|
|||||||
记得修改密码
|
记得修改密码
|
||||||
|
|
||||||
|
|
||||||
## 二、升级
|
## 二、升级Certd
|
||||||
|
|
||||||
::: warning
|
::: warning
|
||||||
如果您是第一次升级certd版本,切记切记先备份一下数据
|
如果您是第一次升级certd版本,切记切记先备份一下数据
|
||||||
```
|
```
|
||||||
# docker-compose.yaml配置
|
# 查看/opt/certd/docker-compose.yaml配置
|
||||||
- /data/certd:/app/data # 请务必确保 /app/data 这个路径没有改动,固定写死
|
- /data/certd:/app/data # 请务必确保 /app/data 这个路径没有改动,固定写死
|
||||||
```
|
```
|
||||||
:::
|
:::
|
||||||
@@ -70,6 +87,7 @@ https://your_server_ip:7002
|
|||||||
|
|
||||||
### 如果使用`latest`版本
|
### 如果使用`latest`版本
|
||||||
```shell
|
```shell
|
||||||
|
cd /opt/certd
|
||||||
#重新拉取镜像
|
#重新拉取镜像
|
||||||
docker pull registry.cn-shenzhen.aliyuncs.com/handsfree/certd:latest
|
docker pull registry.cn-shenzhen.aliyuncs.com/handsfree/certd:latest
|
||||||
# 重新启动容器
|
# 重新启动容器
|
||||||
|
|||||||
@@ -22,51 +22,3 @@
|
|||||||
可以查看最新版本号,以及所有版本的更新日志
|
可以查看最新版本号,以及所有版本的更新日志
|
||||||
[CHANGELOG](../changelogs/CHANGELOG.md)
|
[CHANGELOG](../changelogs/CHANGELOG.md)
|
||||||
|
|
||||||
|
|
||||||
## 自动升级配置
|
|
||||||
|
|
||||||
### 1. 方法一:使用watchtower监控
|
|
||||||
|
|
||||||
修改docker-compose.yaml文件增加如下配置, 使用watchtower监控自动升级
|
|
||||||
```yaml
|
|
||||||
services:
|
|
||||||
certd:
|
|
||||||
...
|
|
||||||
labels:
|
|
||||||
com.centurylinklabs.watchtower.enable: "true"
|
|
||||||
|
|
||||||
# ↓↓↓↓ --------------------------------------------------------- 自动升级,上面certd的版本号要保持为latest
|
|
||||||
certd-updater: # 添加 Watchtower 服务
|
|
||||||
image: containrrr/watchtower:latest
|
|
||||||
container_name: certd-updater
|
|
||||||
restart: unless-stopped
|
|
||||||
volumes:
|
|
||||||
- /var/run/docker.sock:/var/run/docker.sock
|
|
||||||
# 配置 自动更新
|
|
||||||
environment:
|
|
||||||
- WATCHTOWER_CLEANUP=true # 自动清理旧版本容器
|
|
||||||
- WATCHTOWER_INCLUDE_STOPPED=false # 不更新已停止的容器
|
|
||||||
- WATCHTOWER_LABEL_ENABLE=true # 根据容器标签进行更新
|
|
||||||
- WATCHTOWER_POLL_INTERVAL=600 # 每 10 分钟检查一次更新
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
### 2. 方法二:使用Certd版本监控功能
|
|
||||||
|
|
||||||
选择Github-检查Release版本插件
|
|
||||||

|
|
||||||
按如下图填写配置
|
|
||||||

|
|
||||||
|
|
||||||
|
|
||||||
检测到新版本后执行宿主机升级命令:
|
|
||||||
|
|
||||||
```shell
|
|
||||||
# 拉取最新镜像
|
|
||||||
docker pull registry.cn-shenzhen.aliyuncs.com/handsfree/certd:latest
|
|
||||||
# 升级容器命令, 替换成你自己的certd更新命令
|
|
||||||
export RESTART_CERT='sleep 10; cd ~/deploy/certd/ ; docker compose down; docker compose up -d'
|
|
||||||
# 构造一个脚本10s后在后台执行,避免容器销毁时执行太快,导致流水线任务无法结束
|
|
||||||
nohup sh -c '$RESTART_CERT' >/dev/null 2>&1 & echo '10秒后重启' && exit
|
|
||||||
```
|
|
||||||
@@ -31,7 +31,11 @@ header中传入x-certd-token即可调用开放接口
|
|||||||
支持证书id和域名两种方式获取证书。
|
支持证书id和域名两种方式获取证书。
|
||||||
|
|
||||||
### 创建新的证书申请
|
### 创建新的证书申请
|
||||||
参数autoApply=true,将在没有证书时自动触发申请证书,检查逻辑如下:
|
参数`autoApply=true`将在没有证书时自动触发申请证书。申请参数支持另外传入:
|
||||||
|
- `autoApplyTemplateId`:使用指定 ID 的证书申请参数模版;不传时不使用模版
|
||||||
|
- `autoApplyParams`:自定义证书申请参数,会与系统默认参数、模版参数合并,并覆盖同名字段
|
||||||
|
|
||||||
|
检查逻辑如下:
|
||||||
1. 如果证书仓库里面有,且没有过期,就直接返回证书
|
1. 如果证书仓库里面有,且没有过期,就直接返回证书
|
||||||
2. 如果没有或者已过期,就会去找流水线,有就触发流水线执行
|
2. 如果没有或者已过期,就会去找流水线,有就触发流水线执行
|
||||||
3. 如果没有流水线,就创建一个流水线,触发运行(`注意:需要提前在域名管理中配置好域名校验方式,否则会申请失败`)
|
3. 如果没有流水线,就创建一个流水线,触发运行(`注意:需要提前在域名管理中配置好域名校验方式,否则会申请失败`)
|
||||||
|
|||||||
@@ -20,58 +20,66 @@
|
|||||||
| 16.| **APISIX授权** | |
|
| 16.| **APISIX授权** | |
|
||||||
| 17.| **亚马逊云aws授权** | |
|
| 17.| **亚马逊云aws授权** | |
|
||||||
| 18.| **亚马逊云科技(国区)授权** | |
|
| 18.| **亚马逊云科技(国区)授权** | |
|
||||||
| 19.| **CacheFly** | CacheFly |
|
| 19.| **微软云Azure授权** | |
|
||||||
| 20.| **EAB授权** | ZeroSSL证书申请需要EAB授权 |
|
| 20.| **BIND9 DNS 授权** | 通过 SSH 连接到 BIND9 服务器,使用 nsupdate 命令管理 DNS 记录 |
|
||||||
| 21.| **google cloud** | 谷歌云授权 |
|
| 21.| **CacheFly** | CacheFly |
|
||||||
| 22.| **cloudflare授权** | |
|
| 22.| **ACME账号** | 用于复用ACME账号私钥和账号地址,证书申请时不再临时创建账号 |
|
||||||
| 23.| **中国移动CND授权** | |
|
| 23.| **EAB授权** | ZeroSSL证书申请需要EAB授权 |
|
||||||
| 24.| **授权插件示例** | 这是一个示例授权插件,用于演示如何实现一个授权插件 |
|
| 24.| **google cloud** | 谷歌云授权 |
|
||||||
| 25.| **dns.la授权** | |
|
| 25.| **cloudflare授权** | |
|
||||||
| 26.| **多吉云** | |
|
| 26.| **中国移动CND授权** | |
|
||||||
| 27.| **Dokploy授权** | |
|
| 27.| **授权插件示例** | 这是一个示例授权插件,用于演示如何实现一个授权插件 |
|
||||||
| 28.| **farcdn授权** | |
|
| 28.| **dns.la授权** | |
|
||||||
| 29.| **FlexCDN授权** | |
|
| 29.| **彩虹DNS** | 彩虹DNS管理系统授权 |
|
||||||
| 30.| **Gcore** | Gcore |
|
| 30.| **多吉云** | |
|
||||||
| 31.| **Github授权** | |
|
| 31.| **Dokploy授权** | |
|
||||||
| 32.| **godaddy授权** | |
|
| 32.| **farcdn授权** | |
|
||||||
| 33.| **金山云授权** | |
|
| 33.| **FlexCDN授权** | |
|
||||||
| 34.| **FTP授权** | |
|
| 34.| **Gcore** | Gcore |
|
||||||
| 35.| **七牛OSS授权** | |
|
| 35.| **Github授权** | |
|
||||||
| 36.| **腾讯云COS授权** | 腾讯云对象存储授权,包含地域和存储桶 |
|
| 36.| **godaddy授权** | |
|
||||||
| 37.| **s3/minio授权** | S3/minio oss授权 |
|
| 37.| **HiPM DNSMgr** | HiPM DNSMgr API Token 授权 |
|
||||||
| 38.| **namesilo授权** | |
|
| 38.| **金山云授权** | |
|
||||||
| 39.| **Next Terminal 授权** | 用于访问 Next Terminal API 的授权配置 |
|
| 39.| **FTP授权** | |
|
||||||
| 40.| **1panel授权** | 账号和密码 |
|
| 40.| **七牛OSS授权** | |
|
||||||
| 41.| **支付宝** | |
|
| 41.| **腾讯云COS授权** | 腾讯云对象存储授权,包含地域和存储桶 |
|
||||||
| 42.| **白山云授权** | |
|
| 42.| **s3/minio授权** | S3/minio oss授权 |
|
||||||
| 43.| **宝塔云WAF授权** | 用于连接和管理宝塔云WAF服务的授权配置 |
|
| 43.| **namesilo授权** | |
|
||||||
| 44.| **cdnfly授权** | |
|
| 44.| **Next Terminal 授权** | 用于访问 Next Terminal API 的授权配置 |
|
||||||
| 45.| **k8s授权** | |
|
| 45.| **Nginx Proxy Manager 授权** | 用于登录 Nginx Proxy Manager,并为代理主机证书部署提供授权。 |
|
||||||
| 46.| **括彩云cdn授权** | 括彩云CDN,每月免费30G,[注册即领](https://kuocaicdn.com/register?code=8mn536rrzfbf8) |
|
| 46.| **1panel授权** | 账号和密码 |
|
||||||
| 47.| **LeCDN授权** | |
|
| 47.| **支付宝** | |
|
||||||
| 48.| **lucky** | |
|
| 48.| **白山云授权** | |
|
||||||
| 49.| **猫云授权** | |
|
| 49.| **宝塔云WAF授权** | 用于连接和管理宝塔云WAF服务的授权配置 |
|
||||||
| 50.| **plesk授权** | |
|
| 50.| **cdnfly授权** | |
|
||||||
| 51.| **长亭雷池授权** | |
|
| 51.| **k8s授权** | |
|
||||||
| 52.| **群晖登录授权** | |
|
| 52.| **括彩云cdn授权** | 括彩云CDN,每月免费30G,[注册即领](https://kuocaicdn.com/register?code=8mn536rrzfbf8) |
|
||||||
| 53.| **uniCloud** | unicloud授权 |
|
| 53.| **LeCDN授权** | |
|
||||||
| 54.| **微信支付** | |
|
| 54.| **lucky** | |
|
||||||
| 55.| **易盾rcdn授权** | 易盾CDN,每月免费30G,[注册即领](https://rhcdn.yiduncdn.com/register?code=8mn536rrzfbf8) |
|
| 55.| **猫云授权** | |
|
||||||
| 56.| **易发云短信** | sms.yfyidc.cn/ |
|
| 56.| **plesk授权** | |
|
||||||
| 57.| **易盾DCDN授权** | https://user.yiduncdn.com |
|
| 57.| **长亭雷池授权** | |
|
||||||
| 58.| **易支付** | |
|
| 58.| **群晖登录授权** | |
|
||||||
| 59.| **proxmox** | |
|
| 59.| **uniCloud** | unicloud授权 |
|
||||||
| 60.| **UCloud授权** | 优刻得授权 |
|
| 60.| **微信支付** | |
|
||||||
| 61.| **又拍云** | |
|
| 61.| **易盾rcdn授权** | 易盾CDN,每月免费30G,[注册即领](https://rhcdn.yiduncdn.com/register?code=8mn536rrzfbf8) |
|
||||||
| 62.| **网宿授权** | |
|
| 62.| **易发云短信** | sms.yfyidc.cn/ |
|
||||||
| 63.| **西部数码授权** | |
|
| 63.| **易盾DCDN授权** | https://user.yiduncdn.com |
|
||||||
| 64.| **我爱云授权** | 我爱云CDN |
|
| 64.| **易支付** | |
|
||||||
| 65.| **新网授权(代理方式)** | |
|
| 65.| **proxmox** | |
|
||||||
| 66.| **新网授权** | |
|
| 66.| **Spaceship.com 授权** | Spaceship.com API 授权插件 |
|
||||||
| 67.| **新网互联授权** | 仅支持代理账号,ip需要加入白名单 |
|
| 67.| **Technitium DNS Server** | Technitium DNS Server 自建DNS服务器授权 |
|
||||||
| 68.| **Zenlayer授权** | Zenlayer授权 |
|
| 68.| **UCloud授权** | 优刻得授权 |
|
||||||
| 69.| **GoEdge授权** | |
|
| 69.| **又拍云** | |
|
||||||
| 70.| **雨云授权** | https://app.rainyun.com/ |
|
| 70.| **网宿授权** | |
|
||||||
|
| 71.| **西部数码授权** | |
|
||||||
|
| 72.| **我爱云授权** | 我爱云CDN |
|
||||||
|
| 73.| **新网授权(代理方式)** | |
|
||||||
|
| 74.| **新网授权** | |
|
||||||
|
| 75.| **新网互联授权** | 仅支持代理账号,ip需要加入白名单 |
|
||||||
|
| 76.| **Zenlayer授权** | Zenlayer授权 |
|
||||||
|
| 77.| **GoEdge授权** | |
|
||||||
|
| 78.| **雨云授权** | https://app.rainyun.com/ |
|
||||||
|
|
||||||
<style module>
|
<style module>
|
||||||
table th:first-of-type {
|
table th:first-of-type {
|
||||||
|
|||||||
@@ -1,12 +1,12 @@
|
|||||||
# 任务插件
|
# 任务插件
|
||||||
共 `125` 款任务插件
|
共 `132` 款任务插件
|
||||||
## 1. 证书申请
|
## 1. 证书申请
|
||||||
|
|
||||||
| 序号 | 名称 | 说明 |
|
| 序号 | 名称 | 说明 |
|
||||||
|-----|-----|-----|
|
|-----|-----|-----|
|
||||||
| 1.| **证书申请(JS版)** | 免费通配符域名证书申请,支持多个域名打到同一个证书上 |
|
| 1.| **证书申请(JS版)** | 免费通配符域名证书申请,支持多个域名打到同一个证书上 |
|
||||||
| 2.| **已有证书托管** | 手动上传自定义证书后,自动部署(每次证书有更新,都需要手动上传一次) |
|
| 2.| **已有证书托管** | 手动上传自定义证书后,自动部署(每次证书有更新,都需要手动上传一次) |
|
||||||
| 3.| **获取阿里云订阅证书** | 从阿里云拉取订阅模式的商用证书 |
|
| 3.| **获取阿里云订阅证书** | 从阿里云拉取订阅模式的商用证书(支持 API 1.0 和 2.0) |
|
||||||
| 4.| **证书申请(Lego)** | 支持海量DNS解析提供商,推荐使用,一样的免费通配符域名证书申请,支持多个域名打到同一个证书上 |
|
| 4.| **证书申请(Lego)** | 支持海量DNS解析提供商,推荐使用,一样的免费通配符域名证书申请,支持多个域名打到同一个证书上 |
|
||||||
## 2. 主机
|
## 2. 主机
|
||||||
|
|
||||||
@@ -58,45 +58,49 @@
|
|||||||
| 3.| **Dokploy-部署server证书** | 自动更新Dokploy server证书 |
|
| 3.| **Dokploy-部署server证书** | 自动更新Dokploy server证书 |
|
||||||
| 4.| **飞牛NAS-部署证书** | |
|
| 4.| **飞牛NAS-部署证书** | |
|
||||||
| 5.| **NextTerminal-更新证书** | 更新 Next Terminal 证书 |
|
| 5.| **NextTerminal-更新证书** | 更新 Next Terminal 证书 |
|
||||||
| 6.| **1Panel-部署面板证书** | 更新1Panel的面板证书 |
|
| 6.| **Nginx Proxy Manager-部署到主机** | 上传自定义证书到 Nginx Proxy Manager,并绑定到所选主机。 |
|
||||||
| 7.| **1Panel-更新站点证书** | 更新1Panel的站点证书 |
|
| 7.| **1Panel-部署面板证书** | 更新1Panel的面板证书 |
|
||||||
| 8.| **宝塔-删除过期证书** | 删除证书夹中过期证书 |
|
| 8.| **1Panel-更新站点证书** | 更新1Panel的站点证书 |
|
||||||
| 9.| **宝塔-WAF证书部署** | 部署宝塔云WAF/aaWAF |
|
| 9.| **宝塔-删除过期证书** | 删除证书夹中过期证书 |
|
||||||
| 10.| **宝塔-面板证书部署** | 部署宝塔面板本身的ssl证书 |
|
| 10.| **宝塔-WAF证书部署** | 部署宝塔云WAF/aaWAF |
|
||||||
| 11.| **宝塔win-网站证书部署** | 部署到Windows版宝塔管理的站点的ssl证书 |
|
| 11.| **宝塔-面板证书部署** | 部署宝塔面板本身的ssl证书 |
|
||||||
| 12.| **宝塔-网站证书部署** | 部署宝塔管理的站点的ssl证书,目前支持宝塔网站站点、docker站点等。本插件也支持aaPanel。 |
|
| 12.| **宝塔win-网站证书部署** | 部署到Windows版宝塔管理的站点的ssl证书 |
|
||||||
| 13.| **K8S-Apply自定义yaml** | apply自定义yaml到k8s |
|
| 13.| **宝塔-网站证书部署** | 部署宝塔管理的站点的ssl证书,目前支持宝塔网站站点、docker站点等。本插件也支持aaPanel。 |
|
||||||
| 14.| **K8S-Ingress 证书部署** | 部署证书到k8s的Ingress |
|
| 14.| **K8S-Apply自定义yaml** | apply自定义yaml到k8s |
|
||||||
| 15.| **K8S-部署证书到Secret** | 部署证书到k8s的secret |
|
| 15.| **K8S-Ingress 证书部署** | 部署证书到k8s的Ingress |
|
||||||
| 16.| **lucky-更新Lucky证书** | |
|
| 16.| **K8S-部署证书到Secret** | 部署证书到k8s的secret |
|
||||||
| 17.| **Plesk-部署Plesk网站证书** | |
|
| 17.| **lucky-更新Lucky证书** | |
|
||||||
| 18.| **Plesk-更新证书** | 不会创建新证书记录,直接更新旧的证书 |
|
| 18.| **Plesk-部署Plesk网站证书** | |
|
||||||
| 19.| **雷池-更新证书(支持控制台和防护应用)** | 更新长亭雷池WAF的证书,支持更新控制台和防护应用的证书。 |
|
| 19.| **Plesk-更新证书** | 不会创建新证书记录,直接更新旧的证书 |
|
||||||
| 20.| **群晖-部署证书到群晖面板** | Synology,支持6.x以上版本 |
|
| 20.| **雷池-更新证书(支持控制台和防护应用)** | 更新长亭雷池WAF的证书,支持更新控制台和防护应用的证书。 |
|
||||||
| 21.| **群晖-刷新OTP登录有效期** | 群晖登录状态可能30天失效,需要在失效之前登录一次,刷新有效期,您可以将其放在“部署到群晖面板”任务之后 |
|
| 21.| **群晖-部署证书到群晖面板** | Synology,支持6.x以上版本 |
|
||||||
| 22.| **uniCloud-部署到服务空间** | 部署到服务空间 |
|
| 22.| **群晖-刷新OTP登录有效期** | 群晖登录状态可能30天失效,需要在失效之前登录一次,刷新有效期,您可以将其放在“部署到群晖面板”任务之后 |
|
||||||
| 23.| **Proxmox-上传证书到Proxmox** | |
|
| 23.| **uniCloud-部署到服务空间** | 部署到服务空间 |
|
||||||
| 24.| **威联通-部署证书到威联通** | 部署证书到qnap |
|
| 24.| **Proxmox-上传证书到Proxmox** | |
|
||||||
|
| 25.| **威联通-部署证书到威联通** | 部署证书到qnap |
|
||||||
## 5. 阿里云
|
## 5. 阿里云
|
||||||
|
|
||||||
| 序号 | 名称 | 说明 |
|
| 序号 | 名称 | 说明 |
|
||||||
|-----|-----|-----|
|
|-----|-----|-----|
|
||||||
| 1.| **阿里云-部署到Ack** | 部署到阿里云Ack集群Ingress等通过Secret管理证书的应用 |
|
| 1.| **阿里云-删除即将过期证书** | 仅删除未使用的证书 |
|
||||||
| 2.| **阿里云-部署至ALB(应用负载均衡)** | ALB,更新监听器的默认证书 |
|
| 2.| **阿里云-部署到Ack** | 部署到阿里云Ack集群Ingress等通过Secret管理证书的应用 |
|
||||||
| 3.| **阿里云-部署至任意云资源** | 【不建议使用】需要消耗阿里云自动部署次数,支持SLB、LIVE、webHosting、VOD、CR、DCDN、DDoS、CDN、ALB、APIGateway、FC、GA、MSE、NLB、OSS、SAE、WAF等云产品 |
|
| 3.| **阿里云-部署至ALB(应用负载均衡)** | ALB,更新监听器的默认证书 |
|
||||||
| 4.| **阿里云-部署至云原生API网关/AI网关** | 自动部署域名证书至云原生API网关、AI网关 |
|
| 4.| **阿里云-部署至任意云资源** | 【不建议使用】需要消耗阿里云自动部署次数,支持SLB、LIVE、webHosting、VOD、CR、DCDN、DDoS、CDN、ALB、APIGateway、FC、GA、MSE、NLB、OSS、SAE、WAF等云产品 |
|
||||||
| 5.| **阿里云-部署证书至API网关** | 自动部署域名证书至阿里云API网关(APIGateway) |
|
| 5.| **阿里云-部署至云原生API网关/AI网关** | 自动部署域名证书至云原生API网关、AI网关 |
|
||||||
| 6.| **阿里云-部署证书至CDN** | 自动部署域名证书至阿里云CDN |
|
| 6.| **阿里云-部署证书至API网关** | 自动部署域名证书至阿里云API网关(APIGateway) |
|
||||||
| 7.| **阿里云-部署证书至DCDN** | 依赖证书申请前置任务,自动部署域名证书至阿里云DCDN |
|
| 7.| **阿里云-部署证书至CDN** | 自动部署域名证书至阿里云CDN |
|
||||||
| 8.| **阿里云-部署至ESA** | 部署证书到阿里云ESA(边缘安全加速),自动删除过期证书 |
|
| 8.| **阿里云-部署证书至DCDN** | 依赖证书申请前置任务,自动部署域名证书至阿里云DCDN |
|
||||||
| 9.| **阿里云-部署至阿里云FC(3.0)** | 部署证书到阿里云函数计算(FC3.0) |
|
| 9.| **阿里云-部署至ESA** | 部署证书到阿里云ESA(边缘安全加速),自动删除过期证书 |
|
||||||
| 10.| **阿里云-部署至GA** | 部署证书到阿里云GA(全球加速),支持更新默认证书和扩展证书 |
|
| 10.| **阿里云-部署至阿里云FC(3.0)** | 部署证书到阿里云函数计算(FC3.0) |
|
||||||
| 11.| **阿里云-部署至NLB(网络负载均衡)** | NLB,网络负载均衡,更新监听器的默认证书 |
|
| 11.| **阿里云-部署至GA** | 部署证书到阿里云GA(全球加速),支持更新默认证书和扩展证书 |
|
||||||
| 12.| **阿里云-部署证书至OSS** | 部署域名证书至阿里云OSS自定义域名,不是上传到阿里云oss |
|
| 12.| **阿里云-部署至直播(Live)** | 部署证书到阿里云视频直播(Live)域名 |
|
||||||
| 13.| **阿里云-部署至CLB(传统负载均衡)** | 部署证书到阿里云CLB(传统负载均衡) |
|
| 13.| **阿里云-部署至NLB(网络负载均衡)** | NLB,网络负载均衡,更新监听器的默认证书 |
|
||||||
| 14.| **阿里云-部署至VOD** | 部署证书到阿里云视频点播(vod) |
|
| 14.| **阿里云-部署证书至OSS** | 部署域名证书至阿里云OSS自定义域名,不是上传到阿里云oss |
|
||||||
| 15.| **阿里云-部署至阿里云WAF** | 部署证书到阿里云WAF |
|
| 15.| **阿里云-部署至CLB(传统负载均衡)** | 部署证书到阿里云CLB(传统负载均衡) |
|
||||||
| 16.| **阿里云-上传证书到CAS** | 上传证书到阿里云证书管理服务(CAS),如果不想在阿里云上同一份证书上传多次,可以把此任务作为前置任务,其他阿里云任务证书那一项选择此任务的输出 |
|
| 16.| **阿里云-部署至VOD** | 部署证书到阿里云视频点播(vod) |
|
||||||
|
| 17.| **阿里云-部署至阿里云WAF(云产品接入)** | 部署证书到阿里云WAF(云产品接入),CNAME方式接入的请选择另外一个waf插件 |
|
||||||
|
| 18.| **阿里云-部署至阿里云WAF(cname接入)** | 部署证书到阿里云WAF(cname接入),云资源的请选择另外一个waf插件 |
|
||||||
|
| 19.| **阿里云-上传证书到CAS** | 上传证书到阿里云证书管理服务(CAS),如果不想在阿里云上同一份证书上传多次,可以把此任务作为前置任务,其他阿里云任务证书那一项选择此任务的输出 |
|
||||||
## 6. 华为云
|
## 6. 华为云
|
||||||
|
|
||||||
| 序号 | 名称 | 说明 |
|
| 序号 | 名称 | 说明 |
|
||||||
@@ -112,9 +116,9 @@
|
|||||||
| 1.| **腾讯云-删除即将过期证书** | 仅删除未使用的证书 |
|
| 1.| **腾讯云-删除即将过期证书** | 仅删除未使用的证书 |
|
||||||
| 2.| **腾讯云-部署证书到任意云资源** | 支持负载均衡、CDN、DDoS、直播、点播、Web应用防火墙、API网关、TEO、容器服务、对象存储、轻应用服务器、云原生微服务、云开发 |
|
| 2.| **腾讯云-部署证书到任意云资源** | 支持负载均衡、CDN、DDoS、直播、点播、Web应用防火墙、API网关、TEO、容器服务、对象存储、轻应用服务器、云原生微服务、云开发 |
|
||||||
| 3.| **腾讯云-部署到CDN(废弃)** | 已废弃,请使用v2版 |
|
| 3.| **腾讯云-部署到CDN(废弃)** | 已废弃,请使用v2版 |
|
||||||
| 4.| **腾讯云-部署到CDN-v2** | 推荐使用 |
|
| 4.| **腾讯云-部署到CDN-v2** | 推荐使用,支持CDN域名以及COS加速域名 |
|
||||||
| 5.| **腾讯云-部署到CLB** | 暂时只支持单向认证证书,暂时只支持通用负载均衡 |
|
| 5.| **腾讯云-部署到CLB** | 暂时只支持单向认证证书,暂时只支持通用负载均衡 |
|
||||||
| 6.| **腾讯云-部署证书到COS** | 部署到腾讯云COS源站域名证书【注意:很不稳定,需要重试很多次偶尔才能成功一次】 |
|
| 6.| **腾讯云-部署证书到COS** | 部署到腾讯云COS源站域名证书,注意是源站域名,加速域名请使用腾讯云CDN v2插件【注意:很不稳定,需要重试很多次偶尔才能成功一次】 |
|
||||||
| 7.| **腾讯云-部署到腾讯云EO** | 腾讯云边缘安全加速平台EdgeOne(EO) |
|
| 7.| **腾讯云-部署到腾讯云EO** | 腾讯云边缘安全加速平台EdgeOne(EO) |
|
||||||
| 8.| **腾讯云-部署到腾讯云直播** | https://console.cloud.tencent.com/live/ |
|
| 8.| **腾讯云-部署到腾讯云直播** | https://console.cloud.tencent.com/live/ |
|
||||||
| 9.| **腾讯云-部署到TKE** | 修改TKE集群密钥配置,支持Opaque和TLS证书类型。注意: 1. serverless集群请使用K8S部署插件; 2. Opaque类型需要【上传到腾讯云】作为前置任务; 3. ApiServer需要开通公网访问(或者certd可访问),实际上底层仍然是通过KubeClient进行部署 |
|
| 9.| **腾讯云-部署到TKE** | 修改TKE集群密钥配置,支持Opaque和TLS证书类型。注意: 1. serverless集群请使用K8S部署插件; 2. Opaque类型需要【上传到腾讯云】作为前置任务; 3. ApiServer需要开通公网访问(或者certd可访问),实际上底层仍然是通过KubeClient进行部署 |
|
||||||
@@ -130,8 +134,10 @@
|
|||||||
| 3.| **火山引擎-部署证书至CLB** | 部署至火山引擎负载均衡 |
|
| 3.| **火山引擎-部署证书至CLB** | 部署至火山引擎负载均衡 |
|
||||||
| 4.| **火山引擎-部署证书至DCDN** | 部署至火山引擎全站加速 |
|
| 4.| **火山引擎-部署证书至DCDN** | 部署至火山引擎全站加速 |
|
||||||
| 5.| **火山引擎-部署证书至Live** | 部署至火山引擎视频直播 |
|
| 5.| **火山引擎-部署证书至Live** | 部署至火山引擎视频直播 |
|
||||||
| 6.| **火山引擎-部署证书至VOD** | 部署至火山引擎视频点播(暂不可用) |
|
| 6.| **火山引擎-部署证书至TOS自定义域名** | 仅限TOS自定义域名,加速域名请选择火山引擎的CDN插件 |
|
||||||
| 7.| **火山引擎-上传证书至证书中心** | 上传证书至火山引擎证书中心 |
|
| 7.| **火山引擎-替换VKE证书** | 替换火山引擎VKE集群中的TLS Secret证书 |
|
||||||
|
| 8.| **火山引擎-部署证书至VOD** | 部署至火山引擎视频点播 |
|
||||||
|
| 9.| **火山引擎-上传证书至证书中心** | 上传证书至火山引擎证书中心 |
|
||||||
## 9. 京东云
|
## 9. 京东云
|
||||||
|
|
||||||
| 序号 | 名称 | 说明 |
|
| 序号 | 名称 | 说明 |
|
||||||
@@ -153,8 +159,9 @@
|
|||||||
| 序号 | 名称 | 说明 |
|
| 序号 | 名称 | 说明 |
|
||||||
|-----|-----|-----|
|
|-----|-----|-----|
|
||||||
| 1.| **百度云-部署证书到负载均衡** | 部署到百度云负载均衡,包括BLB、APPBLB |
|
| 1.| **百度云-部署证书到负载均衡** | 部署到百度云负载均衡,包括BLB、APPBLB |
|
||||||
| 2.| **百度云-部署证书到CDN** | 部署到百度云CDN |
|
| 2.| **百度云-部署到CCE** | 部署到百度云CCE集群Ingress等通过Secret管理证书的应用 |
|
||||||
| 3.| **百度云-上传到证书托管** | 上传证书到百度云证书托管中心 |
|
| 3.| **百度云-部署证书到CDN** | 部署到百度云CDN |
|
||||||
|
| 4.| **百度云-上传到证书托管** | 上传证书到百度云证书托管中心 |
|
||||||
## 12. 七牛云
|
## 12. 七牛云
|
||||||
|
|
||||||
| 序号 | 名称 | 说明 |
|
| 序号 | 名称 | 说明 |
|
||||||
|
|||||||
@@ -5,22 +5,29 @@
|
|||||||
| 1.| **阿里ESA** | 阿里ESA DNS解析 |
|
| 1.| **阿里ESA** | 阿里ESA DNS解析 |
|
||||||
| 2.| **阿里云** | 阿里云DNS解析提供商 |
|
| 2.| **阿里云** | 阿里云DNS解析提供商 |
|
||||||
| 3.| **AWS Route53** | AWS Route53 DNS解析提供商 |
|
| 3.| **AWS Route53** | AWS Route53 DNS解析提供商 |
|
||||||
| 4.| **火山引擎** | 火山引擎DNS解析提供商 |
|
| 4.| **Azure DNS** | Azure DNS 解析提供商 |
|
||||||
| 5.| **京东云** | 京东云DNS解析提供商 |
|
| 5.| **火山引擎** | 火山引擎DNS解析提供商 |
|
||||||
| 6.| **新网(代理方式)** | 新网域名解析(代理方式) |
|
| 6.| **京东云** | 京东云DNS解析提供商 |
|
||||||
| 7.| **新网** | 新网域名解析 |
|
| 7.| **新网(代理方式)** | 新网域名解析(代理方式) |
|
||||||
| 8.| **cloudflare** | cloudflare dns provider |
|
| 8.| **新网** | 新网域名解析 |
|
||||||
| 9.| **dns.la** | dns.la |
|
| 9.| **BIND9 DNS** | 通过 SSH 连接到 BIND9 服务器,使用 nsupdate 命令管理 DNS 记录 |
|
||||||
| 10.| **godaddy** | GoDaddy |
|
| 10.| **cloudflare** | cloudflare dns provider |
|
||||||
| 11.| **华为云** | 华为云DNS解析提供商 |
|
| 11.| **dns.la** | dns.la |
|
||||||
| 12.| **namesilo** | namesilo dns provider |
|
| 12.| **godaddy** | GoDaddy |
|
||||||
| 13.| **雨云** | 雨云DNS解析提供商 |
|
| 13.| **HiPM DNSMgr** | HiPM DNSMgr DNS 解析提供商 |
|
||||||
| 14.| **腾讯云** | 腾讯云域名DNS解析提供者 |
|
| 14.| **华为云** | 华为云DNS解析提供商 |
|
||||||
| 15.| **腾讯云EO DNS** | 腾讯云EO DNS解析提供者 |
|
| 15.| **namesilo** | namesilo dns provider |
|
||||||
| 16.| **西部数码** | west dns provider |
|
| 16.| **雨云** | 雨云DNS解析提供商 |
|
||||||
| 17.| **Dns提供商Demo** | dns provider示例 |
|
| 17.| **Technitium DNS Server** | Technitium DNS Server 自建DNS服务器 |
|
||||||
| 18.| **51dns** | 51DNS |
|
| 18.| **腾讯云** | 腾讯云域名DNS解析提供者 |
|
||||||
| 19.| **新网互联** | 新网互联 |
|
| 19.| **腾讯云EO DNS** | 腾讯云EO DNS解析提供者 |
|
||||||
|
| 20.| **西部数码** | west dns provider |
|
||||||
|
| 21.| **Google Cloud DNS** | Google Cloud DNS提供商 |
|
||||||
|
| 22.| **Dns提供商Demo** | dns provider示例 |
|
||||||
|
| 23.| **彩虹DNS** | 彩虹DNS管理系统 |
|
||||||
|
| 24.| **Spaceship** | Spaceship 域名解析 |
|
||||||
|
| 25.| **51dns** | 51DNS |
|
||||||
|
| 26.| **新网互联** | 新网互联 |
|
||||||
|
|
||||||
<style module>
|
<style module>
|
||||||
table th:first-of-type {
|
table th:first-of-type {
|
||||||
|
|||||||
@@ -60,3 +60,6 @@ DNS problem: NXDOMAIN looking up TXT for _acme-challenge.xxxxx - check that a D
|
|||||||
1、域名的ns服务器修改成别的了,但申请证书时的DNS提供商选择错误(检查确认,配置正确的DNS提供商)
|
1、域名的ns服务器修改成别的了,但申请证书时的DNS提供商选择错误(检查确认,配置正确的DNS提供商)
|
||||||
2、证书颁发机构与ns域名服务器之间访问不通,无法查询到TXT记录(尝试更换证书颁发机构)
|
2、证书颁发机构与ns域名服务器之间访问不通,无法查询到TXT记录(尝试更换证书颁发机构)
|
||||||
3、ns服务商解析值生效慢(尝试修改证书申请任务里面的等待生效时长600-1000s)
|
3、ns服务商解析值生效慢(尝试修改证书申请任务里面的等待生效时长600-1000s)
|
||||||
|
|
||||||
|
## 8. 同一份证书上传多次的问题
|
||||||
|
同一份证书在阿里云、腾讯云中上传多次,[请使用证书复用功能](../use/pretask/index.md),避免重复上传。
|
||||||
@@ -28,6 +28,11 @@ https://certd.handsfree.work/
|
|||||||
2. [Docker方式部署](./install/docker/)
|
2. [Docker方式部署](./install/docker/)
|
||||||
3. [源码方式部署](./install/source/)
|
3. [源码方式部署](./install/source/)
|
||||||
|
|
||||||
|
::: tip
|
||||||
|
默认安装使用SQLite数据库,如果需要使用MySQL、PostgreSQL数据库,请参考[多数据库支持](./install/database.md)
|
||||||
|
:::
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### 2. 访问测试
|
### 2. 访问测试
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,28 @@
|
|||||||
|
# Azure 配置
|
||||||
|
|
||||||
|
## Access授权配置
|
||||||
|
|
||||||
|
1. 登录 Azure 并创建一个资源组 【可选,如果已经有了可以不用创建】
|
||||||
|
2. 创建一个应用程序
|
||||||
|
Microsoft Entra ID - 》 应用注册 - 》 新注册
|
||||||
|

|
||||||
|

|
||||||
|
|
||||||
|
3. 配置授权
|
||||||
|

|
||||||
|
|
||||||
|
4. 点击测试
|
||||||
|
|
||||||
|
## Azure DNS 配置
|
||||||
|
|
||||||
|
1. 创建一个 DNS 区域(就是一个域名)
|
||||||
|

|
||||||
|

|
||||||
|
|
||||||
|
2. 为这个域名和上面创建的授权应用分配角色
|
||||||
|

|
||||||
|

|
||||||
|

|
||||||
|
|
||||||
|
3. 然后就可以给dns区域去申请证书了
|
||||||
|
|
||||||
|
After Width: | Height: | Size: 107 KiB |
|
After Width: | Height: | Size: 70 KiB |
|
After Width: | Height: | Size: 108 KiB |
|
After Width: | Height: | Size: 55 KiB |
|
After Width: | Height: | Size: 62 KiB |
|
After Width: | Height: | Size: 145 KiB |
|
After Width: | Height: | Size: 93 KiB |
|
After Width: | Height: | Size: 112 KiB |
@@ -7,3 +7,4 @@
|
|||||||
* [支付宝支付配置](./payments/alipay.md)
|
* [支付宝支付配置](./payments/alipay.md)
|
||||||
* [微信支付配置](./payments/wxpay.md)
|
* [微信支付配置](./payments/wxpay.md)
|
||||||
* [彩虹易支付配置](./payments/yizhifu.md)
|
* [彩虹易支付配置](./payments/yizhifu.md)
|
||||||
|
* [插件选项映射](./plugin/)
|
||||||
|
After Width: | Height: | Size: 67 KiB |
|
After Width: | Height: | Size: 133 KiB |
@@ -0,0 +1,37 @@
|
|||||||
|
# 插件选项映射
|
||||||
|
|
||||||
|
商业版可以通过插件配置,自定义插件中下拉选择框的选项显示内容。
|
||||||
|
|
||||||
|
## 适用场景
|
||||||
|
|
||||||
|
插件中部分下拉选择框的选项可能带有"免费"、"测试"等字眼,商业版运营场景下需要隐藏或改写这些文字。
|
||||||
|
|
||||||
|
## 配置方式
|
||||||
|
|
||||||
|
1. 进入"系统管理" → "插件管理"
|
||||||
|
2. 找到需要配置的插件(如 CertApply 证书申请),点击"配置"按钮
|
||||||
|
3. 在"插件参数自定义"对话框中,找到带有下拉选项的参数(如"证书颁发机构")
|
||||||
|
4. 该参数的配置行会多出一项"选项映射",点击"自定义"
|
||||||
|
|
||||||
|
### 填写映射关系
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
系统会列出该下拉框的所有**选项值**和**原始显示内容**:
|
||||||
|
|
||||||
|
| 选项值 | 原始显示 | 自定义显示 |
|
||||||
|
|---|---|---|
|
||||||
|
| letsencrypt | Let's Encrypt(免费,新手推荐,支持IP证书) | [输入框] |
|
||||||
|
| google | Google(免费) | [输入框] |
|
||||||
|
|
||||||
|
- "自定义显示"一列为输入框,默认 placeholder 显示原始内容
|
||||||
|
- 只需填写**需要改写**的选项,留空的选项将保持原始显示
|
||||||
|
- 例如:将 Let's Encrypt(免费,新手推荐,支持IP证书) 改写为 Let's Encrypt
|
||||||
|
|
||||||
|
### 保存生效
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
填写完成后保存配置,用户在创建证书流水线时看到的选项文字即会变更为自定义内容。
|
||||||
|
|
||||||
|
|
||||||
|
Before Width: | Height: | Size: 44 KiB After Width: | Height: | Size: 92 KiB |
@@ -8,7 +8,7 @@
|
|||||||

|

|
||||||

|

|
||||||
3. 填写域名、端口和密码
|
3. 填写域名、端口和密码
|
||||||

|

|
||||||
|
|
||||||
## QQ邮箱配置
|
## QQ邮箱配置
|
||||||
1. smtp配置
|
1. smtp配置
|
||||||
@@ -20,4 +20,6 @@ smtp端口: 465
|
|||||||
```
|
```
|
||||||
|
|
||||||
2. 获取授权码
|
2. 获取授权码
|
||||||
|
登录qq邮箱,点击账号与安全
|
||||||
|
|
||||||

|

|
||||||
|
|||||||
|
After Width: | Height: | Size: 161 KiB |
@@ -26,16 +26,20 @@ Created an external account key
|
|||||||
[b64MacKey: xxxxxxxxxxxxxxxx
|
[b64MacKey: xxxxxxxxxxxxxxxx
|
||||||
keyId: xxxxxxxxxxxxx]
|
keyId: xxxxxxxxxxxxx]
|
||||||
```
|
```
|
||||||
|

|
||||||
|
|
||||||
3. 到Certd中,创建一条EAB授权记录,填写keyId(=kid) 和 b64MacKey 信息
|
3. 到Certd中,创建一条EAB授权记录,填写keyId(=kid) 和 b64MacKey 信息
|
||||||
注意:keyId没有`]`结尾,不要把`]`也复制了
|
注意:keyId没有`]`结尾,不要把`]`也复制了
|
||||||
|
|
||||||
注意:EAB授权使用过一次之后,会绑定邮箱,后续再次使用时,要使用相同的邮箱
|
注意:EAB授权使用过一次之后,会绑定邮箱,后续再次使用时,要使用相同的邮箱,所以邮箱切记不要修改
|
||||||
否则会报错 `Unknown external account binding (EAB) key. This may be due to the EAB key expiring which occurs 7 days after creation`
|
否则会报错 `Unknown external account binding (EAB) key. This may be due to the EAB key expiring which occurs 7 days after creation`
|
||||||
|
|
||||||
### 2.2 通过服务账号获取EAB
|
4. 创建证书流水线,选择证书提供商为google,选择EAB授权,运行流水线申请证书
|
||||||
|
|
||||||
此方式可以自动EAB,需要配置代理
|
|
||||||
|
### 2.2 通过google服务账号接口获取授权
|
||||||
|
|
||||||
|
此方式可以自动获取EAB,需要服务端配置代理
|
||||||
|
|
||||||
1. 创建服务账号
|
1. 创建服务账号
|
||||||
https://console.cloud.google.com/projectselector2/iam-admin/serviceaccounts/create?walkthrough_id=iam--create-service-account&hl=zh-cn#step_index=1
|
https://console.cloud.google.com/projectselector2/iam-admin/serviceaccounts/create?walkthrough_id=iam--create-service-account&hl=zh-cn#step_index=1
|
||||||
@@ -48,9 +52,7 @@ https://console.cloud.google.com/projectselector2/iam-admin/serviceaccounts/crea
|
|||||||
7. 点击`添加密钥`->`创建新密钥`->`JSON`,下载密钥文件
|
7. 点击`添加密钥`->`创建新密钥`->`JSON`,下载密钥文件
|
||||||
8. 将json文件内容粘贴到 certd中 Google服务授权输入框中
|
8. 将json文件内容粘贴到 certd中 Google服务授权输入框中
|
||||||
|
|
||||||
|
9. 创建证书流水线,选择证书提供商为google, 选择服务账号授权,运行流水线申请证书
|
||||||
|
|
||||||
## 3、 创建证书流水线
|
|
||||||
选择证书提供商为google, 选择EAB授权 或 服务账号授权
|
|
||||||
|
|
||||||
## 4、 其他就跟正常申请证书一样了
|
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,40 @@
|
|||||||
|
# 企业模式(项目管理)
|
||||||
|
|
||||||
|
## 模式简介
|
||||||
|
Certd支持两种管理模式,`SaaS模式(默认)`和`企业模式`。
|
||||||
|
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
## SaaS模式
|
||||||
|
* 默认的模式,每个用户管理自己的流水线和授权资源,每个用户独立使用。
|
||||||
|
* Certd系统作为SaaS提供证书自动申请部署服务,您的客户注册即可使用,无需自己部署
|
||||||
|
|
||||||
|
|
||||||
|
## 企业模式
|
||||||
|
|
||||||
|
* 通过项目合作管理流水线证书和授权资源,所有用户视为企业内部员工。
|
||||||
|
|
||||||
|
* 当你想在企业内部使用,企业内部有多个项目,各个项目成员共同管理项目资源和证书时可以启用此模式
|
||||||
|
|
||||||
|
* 需要在"系统设置->管理模式"中开启`企业模式`
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
|
||||||
|
::: warning
|
||||||
|
* 建议在开始使用时固定一个合适的模式,之后就不要随意切换了。
|
||||||
|
* 商业版不能使用企业模式,因为商业版提供功能价值在于SaaS服务,与企业模式冲突
|
||||||
|
:::
|
||||||
|
|
||||||
|
### 数据迁移
|
||||||
|
模式之间数据不互通,您可以通过个人数据迁移功能将数据转到项目之下
|
||||||
|
|
||||||
|
#### 个人数据迁移到项目
|
||||||
|
注意:此操作不可逆,请谨慎操作
|
||||||
|

|
||||||
|
|
||||||
|
#### 流水线数据转到其他项目
|
||||||
|
项目之间流水线数据可以转移,依赖的授权数据会同步复制一份
|
||||||
|
|
||||||
|

|
||||||
|
After Width: | Height: | Size: 95 KiB |
|
After Width: | Height: | Size: 118 KiB |
|
After Width: | Height: | Size: 145 KiB |
@@ -1,10 +1,10 @@
|
|||||||
# 带输出的前置任务
|
# 证书复用
|
||||||
|
|
||||||
前置任务输出可以在后续任务中使用
|
前置任务输出可以在后续任务中使用
|
||||||
|
|
||||||
比如上传证书到阿里云,会返回阿里云的CertId,之后其他阿里云的部署任务可以选择复用这个证书
|
比如上传证书到阿里云,会返回阿里云的CertId,之后其他阿里云的部署任务可以选择复用这个证书
|
||||||
|
|
||||||
## 复用证书
|
## 使用方法
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
|||||||
@@ -9,5 +9,5 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"npmClient": "pnpm",
|
"npmClient": "pnpm",
|
||||||
"version": "1.38.12"
|
"version": "1.41.1"
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -9,6 +9,7 @@
|
|||||||
"@lerna-lite/run": "^3.9.3",
|
"@lerna-lite/run": "^3.9.3",
|
||||||
"@lerna-lite/version": "^3.9.3",
|
"@lerna-lite/version": "^3.9.3",
|
||||||
"axios": "^1.9.0",
|
"axios": "^1.9.0",
|
||||||
|
"cross-env": "^7.0.3",
|
||||||
"medium-zoom": "^1.1.0",
|
"medium-zoom": "^1.1.0",
|
||||||
"vitepress": "^2.0.0-alpha.4",
|
"vitepress": "^2.0.0-alpha.4",
|
||||||
"vitepress-plugin-lightbox": "^1.0.2"
|
"vitepress-plugin-lightbox": "^1.0.2"
|
||||||
@@ -19,14 +20,15 @@
|
|||||||
"devb": "lerna run dev-build",
|
"devb": "lerna run dev-build",
|
||||||
"i-all": "lerna link && lerna exec npm install ",
|
"i-all": "lerna link && lerna exec npm install ",
|
||||||
"publish": "pnpm run prepublishOnly2 && lerna publish --force-publish=pro/plus-core --conventional-commits && pnpm run afterpublishOnly ",
|
"publish": "pnpm run prepublishOnly2 && lerna publish --force-publish=pro/plus-core --conventional-commits && pnpm run afterpublishOnly ",
|
||||||
|
"publish2":" npm run pub_all && pnpm run afterpublishOnly",
|
||||||
"afterpublishOnly": "pnpm run copylogs && time /t >trigger/build.trigger && git add ./trigger/build.trigger && git commit -m \"build: trigger build image\" && TIMEOUT /T 10 && pnpm run commitAll",
|
"afterpublishOnly": "pnpm run copylogs && time /t >trigger/build.trigger && git add ./trigger/build.trigger && git commit -m \"build: trigger build image\" && TIMEOUT /T 10 && pnpm run commitAll",
|
||||||
"transform-sql": "cd ./packages/ui/certd-server/db/ && node --experimental-json-modules transform.js",
|
"transform-sql": "cd ./packages/ui/certd-server/db/ && node --experimental-json-modules transform.js",
|
||||||
"plugin-doc-gen": "cd ./packages/ui/certd-server/ && pnpm run export-metadata",
|
"plugin-doc-gen": "cd ./packages/ui/certd-server/ && pnpm run export-metadata",
|
||||||
"commitAll": "git add . && git commit -m \"build: publish\" && git push && pnpm run commitPro",
|
"commitAll": "git add . && git commit -m \"build: publish\" && git push && pnpm run commitPro",
|
||||||
"commitPro": "cd ./packages/pro/ && git add . && git commit -m \"build: publish\" && git push",
|
"commitPro": "cd ./packages/pro/ && git add . && git commit -m \"build: publish\" && git push",
|
||||||
"copylogs": "copyfiles \"CHANGELOG.md\" ./docs/guide/changelogs/",
|
"copylogs": "copyfiles \"CHANGELOG.md\" ./docs/guide/changelogs/",
|
||||||
"prepublishOnly1": "pnpm run check && lerna run build ",
|
"prepublishOnly1": "pnpm run test:unit && pnpm run check && lerna run build ",
|
||||||
"prepublishOnly2": "pnpm run check && pnpm run before-build && lerna run build && pnpm run plugin-doc-gen",
|
"prepublishOnly2": "pnpm run test:unit && pnpm run check && pnpm run before-build && lerna run build && pnpm run plugin-doc-gen",
|
||||||
"before-build": "pnpm run transform-sql && cd ./packages/core/basic && time /t >build.md && git add ./build.md && git commit -m \"build: prepare to build\"",
|
"before-build": "pnpm run transform-sql && cd ./packages/core/basic && time /t >build.md && git add ./build.md && git commit -m \"build: prepare to build\"",
|
||||||
"deploy1": "node --experimental-json-modules ./scripts/deploy.js ",
|
"deploy1": "node --experimental-json-modules ./scripts/deploy.js ",
|
||||||
"check": "node --experimental-json-modules ./scripts/publish-check.js",
|
"check": "node --experimental-json-modules ./scripts/publish-check.js",
|
||||||
@@ -35,8 +37,10 @@
|
|||||||
"docs:dev": "vitepress dev docs",
|
"docs:dev": "vitepress dev docs",
|
||||||
"docs:build": "pnpm run copylogs && vitepress build docs",
|
"docs:build": "pnpm run copylogs && vitepress build docs",
|
||||||
"docs:preview": "vitepress preview docs",
|
"docs:preview": "vitepress preview docs",
|
||||||
|
"test:unit": "cross-env NODE_ENV=unittest pnpm -r --workspace-concurrency=1 run test:unit",
|
||||||
"pub": "echo 1",
|
"pub": "echo 1",
|
||||||
"dev": "pnpm run -r --parallel compile ",
|
"dev": "pnpm run -r --parallel compile ",
|
||||||
|
"pub_all": "node ./scripts/pub-all.js",
|
||||||
"release": "time /t >trigger/release.trigger && git add trigger/release.trigger && git commit -m \"build: release\" && git push",
|
"release": "time /t >trigger/release.trigger && git add trigger/release.trigger && git commit -m \"build: release\" && git push",
|
||||||
"publish_to_atomgit": "node --experimental-json-modules ./scripts/publish-atomgit.js",
|
"publish_to_atomgit": "node --experimental-json-modules ./scripts/publish-atomgit.js",
|
||||||
"publish_to_gitee": "node --experimental-json-modules ./scripts/publish-gitee.js",
|
"publish_to_gitee": "node --experimental-json-modules ./scripts/publish-gitee.js",
|
||||||
|
|||||||
@@ -1,4 +1,13 @@
|
|||||||
{
|
{
|
||||||
|
"parser": "@typescript-eslint/parser",
|
||||||
|
"parserOptions": {
|
||||||
|
"ecmaVersion": 2022,
|
||||||
|
"sourceType": "module"
|
||||||
|
},
|
||||||
|
"ignorePatterns": [
|
||||||
|
"dist",
|
||||||
|
"node_modules"
|
||||||
|
],
|
||||||
"extends": [
|
"extends": [
|
||||||
"plugin:prettier/recommended",
|
"plugin:prettier/recommended",
|
||||||
"prettier"
|
"prettier"
|
||||||
@@ -7,9 +16,12 @@
|
|||||||
"eslint-plugin-import"
|
"eslint-plugin-import"
|
||||||
],
|
],
|
||||||
"env": {
|
"env": {
|
||||||
|
"node": true,
|
||||||
|
"es2022": true,
|
||||||
"mocha": true
|
"mocha": true
|
||||||
},
|
},
|
||||||
"rules": {
|
"rules": {
|
||||||
|
"prettier/prettier": "off",
|
||||||
"@typescript-eslint/no-var-requires": "off",
|
"@typescript-eslint/no-var-requires": "off",
|
||||||
"@typescript-eslint/ban-ts-comment": "off",
|
"@typescript-eslint/ban-ts-comment": "off",
|
||||||
"@typescript-eslint/ban-ts-ignore": "off",
|
"@typescript-eslint/ban-ts-ignore": "off",
|
||||||
|
|||||||
@@ -4,3 +4,8 @@ node_modules/
|
|||||||
npm-debug.log
|
npm-debug.log
|
||||||
package-lock.json
|
package-lock.json
|
||||||
/.idea/
|
/.idea/
|
||||||
|
/dist/
|
||||||
|
/dist-test/
|
||||||
|
/logs/
|
||||||
|
/tsconfig.tsbuildinfo
|
||||||
|
/tsconfig.test.tsbuildinfo
|
||||||
|
|||||||
@@ -3,6 +3,126 @@
|
|||||||
All notable changes to this project will be documented in this file.
|
All notable changes to this project will be documented in this file.
|
||||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||||
|
|
||||||
|
## [1.41.1](https://github.com/publishlab/node-acme-client/compare/v1.41.0...v1.41.1) (2026-06-05)
|
||||||
|
|
||||||
|
**Note:** Version bump only for package @certd/acme-client
|
||||||
|
|
||||||
|
# [1.41.0](https://github.com/publishlab/node-acme-client/compare/v1.40.5...v1.41.0) (2026-06-04)
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* 修复阿里云证书订单orderid 选择出错的问题 ([41254d1](https://github.com/publishlab/node-acme-client/commit/41254d10b748a2d3e6ba43c7e11411650c748d1b))
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
* 支持dns-persist-01持久化验证方式申请证书,优化Acme账号的存储方式 ([67b05e2](https://github.com/publishlab/node-acme-client/commit/67b05e2d75e96b9f855e1ca0b3d0d8d03b92d8e6))
|
||||||
|
|
||||||
|
## [1.40.5](https://github.com/publishlab/node-acme-client/compare/v1.40.4...v1.40.5) (2026-05-26)
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* 修复阿里云证书订单orderid 选择出错的问题 ([af9047b](https://github.com/publishlab/node-acme-client/commit/af9047bf3c54ce71b11727ccc6220288ed1f57be))
|
||||||
|
|
||||||
|
## [1.40.4](https://github.com/publishlab/node-acme-client/compare/v1.40.3...v1.40.4) (2026-05-24)
|
||||||
|
|
||||||
|
**Note:** Version bump only for package @certd/acme-client
|
||||||
|
|
||||||
|
## [1.40.3](https://github.com/publishlab/node-acme-client/compare/v1.40.2...v1.40.3) (2026-05-21)
|
||||||
|
|
||||||
|
**Note:** Version bump only for package @certd/acme-client
|
||||||
|
|
||||||
|
## [1.40.2](https://github.com/publishlab/node-acme-client/compare/v1.40.1...v1.40.2) (2026-05-19)
|
||||||
|
|
||||||
|
**Note:** Version bump only for package @certd/acme-client
|
||||||
|
|
||||||
|
## [1.40.1](https://github.com/publishlab/node-acme-client/compare/v1.40.0...v1.40.1) (2026-05-18)
|
||||||
|
|
||||||
|
**Note:** Version bump only for package @certd/acme-client
|
||||||
|
|
||||||
|
# [1.40.0](https://github.com/publishlab/node-acme-client/compare/v1.39.16...v1.40.0) (2026-05-14)
|
||||||
|
|
||||||
|
**Note:** Version bump only for package @certd/acme-client
|
||||||
|
|
||||||
|
## [1.39.16](https://github.com/publishlab/node-acme-client/compare/v1.39.15...v1.39.16) (2026-05-13)
|
||||||
|
|
||||||
|
**Note:** Version bump only for package @certd/acme-client
|
||||||
|
|
||||||
|
## [1.39.15](https://github.com/publishlab/node-acme-client/compare/v1.39.14...v1.39.15) (2026-05-13)
|
||||||
|
|
||||||
|
### Performance Improvements
|
||||||
|
|
||||||
|
* 优化申请时报错日志增加对应域名打印 ([d6e9e59](https://github.com/publishlab/node-acme-client/commit/d6e9e5987bd52ea12ee18745615486eadd4c87ff))
|
||||||
|
|
||||||
|
## [1.39.14](https://github.com/publishlab/node-acme-client/compare/v1.39.13...v1.39.14) (2026-05-11)
|
||||||
|
|
||||||
|
**Note:** Version bump only for package @certd/acme-client
|
||||||
|
|
||||||
|
## [1.39.13](https://github.com/publishlab/node-acme-client/compare/v1.39.12...v1.39.13) (2026-05-10)
|
||||||
|
|
||||||
|
### Performance Improvements
|
||||||
|
|
||||||
|
* 重构自动加载模块并优化EAB授权处理 ([4755216](https://github.com/publishlab/node-acme-client/commit/4755216505ad18555a50da9d8008c2207c48df86))
|
||||||
|
|
||||||
|
## [1.39.12](https://github.com/publishlab/node-acme-client/compare/v1.39.11...v1.39.12) (2026-04-29)
|
||||||
|
|
||||||
|
### Performance Improvements
|
||||||
|
|
||||||
|
* 增加权威NS检查开关,某些用户服务器禁止向黑名单NS服务器发请求 ([1aa50cf](https://github.com/publishlab/node-acme-client/commit/1aa50cf53a0deab752f35ec973912e41ab8161b6))
|
||||||
|
|
||||||
|
## [1.39.11](https://github.com/publishlab/node-acme-client/compare/v1.39.10...v1.39.11) (2026-04-26)
|
||||||
|
|
||||||
|
### Performance Improvements
|
||||||
|
|
||||||
|
* 为DNS解析器添加超时配置,避免查询时间过长 ([cc5154e](https://github.com/publishlab/node-acme-client/commit/cc5154e04e87f648111119b4eeb4e3cb4dd6cc41))
|
||||||
|
* 优化权威域名服务器查询超时时长 ([77db5ec](https://github.com/publishlab/node-acme-client/commit/77db5ecd12c51293e4de178e43ca0067bc70b46d))
|
||||||
|
* **technitium:** 添加Technitium DNS Server插件支持 ([edeb817](https://github.com/publishlab/node-acme-client/commit/edeb817c39597e4fa73a17ff4ca3f712f0320fec))
|
||||||
|
|
||||||
|
## [1.39.10](https://github.com/publishlab/node-acme-client/compare/v1.39.9...v1.39.10) (2026-04-11)
|
||||||
|
|
||||||
|
**Note:** Version bump only for package @certd/acme-client
|
||||||
|
|
||||||
|
## [1.39.9](https://github.com/publishlab/node-acme-client/compare/v1.39.8...v1.39.9) (2026-04-05)
|
||||||
|
|
||||||
|
**Note:** Version bump only for package @certd/acme-client
|
||||||
|
|
||||||
|
## [1.39.8](https://github.com/publishlab/node-acme-client/compare/v1.39.7...v1.39.8) (2026-03-31)
|
||||||
|
|
||||||
|
**Note:** Version bump only for package @certd/acme-client
|
||||||
|
|
||||||
|
## [1.39.7](https://github.com/publishlab/node-acme-client/compare/v1.39.6...v1.39.7) (2026-03-25)
|
||||||
|
|
||||||
|
**Note:** Version bump only for package @certd/acme-client
|
||||||
|
|
||||||
|
## [1.39.6](https://github.com/publishlab/node-acme-client/compare/v1.39.5...v1.39.6) (2026-03-22)
|
||||||
|
|
||||||
|
**Note:** Version bump only for package @certd/acme-client
|
||||||
|
|
||||||
|
## [1.39.5](https://github.com/publishlab/node-acme-client/compare/v1.39.4...v1.39.5) (2026-03-18)
|
||||||
|
|
||||||
|
**Note:** Version bump only for package @certd/acme-client
|
||||||
|
|
||||||
|
## [1.39.4](https://github.com/publishlab/node-acme-client/compare/v1.39.3...v1.39.4) (2026-03-17)
|
||||||
|
|
||||||
|
**Note:** Version bump only for package @certd/acme-client
|
||||||
|
|
||||||
|
## [1.39.3](https://github.com/publishlab/node-acme-client/compare/v1.39.2...v1.39.3) (2026-03-17)
|
||||||
|
|
||||||
|
**Note:** Version bump only for package @certd/acme-client
|
||||||
|
|
||||||
|
## [1.39.2](https://github.com/publishlab/node-acme-client/compare/v1.39.1...v1.39.2) (2026-03-16)
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* 修复京东云报错不准确的bug ([10dd89a](https://github.com/publishlab/node-acme-client/commit/10dd89ae62e438a211a15e729559af823a096583))
|
||||||
|
|
||||||
|
## [1.39.1](https://github.com/publishlab/node-acme-client/compare/v1.39.0...v1.39.1) (2026-03-09)
|
||||||
|
|
||||||
|
**Note:** Version bump only for package @certd/acme-client
|
||||||
|
|
||||||
|
# [1.39.0](https://github.com/publishlab/node-acme-client/compare/v1.38.12...v1.39.0) (2026-03-07)
|
||||||
|
|
||||||
|
**Note:** Version bump only for package @certd/acme-client
|
||||||
|
|
||||||
## [1.38.12](https://github.com/publishlab/node-acme-client/compare/v1.38.11...v1.38.12) (2026-02-18)
|
## [1.38.12](https://github.com/publishlab/node-acme-client/compare/v1.38.11...v1.38.12) (2026-02-18)
|
||||||
|
|
||||||
**Note:** Version bump only for package @certd/acme-client
|
**Note:** Version bump only for package @certd/acme-client
|
||||||
|
|||||||
@@ -3,22 +3,22 @@
|
|||||||
"description": "Simple and unopinionated ACME client",
|
"description": "Simple and unopinionated ACME client",
|
||||||
"private": false,
|
"private": false,
|
||||||
"author": "nmorsman",
|
"author": "nmorsman",
|
||||||
"version": "1.38.12",
|
"version": "1.41.1",
|
||||||
"type": "module",
|
"type": "module",
|
||||||
"module": "scr/index.js",
|
"module": "./dist/index.js",
|
||||||
"main": "src/index.js",
|
"main": "./dist/index.js",
|
||||||
"types": "types/index.d.ts",
|
"types": "./dist/index.d.ts",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"homepage": "https://github.com/publishlab/node-acme-client",
|
"homepage": "https://github.com/publishlab/node-acme-client",
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": ">= 18"
|
"node": ">= 18"
|
||||||
},
|
},
|
||||||
"files": [
|
"files": [
|
||||||
"src",
|
"dist",
|
||||||
"types"
|
"types"
|
||||||
],
|
],
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@certd/basic": "^1.38.12",
|
"@certd/basic": "^1.41.1",
|
||||||
"@peculiar/x509": "^1.11.0",
|
"@peculiar/x509": "^1.11.0",
|
||||||
"asn1js": "^3.0.5",
|
"asn1js": "^3.0.5",
|
||||||
"axios": "^1.9.0",
|
"axios": "^1.9.0",
|
||||||
@@ -35,10 +35,12 @@
|
|||||||
"@typescript-eslint/parser": "^8.26.1",
|
"@typescript-eslint/parser": "^8.26.1",
|
||||||
"chai": "^4.4.1",
|
"chai": "^4.4.1",
|
||||||
"chai-as-promised": "^7.1.2",
|
"chai-as-promised": "^7.1.2",
|
||||||
|
"cross-env": "^7.0.3",
|
||||||
"eslint": "^8.57.0",
|
"eslint": "^8.57.0",
|
||||||
"eslint-config-prettier": "^8.5.0",
|
"eslint-config-prettier": "^8.5.0",
|
||||||
"eslint-plugin-import": "^2.29.1",
|
"eslint-plugin-import": "^2.29.1",
|
||||||
"eslint-plugin-prettier": "^4.2.1",
|
"eslint-plugin-prettier": "^4.2.1",
|
||||||
|
"esmock": "^2.7.5",
|
||||||
"jsdoc-to-markdown": "^8.0.1",
|
"jsdoc-to-markdown": "^8.0.1",
|
||||||
"mocha": "^10.6.0",
|
"mocha": "^10.6.0",
|
||||||
"nock": "^13.5.4",
|
"nock": "^13.5.4",
|
||||||
@@ -47,13 +49,17 @@
|
|||||||
"typescript": "^5.4.2"
|
"typescript": "^5.4.2"
|
||||||
},
|
},
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"build-docs": "jsdoc2md src/client.js > docs/client.md && jsdoc2md src/crypto/index.js > docs/crypto.md && jsdoc2md src/crypto/forge.js > docs/forge.md",
|
"before-build": "node -e \"const fs=require('fs');fs.rmSync('dist',{recursive:true,force:true});fs.rmSync('tsconfig.tsbuildinfo',{force:true});\"",
|
||||||
"lint": "eslint .",
|
"build": "npm run before-build && tsc -p tsconfig.build.json --skipLibCheck",
|
||||||
"lint-types": "tsd",
|
"build-docs": "jsdoc2md dist/client.js > docs/client.md && jsdoc2md dist/crypto/index.js > docs/crypto.md && jsdoc2md dist/crypto/forge.js > docs/forge.md",
|
||||||
"prepublishOnly": "npm run build-docs",
|
"lint": "eslint \"src/**/*.ts\" \"types/**/*.ts\"",
|
||||||
|
"lint-types": "tsd --files \"types/index.test-d.ts\"",
|
||||||
|
"prepublishOnly": "npm run build && npm run build-docs",
|
||||||
"test": "mocha -t 60000 \"test/setup.js\" \"test/**/*.spec.js\"",
|
"test": "mocha -t 60000 \"test/setup.js\" \"test/**/*.spec.js\"",
|
||||||
|
"before-test:unit": "node -e \"const fs=require('fs');fs.rmSync('dist-test',{recursive:true,force:true});fs.rmSync('tsconfig.test.tsbuildinfo',{force:true});\"",
|
||||||
|
"test:unit": "cross-env NODE_ENV=unittest npm run before-test:unit && cross-env NODE_ENV=unittest tsc -p tsconfig.test.json --skipLibCheck && cross-env NODE_ENV=unittest mocha -t 60000 \"dist-test/**/*.test.js\"",
|
||||||
"pub": "npm publish",
|
"pub": "npm publish",
|
||||||
"compile": "echo '1'"
|
"compile": "tsc --skipLibCheck --watch"
|
||||||
},
|
},
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
@@ -70,5 +76,5 @@
|
|||||||
"bugs": {
|
"bugs": {
|
||||||
"url": "https://github.com/publishlab/node-acme-client/issues"
|
"url": "https://github.com/publishlab/node-acme-client/issues"
|
||||||
},
|
},
|
||||||
"gitHead": "49457505cdf8156fd9d936b8e9ace0b48e43a6b2"
|
"gitHead": "cdea411136fdf56352699a6e278a403e0f53a94f"
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,3 +1,4 @@
|
|||||||
|
// @ts-nocheck
|
||||||
/**
|
/**
|
||||||
* ACME API client
|
* ACME API client
|
||||||
*/
|
*/
|
||||||
@@ -1,3 +1,4 @@
|
|||||||
|
// @ts-nocheck
|
||||||
/**
|
/**
|
||||||
* ACME auto helper
|
* ACME auto helper
|
||||||
*/
|
*/
|
||||||
@@ -21,7 +22,8 @@ const defaultOpts = {
|
|||||||
},
|
},
|
||||||
challengeRemoveFn: async () => {
|
challengeRemoveFn: async () => {
|
||||||
throw new Error("Missing challengeRemoveFn()");
|
throw new Error("Missing challengeRemoveFn()");
|
||||||
}
|
},
|
||||||
|
waitDnsDiffuseTime: 30,
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -165,6 +167,7 @@ export default async (client, userOpts) => {
|
|||||||
await client.completeChallenge(challenge);
|
await client.completeChallenge(challenge);
|
||||||
}catch (e) {
|
}catch (e) {
|
||||||
await deactivateAuth(e);
|
await deactivateAuth(e);
|
||||||
|
e.message = `[${d}] ${e.message || "completeChallenge error"}`;
|
||||||
throw e;
|
throw e;
|
||||||
}
|
}
|
||||||
challengeCompleted = true;
|
challengeCompleted = true;
|
||||||
@@ -174,8 +177,9 @@ export default async (client, userOpts) => {
|
|||||||
|
|
||||||
|
|
||||||
} catch (e) {
|
} catch (e) {
|
||||||
log(`[auto] [${d}] challengeCreateFn threw error: ${e.message}`);
|
log(`[auto] [${d}] challengeCreateFn threw error: ${e.message || e}`);
|
||||||
await deactivateAuth(e);
|
await deactivateAuth(e);
|
||||||
|
e.message = `[${d}] ${e.message || "challengeCreateFn error"}`;
|
||||||
throw e;
|
throw e;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -1,3 +1,4 @@
|
|||||||
|
// @ts-nocheck
|
||||||
/**
|
/**
|
||||||
* Axios instance
|
* Axios instance
|
||||||
*/
|
*/
|
||||||
@@ -1,3 +1,4 @@
|
|||||||
|
// @ts-nocheck
|
||||||
/**
|
/**
|
||||||
* ACME client
|
* ACME client
|
||||||
*
|
*
|
||||||
@@ -466,6 +467,10 @@ class AcmeClient {
|
|||||||
return createHash('sha256').update(result).digest('base64url');
|
return createHash('sha256').update(result).digest('base64url');
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if (challenge.type === 'dns-persist-01') {
|
||||||
|
return '';
|
||||||
|
}
|
||||||
|
|
||||||
/* https://datatracker.ietf.org/doc/html/rfc8737 */
|
/* https://datatracker.ietf.org/doc/html/rfc8737 */
|
||||||
if (challenge.type === 'tls-alpn-01') {
|
if (challenge.type === 'tls-alpn-01') {
|
||||||
return result;
|
return result;
|
||||||
@@ -494,7 +499,7 @@ class AcmeClient {
|
|||||||
throw new Error('Unable to verify ACME challenge, URL not found');
|
throw new Error('Unable to verify ACME challenge, URL not found');
|
||||||
}
|
}
|
||||||
|
|
||||||
const {challenges} = createChallengeFn({logger:this.logger});
|
const {challenges} = createChallengeFn({logger:this.logger,walkFromAuthoritative: this.opts.walkFromAuthoritative});
|
||||||
|
|
||||||
const verify = challenges
|
const verify = challenges
|
||||||
if (typeof verify[challenge.type] === 'undefined') {
|
if (typeof verify[challenge.type] === 'undefined') {
|
||||||
@@ -570,14 +575,14 @@ class AcmeClient {
|
|||||||
* ```
|
* ```
|
||||||
*/
|
*/
|
||||||
|
|
||||||
async waitForValidStatus(item,d) {
|
async waitForValidStatus(item, d?) {
|
||||||
if (!item.url) {
|
if (!item.url) {
|
||||||
throw new Error(`[${d}] Unable to verify status of item, URL not found`);
|
throw new Error(`[${d}] Unable to verify status of item, URL not found`);
|
||||||
}
|
}
|
||||||
|
|
||||||
const verifyFn = async (abort) => {
|
const verifyFn = async (abort) => {
|
||||||
if (this.opts.signal && this.opts.signal.aborted) {
|
if (this.opts.signal && this.opts.signal.aborted) {
|
||||||
abort();
|
abort(true);
|
||||||
throw new CancelError('用户取消');
|
throw new CancelError('用户取消');
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -588,7 +593,8 @@ class AcmeClient {
|
|||||||
|
|
||||||
if (invalidStates.includes(resp.data.status)) {
|
if (invalidStates.includes(resp.data.status)) {
|
||||||
abort();
|
abort();
|
||||||
throw new Error(util.formatResponseError(resp));
|
this.log(`[${d}] : 检查状态 = ${resp.data.status} : ${JSON.stringify(resp.data)}`);
|
||||||
|
throw new Error("校验失败:" + util.formatResponseError(resp));
|
||||||
}
|
}
|
||||||
else if (pendingStates.includes(resp.data.status)) {
|
else if (pendingStates.includes(resp.data.status)) {
|
||||||
throw new Error(`[${d}] Operation is pending or processing(当前仍然在等待状态)`);
|
throw new Error(`[${d}] Operation is pending or processing(当前仍然在等待状态)`);
|
||||||
@@ -1,3 +1,4 @@
|
|||||||
|
// @ts-nocheck
|
||||||
/**
|
/**
|
||||||
* Legacy node-forge crypto interface
|
* Legacy node-forge crypto interface
|
||||||
*
|
*
|
||||||
@@ -112,7 +113,7 @@ function parseDomains(obj) {
|
|||||||
* ```
|
* ```
|
||||||
*/
|
*/
|
||||||
|
|
||||||
export async function createPrivateKey(size = 2048) {
|
export async function createPrivateKey(size = 2048): Promise<Buffer> {
|
||||||
const keyPair = await generateKeyPair({ bits: size });
|
const keyPair = await generateKeyPair({ bits: size });
|
||||||
const pemKey = forge.pki.privateKeyToPem(keyPair.privateKey);
|
const pemKey = forge.pki.privateKeyToPem(keyPair.privateKey);
|
||||||
return Buffer.from(pemKey);
|
return Buffer.from(pemKey);
|
||||||
@@ -131,7 +132,7 @@ export async function createPrivateKey(size = 2048) {
|
|||||||
* ```
|
* ```
|
||||||
*/
|
*/
|
||||||
|
|
||||||
export const createPublicKey = async (key) => {
|
export const createPublicKey = async (key): Promise<Buffer> => {
|
||||||
const privateKey = forge.pki.privateKeyFromPem(key);
|
const privateKey = forge.pki.privateKeyFromPem(key);
|
||||||
const publicKey = forge.pki.rsa.setPublicKey(privateKey.n, privateKey.e);
|
const publicKey = forge.pki.rsa.setPublicKey(privateKey.n, privateKey.e);
|
||||||
const pemKey = forge.pki.publicKeyToPem(publicKey);
|
const pemKey = forge.pki.publicKeyToPem(publicKey);
|
||||||
@@ -174,7 +175,7 @@ export const splitPemChain = (str) => forge.pem.decode(str).map(forge.pem.encode
|
|||||||
* ```
|
* ```
|
||||||
*/
|
*/
|
||||||
|
|
||||||
export const getModulus = async (input) => {
|
export const getModulus = async (input): Promise<Buffer> => {
|
||||||
if (!Buffer.isBuffer(input)) {
|
if (!Buffer.isBuffer(input)) {
|
||||||
input = Buffer.from(input);
|
input = Buffer.from(input);
|
||||||
}
|
}
|
||||||
@@ -197,7 +198,7 @@ export const getModulus = async (input) => {
|
|||||||
* ```
|
* ```
|
||||||
*/
|
*/
|
||||||
|
|
||||||
export const getPublicExponent = async (input) => {
|
export const getPublicExponent = async (input): Promise<Buffer> => {
|
||||||
if (!Buffer.isBuffer(input)) {
|
if (!Buffer.isBuffer(input)) {
|
||||||
input = Buffer.from(input);
|
input = Buffer.from(input);
|
||||||
}
|
}
|
||||||
@@ -1,3 +1,4 @@
|
|||||||
|
// @ts-nocheck
|
||||||
/**
|
/**
|
||||||
* Native Node.js crypto interface
|
* Native Node.js crypto interface
|
||||||
*
|
*
|
||||||
@@ -67,7 +68,7 @@ function getKeyInfo(keyPem) {
|
|||||||
* ```
|
* ```
|
||||||
*/
|
*/
|
||||||
|
|
||||||
export async function createPrivateRsaKey(modulusLength = 2048, encodingType = 'pkcs8') {
|
export async function createPrivateRsaKey(modulusLength = 2048, encodingType = 'pkcs8'): Promise<Buffer> {
|
||||||
const pair = await generateKeyPair('rsa', {
|
const pair = await generateKeyPair('rsa', {
|
||||||
modulusLength,
|
modulusLength,
|
||||||
privateKeyEncoding: {
|
privateKeyEncoding: {
|
||||||
@@ -105,7 +106,7 @@ export const createPrivateKey = createPrivateRsaKey;
|
|||||||
* ```
|
* ```
|
||||||
*/
|
*/
|
||||||
|
|
||||||
export const createPrivateEcdsaKey = async (namedCurve = 'P-256', encodingType = 'pkcs8') => {
|
export const createPrivateEcdsaKey = async (namedCurve = 'P-256', encodingType = 'pkcs8'): Promise<Buffer> => {
|
||||||
const pair = await generateKeyPair('ec', {
|
const pair = await generateKeyPair('ec', {
|
||||||
namedCurve,
|
namedCurve,
|
||||||
privateKeyEncoding: {
|
privateKeyEncoding: {
|
||||||
@@ -129,7 +130,7 @@ export const createPrivateEcdsaKey = async (namedCurve = 'P-256', encodingType =
|
|||||||
* ```
|
* ```
|
||||||
*/
|
*/
|
||||||
|
|
||||||
export const getPublicKey = (keyPem) => {
|
export const getPublicKey = (keyPem): Buffer => {
|
||||||
const info = getKeyInfo(keyPem);
|
const info = getKeyInfo(keyPem);
|
||||||
|
|
||||||
const publicKey = info.publicKey.export({
|
const publicKey = info.publicKey.export({
|
||||||
@@ -1,3 +1,4 @@
|
|||||||
|
// @ts-nocheck
|
||||||
export class CancelError extends Error {
|
export class CancelError extends Error {
|
||||||
constructor(message) {
|
constructor(message) {
|
||||||
super(message);
|
super(message);
|
||||||
@@ -1,3 +1,4 @@
|
|||||||
|
// @ts-nocheck
|
||||||
/**
|
/**
|
||||||
* ACME HTTP client
|
* ACME HTTP client
|
||||||
*/
|
*/
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
import assert from "node:assert/strict";
|
||||||
|
import { directory, getAllSslProviderDomains, getDirectoryUrl } from "./index.js";
|
||||||
|
|
||||||
|
declare const describe: any;
|
||||||
|
declare const it: any;
|
||||||
|
|
||||||
|
describe("directory helpers", () => {
|
||||||
|
it("selects the provider specific directory endpoint", () => {
|
||||||
|
assert.equal(getDirectoryUrl({ sslProvider: "sslcom", pkType: "ec" }), directory.sslcom.ec);
|
||||||
|
assert.equal(getDirectoryUrl({ sslProvider: "letsencrypt", pkType: "rsa" }), directory.letsencrypt.production);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("includes configured provider domains", () => {
|
||||||
|
const domains = getAllSslProviderDomains();
|
||||||
|
|
||||||
|
assert.ok(domains.includes("acme.litessl.com"));
|
||||||
|
assert.ok(domains.includes("acme.ssl.com"));
|
||||||
|
});
|
||||||
|
});
|
||||||
@@ -1,8 +1,9 @@
|
|||||||
|
// @ts-nocheck
|
||||||
/**
|
/**
|
||||||
* acme-client
|
* acme-client
|
||||||
*/
|
*/
|
||||||
import AcmeClinet from './client.js'
|
export { default as Client } from './client.js'
|
||||||
export const Client = AcmeClinet
|
export type * from './types.js'
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Directory URLs
|
* Directory URLs
|
||||||
@@ -1,3 +1,4 @@
|
|||||||
|
// @ts-nocheck
|
||||||
/**
|
/**
|
||||||
* ACME logger
|
* ACME logger
|
||||||
*/
|
*/
|
||||||
@@ -0,0 +1,127 @@
|
|||||||
|
/**
|
||||||
|
* Account
|
||||||
|
*
|
||||||
|
* https://datatracker.ietf.org/doc/html/rfc8555#section-7.1.2
|
||||||
|
* https://datatracker.ietf.org/doc/html/rfc8555#section-7.3
|
||||||
|
* https://datatracker.ietf.org/doc/html/rfc8555#section-7.3.2
|
||||||
|
*/
|
||||||
|
|
||||||
|
export interface Account {
|
||||||
|
status: "valid" | "deactivated" | "revoked";
|
||||||
|
orders: string;
|
||||||
|
contact?: string[];
|
||||||
|
termsOfServiceAgreed?: boolean;
|
||||||
|
externalAccountBinding?: object;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface AccountCreateRequest {
|
||||||
|
contact?: string[];
|
||||||
|
termsOfServiceAgreed?: boolean;
|
||||||
|
onlyReturnExisting?: boolean;
|
||||||
|
externalAccountBinding?: object;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface AccountUpdateRequest {
|
||||||
|
status?: string;
|
||||||
|
contact?: string[];
|
||||||
|
termsOfServiceAgreed?: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Order
|
||||||
|
*
|
||||||
|
* https://datatracker.ietf.org/doc/html/rfc8555#section-7.1.3
|
||||||
|
* https://datatracker.ietf.org/doc/html/rfc8555#section-7.4
|
||||||
|
*/
|
||||||
|
|
||||||
|
export interface Order {
|
||||||
|
status: "pending" | "ready" | "processing" | "valid" | "invalid";
|
||||||
|
identifiers: Identifier[];
|
||||||
|
authorizations: string[];
|
||||||
|
finalize: string;
|
||||||
|
expires?: string;
|
||||||
|
notBefore?: string;
|
||||||
|
notAfter?: string;
|
||||||
|
error?: object;
|
||||||
|
certificate?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface OrderCreateRequest {
|
||||||
|
identifiers: Identifier[];
|
||||||
|
notBefore?: string;
|
||||||
|
notAfter?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Authorization
|
||||||
|
*
|
||||||
|
* https://datatracker.ietf.org/doc/html/rfc8555#section-7.1.4
|
||||||
|
*/
|
||||||
|
|
||||||
|
export interface Authorization {
|
||||||
|
identifier: Identifier;
|
||||||
|
status: "pending" | "valid" | "invalid" | "deactivated" | "expired" | "revoked";
|
||||||
|
challenges: Challenge[];
|
||||||
|
expires?: string;
|
||||||
|
wildcard?: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface Identifier {
|
||||||
|
type: string;
|
||||||
|
value: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Challenge
|
||||||
|
*
|
||||||
|
* https://datatracker.ietf.org/doc/html/rfc8555#section-8
|
||||||
|
* https://datatracker.ietf.org/doc/html/rfc8555#section-8.3
|
||||||
|
* https://datatracker.ietf.org/doc/html/rfc8555#section-8.4
|
||||||
|
*/
|
||||||
|
|
||||||
|
export interface ChallengeAbstract {
|
||||||
|
type: string;
|
||||||
|
url: string;
|
||||||
|
status: "pending" | "processing" | "valid" | "invalid";
|
||||||
|
validated?: string;
|
||||||
|
error?: object;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface HttpChallenge extends ChallengeAbstract {
|
||||||
|
type: "http-01";
|
||||||
|
token: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface DnsChallenge extends ChallengeAbstract {
|
||||||
|
type: "dns-01";
|
||||||
|
token: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface DnsPersistChallenge extends ChallengeAbstract {
|
||||||
|
type: "dns-persist-01";
|
||||||
|
}
|
||||||
|
|
||||||
|
export type Challenge = HttpChallenge | DnsChallenge | DnsPersistChallenge;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Certificate
|
||||||
|
*
|
||||||
|
* https://datatracker.ietf.org/doc/html/rfc8555#section-7.6
|
||||||
|
*/
|
||||||
|
|
||||||
|
export enum CertificateRevocationReason {
|
||||||
|
Unspecified = 0,
|
||||||
|
KeyCompromise = 1,
|
||||||
|
CACompromise = 2,
|
||||||
|
AffiliationChanged = 3,
|
||||||
|
Superseded = 4,
|
||||||
|
CessationOfOperation = 5,
|
||||||
|
CertificateHold = 6,
|
||||||
|
RemoveFromCRL = 8,
|
||||||
|
PrivilegeWithdrawn = 9,
|
||||||
|
AACompromise = 10,
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface CertificateRevocationRequest {
|
||||||
|
reason?: CertificateRevocationReason;
|
||||||
|
}
|
||||||
@@ -0,0 +1,131 @@
|
|||||||
|
import type * as rfc8555 from "./rfc8555.js";
|
||||||
|
import type { Challenge } from "./rfc8555.js";
|
||||||
|
|
||||||
|
export type * from "./rfc8555.js";
|
||||||
|
|
||||||
|
export type PrivateKeyBuffer = Buffer;
|
||||||
|
export type PublicKeyBuffer = Buffer;
|
||||||
|
export type CertificateBuffer = Buffer;
|
||||||
|
export type CsrBuffer = Buffer;
|
||||||
|
|
||||||
|
export type PrivateKeyString = string;
|
||||||
|
export type PublicKeyString = string;
|
||||||
|
export type CertificateString = string;
|
||||||
|
export type CsrString = string;
|
||||||
|
|
||||||
|
export interface Order extends rfc8555.Order {
|
||||||
|
url: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface Authorization extends rfc8555.Authorization {
|
||||||
|
url: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export type UrlMapping = {
|
||||||
|
enabled: boolean;
|
||||||
|
mappings: Record<string, string>;
|
||||||
|
};
|
||||||
|
|
||||||
|
export interface ClientExternalAccountBindingOptions {
|
||||||
|
kid: string;
|
||||||
|
hmacKey: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ClientOptions {
|
||||||
|
sslProvider: string;
|
||||||
|
directoryUrl: string;
|
||||||
|
accountKey: PrivateKeyBuffer | PrivateKeyString;
|
||||||
|
accountUrl?: string;
|
||||||
|
externalAccountBinding?: ClientExternalAccountBindingOptions;
|
||||||
|
backoffAttempts?: number;
|
||||||
|
backoffMin?: number;
|
||||||
|
backoffMax?: number;
|
||||||
|
urlMapping?: UrlMapping;
|
||||||
|
signal?: AbortSignal;
|
||||||
|
logger?: any;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ClientAutoOptions {
|
||||||
|
csr: CsrBuffer | CsrString;
|
||||||
|
challengeCreateFn: (
|
||||||
|
authz: Authorization,
|
||||||
|
keyAuthorization: (challenge: Challenge) => Promise<string>
|
||||||
|
) => Promise<{ recordReq?: any; recordRes?: any; dnsProvider?: any; challenge: Challenge; keyAuthorization: string }>;
|
||||||
|
challengeRemoveFn: (authz: Authorization, challenge: Challenge, keyAuthorization: string, recordReq: any, recordRes: any, dnsProvider: any, httpUploader: any) => Promise<any>;
|
||||||
|
email?: string;
|
||||||
|
termsOfServiceAgreed?: boolean;
|
||||||
|
skipChallengeVerification?: boolean;
|
||||||
|
challengePriority?: string[];
|
||||||
|
preferredChain?: string;
|
||||||
|
signal?: AbortSignal;
|
||||||
|
profile?: string;
|
||||||
|
waitDnsDiffuseTime?: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface CertificateDomains {
|
||||||
|
commonName: string;
|
||||||
|
altNames: string[];
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface CertificateIssuer {
|
||||||
|
commonName: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface CertificateInfo {
|
||||||
|
issuer: CertificateIssuer;
|
||||||
|
domains: CertificateDomains;
|
||||||
|
notAfter: Date;
|
||||||
|
notBefore: Date;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface CsrOptions {
|
||||||
|
keySize?: number;
|
||||||
|
commonName?: string;
|
||||||
|
altNames?: string[];
|
||||||
|
country?: string;
|
||||||
|
state?: string;
|
||||||
|
locality?: string;
|
||||||
|
organization?: string;
|
||||||
|
organizationUnit?: string;
|
||||||
|
emailAddress?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface RsaPublicJwk {
|
||||||
|
e: string;
|
||||||
|
kty: string;
|
||||||
|
n: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface EcdsaPublicJwk {
|
||||||
|
crv: string;
|
||||||
|
kty: string;
|
||||||
|
x: string;
|
||||||
|
y: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface CryptoInterface {
|
||||||
|
createPrivateKey(keySize?: number, encodingType?: string): Promise<PrivateKeyBuffer>;
|
||||||
|
createPrivateRsaKey(keySize?: number, encodingType?: string): Promise<PrivateKeyBuffer>;
|
||||||
|
createPrivateEcdsaKey(namedCurve?: "P-256" | "P-384" | "P-521", encodingType?: string): Promise<PrivateKeyBuffer>;
|
||||||
|
getPublicKey(keyPem: PrivateKeyBuffer | PrivateKeyString | PublicKeyBuffer | PublicKeyString): PublicKeyBuffer;
|
||||||
|
getJwk(keyPem: PrivateKeyBuffer | PrivateKeyString | PublicKeyBuffer | PublicKeyString): RsaPublicJwk | EcdsaPublicJwk;
|
||||||
|
splitPemChain(chainPem: CertificateBuffer | CertificateString): string[];
|
||||||
|
getPemBodyAsB64u(pem: CertificateBuffer | CertificateString): string;
|
||||||
|
readCsrDomains(csrPem: CsrBuffer | CsrString): CertificateDomains;
|
||||||
|
readCertificateInfo(certPem: CertificateBuffer | CertificateString): CertificateInfo;
|
||||||
|
createCsr(data: CsrOptions, keyPem?: PrivateKeyBuffer | PrivateKeyString, encodingType?: string): Promise<[PrivateKeyBuffer, CsrBuffer]>;
|
||||||
|
createAlpnCertificate(authz: Authorization, keyAuthorization: string, keyPem?: PrivateKeyBuffer | PrivateKeyString): Promise<[PrivateKeyBuffer, CertificateBuffer]>;
|
||||||
|
isAlpnCertificateAuthorizationValid(certPem: CertificateBuffer | CertificateString, keyAuthorization: string): boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface CryptoLegacyInterface {
|
||||||
|
createPrivateKey(size?: number): Promise<PrivateKeyBuffer>;
|
||||||
|
createPublicKey(key: PrivateKeyBuffer | PrivateKeyString): Promise<PublicKeyBuffer>;
|
||||||
|
getPemBody(str: string): string;
|
||||||
|
splitPemChain(str: string): string[];
|
||||||
|
getModulus(input: PrivateKeyBuffer | PrivateKeyString | PublicKeyBuffer | PublicKeyString | CertificateBuffer | CertificateString | CsrBuffer | CsrString): Promise<Buffer>;
|
||||||
|
getPublicExponent(input: PrivateKeyBuffer | PrivateKeyString | PublicKeyBuffer | PublicKeyString | CertificateBuffer | CertificateString | CsrBuffer | CsrString): Promise<Buffer>;
|
||||||
|
readCsrDomains(csr: CsrBuffer | CsrString): Promise<CertificateDomains>;
|
||||||
|
readCertificateInfo(cert: CertificateBuffer | CertificateString): Promise<CertificateInfo>;
|
||||||
|
createCsr(data: CsrOptions, key?: PrivateKeyBuffer | PrivateKeyString): Promise<[PrivateKeyBuffer, CsrBuffer]>;
|
||||||
|
}
|
||||||
@@ -0,0 +1,58 @@
|
|||||||
|
import assert from "node:assert/strict";
|
||||||
|
import { formatResponseError, parseRetryAfterHeader, retry } from "./util.js";
|
||||||
|
|
||||||
|
declare const describe: any;
|
||||||
|
declare const it: any;
|
||||||
|
|
||||||
|
describe("util helpers", () => {
|
||||||
|
it("parses retry-after values", () => {
|
||||||
|
assert.equal(parseRetryAfterHeader("120"), 120);
|
||||||
|
assert.equal(parseRetryAfterHeader("invalid"), 0);
|
||||||
|
assert.equal(parseRetryAfterHeader("Wed, 21 Oct 2015 07:28:00 GMT"), 0);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("formats response errors without newlines", () => {
|
||||||
|
const error = formatResponseError({
|
||||||
|
data: {
|
||||||
|
error: {
|
||||||
|
detail: "line 1\nline 2",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
assert.equal(error, "line 1line 2");
|
||||||
|
});
|
||||||
|
|
||||||
|
it("retries until success", async () => {
|
||||||
|
const delays: number[] = [];
|
||||||
|
const originalSetTimeout = globalThis.setTimeout;
|
||||||
|
let attempts = 0;
|
||||||
|
|
||||||
|
(globalThis as any).setTimeout = (fn: (...args: any[]) => void, delay?: number) => {
|
||||||
|
delays.push(Number(delay));
|
||||||
|
return originalSetTimeout(fn, 0);
|
||||||
|
};
|
||||||
|
|
||||||
|
try {
|
||||||
|
const result = await retry(
|
||||||
|
async () => {
|
||||||
|
attempts += 1;
|
||||||
|
|
||||||
|
if (attempts < 3) {
|
||||||
|
throw new Error(`boom-${attempts}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
return "ok";
|
||||||
|
},
|
||||||
|
{ attempts: 3, min: 10, max: 20 },
|
||||||
|
() => {}
|
||||||
|
);
|
||||||
|
|
||||||
|
assert.equal(result, "ok");
|
||||||
|
assert.equal(attempts, 3);
|
||||||
|
assert.deepEqual(delays, [10, 20]);
|
||||||
|
} finally {
|
||||||
|
(globalThis as any).setTimeout = originalSetTimeout;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
});
|
||||||