diff --git a/README.md b/README.md index 6b1ce12d..e0c424aa 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,7 @@ https://certd.handsfree.work/ ↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑↑ 当前支持的部署插件列表 -![演示](./doc/images/plugins.png) +![演示](./docs/images/plugins/list.png) ## 四、私有化部署 @@ -71,7 +71,7 @@ https://certd.handsfree.work/ * 镜像构建通过`Actions`自动执行,过程公开透明,请放心使用 * [点我查看镜像构建日志](https://github.com/certd/certd/actions/workflows/build-image.yml) -![](./doc/images/action-build.jpg) +![](./docs/images/action/action-build.jpg) ## 五、 升级 diff --git a/doc/deploy/baota/baota.md b/doc/deploy/baota/baota.md deleted file mode 100644 index 9b4cd640..00000000 --- a/doc/deploy/baota/baota.md +++ /dev/null @@ -1,32 +0,0 @@ -# 宝塔部署教程 - -## 编排模版部署 - -### 创建docker模版 -打开docker-compose.yaml, -https://gitee.com/certd/certd/raw/v2/docker/run/docker-compose.yaml - -整个内容复制下来 - -然后到宝塔里面进到docker的编排模版,新建模版 -![](./images/1.png) - -### 启动应用 - -![img.png](./images/2.png) - -等待启动完成 - -### 打开应用 - -http://ip:7001 - - -## 二、一键应用部署 -需要宝塔9.2.0版本 - -### 应用商店 -进入应用商店,更新应用列表 - -### 搜索certd -点击安装 \ No newline at end of file diff --git a/doc/deploy/baota/images/1.png b/doc/deploy/baota/images/1.png deleted file mode 100644 index 50f6be0b..00000000 Binary files a/doc/deploy/baota/images/1.png and /dev/null differ diff --git a/doc/deploy/baota/images/2.png b/doc/deploy/baota/images/2.png deleted file mode 100644 index 90966cb1..00000000 Binary files a/doc/deploy/baota/images/2.png and /dev/null differ diff --git a/doc/deploy/koyeb.md b/doc/deploy/koyeb.md deleted file mode 100644 index e69de29b..00000000 diff --git a/doc/dev/development.md b/doc/dev/development.md deleted file mode 100644 index 3d1fadcb..00000000 --- a/doc/dev/development.md +++ /dev/null @@ -1,96 +0,0 @@ -# 本地开发 -欢迎贡献插件 - -## 1.本地调试运行 - -### 克隆代码 -```shell - -# 克隆代码 -git clone https://github.com/certd/certd - -#进入项目目录 -cd certd - -# 切换到最新版本代码 -git checkout v1.26.7 # 这里换成最新版本号 - -``` - -### 修改pnpm-workspace.yaml文件 -重要:否则无法正确加载专业版的access和plugin -```yaml -# pnpm-workspace.yaml -packages: - - 'packages/**' # <--------------注释掉这一行,PR时不要提交此修改 - - 'packages/ui/**' -``` - -### 安装依赖和初始化: -```shell -# 安装pnpm,如果提示npm命令不存在,就需要先安装nodejs -npm install -g pnpm@8.15.7 --registry=https://registry.npmmirror.com - -# 使用国内镜像源,如果有代理,就不需要 -pnpm config set registry https://registry.npmmirror.com -# 安装依赖 -pnpm install - -# 初始化构建 -npm run init -``` - -### 启动 server: -```shell -cd packages/ui/certd-server -npm run dev -``` - -### 启动 client: -```shell -cd packages/ui/certd-client -npm run dev - -# 会自动打开浏览器,确认正常运行 - -``` - -## 开发插件 -进入 `packages/ui/certd-server/src/plugins` - -### 1.复制`plugin-demo`目录作为你的插件目录 -比如你想做`cloudflare`的插件,那么你可以复制`plugin-demo`目录,将其命名成`plugin-cloudflare`。 -以下均以`plugin-cloudflare`为例进行说明,你需要将其替换成你的插件名称 - -### 2. access授权 -如果这是一个新的平台,它应该有授权方式,比如accessKey accessSecret之类的 -参考`plugin-cloudflare/access.ts` 修改为你要做的平台的`access` -这样用户就可以在`certd`后台中创建这种授权凭证了 - -### 3. dns-provider -如果域名是这个平台进行解析的,那么你需要实现dns-provider,(申请证书需要) -参考`plugin-cloudflare/dns-provider.ts` 修改为你要做的平台的`dns-provider` - -### 4. plugin-deploy -如果这个平台有需要部署证书的地方 -参考`plugin-cloudflare/plugins/plugin-deploy-to-xx.ts` 修改为你要做的平台的`plugin-deploy-to-xx` - -### 5. 增加导入 -在`plugin-cloudflare/index.ts`中增加你的插件的`import` -```ts -export * from './dns-provider' -export * from './access' -export * from './plugins/plugin-deploy-to-xx' -```` - -在`./src/plugins/index.ts`中增加`import` - -```ts -export * from "./plugin-cloudflare.js" -``` - -## 重启服务进行调试 -刷新浏览器,检查你的插件是否工作正常, 确保能够正常进行证书申请和部署 - -## 提交PR -我们将尽快审核PR diff --git a/doc/images/action-build.jpg b/doc/images/action-build.jpg deleted file mode 100644 index 9e7187a0..00000000 Binary files a/doc/images/action-build.jpg and /dev/null differ diff --git a/doc/images/donate.png b/doc/images/donate.png deleted file mode 100644 index dc3f501e..00000000 Binary files a/doc/images/donate.png and /dev/null differ diff --git a/doc/images/me.png b/doc/images/me.png deleted file mode 100644 index ad620803..00000000 Binary files a/doc/images/me.png and /dev/null differ diff --git a/doc/images/plugins.png b/doc/images/plugins.png deleted file mode 100644 index 8bc59cb5..00000000 Binary files a/doc/images/plugins.png and /dev/null differ diff --git a/step.md b/step.md index e0b7458a..71dc5447 100644 --- a/step.md +++ b/step.md @@ -106,9 +106,5 @@ cron格式,例如: `0 0 3 * * *` 表示每天凌晨3点执行 以上,演示了从创建证书申请任务到自动部署证书全流程。 -如有疑问,欢迎加入群聊(请备注certd) -* QQ群:141236433 -* 微信群: - ![](https://ai.handsfree.work/images/exchange_wxqroup.png) - +如有任何疑问,[欢迎联系我们](https://certd.docmirror.cn/guide/contact/)